Create Agent API Key

As an Organization Admin, create a new API key for an agent belonging to a user in your organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401.

The agent is resolved through the ownership chain organization → user → agent, all scoped to your own organization. A user or agent that does not exist, belongs to another organization, or is not owned by the given user returns 404. The agent must be active. An inactive agent also returns 404.

The raw key is returned only in this response and cannot be retrieved again. Store it securely on receipt. Afterwards the key is identified only by its id and lastFour.

The new key is active immediately. An agent can hold multiple active keys at once. Use the optional notes field to label keys for rotation tracking.

Path Params
uuid
required

Unique identifier of the user who owns the agent. e.g. "906fc259-ef0a-4736-bdcd-c1d5a78db483"

uuid
required

Unique identifier of the agent to create a key for. e.g. "5d084831-4a11-4970-bf62-bb6fc0b9f3a2"

Body Params
string
length ≤ 1000

Free-form label for the key, e.g. a rotation batch or environment name. At most 1000 characters.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json