AuthSpokeAuthSpoke Developers
Enterprise AI · API Reference

AI Agents

Register and manage AI agents as governed identities with computed risk and trust.

GET/api/v1/ai/agents

List ai agents

List ai agents in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Query parameters

pageZero-based page index where supported.
sizePage size where supported.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/ai/agents" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
POST/api/v1/ai/agents

Create or run ai agents

Create or run ai agents in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

201Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X POST "https://api.authspoke.com/api/v1/ai/agents" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
GET/api/v1/ai/agents/{id}

Get agents id

Get agents id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Path parameters

id*id identifier.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X GET "https://api.authspoke.com/api/v1/ai/agents/{id}" \
  -H "Authorization: Bearer $TOKEN"

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
PUT/api/v1/ai/agents/{id}

Replace agents id

Replace agents id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Path parameters

id*id identifier.

Request body

namestringDisplay name or operation name where applicable.
statusstringStatus or lifecycle value where applicable.
reasonstringAudit reason for governed changes.
metadataobjectProvider or business metadata.
configurationobjectConnector, policy, or resource configuration.

Responses

200Successful response.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X PUT "https://api.authspoke.com/api/v1/ai/agents/{id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example","metadata":{}}'

Example response

JSON
{
  "id": "uuid",
  "status": "OK"
}
DELETE/api/v1/ai/agents/{id}

Delete agents id

Delete agents id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.

🔒 Bearer JWT required

Path parameters

id*id identifier.

Responses

204Deleted or completed with no response body.
400Invalid request.
401Missing or invalid authentication.
403Forbidden by permission, SKU, or provider-admin policy.
404Resource not found or not in the caller's tenant.

Example request

cURL
curl -X DELETE "https://api.authspoke.com/api/v1/ai/agents/{id}" \
  -H "Authorization: Bearer $TOKEN"