Anthropic Complete API

openapi: 3.2.0
info:
  title: Anthropic Complete API
servers:
- url: https://api.anthropic.com
tags:
- name: Complete
paths:
  /v1/complete:
    post:
      summary: Create a Text Completion
      description: '[Legacy] Create a Text Completion.


        The Text Completions API is a legacy API. We recommend using the Messages API going forward.


        Future models and features will not be compatible with Text Completions. See our migration guide for guidance in migrating from Text Completions to Messages.'
      operationId: complete_post
      parameters:
      - name: anthropic-version
        in: header
        required: false
        schema:
          type: string
          description: 'The version of the Claude API you want to use.


            Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
          title: Anthropic-Version
        description: 'The version of the Claude API you want to use.


          Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).'
      - name: anthropic-beta
        in: header
        required: false
        schema:
          type: string
          items:
            type: string
          description: 'Optional header to specify the beta version(s) you want to use.


            To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.'
          title: Anthropic-Beta
          x-stainless-override-schema:
            x-stainless-param: betas
            x-stainless-extend-default: true
            type: array
            description: Optional header to specify the beta version(s) you want to use.
            items:
              $ref: '#/components/schemas/AnthropicBeta'
        description: 'Optional header to specify the beta version(s) you want to use.


          To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.'
      responses:
        '200':
          description: Text Completion object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompletionResponse'
        4XX:
          description: 'Error response.


            See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompletionRequest'
        required: true
      tags:
      - Complete
