Create Agent API Key

Changed on

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

post/api/v1/organizations/users/{userId}/agents/{agentId}/api-keys

Request

  • Base URL
    https://api.skyfire.xyz
  • URL
    https://api.skyfire.xyz/api/v1/organizations/users/{userId}/agents/{agentId}/api-keys
  • Auth
    API key in header skyfire-api-key

Path parameters

userIdstring uuid required

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

agentIdstring uuid required

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

Request body

notesstring

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

Response

Ok

idstring required

Unique identifier of the API key. Use this ID to activate or deactivate the key.

apiKeystring required

The raw API key. Returned only in this response — it cannot be retrieved again.

lastFourstring required

Last four characters of the key, for identifying it in listings.

activeboolean required

Whether the key currently authenticates. Always true on creation.

notesstring

The label provided at creation. Omitted when none was set.

createdAtstring required

When the key was created. e.g. "2026-08-28T17:04:11.000Z".

Changes