> ## Documentation Index > Fetch the complete documentation index at: https://docs.agile-tools.io/llms.txt > Use this file to discover all available pages before exploring further. # Create budget > Creates a budget for a target (value unit, organizational unit or team). Resolve the target id via GET /v1/public/value-units, /v1/public/organizational-units or /v1/public/teams. Resolve the currency unit id via GET /v1/public/units. ## OpenAPI ````yaml /openapi.v1.local.json post /v1/public/budgets openapi: 3.0.3 info: title: Agile Tools Public API description: >- REST API for integrating external systems with Agile Tools. ## Authentication Most endpoints require an `X-API-Key` header containing a valid owner-typed API key. Supported ownership types are `ORGANIZATION`, `PERSON`, and `VALUE_UNIT`. Anonymous library browsing endpoints use short-lived session tokens instead. ## Scope Behavior Wildcard scope (`*`) is organization-only. Value-unit keys are restricted to value-unit-centric endpoint families and descendant scope checks. Personal keys default to personal-empty scope unless explicit permissions are granted. Cross-organization key governance is out of scope for `/v1/public/*` and is handled by `/v1/sys/public-api-keys`. ## Rate Limiting Requests are rate-limited per API key based on your subscription plan. When a limit is exceeded the API returns `429 Too Many Requests` with a `Retry-After` header. ## Idempotency POST and PUT requests support idempotent replay via the optional `Idempotency-Key` header. Selected high-risk KPI and Health Metric write endpoints require this header to ensure safe retries without duplicate side-effects. ## Response Envelope Public v1 and v2 response contracts coexist during migration. Authenticated public endpoints use `PublicApiKeyMeta` semantics (`requestId`, `timestamp`) and anonymous public endpoints use `PublicAnonymousMeta` semantics. Anonymous library endpoints may add `PublicAnonymousLibraryMeta` tab-count metadata while authenticated public endpoints do not define a library tab-count metadata branch. ## Public Docs Visibility Policy Published public docs intentionally exclude anonymous Sessions and Library endpoints. Those v1 anonymous flows remain runtime-stable but are not listed in Mintlify-facing OpenAPI output. ## Migration Guidance For list endpoints, migrate in stages: keep v1 stable, adopt v2 offset mode first, then adopt v2 cursor mode where needed. Fallback expectation: clients may continue using v1 while v2 adoption is rolled out incrementally. ## Versioning & Deprecation Policy Breaking changes require a new major version (`/v2/`). Non-breaking additions ship in the current version. Deprecated endpoints include a `Sunset` HTTP header with the removal date. Minimum notice period: 6 months. contact: name: Agile Tools Developer Support url: https://teampoolz.mintlify.app email: dev-support@agile-tools.io version: 1.0.0 servers: - url: https://api.agile-tools.io description: Production - url: https://api.alpha.agile-tools.io description: Staging - url: https://free-trusty-kit.ngrok-free.app description: Local Development security: [] tags: - name: Address - name: Audit - name: Auth - name: Available scope - name: Billing Role - name: Billing Role Rate - name: Billing Role Rates - name: Billing Roles - name: Board - name: Budget - name: Budgets - name: Check In - name: Client - name: Client Project - name: Contact Info - name: Country - name: Demo Management - name: Goal - name: Goal Template - name: Goals - name: Group Notification Preferences - name: Groups description: Operations related to user groups - name: Health Metrics - name: Holiday Schemes - name: Hrosc - name: ISCO Groups - name: Integrations - name: Janitor System - name: Job Positions - name: KPIs - name: Key Result - name: Key Result Template - name: Key Results - name: Library Admin - name: Library Export - name: Library Import - name: Manager - name: Metric Period - name: Metric Template - name: Milestone - name: Nav Info - name: Newsletter - name: Notification Preferences - name: Observed Metrics - name: Org Account - name: Organizational Unit - name: Organizational Units - name: People - name: Person - name: Person Job Positions - name: Person Rate - name: Person Rates - name: Person Skills - name: Preferences - name: Public API Keys - name: Registration - name: SCM Repositories - name: Skills - name: Strategic Concept - name: Strategy - name: Stripe - name: Subscription - name: Sys Billing Role Rates - name: Sys Billing Roles - name: Sys Budgets - name: Sys Catalog - name: Sys Catalog Skill Groups - name: Sys Catalog Sync - name: Sys Check Ins - name: Sys Goals - name: Sys Job Positions - name: Sys Key Results - name: Sys Organizational Units - name: Sys Person - name: Sys Person Job Positions - name: Sys Person Rates - name: Sys Person Skills - name: Sys Public API Keys - name: Sys Skills - name: Sys Tags - name: Sys Teams - name: Sys Value Items - name: Sys Value Units - name: Tag - name: Tags - name: Team - name: Teams - name: Time zones - name: Timesheet - name: Timesheet Export - name: Timesheet Period Configuration - name: Timesheet Period Management - name: Timesheet Periods - name: Unit - name: Value Item - name: Value Item Settings - name: Value Items - name: Value Unit - name: Value Units - name: Webhooks - name: Workboards - name: Workflow - name: Workload Schemes - name: Worklog Approvals Configuration - name: Worklog Conflicts - name: Worklog Scheduler Configuration - name: Worklogs paths: /v1/public/budgets: post: tags: - Budgets summary: Create budget description: >- Creates a budget for a target (value unit, organizational unit or team). Resolve the target id via GET /v1/public/value-units, /v1/public/organizational-units or /v1/public/teams. Resolve the currency unit id via GET /v1/public/units. operationId: createPublicBudget requestBody: description: >- Create payload for a budget. Resolve targetId via GET /v1/public/value-units, /v1/public/organizational-units or /v1/public/teams. Resolve currencyUnitId via GET /v1/public/units. content: application/json: schema: $ref: '#/components/schemas/PublicBudgetCreateDto' examples: create budget: value: targetId: ec62afde-2718-4e54-98d8-aa2578f5d8a6 targetType: VALUEUNIT periodStart: '2026-01-01' periodEnd: '2026-12-31' budgetAmount: 250000 currencyUnitId: 7c9e6679-7425-40de-944b-e07fc1f90ae7 description: Q1 platform budget externalId: BUDGET_Q1_2026 required: true responses: '200': description: Budget created content: application/json: schema: $ref: '#/components/schemas/PublicBudgetDto' examples: created budget: value: data: id: 6b9a8462-e58f-4697-a725-f55bb86e3b2d targetId: ec62afde-2718-4e54-98d8-aa2578f5d8a6 targetType: VALUEUNIT periodStart: '2026-01-01' periodEnd: '2026-12-31' budgetAmount: 250000 currencyUnitId: 7c9e6679-7425-40de-944b-e07fc1f90ae7 description: Q1 platform budget externalId: BUDGET_Q1_2026 spentAmount: 0 remainingAmount: 250000 spentPercentage: 0 unvaluedMinutes: 0 meta: requestId: f056699e-497d-41d9-a877-d7c862de6587 timestamp: '2026-04-03T12:08:00Z' '400': description: Invalid create payload or unsupported target type '404': description: Target or currency unit not found '409': description: externalId already in use in this organization security: - apiKey: [] components: schemas: PublicBudgetCreateDto: required: - targetId - targetType - periodStart - periodEnd - budgetAmount - currencyUnitId type: object properties: targetId: description: >- Id of the target (value unit, organizational unit or team) the budget applies to. maxLength: 100 pattern: \S type: string example: 6b9a8462-e58f-4697-a725-f55bb86e3b2d targetType: description: Type of the target. One of VALUEUNIT, ORGANIZATIONALUNIT, TEAM. type: string allOf: - $ref: '#/components/schemas/BudgetType' example: VALUEUNIT periodStart: description: Budget period start (inclusive). type: string allOf: - $ref: '#/components/schemas/LocalDate' example: '2026-01-01' periodEnd: description: Budget period end (inclusive). type: string allOf: - $ref: '#/components/schemas/LocalDate' example: '2026-12-31' budgetAmount: description: Budget amount in the budget currency. minimum: 0 pattern: ^\d{1,10}([.]\d{1,2})?$ type: number example: 250000 currencyUnitId: description: Id of the currency unit. Resolve via GET /v1/public/units. maxLength: 100 pattern: \S type: string example: 7c9e6679-7425-40de-944b-e07fc1f90ae7 description: description: Optional budget description. maxLength: 500 type: string example: Q1 platform budget externalId: description: >- Optional external system identifier. Must be unique within the organization. maxLength: 255 type: string example: BUDGET_Q1_2026 PublicBudgetDto: type: object properties: id: type: string targetId: type: string targetType: $ref: '#/components/schemas/BudgetType' periodStart: $ref: '#/components/schemas/LocalDate' periodEnd: $ref: '#/components/schemas/LocalDate' budgetAmount: type: number currencyUnitId: type: string description: type: string externalId: type: string spentAmount: type: number remainingAmount: type: number spentPercentage: format: double type: number unvaluedMinutes: format: int64 type: integer BudgetType: enum: - VALUEUNIT - ORGANIZATIONALUNIT - TEAM type: string LocalDate: format: date type: string example: '2022-03-10' securitySchemes: apiKey: type: apiKey description: >- Owner-typed API key (`ORGANIZATION`, `PERSON`, `VALUE_UNIT`). Manage org-scoped lifecycle with `/v1/public-api-keys`; cross-org governance is restricted to `/v1/sys/public-api-keys`. name: X-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.