Create an API key

Create a new API key for the organization. The raw token is returned once and never retrievable again. Requires a key with the manage-API-keys capability.

post/v1/api-keys

Request

  • Base URL
    https://api.runbear.io
  • Auth
    HTTP bearer

Request body

descriptionstring nullable

Human-readable label for the key

canChatboolean

Allow the key to run threads, chat, and upload files

canManageAgentsboolean

Allow the key to create/update/delete agents and org config

canManageApiKeysboolean

Allow the key to manage the organization's API keys. The highest-privilege capability — grant only to trusted internal keys.

allowedAgentIdsstring[]

Restrict the key to these agent (App) ids. Omit or leave empty for all agents.

Response

Default Response

idstring uuid required

Unique identifier of the API key

tokenstring required

The raw secret token. Shown once at creation and never retrievable again.

Changes

No recorded changes to this operation across all 1 revision of this API.