Organize access with gateway keys

Assign keys around people and applications, with clear resource and access boundaries.

Concept & preparation guideUpdated Oct 21, 2026

Distinguish the two credentials

Provider credential
Used by the gateway to connect to a model service, configured by an authorized administrator.
Gateway key
Used by an application to access BOS API; associate it with the person or application using it.

Organize keys by purpose

  • Confirm resource ownership and management permissions before assigning keys.
  • Separate applications, environments, or purposes to make usage and troubleshooting easier to follow.
  • Confirm the available models, quota, and request frequency requirements for each key.
  • Verify request behavior after credential changes and follow the key management process for your deployment version.

Verify actual permission boundaries

Organizations, people, and keys describe the objects being managed. They do not imply that every role has the same permissions. Verify who can create, view, edit, or revoke each resource for your deployment.

Credential visibility, log fields, and isolation behavior require their own mechanism descriptions and test evidence. This concept guide makes no security acceptance claims.

Match capabilities and procedures to your deployment version. Read the documentation scope

BOS API · TYPEX

Sales consultation is unavailable

Sales reception could not be initialized. Please try again later. Documentation and free self-hosting remain available.

Read the docsSelf-host for free