POST
/
agents
/
register
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "status": "Unknown",
  "acp_type": "sync",
  "status_reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "registration_metadata": {},
  "registered_at": "2023-11-07T05:31:56Z",
  "agent_api_key": "<string>"
}

Body

application/json
​
name
string
required

The unique name of the agent.

​
description
string
required

The description of the agent.

​
acp_url
string
required

The URL of the ACP server for the agent.

​
acp_type
enum<string>
required

The type of ACP to use for the agent.

Available options:
sync,
agentic
​
agent_id
string | null

Optional agent ID if the agent already exists and needs to be updated.

​
principal_context
any

Principal used for authorization

​
registration_metadata
object | null

The metadata for the agent's registration.

Response

Successful Response

Response model for registering an agent.

​
id
string
required

The unique identifier of the agent.

​
name
string
required

The unique name of the agent.

​
description
string
required

The description of the action.

​
acp_type
enum<string>
required

The type of the ACP Server (Either sync or agentic)

Available options:
sync,
agentic
​
created_at
string<date-time>
required

The timestamp when the agent was created

​
updated_at
string<date-time>
required

The timestamp when the agent was last updated

​
status
enum<string>

The status of the action, indicating if it's building, ready, failed, etc.

Available options:
Pending,
Building,
Ready,
Failed,
Unknown
​
status_reason
string | null

The reason for the status of the action.

​
registration_metadata
object | null

The metadata for the agent's registration.

​
registered_at
string<date-time> | null

The timestamp when the agent was last registered

​
agent_api_key
string | null

The API key for the agent, if applicable.