Clarity · Schema

BudgetCreateRequest

Create body — also the validator a PATCH is re-run through after merging. Rules: ``scope='global'`` ⇔ no ``project_id``; ``period='custom'`` ⇔ both bounds present (and ``custom_to > custom_from``); ``surfaces`` is omitted (all) or a non-empty subset of the known surfaces (deduped, sorted); naive datetimes are read as UTC.

Artificial IntelligenceCustomer ExperienceAI AgentsEnterprise

Properties

Name Type Description
name string Display name
scope string
project_id object
period string
custom_from object
custom_to object
surfaces object None = all surfaces
lens object None = all spend
usd_threshold object
enabled boolean
View JSON Schema on GitHub

JSON Schema

onclarity-com-budget-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-budget-create-request-schema.json",
  "title": "BudgetCreateRequest",
  "description": "Create body — also the validator a PATCH is re-run through after merging.\n\nRules: ``scope='global'`` ⇔ no ``project_id``; ``period='custom'`` ⇔ both bounds present\n(and ``custom_to > custom_from``); ``surfaces`` is omitted (all) or a non-empty subset\nof the known surfaces (deduped, sorted); naive datetimes are read as UTC.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/onclarity-com-agent-costs-api-openapi.yml#/components/schemas/BudgetCreateRequest",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "title": "Name",
      "description": "Display name"
    },
    "scope": {
      "type": "string",
      "enum": [
        "global",
        "project"
      ],
      "title": "Scope"
    },
    "project_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Id"
    },
    "period": {
      "type": "string",
      "enum": [
        "day",
        "week",
        "month",
        "custom"
      ],
      "title": "Period",
      "default": "day"
    },
    "custom_from": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Custom From"
    },
    "custom_to": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Custom To"
    },
    "surfaces": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Surfaces",
      "description": "None = all surfaces"
    },
    "lens": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "internal",
            "tenant"
          ]
        },
        {
          "type": "null"
        }
      ],
      "title": "Lens",
      "description": "None = all spend"
    },
    "usd_threshold": {
      "anyOf": [
        {
          "type": "number",
          "exclusiveMinimum": 0.0
        },
        {
          "type": "string",
          "pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,10}|(?=[\\d.]{1,13}0*$)\\d{0,10}\\.\\d{0,2}0*$)"
        }
      ],
      "title": "Usd Threshold"
    },
    "enabled": {
      "type": "boolean",
      "title": "Enabled",
      "default": true
    }
  },
  "type": "object",
  "required": [
    "name",
    "scope",
    "usd_threshold"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/onclarity-com-budget-create-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.