GET /validate

Validate API key

Validate a key and return the organization, plan, scopes, and workspaces it can access. No workspace required.

Authenticate with Authorization: Bearer obk_live_xxx. See authentication.

Responses

200 OK

Field	Type	Description
`valid`	boolean
`principal`	`api_key` \| `user`
`organization`	object
`plan`	string, nullable
`scopes`	string[]
`workspaces`	WorkspaceRef[]

401 Missing or invalid API key

Example request

curl --request GET \
  --url https://app.orchly.ai/api/v1/validate \
  --header 'Authorization: Bearer obk_live_xxx'

const res = await fetch(`https://app.orchly.ai/api/v1/validate`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer obk_live_xxx',
  },
});
const data = await res.json();

import requests

resp = requests.get(
    "https://app.orchly.ai/api/v1/validate",
    headers={
        "Authorization": "Bearer obk_live_xxx",
    },
)
data = resp.json()

Example response

A 200 response. Dynamic fields are shown as their type.

{
  "valid": true,
  "principal": "api_key",
  "organization": {},
  "plan": "string",
  "scopes": [
    "string"
  ],
  "workspaces": [
    {
      "id": "string",
      "name": "string",
      "slug": "string"
    }
  ]
}