components:
  schemas:
    AuthenticationError:
      properties:
        message:
          default: Authentication error
          title: Message
          type: string
        type:
          const: authentication_error
          default: authentication_error
          title: Type
          type: string
      required:
      - message
      - type
      title: AuthenticationError
      type: object
    Metadata:
      additionalProperties: false
      properties:
        user_id:
          anyOf:
          - maxLength: 512
            type: string
          - type: 'null'
          description: 'An external identifier for the user who is associated with the request.


            This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number.'
          examples:
          - 13803d75-b4b5-4c3e-b2a2-6f21399b021b
          title: User Id
      title: Metadata
      type: object
    BillingError:
      properties:
        message:
          default: Billing error
          title: Message
          type: string
        type:
          const: billing_error
          default: billing_error
          title: Type
          type: string
      required:
      - message
      - type
      title: BillingError
      type: object
    GatewayTimeoutError:
      properties:
        message:
          default: Request timeout
          title: Message
          type: string
        type:
          const: timeout_error
          default: timeout_error
          title: Type
          type: string
      required:
      - message
      - type
      title: GatewayTimeoutError
      type: object
    AnthropicBeta:
      anyOf:
      - type: string
      - type: string
        enum:
        - message-batches-2024-09-24
        - prompt-caching-2024-07-31
        - computer-use-2024-10-22
        - computer-use-2025-01-24
        - pdfs-2024-09-25
        - token-counting-2024-11-01
        - token-efficient-tools-2025-02-19
        - output-128k-2025-02-19
        - files-api-2025-04-14
        - mcp-client-2025-04-04
        - mcp-client-2025-11-20
        - dev-full-thinking-2025-05-14
        - interleaved-thinking-2025-05-14
        - code-execution-2025-05-22
        - extended-cache-ttl-2025-04-11
        - context-1m-2025-08-07
        - context-management-2025-06-27
        - model-context-window-exceeded-2025-08-26
        - skills-2025-10-02
        - fast-mode-2026-02-01
        - output-300k-2026-03-24
        - user-profiles-2026-03-24
        - user-profiles-2026-08-18
        - advisor-tool-2026-03-01
        - managed-agents-2026-04-01
        - cache-diagnosis-2026-04-07
        - dreaming-2026-04-21
        - thinking-token-count-2026-05-13
        - server-side-fallback-2026-06-01
        - server-side-fallback-2026-07-01
        - fallback-credit-2026-06-01
        - fallback-credit-2026-07-01
        - agent-memory-2026-07-22
        - mid-conversation-tool-changes-2026-07-01
        - compact-2026-01-12
        - computer-use-2025-11-24
        - mcp-tunnels-2026-06-22
        - structured-outputs-2025-11-13
        - task-budgets-2026-03-13
        - thinking-display-updates-2026-08-18
        - ce-user-management-2026-07-13
        x-stainless-nominal: false
    ErrorResponse:
      properties:
        error:
          discriminator:
            mapping:
              api_error: '#/components/schemas/APIError'
              authentication_error: '#/components/schemas/AuthenticationError'
              billing_error: '#/components/schemas/BillingError'
              invalid_request_error: '#/components/schemas/InvalidRequestError'
              not_found_error: '#/components/schemas/NotFoundError'
              overloaded_error: '#/components/schemas/OverloadedError'
              permission_error: '#/components/schemas/PermissionError'
              rate_limit_error: '#/components/schemas/RateLimitError'
              timeout_error: '#/components/schemas/GatewayTimeoutError'
            propertyName: type
          oneOf:
          - $ref: '#/components/schemas/InvalidRequestError'
          - $ref: '#/components/schemas/AuthenticationError'
          - $ref: '#/components/schemas/BillingError'
          - $ref: '#/components/schemas/PermissionError'
          - $ref: '#/components/schemas/NotFoundError'
          - $ref: '#/components/schemas/RateLimitError'
          - $ref: '#/components/schemas/GatewayTimeoutError'
          - $ref: '#/components/schemas/APIError'
          - $ref: '#/components/schemas/OverloadedError'
          title: Error
        request_id:
          anyOf:
          - type: string
          - type: 'null'
          default: null
          title: Request Id
        type:
          const: error
          default: error
          title: Type
          type: string
      required:
      - error
      - request_id
      - type
      title: ErrorResponse
      type: object
    Model:
      title: Model
      description: 'The model that will complete your prompt.


        See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.'
      anyOf:
      - type: string
      - const: claude-sonnet-5
        description: High-performance model for coding and agents
        x-stainless-nominal: false
      - const: claude-fable-5
        description: Next generation of intelligence for the hardest knowledge work and coding problems
        x-stainless-nominal: false
      - const: claude-mythos-5
        description: Most capable model for cybersecurity and biology research
        x-stainless-nominal: false
      - const: claude-opus-5
        description: Powerful intelligence for long-running agents and coding
        x-stainless-nominal: false
      - const: claude-opus-4-8
        description: Powerful intelligence for long-running agents and coding
        x-stainless-nominal: false
      - const: claude-opus-4-7
        description: Powerful intelligence for long-running agents and coding
        x-stainless-nominal: false
      - const: claude-mythos-preview
        description: New class of intelligence, strongest in coding and cybersecurity
        x-stainless-nominal: false
        deprecated: true
        x-stainless-deprecation-message: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
      - const: claude-opus-4-6
        description: Powerful intelligence for long-running agents and coding
        x-stainless-nominal: false
      - const: claude-sonnet-4-6
        description: Best combination of speed and intelligence
        x-stainless-nominal: false
      - const: claude-haiku-4-5
        description: Fastest model with near-frontier intelligence
        x-stainless-nominal: false
      - const: claude-haiku-4-5-20251001
        description: Fastest model with near-frontier intelligence
        x-stainless-nominal: false
      - const: claude-opus-4-5
        description: Powerful intelligence for long-running agents and coding
        x-stainless-nominal: false
      - const: claude-opus-4-5-20251101
        description: Powerful intelligence for long-running agents and coding
        x-stainless-nominal: false
      - const: claude-sonnet-4-5
        description: High-performance model for agents and coding
        x-stainless-nominal: false
      - const: claude-sonnet-4-5-20250929
        description: High-performance model for agents and coding
        x-stainless-nominal: false
    InvalidRequestError:
      properties:
        message:
          default: Invalid request
          title: Message
          type: string
        type:
          const: invalid_request_error
          default: invalid_request_error
          title: Type
          type: string
      required:
      - message
      - type
      title: InvalidRequestError
      type: object
    CompletionRequest:
      additionalProperties: false
      examples:
      - max_tokens_to_sample: 256
        model: claude-2.1
        prompt: '


          Human: Hello, world!


          Assistant:'
      properties:
        model:
          $ref: '#/components/schemas/Model'
        prompt:
          description: 'The prompt that you want Claude to complete.


            For proper response generation you will need to format your prompt using alternating `\n\nHuman:` and `\n\nAssistant:` conversational turns. For example:


            ```

            "\n\nHuman: {userQuestion}\n\nAssistant:"

            ```


            See [prompt validation](https://platform.claude.com/docs/en/build-with-claude/working-with-messages) and our guide to [prompt design](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/overview) for more details.'
          examples:
          - '


            Human: Hello, world!


            Assistant:'
          minLength: 1
          title: Prompt
          type: string
        max_tokens_to_sample:
          description: 'The maximum number of tokens to generate before stopping.


            Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.'
          examples:
          - 256
          minimum: 1
          title: Max Tokens To Sample
          type: integer
        stop_sequences:
          description: 'Sequences that will cause the model to stop generating.


            Our models stop on `"\n\nHuman:"`, and may include additional built-in stop sequences in the future. By providing the stop_sequences parameter, you may include additional strings that will cause the model to stop generating.'
          items:
            type: string
          title: Stop Sequences
          type: array
        temperature:
          deprecated: true
          description: 'Amount of randomness injected into the response.


            Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks.


            Note that even with `temperature` of `0.0`, the results will not be fully deterministic.'
          examples:
          - 1
          maximum: 1
          minimum: 0
          title: Temperature
          type: number
          x-stainless-deprecation-message: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error.
          x-stainless-skip:
          - python
        top_p:
          deprecated: true
          description: 'Use nucleus sampling.


            In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`.


            Recommended for advanced use cases only.'
          examples:
          - 0.7
          maximum: 1
          minimum: 0
          title: Top P
          type: number
          x-stainless-deprecation-message: Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error.
          x-stainless-skip:
          - python
        top_k:
          deprecated: true
          description: 'Only sample from the top K options for each subsequent token.


            Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277).


            Recommended for advanced use cases only.'
          examples:
          - 5
          minimum: 0
          title: Top K
          type: integer
          x-stainless-deprecation-message: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error.
          x-stainless-skip:
          - python
        metadata:
          $ref: '#/components/schemas/Metadata'
          description: An object describing metadata about the request.
        stream:
          description: 'Whether to incrementally stream the response using server-sent events.


            See [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming) for details.'
          title: Stream
          type: boolean
      required:
      - max_tokens_to_sample
      - model
      - prompt
      title: CompletionRequest
      type: object
    RateLimitError:
      properties:
        message:
          default: Rate limited
          title: Message
          type: string
        type:
          const: rate_limit_error
          default: rate_limit_error
          title: Type
          type: string
      required:
      - message
      - type
      title: RateLimitError
      type: object
    CompletionResponse:
      properties:
        completion:
          type: string
          title: Completion
          description: The resulting completion up to and excluding the stop sequences.
          examples:
          - ' Hello! My name is Claude.'
        id:
          type: string
          title: Id
          description: 'Unique object identifier.


            The format and length of IDs may change over time.'
        model:
          $ref: '#/components/schemas/Model'
        stop_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Stop Reason
          description: 'The reason that we stopped.


            This may be one the following values:

            * `"stop_sequence"`: we reached a stop sequence — either provided by you via the `stop_sequences` parameter, or a stop sequence built into the model

            * `"max_tokens"`: we exceeded `max_tokens_to_sample` or the model''s maximum'
          examples:
          - stop_sequence
        type:
          type: string
          const: completion
          title: Type
          description: 'Object type.


            For Text Completions, this is always `"completion"`.'
          default: completion
      type: object
      required:
      - completion
      - id
      - model
      - stop_reason
      - type
      title: CompletionResponse
      example:
        completion: ' Hello! My name is Claude.'
        id: compl_018CKm6gsux7P8yMcwZbeCPw
        model: claude-2.1
        stop_reason: stop_sequence
        type: completion
    OverloadedError:
      properties:
        message:
          default: Overloaded
          title: Message
          type: string
        type:
          const: overloaded_error
          default: overloaded_error
          title: Type
          type: string
      required:
      - message
      - type
      title: OverloadedError
      type: object
    APIError:
      properties:
        message:
          default: Internal server error
          title: Message
          type: string
        type:
          const: api_error
          default: api_error
          title: Type
          type: string
      required:
      - message
      - type
      title: APIError
      type: object
    NotFoundError:
      properties:
        message:
          default: Not found
          title: Message
          type: string
        type:
          const: not_found_error
          default: not_found_error
          title: Type
          type: string
      required:
      - message
      - type
      title: NotFoundError
      type: object
    PermissionError:
      properties:
        message:
          default: Permission denied
          title: Message
          type: string
        type:
          const: permission_error
          default: permission_error
          title: Type
          type: string
      required:
      - message
      - type
      title: PermissionError
      type: object