> ## 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

> Get the organisation this request works in: the role it has there and what the request may do, the
organisation's standing, and whether zero data retention is on. An inference key can't call it.



## OpenAPI

````yaml /openapi.json get /v1/organization
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. An API key reads its account but never
    changes it: keys, billing and settings change in the console. 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: Better wording for a decision, tested on your rows. Words, not weights.
  - name: Labeling
    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:
    get:
      tags:
        - Organizations
      summary: Get organization
      description: >-
        Get the organisation this request works in: the role it has there and
        what the request may do, the

        organisation's standing, and whether zero data retention is on. An
        inference key can't call it.
      operationId: getOrganization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                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.
                  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 nothing a decision sends or answers is kept once
                      its answer is returned. 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
        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:
    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
    ErrorResponse:
      description: The body of every error.
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      required:
        - error
      title: ErrorResponse
      type: object
    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.