Apps API · Platform Agents
Platform Agents: 6 endpoints
GET /api/v1/platform-agents/domain-availability
Check platform agent domain availability
Scope: agents:agent:read · Called with: appToken · operationId: check-platform-agent-domain-availability
Required app scope: agents:agent:read.
Validates and assembles a platform agent subdomain, then checks the domain registry for current availability.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
label |
query | string | yes | Subdomain label to check |
Responses
200OK —application/json·DataResponsePlatformAgentDomainAvailabilityDataBodydefaultError —application/problem+json·D8Error
GET /api/v1/platform-agents/domain-config
Get platform agent domain config
Scope: agents:agent:read · Called with: appToken · operationId: get-platform-agent-domain-config
Required app scope: agents:agent:read.
Returns the configured public domain suffix for platform agent subdomains.
Responses
200OK —application/json·DataResponsePlatformAgentDomainConfigDataBodydefaultError —application/problem+json·D8Error
GET /api/v1/platform-agents/model-catalog
Get the global model catalog (deprecated) (Deprecated)
Scope: agents:agent:read · Called with: appToken · operationId: get-model-catalog
Required app scope: agents:agent:read.
Deprecated: always returns an empty models list. There is no model catalog any more; an agent's selectable models are its available_model_ids, returned by GET /api/v1/agents/{member_id}/model-config (available_models). Retained only so existing callers keep decoding; slated for removal.
Responses
200OK —application/json·DataResponseModelCatalogDataBodydefaultError —application/problem+json·D8Error
GET /api/v1/platform-agents/operational-states
List platform agent operational states
Scope: agents:agent:read · Called with: appToken · operationId: list-platform-agent-operational-states
Required app scope: agents:agent:read.
Returns the resource-centric platform-agent control state for every agent add-on, including add-ons whose Agent member has not been created yet. The billing operation/enforcement state is required; the runtime actual phase and the messaging connection presence degrade independently to unknown. available_actions is permission-specific and derived from the authoritative add-on status (active offers pause; paused/suspended offers resume): it is withheld while a conflicting operation/transition is in flight, but does NOT depend on the runtime actual_phase — a healthy add-on still offers pause/resume even when actual_phase is unknown. credit-cap still strips resume when the cap blocks it.
Responses
200OK —application/json·DataResponseListPlatformAgentOperationalStateDTOBodydefaultError —application/problem+json·D8Error
GET /api/v1/platform-agents/timezones
List valid IANA timezones
Scope: agents:agent:read · Called with: appToken · operationId: list-platform-agent-timezones
Required app scope: agents:agent:read.
Returns the sorted list of selectable IANA timezone names (the zones of inhabited regions) plus UTC, for the create-agent timezone field. The list is the same for every agent and excludes historical aliases and placeholder names (e.g. Japan, US/Pacific, Zulu).
Responses
200OK —application/json·DataResponseTimezonesDataBodydefaultError —application/problem+json·D8Error
GET /api/v1/platform-agents/{identity_id}/domain
Get platform agent bound domain
Scope: agents:agent:read · Called with: appToken · operationId: get-platform-agent-domain
Required app scope: agents:agent:read.
Returns the public domain bound to a platform agent, resolved by the agent's identity ID. Returns 404 when the agent has no bound domain.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
identity_id |
path | string (uuid) | yes | Agent identity UUID |
Responses
200OK —application/json·DataResponsePlatformAgentDomainDataBodydefaultError —application/problem+json·D8Error
