Skip to main content
POST
/
agents
/
register-build
Register Build
curl --request POST \
  --url https://api.example.com/agents/register-build \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "principal_context": "<unknown>",
  "registration_metadata": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "Unknown",
  "status_reason": "<string>",
  "registration_metadata": {},
  "registered_at": "2023-11-07T05:31:56Z",
  "production_deployment_id": "<string>"
}

Body

application/json

Request model for registering an agent at build time (pre-deploy).

Unlike RegisterAgentRequest, there is no acp_url (the agent is not running yet) and no acp_type is required. The created agent is left in BUILD_ONLY status so it can be permissioned/shared before it is deployed.

​
name
string
required

The unique name of the agent.

Pattern: ^[a-z0-9-]+$
​
description
string
required

The description of the agent.

​
principal_context
any | null

Principal used for authorization

​
registration_metadata
Registration Metadata · object

The metadata for the agent's build registration.

​
agent_input_type
enum<string> | null

The type of input the agent expects.

Available options:
text,
json

Response

Successful Response

​
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 async)

Available options:
sync,
async,
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>
default:Unknown

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

Available options:
Ready,
Failed,
Unknown,
Deleted,
Unhealthy,
BuildOnly
​
status_reason
string | null

The reason for the status of the action.

​
registration_metadata
Registration Metadata · object

The metadata for the agent's registration.

​
registered_at
string<date-time> | null

The timestamp when the agent was last registered

​
agent_input_type
enum<string> | null

The type of input the agent expects.

Available options:
text,
json
​
production_deployment_id
string | null

ID of the current production deployment.