Skip to main content

​
Budgets

​
List Budgets

Returns budgets visible to the current workspace, ordered by creation time with the newest first. Supports filtering by scope kind, scope target id, period, and active state, plus an optional free-text query that searches across denormalized target names via Typesense. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.budgets.list()

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.budgets.list();

  console.log(result);
}

run();

​
Create a Budget

Creates a new budget in the workspace. Exactly one scope variant must be set (workspace / project / identity / api_key / provider / model). At least one of limits.amount, limits.token_limit, or rate_limit.requests_per_minute MUST be provided. Uniqueness is enforced across (workspace_id, scope_kind, scope_target_id). 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.budgets.create()

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.budgets.create({});

  console.log(result);
}

run();

​
Check a Budget

Internal endpoint used by the gateway to resolve applicable budgets and check enforcement gates for a request. Returns allowed/rejected status with dimension info for rate-limit headers. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.budgets.check()

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.budgets.check({});

  console.log(result);
}

run();

​
Retrieve a Budget

Retrieves the metadata for an existing budget by its unique identifier. Returns NotFound when the budget does not exist in the caller’s workspace. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.budgets.get(budget_id="<id>")

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.budgets.get({
    budgetId: "<id>",
  });

  console.log(result);
}

run();

​
Delete a Budget

Permanently deletes a budget. Consumption counters in Redis for this budget are cleared immediately. The response body is empty on success. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.budgets.delete(budget_id="<id>")

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.budgets.delete({
    budgetId: "<id>",
  });

  console.log(result);
}

run();

​
Update a Budget

Updates mutable fields of a budget: limits, rate limit, activation, and expiration. The scope is immutable: to change a budget’s target, delete and recreate it. Omitted fields keep their current values. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.budgets.update(budget_id="<id>")

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.budgets.update({
    budgetId: "<id>",
    updateBudgetRequest: {},
  });

  console.log(result);
}

run();

​
Get Consumption

Returns the current-period cost, token, and per-minute request counters for the budget. Values reflect the live Redis state for the active period bucket. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.budgets.get_consumption(budget_id="<id>")

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.budgets.getConsumption({
    budgetId: "<id>",
  });

  console.log(result);
}

run();

​
Reset Consumption

Clears the current-period cost, token, and request counters for the budget. The budget record itself is preserved; only the Redis counters are reset. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.budgets.reset_consumption(budget_id="<id>", reset_budget_consumption_request={})

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.budgets.resetConsumption({
    budgetId: "<id>",
    resetBudgetConsumptionRequest: {},
  });

  console.log(result);
}

run();