Agents

Generate Agent Api Key

Changed on

Generate a new API key for an active agent. Rotates any existing key.

post/agents/{agent_id}:generate-api-key

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /agents/{agent_id}:generate-api-key
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Path parameters

agent_idstring required

ID of the agent.

Example:agnt_6968b3984d1c238dbe7e2e29

Response

Successful Response

keystring required

The plaintext API key; shown only once, store it securely.

Example response

{
  "key": "jak_example-secret"
}

Changes