Skip to content
agentex-sdk
API Reference
Agents

Register Build

POST/agents/register-build

Register an agent at build time, before it is deployed, so it can be permissioned and shared prior to deploy. Idempotent by name.

Body ParametersJSONExpand Collapse
description: string

The description of the agent.

name: string

The unique name of the agent.

agent_input_type: optional "text" or "json"

The type of input the agent expects.

One of the following:
"text"
"json"
registration_metadata: optional map[unknown]

The metadata for the agent’s build registration.

ReturnsExpand Collapse
Agent object { id, acp_type, created_at, 9 more }
id: string

The unique identifier of the agent.

acp_type: AcpType

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

One of the following:
"sync"
"async"
"agentic"
created_at: string

The timestamp when the agent was created

formatdate-time
description: string

The description of the action.

name: string

The unique name of the agent.

updated_at: string

The timestamp when the agent was last updated

formatdate-time
agent_input_type: optional "text" or "json"

The type of input the agent expects.

One of the following:
"text"
"json"
production_deployment_id: optional string

ID of the current production deployment.

registered_at: optional string

The timestamp when the agent was last registered

formatdate-time
registration_metadata: optional map[unknown]

The metadata for the agent’s registration.

status: optional "Ready" or "Failed" or "Unknown" or 3 more

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

One of the following:
"Ready"
"Failed"
"Unknown"
"Deleted"
"Unhealthy"
"BuildOnly"
status_reason: optional string

The reason for the status of the action.

Register Build

curl http://localhost:5003/agents/register-build \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{
          "description": "description",
          "name": "name"
        }'
{
  "id": "id",
  "acp_type": "sync",
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "name": "name",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "agent_input_type": "text",
  "production_deployment_id": "production_deployment_id",
  "registered_at": "2019-12-27T18:11:19.117Z",
  "registration_metadata": {
    "foo": "bar"
  },
  "status": "Ready",
  "status_reason": "status_reason"
}
Returns Examples
{
  "id": "id",
  "acp_type": "sync",
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "name": "name",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "agent_input_type": "text",
  "production_deployment_id": "production_deployment_id",
  "registered_at": "2019-12-27T18:11:19.117Z",
  "registration_metadata": {
    "foo": "bar"
  },
  "status": "Ready",
  "status_reason": "status_reason"
}