ReferenceHTTP APIAuth
Check a credential and return its owner
GET
Checks a credential: answers 200 with the owner it authenticates as, or 401. It changes nothing; use it to test an API key before other calls.
Scope: sessions:read (API key or cookie session).
header
AuthorizationBearer <token>For servers and scripts: an API key sent as an HTTP bearer token, Bearer <key>. It holds exactly the scopes it was issued with; a key issued before scopes existed holds none. It never needs the CSRF header, and it cannot manage agents, members, teams or API keys. Issue one in the web console under Settings → API keys; each operation names the scope it needs.
Scope: sessions:read
The credential is valid.
application/json- response
status*stringowner_id*stringLength
1 <= lengthcurl -X GET 'https://example.com/v1'Example Response
{ "status": "ok", "owner_id": "7b0e5c1e-2f4a-4d7e-9a51-3c6f0b8d2e14"}