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

# Submit a System One request

> Sends state and typed questions to a System One model such as Jev and returns its answers. Compatible with the TypeSafe SDKs. Bare System One model IDs such as `jev-1.13` and `jev-latest` are mapped onto the `typesafe/` namespace.



## OpenAPI

````yaml /openapi.json post /systemone
openapi: 3.1.0
info:
  title: Nemonist API
  version: 1.0.0
  description: >-
    OpenRouter-compatible API with durable per-workspace memory. Point any
    OpenRouter client at https://nemonist.com/api/v1 with a Nemonist key
    (sk-nm-...). Chat completions, Responses and Messages requests from a
    workspace carrying a .nemonist/key get its memory; every other request is
    answered as OpenRouter would.
  contact:
    name: Nemonist
    url: https://nemonist.com
servers:
  - url: https://nemonist.com/api/v1
    description: Production
security:
  - apiKey: []
tags:
  - description: API key management endpoints
    name: API Keys
  - description: Analytics and usage endpoints
    name: Analytics
  - description: Anthropic Messages endpoints
    name: Anthropic Messages
  - description: BYOK endpoints
    name: BYOK
  - description: Benchmarks endpoints
    name: Benchmarks
  - description: Chat completion endpoints
    name: Chat
  - description: Credit management endpoints
    name: Credits
  - description: >-
      Public OpenRouter usage datasets. Data returned by these endpoints is
      licensed under CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/):
      reuse and republish it, including commercially, with attribution to
      OpenRouter.
    name: Datasets
  - description: Text embedding endpoints
    name: Embeddings
  - description: Endpoint information
    name: Endpoints
  - name: Folders
    description: >-
      Your memory folders, over your account's API key: read, export, upload,
      and manage keys.
  - description: Generation history endpoints
    name: Generations
  - description: Guardrails endpoints
    name: Guardrails
  - description: Images endpoints
    name: Images
  - name: Memory
    description: Nemonist's per-workspace memory.
  - name: Model runs
    description: Run models (physics and others) on inputs; one contract for every model
  - description: Model information endpoints
    name: Models
  - description: OAuth authentication endpoints
    name: OAuth
  - description: Organization endpoints
    name: Organization
  - description: Private Endpoints endpoints
    name: Private Endpoints
  - description: Provider information endpoints
    name: Providers
  - description: Rerank endpoints
    name: Rerank
  - description: OpenAI-compatible Responses API endpoints
    name: Responses
  - description: Speech-to-text endpoints
    name: STT
    x-displayName: Transcriptions
  - description: >-
      System One endpoints for models such as Jev, compatible with the TypeSafe
      SDKs. See https://openrouter.ai/docs/guides/community/typesafe-sdk.
    name: SystemOne
    x-displayName: System One
  - description: Text-to-speech endpoints
    name: TTS
    x-displayName: Speech
  - description: Video Generation endpoints
    name: Video Generation
  - description: Workspaces endpoints
    name: Workspaces
  - name: beta.responses
    description: >-
      Deprecated alias of responses. Use responses instead; scheduled for
      removal (sunset date TBD).
paths:
  /systemone:
    parameters:
      - $ref: '#/components/parameters/AppIdentifier'
      - $ref: '#/components/parameters/AppDisplayName'
      - $ref: '#/components/parameters/AppCategories'
    post:
      tags:
        - SystemOne
      summary: Submit a System One request
      description: >-
        Sends state and typed questions to a System One model such as Jev and
        returns its answers. Compatible with the TypeSafe SDKs. Bare System One
        model IDs such as `jev-1.13` and `jev-latest` are mapped onto the
        `typesafe/` namespace.
      operationId: createSystemone
      requestBody:
        content:
          application/json:
            example:
              model: typesafe/jev-1.13
              questions:
                is_bug:
                  criteria:
                    'false': The customer is asking a question or requesting a feature.
                    'true': >-
                      The customer describes broken or unexpected product
                      behavior.
                  instructions: Is the customer reporting a software defect?
                  type: noul
                team:
                  criteria:
                    account: Login, permissions, or profile issues.
                    frontend: Rendering, layout, or browser compatibility issues.
                    payments: Checkout, billing, or payment processing issues.
                  instructions: Which team should own this ticket?
                  type: choice
                urgency:
                  criteria:
                    - Can wait for the next release
                    - Should be fixed this week
                    - Blocking revenue right now
                  instructions: How urgent is this ticket?
                  type: score
              state:
                customer_tier: enterprise
                ticket: >-
                  My checkout page shows a blank screen after I click Pay. I
                  have tried two browsers.
            schema:
              $ref: '#/components/schemas/DecisionsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                answers:
                  is_bug:
                    noul: 0.96
                    type: noul
                  team:
                    choice: payments
                    confidence: 0.75
                    probabilities:
                      account: 0
                      frontend: 0.16
                      payments: 0.84
                    type: choice
                  urgency:
                    confidence: 0.99
                    legend:
                      '0': Can wait for the next release
                      '1': Should be fixed this week
                      '2': Blocking revenue right now
                    probabilities:
                      '0': 0
                      '1': 0.01
                      '2': 0.99
                    score: 1.99
                    type: score
                id: gen-dec-1789738314-X5e5eKGQdvR9rblyX250
                model: typesafe/jev-1.13-20260917
                provider: TypeSafe
                usage:
                  cost: 0.000019992
                  input_tokens: 476
                  output_tokens: 70
              schema:
                $ref: '#/components/schemas/DecisionsResponse'
          description: Decisions response
        '400':
          content:
            application/json:
              example:
                error:
                  code: 400
                  message: Invalid request parameters
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
          description: Bad Request - Invalid request parameters or malformed input
        '401':
          content:
            application/json:
              example:
                error:
                  code: 401
                  message: Missing Authentication header
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized - Authentication required or invalid credentials
        '402':
          content:
            application/json:
              example:
                error:
                  code: 402
                  message: >-
                    Insufficient credits. Add more using
                    https://openrouter.ai/credits
              schema:
                $ref: '#/components/schemas/PaymentRequiredResponse'
          description: >-
            Payment Required - Insufficient credits or quota to complete
            request. Nemonist: over a spending cap, or out of credits.
        '403':
          content:
            application/json:
              example:
                error:
                  code: 403
                  message: Only management keys can perform this operation
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden - Authentication successful but insufficient permissions
        '404':
          content:
            application/json:
              example:
                error:
                  code: 404
                  message: Resource not found
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not Found - Resource does not exist
        '413':
          content:
            application/json:
              example:
                error:
                  code: 413
                  message: Request payload too large
              schema:
                $ref: '#/components/schemas/PayloadTooLargeResponse'
          description: Payload Too Large - Request payload exceeds size limits
        '429':
          content:
            application/json:
              example:
                error:
                  code: 429
                  message: Rate limit exceeded
              schema:
                $ref: '#/components/schemas/TooManyRequestsResponse'
          description: >-
            Too Many Requests - Rate limit exceeded. Nemonist: admission limit
            reached; retry after the Retry-After header's seconds.
        '500':
          content:
            application/json:
              example:
                error:
                  code: 500
                  message: Internal Server Error
              schema:
                $ref: '#/components/schemas/InternalServerResponse'
          description: Internal Server Error - Unexpected server error
        '502':
          content:
            application/json:
              example:
                error:
                  code: 502
                  message: Provider returned error
              schema:
                $ref: '#/components/schemas/BadGatewayResponse'
          description: Bad Gateway - Provider/upstream API failure
        '503':
          content:
            application/json:
              example:
                error:
                  code: 503
                  message: Service temporarily unavailable
              schema:
                $ref: '#/components/schemas/ServiceUnavailableResponse'
          description: Service Unavailable - Service temporarily unavailable
        '524':
          content:
            application/json:
              example:
                error:
                  code: 524
                  message: Request timed out. Please try again later.
              schema:
                $ref: '#/components/schemas/EdgeNetworkTimeoutResponse'
          description: Infrastructure Timeout - Provider request timed out at edge network
        '529':
          content:
            application/json:
              example:
                error:
                  code: 529
                  message: Provider returned error
              schema:
                $ref: '#/components/schemas/ProviderOverloadedResponse'
          description: Provider Overloaded - Provider is temporarily overloaded
