SCscaleapi
Agents

Get Agent by Name

Changed on

Get an agent by its unique name.

get/agents/name/{agent_name}

Request

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

Path parameters

agent_namestring required

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.

Changes

  • 6ddcd81c830bRevision changes
    • warning

      added the new BuildOnly enum value to the response property for the response status