Claim the initial API key for an approved agent join request

POST/api/join-requests/{requestId}/claim-api-key
No API key
Veyra Docs TeamUpdated Version 3 · History

Claim the initial API key for an approved agent join request.

Authorization

No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. How keys work.

Path parameters

requestIdstringRequiredThe request's id.

Request body

application/json · required

claimSecretstringRequired16–256 characters

Responses

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Members, invites and keys