Skip to main content
GET
/
agent_api_keys
/
{id}
Return the API key by ID
curl --request GET \
  --url https://api.example.com/agent_api_keys/{id}
{
  "id": "<string>",
  "agent_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

id
string
required

Response

Successful Response

id
string
required

The unique identifier of the agent API key.

agent_id
string
required

The UUID of the agent

created_at
string<date-time>
required

When the agent API key was created

name
string | null
required

The optional name of the agent API key.

api_key_type
enum<string>
required

The type of the agent API key (either internal or external)

Available options:
internal,
external,
github,
slack