Skip to main content
POST
/
agent_api_keys
Create Api Key
curl --request POST \
  --url https://api.example.com/agent_api_keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "agent_id": "<string>",
  "agent_name": "<string>",
  "api_key": "<string>",
  "api_key_type": "external"
}
'
{
  "agent_id": "<string>",
  "api_key": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>"
}

Body

application/json
​
name
string
required

The name of the agent's API key.

​
agent_id
string | null

The UUID of the agent

​
agent_name
string | null

The name of the agent - if not provided, the agent_id must be set.

​
api_key
string | null

Optionally provide the API key value - if not set, one will be generated.

​
api_key_type
enum<string>
default:external

The type of the agent API key (external by default).

Available options:
internal,
external,
github,
slack

Response

Successful Response

​
agent_id
string
required

The UUID of the agent

​
api_key
string
required

The value of the newly created API key.

​
api_key_type
enum<string>
required

The type of the created agent API key (external).

Available options:
internal,
external,
github,
slack
​
created_at
string<date-time>
required

When the agent API key was created

​
id
string
required

The unique identifier of the agent API key.

​
name
string | null
required

The optional name of the agent API key.