Create a new budget

POST

budgets

cURL

curl --request POST \
  --url https://api.orq.ai/v2/budgets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": {
    "workspace": {},
    "project": {
      "project_id": "<string>"
    },
    "identity": {
      "identity_external_id": "<string>"
    },
    "api_key": {
      "api_key_id": "<string>"
    },
    "provider": {
      "provider": "<string>"
    },
    "model": {
      "model_id": "<string>"
    }
  },
  "match": {
    "cel": "<string>"
  },
  "limits": {
    "amount": 123,
    "token_limit": 123
  },
  "rate_limit": {
    "requests_per_minute": 123
  },
  "is_active": true,
  "expires_at": "2023-11-07T05:31:56Z"
}
'

await orq.budgets.create({ scope: { kind: "workspace" }, limits: { period: "MONTHLY", amount: 1000 } });

import requests

url = "https://api.orq.ai/v2/budgets"

payload = {
    "scope": {
        "workspace": {},
        "project": { "project_id": "<string>" },
        "identity": { "identity_external_id": "<string>" },
        "api_key": { "api_key_id": "<string>" },
        "provider": { "provider": "<string>" },
        "model": { "model_id": "<string>" }
    },
    "match": { "cel": "<string>" },
    "limits": {
        "amount": 123,
        "token_limit": 123
    },
    "rate_limit": { "requests_per_minute": 123 },
    "is_active": True,
    "expires_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "budget": {
    "budget_id": "<string>",
    "scope": {
      "workspace": {},
      "project": {
        "project_id": "<string>"
      },
      "identity": {
        "identity_external_id": "<string>"
      },
      "api_key": {
        "api_key_id": "<string>"
      },
      "provider": {
        "provider": "<string>"
      },
      "model": {
        "model_id": "<string>"
      }
    },
    "match": {
      "cel": "<string>"
    },
    "limits": {
      "amount": 123,
      "token_limit": 123
    },
    "rate_limit": {
      "requests_per_minute": 123
    },
    "is_active": true,
    "expires_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "usage": {
      "amount": 123,
      "tokens": 123,
      "requests": 123
    }
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

scope

object

Structured scope. Mutually exclusive with match: provide a scope for the six canonical kinds (the server derives the matching CEL), or provide match for a dynamic budget. Exactly one of the two must be set; the handler enforces that invariant.

Show child attributes

match

object

Raw CEL matching expression for dynamic budgets (e.g. metadata.team == "ml" && provider == "openai"). Validated via CEL parse at write time. Mutually exclusive with scope.

Show child attributes

limits

object

At least one of amount / token_limit / rate_limit.requests_per_minute must be provided on the budget; the handler enforces that invariant.

Show child attributes

rate_limit

object

Optional rate limit.

Show child attributes

is_active

boolean

Whether the budget should be active immediately. Defaults to true when omitted (handler enforces).

expires_at

string<date-time>

Optional expiration. When set in combination with is_active=true, the value MUST be in the future; the handler rejects past values.

Response

200 - application/json

budget

object

Newly created budget.

Show child attributes

⌘I

cURL

curl --request POST \
  --url https://api.orq.ai/v2/budgets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": {
    "workspace": {},
    "project": {
      "project_id": "<string>"
    },
    "identity": {
      "identity_external_id": "<string>"
    },
    "api_key": {
      "api_key_id": "<string>"
    },
    "provider": {
      "provider": "<string>"
    },
    "model": {
      "model_id": "<string>"
    }
  },
  "match": {
    "cel": "<string>"
  },
  "limits": {
    "amount": 123,
    "token_limit": 123
  },
  "rate_limit": {
    "requests_per_minute": 123
  },
  "is_active": true,
  "expires_at": "2023-11-07T05:31:56Z"
}
'

await orq.budgets.create({ scope: { kind: "workspace" }, limits: { period: "MONTHLY", amount: 1000 } });

import requests

url = "https://api.orq.ai/v2/budgets"

payload = {
    "scope": {
        "workspace": {},
        "project": { "project_id": "<string>" },
        "identity": { "identity_external_id": "<string>" },
        "api_key": { "api_key_id": "<string>" },
        "provider": { "provider": "<string>" },
        "model": { "model_id": "<string>" }
    },
    "match": { "cel": "<string>" },
    "limits": {
        "amount": 123,
        "token_limit": 123
    },
    "rate_limit": { "requests_per_minute": 123 },
    "is_active": True,
    "expires_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "budget": {
    "budget_id": "<string>",
    "scope": {
      "workspace": {},
      "project": {
        "project_id": "<string>"
      },
      "identity": {
        "identity_external_id": "<string>"
      },
      "api_key": {
        "api_key_id": "<string>"
      },
      "provider": {
        "provider": "<string>"
      },
      "model": {
        "model_id": "<string>"
      }
    },
    "match": {
      "cel": "<string>"
    },
    "limits": {
      "amount": 123,
      "token_limit": 123
    },
    "rate_limit": {
      "requests_per_minute": 123
    },
    "is_active": true,
    "expires_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "usage": {
      "amount": 123,
      "tokens": 123,
      "requests": 123
    }
  }
}

Orq SDK

Orq CLI

Platform APIs

Gateway APIs

Enterprise APIs (coming soon)

Authorizations

Body

Response