Skip to navigation

Register an agent and get an API key

View as Markdown

Create an agent identity and receive an API key. The anonymous flow returns a key immediately; the email OTP flow verifies an email first. Store the returned api_key — it is shown only once.

Request

This endpoint expects an object.
AnonymousRegisterobjectRequired
OR
EmailOtpInitiateobjectRequired
OR
EmailOtpVerifyobjectRequired

Response

Agent registered
agent_idstringOptionalformat: "uuid"
api_keystringOptional

Store this — it is shown only once.

key_prefixstringOptional
scopeslist of stringsOptional
expires_atdatetime or nullOptional
messagestringOptional

Errors

422
Unprocessable Entity Error