> ## Documentation Index > Fetch the complete documentation index at: https://docs.sqwish.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get organization summary > Account identity, wallet and current policy limits. tier is the tier the organisation is on, which verified purchases net of reversals raise. effective_limits contains rpm, tpm, concurrency, stored_objects, stored_mib, kept_warm, answering, upload_bytes, read_rpm, write_rpm, estimate_tokens_per_minute and fine_tunes, shared across this account's keys and browser sessions. storage is what the account keeps now: objects and bytes, archived datasets included. This summary omits personal console state for every credential. ## OpenAPI ````yaml /openapi.json get /v1/organization/summary openapi: 3.1.0 info: title: OneHot API description: >- Decisions your application can act on: send a context and the questions you want answered, and get a probability for every answer you allow. Authenticate with `Authorization: Bearer onehot_sk_...`. A short guide for coding agents is at /llms.txt. A project's API key reads its account but never changes it: keys, billing and settings change in the console. An admin key runs a shared organisation's billing, projects, keys and members. Money fields ending in _usd are exact decimal strings, never integer cents. Over a rate limit a request gets 429 with Retry-After, and one with more input tokens than your minute allows gets 422 too_many_tokens. version: 0.1.0 servers: - url: https://api.sqwish.ai security: [] tags: - name: Decisions description: Probabilities for questions with fixed outcomes. - name: Models description: Base models, and fine-tuned models by their numbers. - name: Families description: >- Lines of models trained on one dataset, and the switches that let them answer calls. - name: Datasets description: >- Validated training examples. A dataset grows in versions, and a version never changes. - name: Evaluations description: Reusable model results on a dataset's fixed evaluation rows. - name: Fine-tuning description: Training jobs, their events and held-out results. - name: Prompt tuning description: >- Deprecated. Better wording for a decision, tested on your rows. A server with prompt tuning switched off refuses a new job with 503 prompt_tuning_unavailable, and past jobs stay readable. - name: Labelling description: Teacher labels for real queries, reviewed by you. - name: Accounts description: Email OTP sign-in, revocable sessions, security and API keys. - name: Billing description: Exact USD balances, purchases, automatic top-ups and referrals. - name: Organizations description: The organisation a request works in, and the role it has there. - name: Projects description: The projects that keep an organisation's work apart. - name: Integrations description: Endpoints other tools call, such as Claude Code. - name: System description: Health and discovery. paths: /v1/organization/summary: get: tags: - Organizations summary: Get organization summary description: >- Account identity, wallet and current policy limits. tier is the tier the organisation is on, which verified purchases net of reversals raise. effective_limits contains rpm, tpm, concurrency, stored_objects, stored_mib, kept_warm, answering, upload_bytes, read_rpm, write_rpm, estimate_tokens_per_minute and fine_tunes, shared across this account's keys and browser sessions. storage is what the account keeps now: objects and bytes, archived datasets included. This summary omits personal console state for every credential. operationId: getOrganizationSummary responses: '200': description: Successful Response content: application/json: schema: properties: organization: $ref: '#/components/schemas/Organization' description: >- The organisation this request works in, an API key's own or the console's choice, as GET /v1/organization returns it. project: anyOf: - $ref: '#/components/schemas/AccountProject' - type: 'null' description: >- The project this request works in: an API key's own, or the one a console tab works in. Null for an admin key, which works in none. project_access: description: >- `some` when this request reaches only some of its organisation's projects: a developer an owner limited to some, or an API key that works as a developer, which reaches its own project alone. `all` otherwise. enum: - all - some title: Project Access type: string tier: description: >- The tier the organisation is on, whose limits are `effective_limits`. title: Tier type: integer next_tier: anyOf: - $ref: '#/components/schemas/NextTier' - type: 'null' description: >- The tier above this one and what buying credit must add to reach it; null at the top tier. effective_limits: $ref: '#/components/schemas/AccountLimits' places: $ref: '#/components/schemas/Places' storage: $ref: '#/components/schemas/Storage' wallet: $ref: '#/components/schemas/Wallet' user: $ref: '#/components/schemas/UserIdentity' required: - organization - project - project_access - tier - next_tier - effective_limits - places - storage - wallet - user title: AccountSummary type: object 4XX: description: >- Client error. On a 422, `error.details` lists each field that failed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 5XX: description: Server error. A 503 names what is not running on this server. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: Organization: properties: id: type: string title: Id kind: type: string enum: - personal - organization title: Kind description: >- `personal` for a person's own organisation, `organization` for one shared by several people. name: type: string title: Name role: type: string enum: - owner - developer - billing title: Role description: >- The role this request works with. A console session's is its person's. An API key works as an owner in a personal organisation; in a shared one, an admin key as an owner, a billing member's as billing, and any other as a developer. sees_billing: type: boolean title: Sees Billing description: >- Whether this role sees billing: owners and billing members do. Read permissions for the actions this credential can make. deprecated: true permissions: items: type: string type: array title: Permissions description: >- What this request is allowed to do here, such as `work.write`: what its role allows and, for an API key, its access, but for changes only the console makes. Its standing, the projects it is kept to and a project's spending limit may still refuse a call. status: type: string enum: - active - waitlisted - blocked - deleted title: Status description: >- Whether it may work: `waitlisted` until a personal organisation is admitted, `blocked` while it is suspended. zero_data_retention: $ref: '#/components/schemas/ZeroDataRetention' description: >- Whether zero data retention is on: what a decision sends or answers isn't stored once its answer is returned, and usage records stay. Sqwish switches it on for an organisation that has signed for it. Each switch takes a few minutes to reach every region, as the zero data retention guide says. type: object required: - id - kind - name - role - sees_billing - permissions - status - zero_data_retention title: Organization AccountProject: properties: id: type: string title: Id name: type: string title: Name default: type: boolean title: Default description: >- Whether it is its organisation's Default project, whose id is its own. type: object required: - id - name - default title: AccountProject NextTier: properties: tier: type: integer title: Tier minimum_paid_usd: type: string title: Minimum Paid Usd description: What verified purchases must come to for this tier. remaining_usd: type: string title: Remaining Usd description: How much more to buy to reach it. type: object required: - tier - minimum_paid_usd - remaining_usd title: NextTier AccountLimits: properties: rpm: type: integer title: Rpm tpm: type: integer title: Tpm concurrency: type: integer title: Concurrency stored_objects: type: integer title: Stored Objects stored_mib: type: integer title: Stored Mib kept_warm: type: integer title: Kept Warm answering: type: integer title: Answering upload_bytes: type: integer title: Upload Bytes read_rpm: type: integer title: Read Rpm write_rpm: type: integer title: Write Rpm estimate_tokens_per_minute: type: integer title: Estimate Tokens Per Minute fine_tunes: type: integer title: Fine Tunes description: >- Fine-tunes the account can have queued, running or cancelling at once. Another start gets 429 `tenant_queue_full`. type: object required: - rpm - tpm - concurrency - stored_objects - stored_mib - kept_warm - answering - upload_bytes - read_rpm - write_rpm - estimate_tokens_per_minute - fine_tunes title: AccountLimits Places: properties: answering: type: integer title: Answering description: >- Models that answer calls, through a family, their own switch or both, each once: the places counted against `answering` in effective_limits. kept_warm: type: integer title: Kept Warm description: >- Models kept warm, each once: the warm places counted against `kept_warm`. type: object required: - answering - kept_warm title: Places Storage: properties: objects: type: integer title: Objects bytes: type: integer title: Bytes type: object required: - objects - bytes title: Storage Wallet: properties: currency: type: string const: USD title: Currency paid_usd: type: string title: Paid Usd promotional_usd: type: string title: Promotional Usd balance_usd: type: string title: Balance Usd description: >- The credit the account has: paid credit and promotional grants, with what expired grants still hold for work in progress. Available plus reserved, unless a reversed payment left paid holds uncovered. available_usd: type: string title: Available Usd reserved_usd: type: string title: Reserved Usd financial_shortfall_usd: type: string title: Financial Shortfall Usd description: >- Paid credit the account is missing: what it owes, and paid holds it no longer covers. financial_blocked: type: boolean title: Financial Blocked description: >- True while the account's figures are paused for reconciliation: work it accepted still ends and is recorded, but the balance, available and reserved amounts stay as they were until support repairs them, so they can disagree with the work that holds credit meanwhile. type: object required: - currency - paid_usd - promotional_usd - balance_usd - available_usd - reserved_usd - financial_shortfall_usd - financial_blocked title: Wallet UserIdentity: properties: id: type: string title: Id email: anyOf: - type: string - type: 'null' title: Email description: >- Your address; for a shared organisation's API key, its billing email, or null when the key's role doesn't see billing. name: anyOf: - type: string - type: 'null' title: Name created_at: type: number title: Created At admitted_at: anyOf: - type: number - type: 'null' title: Admitted At type: object required: - id - email - name - created_at - admitted_at title: UserIdentity ErrorResponse: description: The body of every error. properties: error: $ref: '#/components/schemas/ErrorBody' required: - error title: ErrorResponse type: object ZeroDataRetention: properties: enabled: type: boolean title: Enabled description: >- Whether it is on. While it is, a decision's Idempotency-Key is not honoured: a retried decision runs again and is charged again. since: anyOf: - type: number - type: 'null' title: Since description: When it was switched on, or null while it is off. type: object required: - enabled - since title: ZeroDataRetention ErrorBody: properties: code: description: A stable code to branch on, such as invalid_request. title: Code type: string message: description: What went wrong and what to change, in plain words. title: Message type: string retryable: description: >- True when another attempt may succeed; it does not prove that no work was done. Respect Retry-After when present. Only operations that support Idempotency-Key replay a prior result, including /v1/decide for 24 hours, but not a decision of an organisation with zero data retention, which keeps no answer. title: Retryable type: boolean request_id: description: Also sent as X-Request-ID. Quote it in bug reports. title: Request Id type: string details: anyOf: - items: $ref: '#/components/schemas/ErrorDetail' type: array - type: 'null' default: null description: On validation errors, one entry for each field that failed. title: Details required: - code - message - retryable - request_id title: ErrorBody type: object ErrorDetail: properties: path: description: Where the problem is, such as ["body", "decisions", 0, "outcomes"]. items: anyOf: - type: string - type: integer title: Path type: array message: title: Message type: string type: anyOf: - type: string - type: 'null' default: null title: Type required: - path - message title: ErrorDetail type: object securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: onehot_sk_... description: Create an API key in the console. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.