> ## Documentation Index
> Fetch the complete documentation index at: https://developers.thinkout.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Summarise budgets

> What the budgets screen shows, per month or for the whole window, per direction or per
category. Give `period`, or both `from` and `to`.

Budgets are monthly, so the window widens to whole months. Each row puts the budget
beside what happened. `budgeted` is the budget. `actual` is the transactions, the
tracking tab's Actual column. `forecast` is the remaining amount of the unrealised
forecasts dated in the period, the tracking tab's Forecasted column. `realised` adds the
two and is the figure the planning tab compares with the budget. Outflows are negative.

`on_budget` is the planning tab's check or warning icon. It is `true` when `realised`
reached an inflow budget or stayed within an outflow budget, and `null` for a month that
has not started, for a cell without a budget and with `interval=total`.

The figures cover the categories shown on the budgets screen. In most workspaces the
categories hidden there include the uncategorised and transfer categories, so budget
totals differ from `/transactions/summary` and `/cash-flow/summary` for the same months.

Budgets convert to `currency` at the rate for the first day of their month, transactions
and forecasts at the rate of their own date. `totals` is the planning tab's Total column
for each direction.

Without `group_by` there is one row per direction per period, and `balances` holds the
planning tab's final balance row: `final_balance` once a month has started and
`budgeted_final_balance`, the balance if the budgets hold, until it has ended.
`balances` is empty with `interval=total`, `group_by`, `category_id` or `direction`.

With `group_by=category` the rows nest as on the screen. A parent category's row is its
whole branch, so adding a parent and its children counts the children twice. A row
whose `id` equals its `parent_id` is the money booked on the parent itself, which the
screen shows as "Others for" the parent. A category appears in a period when something
is budgeted, has moved or is expected for it. `category_id` narrows the rows and
`totals` to those categories and the ones nested under them.

Rows are ordered by period. Within a period inflows come before outflows, and
categories follow the screen's order, parents before their children.

**Inflows and outflows against the budget this quarter, with balances**

```http
GET /budgets/summary?period=this_quarter
```

**This year's outflows against the budget by category, in total**

```http
GET /budgets/summary?period=this_year&interval=total&group_by=category&direction=outflow
```




## OpenAPI

````yaml /openapi/v1.yaml get /budgets/summary
openapi: 3.1.0
info:
  title: ThinkOut API
  version: '1.0'
  description: >
    Read access to the data of a ThinkOut workspace.


    Every endpoint in version 1 is a `GET`. Lists share one envelope and page
    with a cursor

    wherever they can grow. Every response carries `X-RateLimit-Limit`,
    `X-RateLimit-Remaining`

    and `X-RateLimit-Reset`.


    Version 1 changes additively: new endpoints, optional parameters, response
    fields and enum

    values can appear at any time. Tolerate unknown fields and never treat an
    enum as closed.
  contact:
    name: ThinkOut developer support
    url: https://developers.thinkout.io/guides/support
servers:
  - url: https://api.thinkout.io/v1
security:
  - apiKey: []
tags:
  - name: Banks
    description: The workspace's bank connections and the state of each one.
  - name: Accounts
    description: Manual, bank-synced and delegated accounts with computed balances.
  - name: Transactions
    description: Booked and pending movements on the workspace's accounts.
  - name: Categories
    description: The workspace category tree, split by direction and business activity.
  - name: Counterparties
    description: Customers and suppliers that transactions and forecasts are attributed to.
  - name: Labels
    description: Free-form tags grouped by label type.
  - name: Forecasts
    description: Planned inflows and outflows and the transactions that realised them.
  - name: Budgets
    description: >-
      Monthly budgets per category beside what has moved and what is still
      expected, as the budgets screen shows them.
  - name: Scenarios
    description: >-
      The what-ifs built on the scenarios screen and the figures the screen
      shows for them.
  - name: Reports
    description: >-
      Totals rather than rows. Summaries over transactions, forecasts and cash
      flow, and balances per account.
