River AI, Inc. API

openapi: 3.1.0
info:
  title: River AI, Inc. API
  version: '2026-10-18'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-18: 5 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; River AI, Inc. has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 3
    pages-with-code: 2
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-18'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.river.ai/guides/inference.md
  - https://docs.river.ai/guides/inference
  - https://docs.river.ai/guides/inference-images
  - https://docs.river.ai/guides/inference-tools
  - https://docs.river.ai/guides/inference-images.md
  - https://docs.river.ai/guides/inference-tools.md
servers:
- url: https://api.river.ai
paths:
  /v1:
    get:
      operationId: get_v1
      tags:
      - Api
      summary: GET /v1
      x-source: https://docs.river.ai/guides/inference
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl \n Inference Copy page \n Inference quickstart \n Use your River API key with https://api.river.ai/v1 and the OpenAI SDK\
          \ or HTTP. \n Endpoints \n Endpoint Use POST /v1/chat/completions Chat, images, tools, and streaming POST /v1/responses Responses API\
          \ GET /v1/models List model IDs available through the API \n Connect \n Create an API key in the River Console .\nSee Models and pricing\
          \ for available m"
  /v1/chat/completions:
    get:
      operationId: get_v1_chat_completions
      tags:
      - Chat
      summary: GET /v1/chat/completions
      x-source: https://docs.river.ai/guides/inference.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --fail-with-body https://api.river.ai/v1/chat/completions  -H \"Authorization: Bearer $RIVER_API_KEY\"  -H \"Content-Type:\
          \ application/json\"  -d @- <<'JSON'\n  {\n    \"model\": \"deepseek-ai/DeepSeek-V4.1-Flash\",\n    \"messages\": [{\"role\": \"user\"\
          , \"content\": \"Say hello in one short sentence.\"}],\n    \"max_tokens\": 1024\n  }\nJSON\n```"
    post:
      operationId: post_v1_chat_completions
      tags:
      - Chat
      summary: Inference quickstart
      x-source: https://docs.river.ai/guides/inference.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ChatCompletionsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1ChatCompletionsResponse'
      x-evidence:
        kind: documentation
  /v1/models:
    get:
      operationId: get_v1_models
      tags:
      - Models
      summary: Inference quickstart
      x-source: https://docs.river.ai/guides/inference.md
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1ModelsResponse'
      x-evidence:
        kind: documentation
  /v1/responses:
    post:
      operationId: post_v1_responses
      tags:
      - Responses
      summary: Inference quickstart
      x-source: https://docs.river.ai/guides/inference.md
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostV1ChatCompletionsRequest:
      type: object
      properties:
        model:
          type: string
          description: The model ID to use.
        messages:
          type: array
          description: Conversation history.
        max_tokens:
          type: integer
          description: Maximum number of tokens to generate.
        stream:
          type: boolean
          description: If true, stream the response.
      required:
      - model
      - messages
    PostV1ChatCompletionsResponse:
      type: object
      properties:
        choices[0].message.content:
          type: string
          description: The generated answer.
        usage:
          type: object
          description: Token usage counts.
    GetV1ModelsResponse:
      type: object
      properties:
        data:
          type: array
          description: List of model IDs available through the API.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Chat
- name: Models
- name: Responses