Cohere Generate API

openapi: 3.2.0
info:
  title: Cohere Generate API
  version: 1.0.0
servers:
- url: https://api.cohere.com
  description: production
tags:
- name: Generate
paths:
  /v1/generate:
    post:
      operationId: generate_stream
      summary: Generate
      description: 'This API is marked as "Legacy" and is no longer maintained. Follow the migration guide to start using the Chat with Streaming API.


        Generates realistic text conditioned on a given input.'
      parameters:
      - name: X-Client-Name
        in: header
        description: 'The name of the project that is making the request.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: '<Warning>

            This API is marked as "Legacy" and is no longer maintained. Follow the [migration guide](https://docs.cohere.com/docs/migrating-from-cogenerate-to-cochat) to start using the Chat with Streaming API.

            </Warning>

            Generates realistic text conditioned on a given input.

            '
          content:
            text/event-stream:
              schema:
                $ref: '#/components/schemas/generate_Response_stream_streaming'
        '400':
          description: "This error is returned when the request is not well formed. This could be because:\n  - JSON is invalid\n  - The request is missing required fields\n  - The request contains an invalid combination of fields\n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestBadRequestError'
        '401':
          description: "This error indicates that the operation attempted to be performed is not allowed. This could be because:\n  - The api token is invalid\n  - The user does not have the necessary permissions\n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestUnauthorizedError'
        '403':
          description: "This error indicates that the operation attempted to be performed is not allowed. This could be because:\n  - The api token is invalid\n  - The user does not have the necessary permissions\n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestForbiddenError'
        '404':
          description: "This error is returned when a resource is not found. This could be because:\n  - The endpoint does not exist\n  - The resource does not exist eg model id, dataset id\n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestNotFoundError'
        '422':
          description: "This error is returned when the request is not well formed. This could be because:\n  - JSON is invalid\n  - The request is missing required fields\n  - The request contains an invalid combination of fields\n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestUnprocessableEntityError'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestTooManyRequestsError'
        '498':
          description: 'This error is returned when a request or response contains a deny-listed token.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestInvalidTokenError'
        '499':
          description: 'This error is returned when a request is cancelled by the user.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestClientClosedRequestError'
        '500':
          description: 'This error is returned when an uncategorised internal server error occurs.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestInternalServerError'
        '501':
          description: 'This error is returned when the requested feature is not implemented.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestNotImplementedError'
        '503':
          description: "This error is returned when the service is unavailable. This could be due to:\n  - Too many users trying to access the service at the same time\n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestServiceUnavailableError'
        '504':
          description: "This error is returned when a request to the server times out. This could be due to:\n  - An internal services taking too long to respond\n"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRequestGatewayTimeoutError'
      deprecated: true
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              properties:
                prompt:
                  type: string
                  description: 'The input text that serves as the starting point for generating the response.

                    Note: The prompt will be pre-processed and modified before reaching the model.

                    '
                model:
                  type: string
                  description: 'The identifier of the model to generate with. Currently available models are `command` (default), `command-nightly` (experimental), `command-light`, and `command-light-nightly` (experimental).

                    Smaller, "light" models are faster, while larger models will perform better. [Custom models](https://docs.cohere.com/docs/training-custom-models) can also be supplied with their full ID.'
                num_generations:
                  type: integer
                  description: 'The maximum number of generations that will be returned. Defaults to `1`, min value of `1`, max value of `5`.

                    '
                stream:
                  type: boolean
                  enum:
                  - true
                  description: 'When `true`, the response will be a JSON stream of events. Streaming is beneficial for user interfaces that render the contents of the response piece by piece, as it gets generated.


                    The final event will contain the complete response, and will contain an `is_finished` field set to `true`. The event will also contain a `finish_reason`, which can be one of the following:

                    - `COMPLETE` - the model sent back a finished reply

                    - `MAX_TOKENS` - the reply was cut off because the model reached the maximum number of tokens for its context length

                    - `ERROR` - something went wrong when generating the reply

                    - `ERROR_TOXIC` - the model generated a reply that was deemed toxic

                    '
                max_tokens:
                  type: integer
                  description: 'The maximum number of tokens the model will generate as part of the response. Note: Setting a low value may result in incomplete generations.


                    This parameter is off by default, and if it''s not specified, the model will continue generating until it emits an EOS completion token. See [BPE Tokens](/bpe-tokens-wiki) for more details.


                    Can only be set to `0` if `return_likelihoods` is set to `ALL` to get the likelihood of the prompt.

                    '
                truncate:
                  $ref: '#/components/schemas/V1GeneratePostRequestBodyContentApplicationJsonSchemaTruncate'
                  default: END
                  description: 'One of `NONE|START|END` to specify how the API will handle inputs longer than the maximum token length.


                    Passing `START` will discard the start of the input. `END` will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model.


                    If `NONE` is selected, when the input exceeds the maximum input token length an error will be returned.'
                temperature:
                  type: number
                  format: double
                  description: 'A non-negative float that tunes the degree of randomness in generation. Lower temperatures mean less random generations. See [Temperature](/temperature-wiki) for more details.

                    Defaults to `0.75`, min value of `0.0`, max value of `5.0`.

                    '
                seed:
                  type: integer
                  minimum: 0
                  maximum: 18446744073709552000
                  description: 'If specified, the backend will make a best effort to sample tokens

                    deterministically, such that repeated requests with the same

                    seed and parameters should return the same result. However,

                    determinism cannot be totally guaranteed.

                    Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker/Bedrock, Private Deployments

                    '
                preset:
                  type: string
                  description: 'Identifier of a custom preset. A preset is a combination of parameters, such as prompt, temperature etc. You can create presets in the [playground](https://dashboard.cohere.com/playground/generate).

                    When a preset is specified, the `prompt` parameter becomes optional, and any included parameters will override the preset''s parameters.

                    '
                end_sequences:
                  type: array
                  items:
                    type: string
                  description: The generated text will be cut at the beginning of the earliest occurrence of an end sequence. The sequence will be excluded from the text.
                stop_sequences:
                  type: array
                  items:
                    type: string
                  description: The generated text will be cut at the end of the earliest occurrence of a stop sequence. The sequence will be included the text.
                k:
                  type: integer
                  description: 'Ensures only the top `k` most likely tokens are considered for generation at each step.

                    Defaults to `0`, min value of `0`, max value of `500`.

                    '
                p:
                  type: number
                  format: double
                  description: 'Ensures that only the most likely tokens, with total probability mass of `p`, are considered for generation at each step. If both `k` and `p` are enabled, `p` acts after `k`.

                    Defaults to `0.75`. min value of `0.01`, max value of `0.99`.

                    '
                frequency_penalty:
                  type: number
                  format: double
                  description: 'Used to reduce repetitiveness of generated tokens. The higher the value, the stronger a penalty is applied to previously present tokens, proportional to how many times they have already appeared in the prompt or prior generation.


                    Using `frequency_penalty` in combination with `presence_penalty` is not supported on newer models.

                    '
                presence_penalty:
                  type: number
                  format: double
                  description: 'Defaults to `0.0`, min value of `0.0`, max value of `1.0`.


                    Can be used to reduce repetitiveness of generated tokens. Similar to `frequency_penalty`, except that this penalty is applied equally to all tokens that have already appeared, regardless of their exact frequencies.


                    Using `frequency_penalty` in combination with `presence_penalty` is not supported on newer models.

                    '
                return_likelihoods:
                  $ref: '#/components/schemas/V1GeneratePostRequestBodyContentApplicationJsonSchemaReturnLikelihoods'
                  default: NONE
                  description: 'One of `GENERATION|NONE` to specify how and if the token likelihoods are returned with the response. Defaults to `NONE`.


                    If `GENERATION` is selected, the token likelihoods will only be provided for generated text.


                    WARNING: `ALL` is deprecated, and will be removed in a future release.'
                raw_prompting:
                  type: boolean
                  description: When enabled, the user's prompt will be sent to the model without any pre-processing.
              required:
              - prompt
              - stream
      security:
      - bearerAuth: []
      tags:
      - Generate
components:
  schemas:
    FinishReason:
      type: string
      enum:
      - COMPLETE
      - STOP_SEQUENCE
      - ERROR
      - ERROR_TOXIC
      - ERROR_LIMIT
      - USER_CANCEL
      - MAX_TOKENS
      - TIMEOUT
      title: FinishReason
    SingleGenerationInStream:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
          description: Full text of the generation.
        index:
          type: integer
          description: Refers to the nth generation. Only present when `num_generations` is greater than zero.
        finish_reason:
          $ref: '#/components/schemas/FinishReason'
      required:
      - id
      - text
      - finish_reason
      title: SingleGenerationInStream
    GenerateRequestTooManyRequestsError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestTooManyRequestsError
    GenerateRequestGatewayTimeoutError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestGatewayTimeoutError
    GenerateRequestInternalServerError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestInternalServerError
    GenerateRequestClientClosedRequestError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestClientClosedRequestError
    V1GeneratePostRequestBodyContentApplicationJsonSchemaReturnLikelihoods:
      type: string
      enum:
      - GENERATION
      - ALL
      - NONE
      default: NONE
      description: 'One of `GENERATION|NONE` to specify how and if the token likelihoods are returned with the response. Defaults to `NONE`.


        If `GENERATION` is selected, the token likelihoods will only be provided for generated text.


        WARNING: `ALL` is deprecated, and will be removed in a future release.'
      title: V1GeneratePostRequestBodyContentApplicationJsonSchemaReturnLikelihoods
    GenerateRequestNotFoundError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestNotFoundError
    GenerateStreamEventEventType:
      type: string
      enum:
      - text-generation
      - stream-end
      - stream-error
      title: GenerateStreamEventEventType
    GenerateRequestServiceUnavailableError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestServiceUnavailableError
    GenerateRequestUnprocessableEntityError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestUnprocessableEntityError
    GenerateRequestInvalidTokenError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestInvalidTokenError
    V1GeneratePostRequestBodyContentApplicationJsonSchemaTruncate:
      type: string
      enum:
      - NONE
      - START
      - END
      default: END
      description: 'One of `NONE|START|END` to specify how the API will handle inputs longer than the maximum token length.


        Passing `START` will discard the start of the input. `END` will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model.


        If `NONE` is selected, when the input exceeds the maximum input token length an error will be returned.'
      title: V1GeneratePostRequestBodyContentApplicationJsonSchemaTruncate
    GenerateRequestNotImplementedError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestNotImplementedError
    GenerateRequestForbiddenError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestForbiddenError
    GenerateRequestBadRequestError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestBadRequestError
    GenerateStreamEndResponse:
      type: object
      properties:
        id:
          type: string
        prompt:
          type: string
        generations:
          type: array
          items:
            $ref: '#/components/schemas/SingleGenerationInStream'
      required:
      - id
      title: GenerateStreamEndResponse
    generate_Response_stream_streaming:
      oneOf:
      - type: object
        properties:
          event_type:
            $ref: '#/components/schemas/GenerateStreamEventEventType'
          text:
            type: string
            description: A segment of text of the generation.
          index:
            type: integer
            description: Refers to the nth generation. Only present when `num_generations` is greater than zero, and only when text responses are being streamed.
          is_finished:
            type: boolean
        required:
        - event_type
        - text
        - is_finished
        description: text-generation variant
      - type: object
        properties:
          event_type:
            $ref: '#/components/schemas/GenerateStreamEventEventType'
          is_finished:
            type: boolean
          finish_reason:
            $ref: '#/components/schemas/FinishReason'
          response:
            $ref: '#/components/schemas/GenerateStreamEndResponse'
        required:
        - event_type
        - is_finished
        - response
        description: stream-end variant
      - type: object
        properties:
          event_type:
            $ref: '#/components/schemas/GenerateStreamEventEventType'
          index:
            type: integer
            description: Refers to the nth generation. Only present when `num_generations` is greater than zero.
          is_finished:
            type: boolean
          finish_reason:
            $ref: '#/components/schemas/FinishReason'
          err:
            type: string
            description: Error message
        required:
        - event_type
        - is_finished
        - finish_reason
        - err
        description: stream-error variant
      discriminator:
        propertyName: event_type
      description: Response in content type stream when `stream` is `true` in the request parameters. Generation tokens are streamed with the GenerationStream response. The final response is of type GenerationFinalResponse.
      title: generate_Response_stream_streaming
    GenerateRequestUnauthorizedError:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
      title: GenerateRequestUnauthorizedError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer