GET /usage

Get usage

Your organization's API consumption versus its plan ceiling. No workspace required.

Authenticate with Authorization: Bearer obk_live_xxx. See authentication.

Responses

200 OK

Field	Type	Description
`organization_id`	string
`plan`	string, nullable
`hourly_limit`	integer
`period`	object
`daily`	object[]

Example request

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

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

import requests

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

Example response

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

{
  "organization_id": "string",
  "plan": "string",
  "hourly_limit": 0,
  "period": {},
  "daily": [
    {}
  ]
}