paths:
  /budgets/summary:
    get:
      tags:
        - Budgets
      summary: Summarise budgets
      description: >
        What the budgets screen shows, per month or for the whole window, per
        direction or per

        category. Give `period`, or both `from` and `to`.


        Budgets are monthly, so the window widens to whole months. Each row puts
        the budget

        beside what happened. `budgeted` is the budget. `actual` is the
        transactions, the

        tracking tab's Actual column. `forecast` is the remaining amount of the
        unrealised

        forecasts dated in the period, the tracking tab's Forecasted column.
        `realised` adds the

        two and is the figure the planning tab compares with the budget.
        Outflows are negative.


        `on_budget` is the planning tab's check or warning icon. It is `true`
        when `realised`

        reached an inflow budget or stayed within an outflow budget, and `null`
        for a month that

        has not started, for a cell without a budget and with `interval=total`.


        The figures cover the categories shown on the budgets screen. In most
        workspaces the

        categories hidden there include the uncategorised and transfer
        categories, so budget

        totals differ from `/transactions/summary` and `/cash-flow/summary` for
        the same months.


        Budgets convert to `currency` at the rate for the first day of their
        month, transactions

        and forecasts at the rate of their own date. `totals` is the planning
        tab's Total column

        for each direction.


        Without `group_by` there is one row per direction per period, and
        `balances` holds the

        planning tab's final balance row: `final_balance` once a month has
        started and

        `budgeted_final_balance`, the balance if the budgets hold, until it has
        ended.

        `balances` is empty with `interval=total`, `group_by`, `category_id` or
        `direction`.


        With `group_by=category` the rows nest as on the screen. A parent
        category's row is its

        whole branch, so adding a parent and its children counts the children
        twice. A row

        whose `id` equals its `parent_id` is the money booked on the parent
        itself, which the

        screen shows as "Others for" the parent. A category appears in a period
        when something

        is budgeted, has moved or is expected for it. `category_id` narrows the
        rows and

        `totals` to those categories and the ones nested under them.


        Rows are ordered by period. Within a period inflows come before
        outflows, and

        categories follow the screen's order, parents before their children.


        **Inflows and outflows against the budget this quarter, with balances**


        ```http

        GET /budgets/summary?period=this_quarter

        ```


        **This year's outflows against the budget by category, in total**


        ```http

        GET
        /budgets/summary?period=this_year&interval=total&group_by=category&direction=outflow

        ```
      operationId: summariseBudgets
      parameters:
        - $ref: '#/components/parameters/period'
        - name: from
          in: query
          description: >-
            First day of the window, inclusive. Required with `to` unless
            `period` is given.
          schema:
            type: string
            format: date
        - name: to
          in: query
          description: >-
            Last day of the window, inclusive. Required with `from` unless
            `period` is given.
          schema:
            type: string
            format: date
        - $ref: '#/components/parameters/planning_interval'
        - name: group_by
          in: query
          description: >-
            `category` for one row per category per period. Omit it for one row
            per direction per period.
          schema:
            type: string
            enum:
              - category
        - $ref: '#/components/parameters/currency'
        - $ref: '#/components/parameters/planning_category_id'
        - $ref: '#/components/parameters/direction'
      responses:
        '200':
          description: The summary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetsSummary'
              examples:
                By month, with balances:
                  summary: >-
                    One row per direction per month, the final balance row
                    filled
                  value:
                    object: budgets_summary
                    period:
                      from: '2026-10-01'
                      to: '2026-12-31'
                      macro: this_quarter
                      interval: month
                    conversion:
                      applied: true
                      currency: RON
                      basis: own_date
                    group_by: null
                    has_data: true
                    totals:
                      inflow:
                        currency: RON
                        budgeted: '280000.00'
                        actual: '127700.00'
                        forecast: '100000.00'
                        realised: '227700.00'
                      outflow:
                        currency: RON
                        budgeted: '-190000.00'
                        actual: '-88456.25'
                        forecast: '-59200.00'
                        realised: '-147656.25'
                    data:
                      - period_start: '2026-10-01'
                        period_end: '2026-10-31'
                        direction: inflow
                        group: null
                        currency: RON
                        budgeted: '90000.00'
                        actual: '86500.00'
                        forecast: '0.00'
                        realised: '86500.00'
                        on_budget: false
                        note: null
                      - period_start: '2026-10-01'
                        period_end: '2026-10-31'
                        direction: outflow
                        group: null
                        currency: RON
                        budgeted: '-62000.00'
                        actual: '-58340.50'
                        forecast: '0.00'
                        realised: '-58340.50'
                        on_budget: true
                        note: null
                      - period_start: '2026-11-01'
                        period_end: '2026-11-30'
                        direction: inflow
                        group: null
                        currency: RON
                        budgeted: '95000.00'
                        actual: '41200.00'
                        forecast: '48000.00'
                        realised: '89200.00'
                        on_budget: false
                        note: null
                      - period_start: '2026-11-01'
                        period_end: '2026-11-30'
                        direction: outflow
                        group: null
                        currency: RON
                        budgeted: '-64000.00'
                        actual: '-30115.75'
                        forecast: '-27400.00'
                        realised: '-57515.75'
                        on_budget: true
                        note: null
                      - period_start: '2026-12-01'
                        period_end: '2026-12-31'
                        direction: inflow
                        group: null
                        currency: RON
                        budgeted: '95000.00'
                        actual: '0.00'
                        forecast: '52000.00'
                        realised: '52000.00'
                        on_budget: null
                        note: null
                      - period_start: '2026-12-01'
                        period_end: '2026-12-31'
                        direction: outflow
                        group: null
                        currency: RON
                        budgeted: '-64000.00'
                        actual: '0.00'
                        forecast: '-31800.00'
                        realised: '-31800.00'
                        on_budget: null
                        note: null
                    balances:
                      - period_start: '2026-10-01'
                        period_end: '2026-10-31'
                        currency: RON
                        final_balance: '208159.50'
                        budgeted_final_balance: null
                      - period_start: '2026-11-01'
                        period_end: '2026-11-30'
                        currency: RON
                        final_balance: '239843.75'
                        budgeted_final_balance: '239159.50'
                      - period_start: '2026-12-01'
                        period_end: '2026-12-31'
                        currency: RON
                        final_balance: null
                        budgeted_final_balance: '270159.50'
                Outflows by category, in total:
                  summary: >-
                    One row per category for the whole window, nested, no
                    balances
                  value:
                    object: budgets_summary
                    period:
                      from: '2026-01-01'
                      to: '2026-12-31'
                      macro: this_year
                      interval: total
                    conversion:
                      applied: false
                      currency: RON
                      basis: none
                    group_by: category
                    has_data: true
                    totals:
                      inflow: null
                      outflow:
                        currency: RON
                        budgeted: '-600000.00'
                        actual: '-497050.00'
                        forecast: '-96000.00'
                        realised: '-593050.00'
                    data:
                      - period_start: '2026-01-01'
                        period_end: '2026-12-31'
                        direction: outflow
                        group:
                          dimension: category
                          id: 6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d
                          label: Marketing
                          parent_id: null
                        currency: RON
                        budgeted: '-60000.00'
                        actual: '-47250.00'
                        forecast: '-6000.00'
                        realised: '-53250.00'
                        on_budget: null
                        note: null
                      - period_start: '2026-01-01'
                        period_end: '2026-12-31'
                        direction: outflow
                        group:
                          dimension: category
                          id: 3b4c5d6e-7f80-4a1b-9c2d-3e4f5a6b7c8d
                          label: Online ads
                          parent_id: 6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d
                        currency: RON
                        budgeted: '-36000.00'
                        actual: '-30100.00'
                        forecast: '-4000.00'
                        realised: '-34100.00'
                        on_budget: null
                        note: null
                      - period_start: '2026-01-01'
                        period_end: '2026-12-31'
                        direction: outflow
                        group:
                          dimension: category
                          id: 5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b
                          label: Events
                          parent_id: 6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d
                        currency: RON
                        budgeted: '-24000.00'
                        actual: '-15400.00'
                        forecast: '-2000.00'
                        realised: '-17400.00'
                        on_budget: null
                        note: null
                      - period_start: '2026-01-01'
                        period_end: '2026-12-31'
                        direction: outflow
                        group:
                          dimension: category
                          id: 6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d
                          label: Others for Marketing
                          parent_id: 6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d
                        currency: RON
                        budgeted: '0.00'
                        actual: '-1750.00'
                        forecast: '0.00'
                        realised: '-1750.00'
                        on_budget: null
                        note: null
                      - period_start: '2026-01-01'
                        period_end: '2026-12-31'
                        direction: outflow
                        group:
                          dimension: category
                          id: 8c9d0e1f-2a3b-4c4d-9e5f-6a7b8c9d0e1f
                          label: Salaries
                          parent_id: null
                        currency: RON
                        budgeted: '-540000.00'
                        actual: '-449800.00'
                        forecast: '-90000.00'
                        realised: '-539800.00'
                        on_budget: null
                        note: null
                    balances: []
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/RequestTooLarge'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    period:
      name: period
      in: query
      description: >-
        A named window, resolved against the workspace's local day and echoed in
        the response. Takes precedence over `from` and `to`.
      schema:
        $ref: '#/components/schemas/PeriodMacro'
    planning_interval:
      name: interval
      in: query
      description: >-
        The period rows are grouped into. `month` for each calendar month,
        `total` for the whole window as one period.
      schema:
        $ref: '#/components/schemas/PlanningInterval'
    currency:
      name: currency
      in: query
      description: >-
        Currency to report in. Defaults to the workspace currency. An unknown
        code is rejected.
      schema:
        $ref: '#/components/schemas/Currency'
    planning_category_id:
      name: category_id
      in: query
      description: >-
        Only these categories and the categories nested under them.
        Comma-separated for several.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
    direction:
      name: direction
      in: query
      schema:
        $ref: '#/components/schemas/Direction'
  schemas:
    BudgetsSummary:
      type: object
      required:
        - object
        - period
        - conversion
        - group_by
        - has_data
        - totals
        - data
        - balances
      properties:
        object:
          type: string
          const: budgets_summary
        period:
          $ref: '#/components/schemas/ResolvedPlanningPeriod'
        conversion:
          $ref: '#/components/schemas/Conversion'
        group_by:
          type:
            - string
            - 'null'
          enum:
            - category
            - null
        has_data:
          type: boolean
          description: >-
            `false` when nothing is budgeted, has moved or is expected in the
            window, as opposed to figures that came to zero.
        totals:
          $ref: '#/components/schemas/BudgetsSummaryTotals'
        data:
          type: array
          items:
            $ref: '#/components/schemas/BudgetsSummaryRow'
        balances:
          type: array
          description: >-
            The planning tab's final balance row, one entry per month. Empty
            with `interval=total`, `group_by`, `category_id` or `direction`.
          items:
            $ref: '#/components/schemas/BudgetsBalance'
    PeriodMacro:
      type: string
      description: >-
        A named window resolved on the server. `last_30_days` and `last_90_days`
        end today and include it; `last_12_months` starts the day after today
        minus twelve months. `next_month`, `next_quarter` and `next_year` cover
        the whole next calendar month, quarter or year.
      enum:
        - this_month
        - last_month
        - this_quarter
        - last_quarter
        - this_year
        - last_year
        - month_to_date
        - quarter_to_date
        - year_to_date
        - last_30_days
        - last_90_days
        - last_12_months
        - next_month
        - next_quarter
        - next_year
    PlanningInterval:
      type: string
      description: >-
        A period bucket for budget and scenario rows, which are monthly. `total`
        reports the whole window as one period, as the budgets screen's Total
        column does.
      enum:
        - month
        - total
      default: month
    Currency:
      type: string
      description: ISO 4217 alphabetic currency code.
      pattern: ^[A-Z]{3}$
      example: RON
    Direction:
      type: string
      description: >-
        Whether money comes in or goes out. On a transaction or forecast it
        follows the sign of `amount`.
      enum:
        - inflow
        - outflow
    ResolvedPlanningPeriod:
      type: object
      description: The window actually computed, widened to whole months.
      required:
        - from
        - to
        - macro
        - interval
      properties:
        from:
          type: string
          format: date
          description: First day of the first month.
        to:
          type: string
          format: date
          description: Last day of the last month.
        macro:
          oneOf:
            - $ref: '#/components/schemas/PeriodMacro'
            - type: 'null'
          description: >-
            The macro that produced the window, or `null` when the dates were
            given directly or the endpoint's default window applied.
        interval:
          $ref: '#/components/schemas/PlanningInterval'
    Conversion:
      type: object
      description: What was done to make amounts comparable.
      required:
        - applied
        - currency
        - basis
      properties:
        applied:
          type: boolean
          description: '`false` when every amount was already in `currency`.'
        currency:
          $ref: '#/components/schemas/Currency'
        basis:
          type: string
          description: >-
            `transaction_date` converts each movement at the rate for its own
            date. `balance_date` converts a whole balance at one rate.
            `own_date` converts each budget at the rate for the first day of its
            month, and each transaction and forecast at the rate for its own
            date. `none` when nothing was converted.
          enum:
            - transaction_date
            - balance_date
            - own_date
            - none
    BudgetsSummaryTotals:
      type: object
      description: >-
        The planning tab's Total column for each direction, over the whole
        window and the same categories as the rows.
      required:
        - inflow
        - outflow
      properties:
        inflow:
          oneOf:
            - $ref: '#/components/schemas/BudgetFigures'
            - type: 'null'
          description: '`null` when `direction` or `category_id` leaves inflows out.'
        outflow:
          oneOf:
            - $ref: '#/components/schemas/BudgetFigures'
            - type: 'null'
          description: '`null` when `direction` or `category_id` leaves outflows out.'
    BudgetsSummaryRow:
      type: object
      description: >-
        One direction of one period, or one category of one period with
        `group_by=category`. Outflows are negative.
      required:
        - period_start
        - period_end
        - direction
        - group
        - currency
        - budgeted
        - actual
        - forecast
        - realised
        - on_budget
        - note
      properties:
        period_start:
          type: string
          format: date
        period_end:
          type: string
          format: date
        direction:
          $ref: '#/components/schemas/Direction'
        group:
          oneOf:
            - $ref: '#/components/schemas/PlanningCategory'
            - type: 'null'
          description: >-
            The category with `group_by=category`. `null` on a row that stands
            for a whole direction.
        currency:
          $ref: '#/components/schemas/Currency'
        budgeted:
          $ref: '#/components/schemas/Money'
          description: The budget.
        actual:
          $ref: '#/components/schemas/Money'
          description: Transactions dated in the period. The tracking tab's Actual column.
        forecast:
          $ref: '#/components/schemas/Money'
          description: >-
            Remaining amount of the unrealised forecasts dated in the period.
            The tracking tab's Forecasted column.
        realised:
          $ref: '#/components/schemas/Money'
          description: >-
            `actual` plus `forecast`. The figure the planning tab compares with
            the budget.
        on_budget:
          type:
            - boolean
            - 'null'
          description: >-
            The planning tab's check or warning icon. `true` when `realised`
            reached an inflow budget or stayed within an outflow budget. `null`
            for a month that has not started, for a cell without a budget and
            with `interval=total`.
        note:
          type:
            - string
            - 'null'
          description: >-
            The note written on the budget. Set only on category rows with
            `interval=month`.
    BudgetsBalance:
      type: object
      description: One month of the planning tab's final balance row.
      required:
        - period_start
        - period_end
        - currency
        - final_balance
        - budgeted_final_balance
      properties:
        period_start:
          type: string
          format: date
        period_end:
          type: string
          format: date
        currency:
          $ref: '#/components/schemas/Currency'
        final_balance:
          oneOf:
            - $ref: '#/components/schemas/Money'
            - type: 'null'
          description: >-
            The cash flow's balance at the end of the month, projected for the
            month still running. `null` for a month that has not started.
        budgeted_final_balance:
          oneOf:
            - $ref: '#/components/schemas/Money'
            - type: 'null'
          description: >-
            The balance at the end of the month if the budgets hold, carried
            forward from the current month with the budgeted net results. `null`
            for a month that has ended.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request
                - authentication
                - not_found
                - rate_limit
                - server
            code:
              type: string
              description: >
                Stable machine-readable reason. Branch on this, not on
                `message`. One of

                `invalid_parameter`, `invalid_cursor`, `limit_out_of_range`,
                `invalid_expand`,

                `as_of_in_future`, `unauthorized`, `forbidden`,
                `resource_not_found`,

                `too_many_groups`, `period_too_long`, `rate_limited`,
                `internal_error`.
            message:
              type: string
              description: Human-readable explanation. Wording may change.
            param:
              type:
                - string
                - 'null'
              description: The query parameter at fault, when there is one.
            request_id:
              type: string
              description: Quote this when contacting support.
    BudgetFigures:
      type: object
      description: >-
        The planning tab's Total column for one direction. Outflows are
        negative.
      required:
        - currency
        - budgeted
        - actual
        - forecast
        - realised
      properties:
        currency:
          $ref: '#/components/schemas/Currency'
        budgeted:
          $ref: '#/components/schemas/Money'
          description: The budget.
        actual:
          $ref: '#/components/schemas/Money'
          description: Transactions. The tracking tab's Actual column.
        forecast:
          $ref: '#/components/schemas/Money'
          description: >-
            Remaining amount of the unrealised forecasts. The tracking tab's
            Forecasted column.
        realised:
          $ref: '#/components/schemas/Money'
          description: >-
            `actual` plus `forecast`. The figure the planning tab compares with
            the budget.
    PlanningCategory:
      type: object
      description: >-
        The category a budget or scenario row stands for. Rows nest as on the
        screen, so a parent category's row covers its whole branch. A row whose
        `id` equals its `parent_id` is the money booked on the parent category
        itself, which the budgets screen shows as "Others for" the parent.
      required:
        - dimension
        - id
        - label
        - parent_id
      properties:
        dimension:
          type: string
          const: category
        id:
          type: string
          format: uuid
        label:
          type: string
          example: Marketing
        parent_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            The id of the category this row is nested under. `null` for a
            top-level category.
    Money:
      type: string
      description: >-
        Decimal amount as a string with two decimals. Negative means an outflow
        on transactions, forecasts and report figures.
      pattern: ^-?[0-9]+\.[0-9]{2}$
      example: '-1250.00'
  responses:
    BadRequest:
      description: A parameter is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request
              code: invalid_parameter
              message: direction must be 'inflow' or 'outflow'
              param: direction
              request_id: 0HNF8K3QJL2VM:00000001
    Unauthorized:
      description: The API key is missing, malformed, unknown or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication
              code: unauthorized
              message: Missing, malformed, unknown or revoked API key
              param: null
              request_id: 0HNF8K3QJL2VM:00000001
    Forbidden:
      description: >-
        The key is valid but the company's ThinkOut plan does not include the
        API.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication
              code: forbidden
              message: >-
                The API is not included in this company's ThinkOut plan. Contact
                support@thinkout.io to enable it.
              param: null
              request_id: 0HNF8K3QJL2VM:00000001
    RequestTooLarge:
      description: >
        The report would exceed 1000 rows. `period_too_long` is raised from the
        window and

        interval alone, `too_many_groups` after grouping. Narrow the window,
        coarsen the

        interval or add filters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request
              code: too_many_groups
              message: >-
                Grouping by counterparty over this period produces 1240 groups.
                The maximum is 1000. Narrow the period or the filters.
              param: group_by
              request_id: 0HNF8K3QJL2VM:00000001
    RateLimited:
      description: >-
        More than 120 requests in the current minute for this key. Wait for the
        seconds in `Retry-After`.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds until the minute window resets.
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Requests allowed per minute.
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests left in the current minute.
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Seconds until the minute window resets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: rate_limit
              code: rate_limited
              message: Too many requests
              param: null
              request_id: 0HNF8K3QJL2VM:00000001
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A workspace API key created in ThinkOut settings. One key reads one
        workspace.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.