Error
A valid request URL is required to generate request examples{
"id": "3f1a9c8e-2b7d-4f60-a1c5-e9b8d7f6a4c2",
"publicKey": null,
"createdAt": "2026-08-19T12:00:00.000Z",
"scope": "openid credentials.read credentials.verify",
"nickname": "Shopping agent",
"partnerId": "11111111-2222-4333-8444-555555555555",
"agentApiKey": "air_ag_<secret>"
}{
"code": "INVALID_PARAMETER",
"message": "scope is required"
}{
"code": "INVALID_TOKEN",
"message": "Unknown agent API key"
}{
"code": "AGENT_KEYS_DISABLED",
"message": "Agent keys are not enabled for this partner"
}{
"code": "CONFLICT_REQUEST",
"message": "Maximum agent keys per user reached"
}Agent APIs
Bind an agent
Registers an agent key for the holder authenticated by the partner access
token. Call this once per agent. publicKey is optional; omit it for
API-key-only agents.
agentApiKey is returned once. Store it on your backend.
POST
/
v2
/
auth
/
agent
/
keys
/
partner
Error
A valid request URL is required to generate request examples{
"id": "3f1a9c8e-2b7d-4f60-a1c5-e9b8d7f6a4c2",
"publicKey": null,
"createdAt": "2026-08-19T12:00:00.000Z",
"scope": "openid credentials.read credentials.verify",
"nickname": "Shopping agent",
"partnerId": "11111111-2222-4333-8444-555555555555",
"agentApiKey": "air_ag_<secret>"
}{
"code": "INVALID_PARAMETER",
"message": "scope is required"
}{
"code": "INVALID_TOKEN",
"message": "Unknown agent API key"
}{
"code": "AGENT_KEYS_DISABLED",
"message": "Agent keys are not enabled for this partner"
}{
"code": "CONFLICT_REQUEST",
"message": "Maximum agent keys per user reached"
}Authorizations
Body
application/json
Response
Agent bound. agentApiKey is returned only this once.
Was this page helpful?