components:
  parameters:
    AppIdentifier:
      name: HTTP-Referer
      in: header
      schema:
        type: string
      description: >
        The app identifier should be your app's URL and is used as the primary
        identifier for rankings.

        This is used to track API usage per application.
    AppDisplayName:
      name: X-OpenRouter-Title
      in: header
      x-speakeasy-name-override: appTitle
      schema:
        type: string
      description: >
        The app display name allows you to customize how your app appears in
        OpenRouter's dashboard.
    AppCategories:
      name: X-OpenRouter-Categories
      in: header
      x-speakeasy-name-override: appCategories
      schema:
        type: string
      description: >
        Comma-separated list of app categories (e.g. "cli-agent,cloud-agent").
        Used for marketplace rankings.
  schemas:
    DecisionsRequest:
      properties:
        assets:
          additionalProperties:
            $ref: '#/components/schemas/DecisionsImageAsset'
          description: >-
            Images keyed by reference string, as in TypeSafe's API. Write a
            reference wherever the image belongs in `state`, `instructions`, or
            `criteria`; every asset must be referenced at least once, or the
            request fails with `400` naming the unused key. TypeSafe Jev
            endpoints receive `assets` as written and read a reference as a
            whole string value or inside longer text. Every other provider has
            each whole-string reference resolved to an `image_url` part before
            the request is sent, so it is accepted only where that provider
            reads `image_url` parts (top-level `state` items), and a reference
            inside longer text fails with `400`. `image_url` parts and `assets`
            can be mixed in one request.
          type: object
        model:
          type: string
          description: >-
            Model id to answer with, as listed by GET /models (e.g.
            anthropic/claude-sonnet-4.5).
        provider:
          allOf:
            - $ref: '#/components/schemas/ProviderPreferences'
            - description: Provider routing preferences for the request.
          description: Provider routing preferences for this request.
        questions:
          additionalProperties:
            description: >-
              A Decisions question using a boolean, choice, ordered score, or
              image bounding-box evaluation.
            discriminator:
              mapping:
                box: '#/components/schemas/DecisionsBoxQuestion'
                choice: '#/components/schemas/DecisionsChoiceQuestion'
                noul: '#/components/schemas/DecisionsNoulQuestion'
                score: '#/components/schemas/DecisionsScoreQuestion'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/DecisionsNoulQuestion'
              - $ref: '#/components/schemas/DecisionsChoiceQuestion'
              - $ref: '#/components/schemas/DecisionsScoreQuestion'
              - $ref: '#/components/schemas/DecisionsBoxQuestion'
          type: object
          description: >-
            The questions to answer about state, by name; each answer comes back
            under the same name.
        session_id:
          description: >-
            A unique identifier for grouping related requests (e.g., a
            conversation or agent workflow). Used for observability grouping in
            Broadcast and private logging; never sent to the provider. If
            provided in both the request body and the x-session-id header, the
            body value takes precedence. Maximum of 256 characters.
          example: session-1234
          maxLength: 256
          type: string
        state:
          anyOf:
            - type: string
            - additionalProperties: {}
              type: object
            - items: {}
              type: array
          description: >-
            The content to evaluate: a plain string, or a JSON object or array
            of related context.
        trace:
          $ref: '#/components/schemas/TraceConfig'
        user:
          maxLength: 256
          type: string
          description: Id of your end user, for abuse tracking.
      required:
        - model
        - state
        - questions
      type: object
    DecisionsResponse:
      properties:
        answers:
          additionalProperties:
            description: >-
              A Decisions answer using a boolean, choice, score, or image
              bounding-box evaluation.
            discriminator:
              mapping:
                box: '#/components/schemas/DecisionsBoxAnswer'
                choice: '#/components/schemas/DecisionsChoiceAnswer'
                noul: '#/components/schemas/DecisionsNoulAnswer'
                score: '#/components/schemas/DecisionsScoreAnswer'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/DecisionsNoulAnswer'
              - $ref: '#/components/schemas/DecisionsChoiceAnswer'
              - $ref: '#/components/schemas/DecisionsScoreAnswer'
              - $ref: '#/components/schemas/DecisionsBoxAnswer'
          type: object
          description: One answer per question, under the question's name.
        id:
          type: string
          description: Id of this decision request.
        model:
          type: string
          description: Model that answered the decision.
        provider:
          type: string
          description: Provider that served the request.
        usage:
          properties:
            cost:
              format: double
              type: number
              description: What the request cost, in US dollars.
            input_tokens:
              type: integer
              description: Input tokens the decision used.
            input_tokens_details:
              $ref: '#/components/schemas/DecisionsUsageInputTokensDetails'
            output_tokens:
              type: integer
              description: Output tokens the decision generated.
          required:
            - input_tokens
            - output_tokens
          type: object
          description: Tokens and cost of the request.
      required:
        - model
        - answers
        - usage
      type: object
    BadRequestResponse:
      description: Bad Request - Invalid request parameters or malformed input
      example:
        error:
          code: 400
          message: Invalid request parameters
      properties:
        error:
          $ref: '#/components/schemas/BadRequestResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    UnauthorizedResponse:
      description: Unauthorized - Authentication required or invalid credentials
      example:
        error:
          code: 401
          message: Missing Authentication header
      properties:
        error:
          $ref: '#/components/schemas/UnauthorizedResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    PaymentRequiredResponse:
      description: Payment Required - Insufficient credits or quota to complete request
      example:
        error:
          code: 402
          message: Insufficient credits. Add more using https://openrouter.ai/credits
      properties:
        error:
          $ref: '#/components/schemas/PaymentRequiredResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    ForbiddenResponse:
      description: Forbidden - Authentication successful but insufficient permissions
      example:
        error:
          code: 403
          message: Only management keys can perform this operation
      properties:
        error:
          $ref: '#/components/schemas/ForbiddenResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    NotFoundResponse:
      description: Not Found - Resource does not exist
      example:
        error:
          code: 404
          message: Resource not found
      properties:
        error:
          $ref: '#/components/schemas/NotFoundResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    PayloadTooLargeResponse:
      description: Payload Too Large - Request payload exceeds size limits
      example:
        error:
          code: 413
          message: Request payload too large
      properties:
        error:
          $ref: '#/components/schemas/PayloadTooLargeResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    TooManyRequestsResponse:
      description: Too Many Requests - Rate limit exceeded
      example:
        error:
          code: 429
          message: Rate limit exceeded
      properties:
        error:
          $ref: '#/components/schemas/TooManyRequestsResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    InternalServerResponse:
      description: Internal Server Error - Unexpected server error
      example:
        error:
          code: 500
          message: Internal Server Error
      properties:
        error:
          $ref: '#/components/schemas/InternalServerResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    BadGatewayResponse:
      description: Bad Gateway - Provider/upstream API failure
      example:
        error:
          code: 502
          message: Provider returned error
      properties:
        error:
          $ref: '#/components/schemas/BadGatewayResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    ServiceUnavailableResponse:
      description: Service Unavailable - Service temporarily unavailable
      example:
        error:
          code: 503
          message: Service temporarily unavailable
      properties:
        error:
          $ref: '#/components/schemas/ServiceUnavailableResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    EdgeNetworkTimeoutResponse:
      description: Infrastructure Timeout - Provider request timed out at edge network
      example:
        error:
          code: 524
          message: Request timed out. Please try again later.
      properties:
        error:
          $ref: '#/components/schemas/EdgeNetworkTimeoutResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    ProviderOverloadedResponse:
      description: Provider Overloaded - Provider is temporarily overloaded
      example:
        error:
          code: 529
          message: Provider returned error
      properties:
        error:
          $ref: '#/components/schemas/ProviderOverloadedResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    DecisionsImageAsset:
      additionalProperties: false
      description: >-
        An image sent once and referenced by its key in the `assets` map.
        `data_base64` is the PNG or JPEG file in standard base64 with no `data:`
        prefix. The multipart `part` field of TypeSafe's API is not accepted.
      properties:
        data_base64:
          minLength: 1
          pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
          type: string
          description: 'The PNG or JPEG file in standard base64, without a data: prefix.'
        format:
          enum:
            - png
            - jpg
            - jpeg
          type: string
          x-speakeasy-unknown-values: allow
          description: One of "png", "jpg", "jpeg".
        type:
          enum:
            - image
          type: string
          description: One of "image".
      required:
        - format
        - data_base64
      type: object
    ProviderPreferences:
      additionalProperties: false
      description: >-
        When multiple model providers are available, optionally indicate your
        routing preference.
      example:
        allow_fallbacks: true
      properties:
        allow_fallbacks:
          description: >
            Whether to allow backup providers to serve requests

            - true: (default) when the primary provider (or your custom
            providers in "order") is unavailable, use the next best provider.

            - false: use only the primary/custom provider, and return the
            upstream error if it's unavailable.
          type:
            - boolean
            - 'null'
        data_collection:
          description: >-
            Data collection setting. If no available model provider meets the
            requirement, your request will return an error.

            - allow: (default) allow providers which store user data
            non-transiently and may train on it


            - deny: use only providers which do not collect user data.
          enum:
            - deny
            - allow
            - null
          example: allow
          type:
            - string
            - 'null'
          x-speakeasy-unknown-values: allow
        enforce_distillable_text:
          description: >-
            Whether to restrict routing to only models that allow text
            distillation. When true, only models where the author has allowed
            distillation will be used.
          example: true
          type:
            - boolean
            - 'null'
        ignore:
          description: >-
            List of provider slugs to ignore. If provided, this list is merged
            with your account-wide ignored provider settings for this request.
          example:
            - openai
            - anthropic
          items:
            anyOf:
              - $ref: '#/components/schemas/ProviderName'
              - type: string
          type:
            - array
            - 'null'
        max_price:
          description: >-
            The object specifying the maximum price you want to pay for this
            request. USD price per million tokens, for prompt and completion.
          properties:
            audio:
              description: Maximum price in USD per audio unit
              type: string
            completion:
              description: Maximum price in USD per million completion tokens
              type: string
            image:
              description: Maximum price in USD per image
              type: string
            prompt:
              description: Maximum price in USD per million prompt tokens
              type: string
            request:
              description: Maximum price in USD per request
              type: string
          type: object
        only:
          description: >-
            List of provider slugs to allow. If provided, this list is merged
            with your account-wide allowed provider settings for this request.
          example:
            - openai
            - anthropic
          items:
            anyOf:
              - $ref: '#/components/schemas/ProviderName'
              - type: string
          type:
            - array
            - 'null'
        options:
          $ref: '#/components/schemas/ProviderOptions'
        order:
          description: >-
            An ordered list of provider slugs. The router will attempt to use
            the first provider in the subset of this list that supports your
            requested model, and fall back to the next if it is unavailable. If
            no providers are available, the request will fail with an error
            message.
          example:
            - openai
            - anthropic
          items:
            anyOf:
              - $ref: '#/components/schemas/ProviderName'
              - type: string
          type:
            - array
            - 'null'
        preferred_max_latency:
          $ref: '#/components/schemas/PreferredMaxLatency'
        preferred_min_throughput:
          $ref: '#/components/schemas/PreferredMinThroughput'
        quantizations:
          description: A list of quantization levels to filter the provider by.
          items:
            $ref: '#/components/schemas/Quantization'
          type:
            - array
            - 'null'
        require_parameters:
          description: >-
            Whether to filter providers to only those that support the
            parameters you've provided. If this setting is omitted or set to
            false, then providers will receive only the parameters they support,
            and ignore the rest.
          type:
            - boolean
            - 'null'
        sort:
          anyOf:
            - $ref: '#/components/schemas/ProviderSort'
            - $ref: '#/components/schemas/ProviderSortConfig'
            - type: 'null'
          description: >-
            The sorting strategy to use for this request, if "order" is not
            specified. When set, no load balancing is performed.
          example: price
        zdr:
          description: >-
            Whether to restrict routing to only ZDR (Zero Data Retention)
            endpoints. When true, only endpoints that do not retain prompts will
            be used.
          example: true
          type:
            - boolean
            - 'null'
      type:
        - object
        - 'null'
    DecisionsBoxQuestion:
      description: >-
        Finds one target in an image in `state` and answers with one bounding
        box (`top`, `bottom`, `left`, `right` as fractions of the image). Served
        by TypeSafe Jev endpoints only; every other provider rejects a box
        question with `400` before anything is sent upstream.
      properties:
        instructions:
          anyOf:
            - type: string
            - additionalProperties: {}
              type: object
            - items: {}
              type: array
          description: >-
            A description of the target to find, naming the image in `state` it
            is in; not a command, and no `criteria`.
        type:
          enum:
            - box
          type: string
          description: One of "box".
      required:
        - type
        - instructions
      type: object
    DecisionsChoiceQuestion:
      properties:
        criteria:
          additionalProperties:
            anyOf:
              - type: string
              - additionalProperties: {}
                type: object
              - items: {}
                type: array
              - type: 'null'
            description: A plain string, or a JSON object or array of structured guidance.
          type: object
          description: >-
            The options to choose from: each key is an option and its value says
            when to pick it.
        instructions:
          anyOf:
            - type: string
            - additionalProperties: {}
              type: object
            - items: {}
              type: array
          description: A plain string, or a JSON object or array of structured guidance.
        type:
          enum:
            - choice
          type: string
          description: One of "choice".
      required:
        - type
        - instructions
        - criteria
      type: object
    DecisionsNoulQuestion:
      properties:
        criteria:
          properties:
            'false':
              anyOf:
                - type: string
                - additionalProperties: {}
                  type: object
                - items: {}
                  type: array
              description: >-
                A plain string, or a JSON object or array of structured
                guidance.
            'true':
              anyOf:
                - type: string
                - additionalProperties: {}
                  type: object
                - items: {}
                  type: array
              description: >-
                A plain string, or a JSON object or array of structured
                guidance.
          required:
            - 'true'
            - 'false'
          type: object
          description: What true and what false mean for this question.
        instructions:
          anyOf:
            - type: string
            - additionalProperties: {}
              type: object
            - items: {}
              type: array
          description: A plain string, or a JSON object or array of structured guidance.
        type:
          enum:
            - noul
          type: string
          description: One of "noul".
      required:
        - type
        - instructions
      type: object
    DecisionsScoreQuestion:
      properties:
        criteria:
          items:
            anyOf:
              - type: string
              - additionalProperties: {}
                type: object
              - items: {}
                type: array
            description: A plain string, or a JSON object or array of structured guidance.
          minItems: 1
          type: array
          description: The ordered levels to score against, lowest first.
        instructions:
          anyOf:
            - type: string
            - additionalProperties: {}
              type: object
            - items: {}
              type: array
          description: A plain string, or a JSON object or array of structured guidance.
        type:
          enum:
            - score
          type: string
          description: One of "score".
      required:
        - type
        - instructions
        - criteria
      type: object
    TraceConfig:
      additionalProperties: {}
      description: >-
        Metadata for observability and tracing. Known keys (trace_id,
        trace_name, span_name, generation_name, parent_span_id) have special
        handling. Additional keys are passed through as custom metadata to
        configured broadcast destinations.
      example:
        trace_id: trace-abc123
        trace_name: my-app-trace
      properties:
        generation_name:
          type: string
          description: Name of this generation in your traces.
        parent_span_id:
          type: string
          description: Span this generation nests under in your traces.
        span_name:
          type: string
          description: Name of this span in your traces.
        trace_id:
          type: string
          description: Id of the trace this request belongs to.
        trace_name:
          type: string
          description: Name of the trace in your traces.
      type: object
    DecisionsBoxAnswer:
      properties:
        box:
          properties:
            bottom:
              format: double
              type: number
              description: Bottom edge of the box.
            left:
              format: double
              type: number
              description: Left edge of the box.
            right:
              format: double
              type: number
              description: Right edge of the box.
            top:
              format: double
              type: number
              description: Top edge of the box.
          required:
            - top
            - bottom
            - left
            - right
          type: object
          description: >-
            The bounding box found in the image, as fractions of its width and
            height.
        confidence:
          format: double
          type: number
          description: How sure the model is of the box, from 0 to 1.
        type:
          enum:
            - box
          type: string
          description: One of "box".
      required:
        - type
        - box
      type: object
    DecisionsChoiceAnswer:
      properties:
        choice:
          type: string
          description: The key of the chosen option, one of the question's criteria keys.
        confidence:
          format: double
          type: number
          description: The probability of the chosen option, from 0 to 1.
        probabilities:
          additionalProperties:
            format: double
            type: number
          type: object
          description: Probability of each option, by criteria key; they sum to 1.
        type:
          enum:
            - choice
          type: string
          description: One of "choice".
      required:
        - type
        - choice
      type: object
    DecisionsNoulAnswer:
      properties:
        noul:
          format: double
          type: number
          description: Probability, from 0 to 1, that the question's true criterion holds.
        type:
          enum:
            - noul
          type: string
          description: One of "noul".
      required:
        - type
        - noul
      type: object
    DecisionsScoreAnswer:
      properties:
        confidence:
          format: double
          type: number
          description: How sure the model is of the score, from 0 to 1.
        legend:
          additionalProperties:
            anyOf:
              - type: string
              - additionalProperties: {}
                type: object
              - items: {}
                type: array
            description: A plain string, or a JSON object or array of structured guidance.
          type: object
          description: >-
            The question's criteria by index, so each probability key can be
            read.
        probabilities:
          additionalProperties:
            format: double
            type: number
          type: object
          description: >-
            Probability of each criteria position, by its index as a string;
            they sum to 1.
        score:
          format: double
          type: number
          description: >-
            The expected position on the question's ordered criteria, from 0
            (first) to the last index.
        type:
          enum:
            - score
          type: string
          description: One of "score".
      required:
        - type
        - score
      type: object
    DecisionsUsageInputTokensDetails:
      description: Of `input_tokens`, those the provider served from its prompt cache.
      properties:
        cached_tokens:
          type: integer
          description: Input tokens served from the prompt cache.
      required:
        - cached_tokens
      type: object
    BadRequestResponseErrorData:
      description: Error data for BadRequestResponse
      example:
        code: 400
        message: Invalid request parameters
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 400.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    UnauthorizedResponseErrorData:
      description: Error data for UnauthorizedResponse
      example:
        code: 401
        message: Missing Authentication header
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 401.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    PaymentRequiredResponseErrorData:
      description: Error data for PaymentRequiredResponse
      example:
        code: 402
        message: Insufficient credits. Add more using https://openrouter.ai/credits
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 402.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    ForbiddenResponseErrorData:
      description: Error data for ForbiddenResponse
      example:
        code: 403
        message: Only management keys can perform this operation
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 403.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    NotFoundResponseErrorData:
      description: Error data for NotFoundResponse
      example:
        code: 404
        message: Resource not found
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 404.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    PayloadTooLargeResponseErrorData:
      description: Error data for PayloadTooLargeResponse
      example:
        code: 413
        message: Request payload too large
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 413.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    TooManyRequestsResponseErrorData:
      description: Error data for TooManyRequestsResponse
      example:
        code: 429
        message: Rate limit exceeded
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 429.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    InternalServerResponseErrorData:
      description: Error data for InternalServerResponse
      example:
        code: 500
        message: Internal Server Error
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 500.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    BadGatewayResponseErrorData:
      description: Error data for BadGatewayResponse
      example:
        code: 502
        message: Provider returned error
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 502.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    ServiceUnavailableResponseErrorData:
      description: Error data for ServiceUnavailableResponse
      example:
        code: 503
        message: Service temporarily unavailable
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 503.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    EdgeNetworkTimeoutResponseErrorData:
      description: Error data for EdgeNetworkTimeoutResponse
      example:
        code: 524
        message: Request timed out. Please try again later.
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 524.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    ProviderOverloadedResponseErrorData:
      description: Error data for ProviderOverloadedResponse
      example:
        code: 529
        message: Provider returned error
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 529.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    ProviderName:
      enum:
        - Modal
        - AkashML
        - AI21
        - AionLabs
        - Alibaba
        - Ambient
        - Ant Digital
        - Baidu
        - Amazon Bedrock
        - Amazon Nova
        - Anthropic
        - Arcee AI
        - AssemblyAI
        - AtlasCloud
        - Avian
        - Azure
        - BaseTen
        - BytePlus
        - Black Forest Labs
        - Cerebras
        - Chutes
        - Cirrascale
        - Claude Platform on AWS
        - Clarifai
        - Cloudflare
        - Cohere
        - CoreWeave
        - Cosine
        - Crucible
        - Crusoe
        - Darkbloom
        - Databricks
        - Decart
        - Deepgram
        - DeepInfra
        - DeepSeek
        - DekaLLM
        - DigitalOcean
        - ElevenLabs
        - Featherless
        - Fireworks
        - Fish Audio
        - Friendli
        - GMICloud
        - Google
        - Google AI Studio
        - Groq
        - HeyGen
        - Inception
        - Inceptron
        - InferenceNet
        - Ionstream
        - Infermatic
        - Io Net
        - Inferact vLLM
        - Inflection
        - KT
        - Liquid
        - Makora
        - Mara
        - Mancer 2
        - Meta
        - Minimax
        - ModelRun
        - Mistral
        - Modular
        - Moonshot AI
        - Morph
        - VoyageAI by MongoDB
        - TypeSafe
        - Near AI
        - Nebius
        - Nex AGI
        - NextBit
        - Novita
        - Nvidia
        - Ollama
        - OpenAI
        - OpenInference
        - Parallel
        - Parasail
        - ParetoAlpha
        - Particle AI
        - Pearl Research
        - Poolside
        - PrimaLabs
        - PrimeIntellect
        - Perceptron
        - Perplexity
        - Phala
        - Recraft
        - Recursive
        - Reka
        - Relace
        - Respan
        - Sail Research
        - Sakana AI
        - SambaNova
        - ScaleDown
        - Seed
        - SiliconFlow
        - Sourceful
        - StepFun
        - Stealth
        - StreamLake
        - Switchpoint
        - Tencent
        - Tenstorrent
        - Thinking Machines
        - Together
        - Unbiased
        - Upstage
        - Venice
        - Wafer
        - WandB
        - Quiver
        - Krea
        - Runway
        - Xiaomi
        - xAI
        - Z.AI
        - FakeProvider
      example: OpenAI
      type: string
      x-speakeasy-unknown-values: allow
      description: >-
        The display name of the provider serving the endpoint, such as "OpenAI",
        "Anthropic", "Google Vertex" or "Azure". New providers appear over time,
        so accept names not listed here.
    ProviderOptions:
      description: >-
        Provider-specific options keyed by provider slug. The provider segment
        is case-insensitive; an endpoint tag after `/` must match the endpoint
        slug exactly. Only options for the matched provider are forwarded; the
        rest are ignored. Unrecognized keys are silently dropped.
      example:
        openai:
          max_tokens: 1000
      properties:
        01ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the 01ai provider.
        ai21:
          additionalProperties: {}
          type: object
          description: Options sent only to the ai21 provider.
        aion-labs:
          additionalProperties: {}
          type: object
          description: Options sent only to the aion-labs provider.
        akashml:
          additionalProperties: {}
          type: object
          description: Options sent only to the akashml provider.
        alibaba:
          additionalProperties: {}
          type: object
          description: Options sent only to the alibaba provider.
        amazon-bedrock:
          additionalProperties: {}
          type: object
          description: Options sent only to the amazon-bedrock provider.
        amazon-bedrock/claude-on-aws:
          additionalProperties: {}
          type: object
          description: Options sent only to the amazon-bedrock/claude-on-aws provider.
        amazon-nova:
          additionalProperties: {}
          type: object
          description: Options sent only to the amazon-nova provider.
        ambient:
          additionalProperties: {}
          type: object
          description: Options sent only to the ambient provider.
        antdigital:
          additionalProperties: {}
          type: object
          description: Options sent only to the antdigital provider.
        anthropic:
          additionalProperties: {}
          type: object
          description: Options sent only to the anthropic provider.
        anthropic/2:
          additionalProperties: {}
          type: object
          description: Options sent only to the anthropic/2 provider.
        anyscale:
          additionalProperties: {}
          type: object
          description: Options sent only to the anyscale provider.
        arcee-ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the arcee-ai provider.
        assemblyai:
          additionalProperties: {}
          type: object
          description: Options sent only to the assemblyai provider.
        atlas-cloud:
          additionalProperties: {}
          type: object
          description: Options sent only to the atlas-cloud provider.
        atoma:
          additionalProperties: {}
          type: object
          description: Options sent only to the atoma provider.
        avian:
          additionalProperties: {}
          type: object
          description: Options sent only to the avian provider.
        azure:
          additionalProperties: {}
          type: object
          description: Options sent only to the azure provider.
        baidu:
          additionalProperties: {}
          type: object
          description: Options sent only to the baidu provider.
        baseten:
          additionalProperties: {}
          type: object
          description: Options sent only to the baseten provider.
        black-forest-labs:
          additionalProperties: {}
          type: object
          description: Options sent only to the black-forest-labs provider.
        byteplus:
          additionalProperties: {}
          type: object
          description: Options sent only to the byteplus provider.
        centml:
          additionalProperties: {}
          type: object
          description: Options sent only to the centml provider.
        cerebras:
          additionalProperties: {}
          type: object
          description: Options sent only to the cerebras provider.
        chutes:
          additionalProperties: {}
          type: object
          description: Options sent only to the chutes provider.
        cirrascale:
          additionalProperties: {}
          type: object
          description: Options sent only to the cirrascale provider.
        clarifai:
          additionalProperties: {}
          type: object
          description: Options sent only to the clarifai provider.
        claude-on-aws:
          additionalProperties: {}
          type: object
          description: Options sent only to the claude-on-aws provider.
        cloudflare:
          additionalProperties: {}
          type: object
          description: Options sent only to the cloudflare provider.
        cohere:
          additionalProperties: {}
          type: object
          description: Options sent only to the cohere provider.
        coreweave:
          additionalProperties: {}
          type: object
          description: Options sent only to the coreweave provider.
        cosine:
          additionalProperties: {}
          type: object
          description: Options sent only to the cosine provider.
        crofai:
          additionalProperties: {}
          type: object
          description: Options sent only to the crofai provider.
        crucible:
          additionalProperties: {}
          type: object
          description: Options sent only to the crucible provider.
        crusoe:
          additionalProperties: {}
          type: object
          description: Options sent only to the crusoe provider.
        darkbloom:
          additionalProperties: {}
          type: object
          description: Options sent only to the darkbloom provider.
        databricks:
          additionalProperties: {}
          type: object
          description: Options sent only to the databricks provider.
        decart:
          additionalProperties: {}
          type: object
          description: Options sent only to the decart provider.
        deepgram:
          additionalProperties: {}
          type: object
          description: Options sent only to the deepgram provider.
        deepinfra:
          additionalProperties: {}
          type: object
          description: Options sent only to the deepinfra provider.
        deepseek:
          additionalProperties: {}
          type: object
          description: Options sent only to the deepseek provider.
        dekallm:
          additionalProperties: {}
          type: object
          description: Options sent only to the dekallm provider.
        digitalocean:
          additionalProperties: {}
          type: object
          description: Options sent only to the digitalocean provider.
        elevenlabs:
          additionalProperties: {}
          type: object
          description: Options sent only to the elevenlabs provider.
        enfer:
          additionalProperties: {}
          type: object
          description: Options sent only to the enfer provider.
        fake-provider:
          additionalProperties: {}
          type: object
          description: Options sent only to the fake-provider provider.
        featherless:
          additionalProperties: {}
          type: object
          description: Options sent only to the featherless provider.
        fireworks:
          additionalProperties: {}
          type: object
          description: Options sent only to the fireworks provider.
        fish-audio:
          additionalProperties: {}
          type: object
          description: Options sent only to the fish-audio provider.
        friendli:
          additionalProperties: {}
          type: object
          description: Options sent only to the friendli provider.
        gmicloud:
          additionalProperties: {}
          type: object
          description: Options sent only to the gmicloud provider.
        google-ai-studio:
          additionalProperties: {}
          type: object
          description: Options sent only to the google-ai-studio provider.
        google-vertex:
          additionalProperties: {}
          type: object
          description: Options sent only to the google-vertex provider.
        gopomelo:
          additionalProperties: {}
          type: object
          description: Options sent only to the gopomelo provider.
        groq:
          additionalProperties: {}
          type: object
          description: Options sent only to the groq provider.
        heygen:
          additionalProperties: {}
          type: object
          description: Options sent only to the heygen provider.
        huggingface:
          additionalProperties: {}
          type: object
          description: Options sent only to the huggingface provider.
        hyperbolic:
          additionalProperties: {}
          type: object
          description: Options sent only to the hyperbolic provider.
        hyperbolic-quantized:
          additionalProperties: {}
          type: object
          description: Options sent only to the hyperbolic-quantized provider.
        inception:
          additionalProperties: {}
          type: object
          description: Options sent only to the inception provider.
        inceptron:
          additionalProperties: {}
          type: object
          description: Options sent only to the inceptron provider.
        inferact-vllm:
          additionalProperties: {}
          type: object
          description: Options sent only to the inferact-vllm provider.
        inference-net:
          additionalProperties: {}
          type: object
          description: Options sent only to the inference-net provider.
        infermatic:
          additionalProperties: {}
          type: object
          description: Options sent only to the infermatic provider.
        inflection:
          additionalProperties: {}
          type: object
          description: Options sent only to the inflection provider.
        inocloud:
          additionalProperties: {}
          type: object
          description: Options sent only to the inocloud provider.
        io-net:
          additionalProperties: {}
          type: object
          description: Options sent only to the io-net provider.
        ionstream:
          additionalProperties: {}
          type: object
          description: Options sent only to the ionstream provider.
        klusterai:
          additionalProperties: {}
          type: object
          description: Options sent only to the klusterai provider.
        krea:
          additionalProperties: {}
          type: object
          description: Options sent only to the krea provider.
        kt:
          additionalProperties: {}
          type: object
          description: Options sent only to the kt provider.
        lambda:
          additionalProperties: {}
          type: object
          description: Options sent only to the lambda provider.
        lepton:
          additionalProperties: {}
          type: object
          description: Options sent only to the lepton provider.
        liquid:
          additionalProperties: {}
          type: object
          description: Options sent only to the liquid provider.
        lynn:
          additionalProperties: {}
          type: object
          description: Options sent only to the lynn provider.
        lynn-private:
          additionalProperties: {}
          type: object
          description: Options sent only to the lynn-private provider.
        makora:
          additionalProperties: {}
          type: object
          description: Options sent only to the makora provider.
        mancer:
          additionalProperties: {}
          type: object
          description: Options sent only to the mancer provider.
        mancer-old:
          additionalProperties: {}
          type: object
          description: Options sent only to the mancer-old provider.
        mara:
          additionalProperties: {}
          type: object
          description: Options sent only to the mara provider.
        meta:
          additionalProperties: {}
          type: object
          description: Options sent only to the meta provider.
        minimax:
          additionalProperties: {}
          type: object
          description: Options sent only to the minimax provider.
        mistral:
          additionalProperties: {}
          type: object
          description: Options sent only to the mistral provider.
        modal:
          additionalProperties: {}
          type: object
          description: Options sent only to the modal provider.
        modelrun:
          additionalProperties: {}
          type: object
          description: Options sent only to the modelrun provider.
        modular:
          additionalProperties: {}
          type: object
          description: Options sent only to the modular provider.
        moonshotai:
          additionalProperties: {}
          type: object
          description: Options sent only to the moonshotai provider.
        morph:
          additionalProperties: {}
          type: object
          description: Options sent only to the morph provider.
        ncompass:
          additionalProperties: {}
          type: object
          description: Options sent only to the ncompass provider.
        near-ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the near-ai provider.
        nebius:
          additionalProperties: {}
          type: object
          description: Options sent only to the nebius provider.
        nex-agi:
          additionalProperties: {}
          type: object
          description: Options sent only to the nex-agi provider.
        nextbit:
          additionalProperties: {}
          type: object
          description: Options sent only to the nextbit provider.
        nineteen:
          additionalProperties: {}
          type: object
          description: Options sent only to the nineteen provider.
        novita:
          additionalProperties: {}
          type: object
          description: Options sent only to the novita provider.
        nvidia:
          additionalProperties: {}
          type: object
          description: Options sent only to the nvidia provider.
        octoai:
          additionalProperties: {}
          type: object
          description: Options sent only to the octoai provider.
        ollama:
          additionalProperties: {}
          type: object
          description: Options sent only to the ollama provider.
        open-inference:
          additionalProperties: {}
          type: object
          description: Options sent only to the open-inference provider.
        openai:
          additionalProperties: {}
          type: object
          description: Options sent only to the openai provider.
        parallel:
          additionalProperties: {}
          type: object
          description: Options sent only to the parallel provider.
        parasail:
          additionalProperties: {}
          type: object
          description: Options sent only to the parasail provider.
        pareto-alpha:
          additionalProperties: {}
          type: object
          description: Options sent only to the pareto-alpha provider.
        particle-ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the particle-ai provider.
        pearl-research:
          additionalProperties: {}
          type: object
          description: Options sent only to the pearl-research provider.
        perceptron:
          additionalProperties: {}
          type: object
          description: Options sent only to the perceptron provider.
        perplexity:
          additionalProperties: {}
          type: object
          description: Options sent only to the perplexity provider.
        phala:
          additionalProperties: {}
          type: object
          description: Options sent only to the phala provider.
        poolside:
          additionalProperties: {}
          type: object
          description: Options sent only to the poolside provider.
        primalabs:
          additionalProperties: {}
          type: object
          description: Options sent only to the primalabs provider.
        primeintellect:
          additionalProperties: {}
          type: object
          description: Options sent only to the primeintellect provider.
        quiver:
          additionalProperties: {}
          type: object
          description: Options sent only to the quiver provider.
        recraft:
          additionalProperties: {}
          type: object
          description: Options sent only to the recraft provider.
        recursal:
          additionalProperties: {}
          type: object
          description: Options sent only to the recursal provider.
        recursive:
          additionalProperties: {}
          type: object
          description: Options sent only to the recursive provider.
        reflection:
          additionalProperties: {}
          type: object
          description: Options sent only to the reflection provider.
        reka:
          additionalProperties: {}
          type: object
          description: Options sent only to the reka provider.
        relace:
          additionalProperties: {}
          type: object
          description: Options sent only to the relace provider.
        replicate:
          additionalProperties: {}
          type: object
          description: Options sent only to the replicate provider.
        respan:
          additionalProperties: {}
          type: object
          description: Options sent only to the respan provider.
        runway:
          additionalProperties: {}
          type: object
          description: Options sent only to the runway provider.
        sail-research:
          additionalProperties: {}
          type: object
          description: Options sent only to the sail-research provider.
        sakana:
          additionalProperties: {}
          type: object
          description: Options sent only to the sakana provider.
        sakana-ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the sakana-ai provider.
        sambanova:
          additionalProperties: {}
          type: object
          description: Options sent only to the sambanova provider.
        sambanova-cloaked:
          additionalProperties: {}
          type: object
          description: Options sent only to the sambanova-cloaked provider.
        scaledown:
          additionalProperties: {}
          type: object
          description: Options sent only to the scaledown provider.
        seed:
          additionalProperties: {}
          type: object
          description: Options sent only to the seed provider.
        sf-compute:
          additionalProperties: {}
          type: object
          description: Options sent only to the sf-compute provider.
        siliconflow:
          additionalProperties: {}
          type: object
          description: Options sent only to the siliconflow provider.
        sourceful:
          additionalProperties: {}
          type: object
          description: Options sent only to the sourceful provider.
        stealth:
          additionalProperties: {}
          type: object
          description: Options sent only to the stealth provider.
        stepfun:
          additionalProperties: {}
          type: object
          description: Options sent only to the stepfun provider.
        streamlake:
          additionalProperties: {}
          type: object
          description: Options sent only to the streamlake provider.
        switchpoint:
          additionalProperties: {}
          type: object
          description: Options sent only to the switchpoint provider.
        targon:
          additionalProperties: {}
          type: object
          description: Options sent only to the targon provider.
        tencent:
          additionalProperties: {}
          type: object
          description: Options sent only to the tencent provider.
        tenstorrent:
          additionalProperties: {}
          type: object
          description: Options sent only to the tenstorrent provider.
        thinkingmachines:
          additionalProperties: {}
          type: object
          description: Options sent only to the thinkingmachines provider.
        together:
          additionalProperties: {}
          type: object
          description: Options sent only to the together provider.
        together-lite:
          additionalProperties: {}
          type: object
          description: Options sent only to the together-lite provider.
        typesafe:
          additionalProperties: {}
          type: object
          description: Options sent only to the typesafe provider.
        ubicloud:
          additionalProperties: {}
          type: object
          description: Options sent only to the ubicloud provider.
        unbiased:
          additionalProperties: {}
          type: object
          description: Options sent only to the unbiased provider.
        upstage:
          additionalProperties: {}
          type: object
          description: Options sent only to the upstage provider.
        venice:
          additionalProperties: {}
          type: object
          description: Options sent only to the venice provider.
        voyageai:
          additionalProperties: {}
          type: object
          description: Options sent only to the voyageai provider.
        wafer:
          additionalProperties: {}
          type: object
          description: Options sent only to the wafer provider.
        wandb:
          additionalProperties: {}
          type: object
          description: Options sent only to the wandb provider.
        wandb-legacy:
          additionalProperties: {}
          type: object
          description: Options sent only to the wandb-legacy provider.
        xai:
          additionalProperties: {}
          type: object
          description: Options sent only to the xai provider.
        xiaomi:
          additionalProperties: {}
          type: object
          description: Options sent only to the xiaomi provider.
        z-ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the z-ai provider.
      type: object
    PreferredMaxLatency:
      anyOf:
        - format: double
          type: number
        - $ref: '#/components/schemas/PercentileLatencyCutoffs'
        - type: 'null'
      description: >-
        Preferred maximum latency (in seconds). Can be a number (applies to p50)
        or an object with percentile-specific cutoffs. Endpoints above the
        threshold(s) may still be used, but are deprioritized in routing. When
        using fallback models, this may cause a fallback model to be used
        instead of the primary model if it meets the threshold.
      example: 5
    PreferredMinThroughput:
      anyOf:
        - format: double
          type: number
        - $ref: '#/components/schemas/PercentileThroughputCutoffs'
        - type: 'null'
      description: >-
        Preferred minimum throughput (in tokens per second). Can be a number
        (applies to p50) or an object with percentile-specific cutoffs.
        Endpoints below the threshold(s) may still be used, but are
        deprioritized in routing. When using fallback models, this may cause a
        fallback model to be used instead of the primary model if it meets the
        threshold.
      example: 100
    Quantization:
      enum:
        - int4
        - int8
        - fp4
        - mxfp4
        - nvfp4
        - fp6
        - fp8
        - mxfp8
        - fp16
        - bf16
        - fp32
        - unknown
      example: fp16
      type: string
      x-speakeasy-unknown-values: allow
    ProviderSort:
      description: The provider sorting strategy (price, throughput, latency)
      enum:
        - price
        - throughput
        - latency
        - exacto
      example: price
      type: string
      x-speakeasy-unknown-values: allow
    ProviderSortConfig:
      description: The provider sorting strategy (price, throughput, latency)
      example:
        by: price
        partition: model
      properties:
        by:
          description: The provider sorting strategy (price, throughput, latency)
          enum:
            - price
            - throughput
            - latency
            - exacto
            - null
          example: price
          type:
            - string
            - 'null'
          x-speakeasy-unknown-values: allow
        partition:
          description: >-
            Partitioning strategy for sorting: "model" (default) groups
            endpoints by model before sorting (fallback models remain
            fallbacks), "none" sorts all endpoints together regardless of model.
          enum:
            - model
            - none
            - null
          example: model
          type:
            - string
            - 'null'
          x-speakeasy-unknown-values: allow
      type: object
    PercentileLatencyCutoffs:
      description: >-
        Percentile-based latency cutoffs. All specified cutoffs must be met for
        an endpoint to be preferred.
      example:
        p50: 5
        p90: 10
      properties:
        p50:
          description: Maximum p50 latency (seconds)
          format: double
          type:
            - number
            - 'null'
        p75:
          description: Maximum p75 latency (seconds)
          format: double
          type:
            - number
            - 'null'
        p90:
          description: Maximum p90 latency (seconds)
          format: double
          type:
            - number
            - 'null'
        p99:
          description: Maximum p99 latency (seconds)
          format: double
          type:
            - number
            - 'null'
      type: object
    PercentileThroughputCutoffs:
      description: >-
        Percentile-based throughput cutoffs. All specified cutoffs must be met
        for an endpoint to be preferred.
      example:
        p50: 100
        p90: 50
      properties:
        p50:
          description: Minimum p50 throughput (tokens/sec)
          format: double
          type:
            - number
            - 'null'
        p75:
          description: Minimum p75 throughput (tokens/sec)
          format: double
          type:
            - number
            - 'null'
        p90:
          description: Minimum p90 throughput (tokens/sec)
          format: double
          type:
            - number
            - 'null'
        p99:
          description: Minimum p99 throughput (tokens/sec)
          format: double
          type:
            - number
            - 'null'
      type: object
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A Nemonist key (sk-nm-...) as a bearer token in the Authorization
        header.

````

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