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

# List labeling results

> Page through teacher labels for review before creating a dataset. A job's labels can
be read once it is review_ready (409 review_required before that, and for a job that
failed or was cancelled, which costs nothing).



## OpenAPI

````yaml /openapi.json get /v1/labeling/jobs/{job_id}/results
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: >-
      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/labeling/jobs/{job_id}/results:
    get:
      tags:
        - Labelling
      summary: List labeling results
      description: >-
        Page through teacher labels for review before creating a dataset. A
        job's labels can

        be read once it is review_ready (409 review_required before that, and
        for a job that

        failed or was cancelled, which costs nothing).
      operationId: listLabelingResults
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            title: Job Id
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 100
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/LabelingResult'
                    title: Data
                    type: array
                  total:
                    title: Total
                    type: integer
                  offset:
                    title: Offset
                    type: integer
                  limit:
                    title: Limit
                    type: integer
                required:
                  - data
                  - total
                  - offset
                  - limit
                title: Rows
                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:
    LabelingResult:
      properties:
        index:
          type: integer
          title: Index
        context:
          anyOf:
            - type: string
            - additionalProperties: true
              type: object
            - items: {}
              type: array
          title: Context
        decisions:
          items:
            $ref: '#/components/schemas/Decision'
          type: array
          title: Decisions
        teachers:
          items:
            $ref: '#/components/schemas/TeacherResult'
          type: array
          title: Teachers
        valid:
          type: boolean
          title: Valid
        agreement:
          type: boolean
          title: Agreement
        targets:
          additionalProperties:
            additionalProperties:
              type: number
            type: object
          type: object
          title: Targets
        error:
          type: string
          title: Error
      type: object
      required:
        - index
        - context
        - decisions
        - teachers
        - valid
        - agreement
      title: LabelingResult
    ErrorResponse:
      description: The body of every error.
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      required:
        - error
      title: ErrorResponse
      type: object
    Decision:
      properties:
        id:
          type: string
          maxLength: 128
          minLength: 1
          title: Id
        question:
          anyOf:
            - type: string
            - additionalProperties: true
              type: object
            - items: {}
              type: array
          title: Question
        kind:
          type: string
          enum:
            - single
            - binary
            - ordinal
          title: Kind
          default: single
        outcomes:
          title: Outcomes
        rubric:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Rubric
        policy:
          anyOf:
            - $ref: '#/components/schemas/Policy'
            - type: 'null'
      additionalProperties: false
      type: object
      required:
        - id
        - question
      title: Decision
    TeacherResult:
      properties:
        model:
          type: string
          title: Model
        labels:
          additionalProperties:
            type: string
          type: object
          title: Labels
        error:
          type: string
          title: Error
      type: object
      required:
        - model
      title: TeacherResult
    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
    Policy:
      properties:
        action_costs:
          anyOf:
            - additionalProperties:
                additionalProperties:
                  type: number
                type: object
              type: object
            - type: 'null'
          title: Action Costs
        abstain_below:
          anyOf:
            - type: number
              maximum: 1
              minimum: 0
            - type: 'null'
          title: Abstain Below
      additionalProperties: false
      type: object
      title: Policy
    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.