Skip to main content
Aria Compute’s AGENT API authenticates via the Authorization header, which accepts either Bearer or ApiKey with the same key value. Every data-plane request must also carry OpenAI-Beta: agents=v1. Behavior depends on whether AGENT_CLOUD_API_KEY is set at server boot.

Supported schemes

Scheme 1: Bearer

Scheme 2: ApiKey

On the China site, replace the host with https://agent.ariacompute.cn.

How keys resolve

Scopes on self-serve keys are read, write, and admin. Admin implies read and write. Creating, listing, and revoking keys requires admin scope. See Create / List and Revoke. GET /v1/governance/status, /usage and /audit are read-only and require read; the full audit NDJSON export requires read_raw. Policy, credential and checkpoint writes require admin. The playground proxies only the read-only governance routes and shows an unavailable state when upstream scope is missing, without affecting the chat session.

Error response

When auth is required and the key is missing or invalid, the API returns 401. Application errors use the OpenAI-shaped envelope: