> For the complete documentation index, see [llms.txt](https://docs.otari.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.otari.ai/otari/for-integrators/api-reference/overview.md).

# Overview

## Get Overview

> Summarize what the dashboard overview shows beside its usage chart.\
> \
> The counts and the budget judgment in one answer, so the page does not read\
> four collections to compute them. A workspace outside the caller's\
> organization is treated as none given rather than refused, because the id\
> comes from a switcher whose contents can go stale.

```json
{"openapi":"3.1.0","info":{"title":"otari","version":"0.33.0"},"security":[{"ApiKeyAuth":[]},{"XApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"description":"Enter your API key here (sent as Otari-Key header).","in":"header","name":"Otari-Key","type":"apiKey"},"XApiKeyAuth":{"description":"Anthropic-native clients send credentials here (no Bearer prefix).","in":"header","name":"x-api-key","type":"apiKey"}},"schemas":{"OverviewSummaryResponse":{"description":"What the dashboard overview renders beside its usage chart.\n\n``budgets`` and ``ceilings`` are null where the caller may not see them,\nwhich is not the same as a strip with nothing in it: deployment budgets are\nthe operator's, and spend ceilings are an organization owner's or admin's.","properties":{"active_keys":{"title":"Active Keys","type":"integer"},"active_members":{"description":"Active members of the named workspace; 0 when none is named.","title":"Active Members","type":"integer"},"budgets":{"anyOf":[{"$ref":"#/components/schemas/AllocationHealthResponse"},{"type":"null"}]},"ceilings":{"anyOf":[{"$ref":"#/components/schemas/AllocationHealthResponse"},{"type":"null"}]}},"required":["active_keys","active_members","budgets","ceilings"],"title":"OverviewSummaryResponse","type":"object"},"AllocationHealthResponse":{"description":"One set of capped rows, reduced to what a strip renders.","properties":{"capped_count":{"description":"Rows with a finite cap, which are the ones that can be judged.","title":"Capped Count","type":"integer"},"near_count":{"description":"Rows at 80% of their allowance or more, but not past it.","title":"Near Count","type":"integer"},"over_count":{"description":"Rows at or past their allowance.","title":"Over Count","type":"integer"},"total_count":{"description":"Rows of any kind, so a caller can tell 'none configured' from 'none caps spend'.","title":"Total Count","type":"integer"},"worst":{"anyOf":[{"$ref":"#/components/schemas/WorstAllocationResponse"},{"type":"null"}]}},"required":["over_count","near_count","capped_count","total_count","worst"],"title":"AllocationHealthResponse","type":"object"},"WorstAllocationResponse":{"description":"The row furthest through its allowance.","properties":{"allocated":{"title":"Allocated","type":"number"},"budget_id":{"title":"Budget Id","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The row's own name, or null where nobody gave it one.","title":"Name"},"scope_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The scope's id, so an unnamed ceiling can be named after it.","title":"Scope Id"},"scope_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What a spend ceiling caps (workspace, org_member, api_token, ...); null for a budget.","title":"Scope Type"},"spent":{"title":"Spent","type":"number"}},"required":["budget_id","name","spent","allocated","scope_type","scope_id"],"title":"WorstAllocationResponse","type":"object"},"HTTPValidationError":{"properties":{"code":{"const":"invalid_request","description":"Stable error code, also sent as the Otari-Error-Code header.","title":"Code","type":"string"},"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"ctx":{"title":"Context","type":"object"},"input":{"title":"Input"},"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}},"paths":{"/api/v1/overview":{"get":{"description":"Summarize what the dashboard overview shows beside its usage chart.\n\nThe counts and the budget judgment in one answer, so the page does not read\nfour collections to compute them. A workspace outside the caller's\norganization is treated as none given rather than refused, because the id\ncomes from a switcher whose contents can go stale.","operationId":"overview-get_overview","parameters":[{"description":"Narrow the counts to one workspace of the caller's organization.","in":"query","name":"workspace_id","required":false,"schema":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"description":"Narrow the counts to one workspace of the caller's organization.","title":"Workspace Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverviewSummaryResponse"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Get Overview","tags":["overview"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.otari.ai/otari/for-integrators/api-reference/overview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.