Skip to main content
POST
Create an API key for an agent

Authorizations

Authorization
string
header
required

A Skydive API key, sent as Authorization: Bearer sky_live_.... Keys are scoped to a single agent and carry a use or edit scope. The full key value is shown once at creation and never again.

Path Parameters

agentId
string
required

The agent id.

Body

application/json
name
string
required

A label to help you recognize this key later.

Required string length: 1 - 120
Example:

"CI deploy key"

Response

The key was created. This is the only time the full key value is returned.

id
string
required

Unique identifier for this API key.

name
string
required

Human-readable label given to the key at creation.

prefix
string
required

First 12 characters of the key, safe to display. Use it to tell keys apart without exposing the secret.

Example:

"sky_live_1a2"

lastUsedAt
string<date-time> | null
required

When the key was last used to authenticate a request, or null if never used.

createdAt
string<date-time>
required

When the key was created.

key
string
required

The full API key secret. Returned only once, at creation. Store it securely: it cannot be retrieved again.

Example:

"sky_live_1a2b3c4d5e6f..."