Skip to main content
POST
/
v2
/
api-keys
Create a new API key
curl --request POST \
  --url https://api.orq.ai/v2/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "owner": {
    "user": {
      "user_id": "<string>"
    },
    "service_account": {}
  },
  "project_scope": {
    "all": {},
    "single": {
      "project_id": "<string>"
    }
  },
  "permission_mode": 123,
  "access": {},
  "constraints": {
    "expires_at": "2023-11-07T05:31:56Z",
    "budget": {
      "period": 123,
      "amount": 123,
      "token_limit": "<string>"
    },
    "rate_limit": {
      "requests_per_minute": 123
    }
  }
}
'
{
  "api_key": {
    "api_key_id": "<string>",
    "name": "<string>",
    "owner": {
      "user": {
        "user_id": "<string>"
      },
      "service_account": {}
    },
    "project_scope": {
      "all": {},
      "single": {
        "project_id": "<string>"
      }
    },
    "permission_mode": 123,
    "access": {},
    "token_prefix": "<string>",
    "status": 123,
    "constraints": {
      "expires_at": "2023-11-07T05:31:56Z",
      "budget": {
        "period": 123,
        "amount": 123,
        "token_limit": "<string>"
      },
      "rate_limit": {
        "requests_per_minute": 123
      }
    },
    "created_by_id": "<string>",
    "updated_by_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "last_used_at": "2023-11-07T05:31:56Z",
    "legacy_token_family": 123,
    "legacy_key_id": "<string>"
  },
  "token": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.orq.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string

Human-readable name. Required.

owner
object

Owner attribution. Defaults to service_account when omitted.

project_scope
object

Project authorization scope. Defaults to all-projects when omitted.

permission_mode
integer<enum>

Permission preset. Defaults to PERMISSION_MODE_ALL when omitted.

access
object

Per-domain access map. Required when permission_mode = RESTRICTED.

constraints
object

Optional constraints (expires_at, budget, rate_limit).

Response

200 - application/json

OK

api_key
object

Newly minted api-key record.

token
string

Raw bearer token in the form sk-orq-<api_key_id>-<secret>. Returned ONCE; the API never exposes this value again. Clients must persist it immediately on receipt.