SCscaleapi
Agents

Register Agent

Changed on

Register a new agent or update an existing one.

post/agents/register

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

namestring required

The unique name of the agent.

descriptionstring required

The description of the agent.

acp_urlstring required

The URL of the ACP server for the agent.

agent_idstring nullable

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

acp_type'sync' | 'async' | 'agentic' required
principal_contextunknown
registration_metadataobject nullable

The metadata for the agent's registration.

agent_input_type'text' | 'json'

Response

Successful Response

idstring required

The unique identifier of the agent.

namestring required

The unique name of the agent.

descriptionstring required

The description of the action.

status'Ready' | 'Failed' | 'Unknown' | 'Deleted' | 'Unhealthy' | 'BuildOnly'
acp_type'sync' | 'async' | 'agentic' required
status_reasonstring nullable

The reason for the status of the action.

created_atstring date-time required

The timestamp when the agent was created

updated_atstring date-time required

The timestamp when the agent was last updated

registration_metadataobject nullable

The metadata for the agent's registration.

registered_atstring date-time nullable

The timestamp when the agent was last registered

agent_input_type'text' | 'json'
production_deployment_idstring nullable

ID of the current production deployment.

agent_api_keystring nullable

The API key for the agent, if applicable.

Changes