API keys

Create an API key

Changed on

Create a key using an authenticated account session. Permissions default to ["all"]. Use "read-only" to store all currently known read grants, or supply an explicit grant array. Unknown grants are rejected. Permissions are immutable; create a replacement key to change them. Only active can be changed through PATCH /auth/api-keys/{apiKeyId}.

post/auth/api-keys

Request

  • Base URL: https://api.receiptor.ai/v1
  • URL: https://api.receiptor.ai/v1/auth/api-keys
  • Auth: HTTP bearer

Request body

namestring required
workspaceScope'all' | 'current'

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}

Changes