Skip to main content
GET
Get agent

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

agent_uuid
string
required

The agent to retrieve

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Response

Successful Response

uuid
string
required

ID of the agent

Required string length: 36
Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

name
string
required

Name of the agent

type
enum<string>
required
  • agent: built inside Calibrate
  • connection: your existing agent connected to Calibrate
Available options:
agent,
connection
created_at
string
required

When the agent was created (ISO 8601 UTC)

updated_at
string
required

When the agent was last updated (ISO 8601 UTC)

config
object | null

Agent configuration