# Chat Completions

Create a model response for a chat conversation, with an endpoint compatible with OpenAI's chat completions API.

`POST /v1/chat/completions` creates a model response for a chat conversation. It is compatible with OpenAI's chat completions API. For more about chat completions, see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/chat).

The project needs a configured and deployed model to answer.

## Create Chat Completion

`POST /v1/chat/completions`

Creates a model response for the given chat conversation.

### Header parameters

- `X-API-Key` (string, required): Your project API key. See [API keys](https://spice.ai/docs/cloud/portal/apps/api-keys).

### Request body

Required.

Create a chat completion request using a language model.

Content type: `application/json`

- `audio` (object | null): Parameters for audio output. Required when audio output is requested with
  `modalities: ["audio"]`. [Learn more](https://platform.openai.com/docs/guides/audio).
  - `format` (string, required): Specifies the output audio format. Must be one of `wav`, `aac`, `mp3`, `flac`, `opus`, or `pcm16`. Allowed values: `wav`, `aac`, `mp3`, `flac`, `opus`, `pcm16`.
  - `voice` ("alloy" | "ash" | "ballad" | "coral" | "echo" | "fable" | "nova" | "onyx" | "sage" | "shimmer" | object, required): The voice the model uses to respond. Supported voices are
    `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, and `shimmer`.

    One of:
    - **"alloy"** (string): Value: `alloy`.
    - **"ash"** (string): Value: `ash`.
    - **"ballad"** (string): Value: `ballad`.
    - **"coral"** (string): Value: `coral`.
    - **"echo"** (string): Value: `echo`.
    - **"fable"** (string): Value: `fable`.
    - **"nova"** (string): Value: `nova`.
    - **"onyx"** (string): Value: `onyx`.
    - **"sage"** (string): Value: `sage`.
    - **"shimmer"** (string): Value: `shimmer`.
    - **object with other** (object)
      - `other` (string, required)
- `frequency_penalty` (number (float) | null): Number between -2.0 and 2.0. Positive values penalize new tokens based on
  their existing frequency in the text so far, decreasing the model's
  likelihood to repeat the same line verbatim.
- `function_call` ("none" | "auto" | object | null)

  Deprecated in favor of `tool_choice`.

  Controls which (if any) function is called by the model.
  `none` means the model will not call a function and instead generates a message.
  `auto` means the model can pick between generating a message or calling a function.
  Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.

  `none` is the default when no functions are present. `auto` is the default if functions are present.

  One of:
  - **"none"** (string): The model does not call a function, and responds to the end-user. Value: `none`.
  - **"auto"** (string): The model can pick between an end-user or calling a function. Value: `auto`.
  - **object with Function** (object): Forces the model to call the specified function.
    - `Function` (object, required): Forces the model to call the specified function.
      - `name` (string, required)
- `functions` (array of object | null, deprecated)

  Deprecated in favor of `tools`.

  A list of functions the model may generate JSON inputs for.
  - `description` (string | null): A description of what the function does, used by the model to choose when and how to call the function.
  - `name` (string, required): The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
  - `parameters` (any, required)

    The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.

    Omitting `parameters` defines a function with an empty parameter list.
- `logit_bias` (map of integer (int32) | null)

  Modify the likelihood of specified tokens appearing in the completion.

  Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100.
  Mathematically, the bias is added to the logits generated by the model prior to sampling.
  The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection;
  values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
- `logprobs` (boolean | null): Whether to return log probabilities of the output tokens or not. If true,
  returns the log probabilities of each output token returned in the `content` of `message`.
- `max_completion_tokens` (integer (int32) | null): An upper bound for the number of tokens that can be generated for a completion, including
  visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). Minimum: `0`.
- `max_tokens` (integer (int32) | null, deprecated): The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in
  the chat completion. This value can be used to control [costs](https://openai.com/api/pricing/) for text generated via API.
  This value is now deprecated in favor of `max_completion_tokens`, and is
  not compatible with [o-series models](https://platform.openai.com/docs/guides/reasoning). Minimum: `0`.
- `messages` (array of object, required): A list of messages comprising the conversation so far. Depending on the
  [model](https://platform.openai.com/docs/models) you use, different message types (modalities)
  are supported, like [text](https://platform.openai.com/docs/guides/text-generation),
  [images](https://platform.openai.com/docs/guides/vision), and
  [audio](https://platform.openai.com/docs/guides/audio).

  One of:
  - **role: developer** (object)
    - `content` (string | array of object, required): The contents of the developer message.

      One of:
      - **string** (string)
      - **array of object** (array of object)
        - `text` (string, required)
        - `type` (string, required): Value: `text`.
    - `name` (string | null): An optional name for the participant. Provides the model information to differentiate between participants of the same role.
    - `role` (string, required): Value: `developer`.
  - **role: system** (object)
    - `content` (string | array of object, required): The contents of the system message.

      One of:
      - **string** (string): The text contents of the system message.
      - **array of object** (array of object): An array of content parts with a defined type. For system messages, only type `text` is supported.
        - `text` (string, required)
        - `type` (string, required): Value: `text`.
    - `name` (string | null): An optional name for the participant. Provides the model information to differentiate between participants of the same role.
    - `role` (string, required): Value: `system`.
  - **role: user** (object)
    - `content` (string | array of object, required): The contents of the user message.

      One of:
      - **string** (string): The text contents of the message.
      - **array of object** (array of object): An array of content parts with a defined type. Supported options differ based on the [model](https://platform.openai.com/docs/models) being used to generate the response. Can contain text, image, or audio inputs.

        One of:
        - **type: text** (object)
          - `text` (string, required)
          - `type` (string, required): Value: `text`.
        - **type: image\_url** (object)
          - `image_url` (object, required)
            - `detail` (string | null): Specifies the detail level of the image. Learn more in the [Vision guide](https://platform.openai.com/docs/guides/vision/low-or-high-fidelity-image-understanding). Allowed values: `auto`, `low`, `high`.
            - `url` (string, required): Either a URL of the image or the base64 encoded image data.
          - `type` (string, required): Value: `image_url`.
        - **type: input\_audio** (object): Learn about [audio inputs](https://platform.openai.com/docs/guides/audio).
          - `input_audio` (object, required)
            - `data` (string, required): Base64 encoded audio data.
            - `format` (string, required): The format of the encoded audio data. Currently supports "wav" and "mp3". Allowed values: `wav`, `mp3`.
          - `type` (string, required): Value: `input_audio`.
        - **type: file** (object)
          - `file` (object, required)
            - `file_data` (string | null): The base64 encoded file data, used when passing the file to the model
              as a string.
            - `file_id` (string | null): The ID of an uploaded file to use as input.
            - `filename` (string | null): The name of the file, used when passing the file to the model as a
              string.
          - `type` (string, required): Value: `file`.
    - `name` (string | null): An optional name for the participant. Provides the model information to differentiate between participants of the same role.
    - `role` (string, required): Value: `user`.
  - **role: assistant** (object)
    - `audio` (object | null): Data about a previous audio response from the model.
      [Learn more](https://platform.openai.com/docs/guides/audio).
      - `id` (string, required): Unique identifier for a previous audio response from the model.
    - `content` (string | array of object | null): The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.

      One of:
      - **string** (string): The text contents of the message.
      - **array of object** (array of object): An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`.

        One of:
        - **type: text** (object)
          - `text` (string, required)
          - `type` (string, required): Value: `text`.
        - **type: refusal** (object)
          - `refusal` (string, required): The refusal message generated by the model.
          - `type` (string, required): Value: `refusal`.
    - `function_call` (object | null): Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.
      - `arguments` (string, required): The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
      - `name` (string, required): The name of the function to call.
    - `name` (string | null): An optional name for the participant. Provides the model information to differentiate between participants of the same role.
    - `refusal` (string | null): The refusal message by the assistant.
    - `tool_calls` (array of object | null)

      One of:
      - **type: function** (object)
        - `function` (object, required): The function that the model called.
          - `arguments` (string, required): The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
          - `name` (string, required): The name of the function to call.
        - `id` (string, required): The ID of the tool call.
        - `type` (string, required): Value: `function`.
      - **type: custom** (object)
        - `custom_tool` (object, required): The custom tool that the model called.
          - `input` (string, required): The input for the custom tool call generated by the model.
          - `name` (string, required): The name of the custom tool to call.
        - `id` (string, required): The ID of the tool call.
        - `type` (string, required): Value: `custom`.
    - `role` (string, required): Value: `assistant`.
  - **role: tool** (object): Tool message
    - `content` (string | array of object, required): The contents of the tool message.

      One of:
      - **string** (string): The text contents of the tool message.
      - **array of object** (array of object): An array of content parts with a defined type. For tool messages, only type `text` is supported.
        - `text` (string, required)
        - `type` (string, required): Value: `text`.
    - `tool_call_id` (string, required)
    - `role` (string, required): Value: `tool`.
  - **role: function** (object)
    - `content` (string | null): The return value from the function call, to return to the model.
    - `name` (string, required): The name of the function to call.
    - `role` (string, required): Value: `function`.
- `metadata` (any): Developer-defined tags and values used for filtering completions in the [dashboard](https://platform.openai.com/chat-completions).
- `modalities` (array of string | null)

  Output types that you would like the model to generate. Most models are capable of generating
  text, which is the default:

  `["text"]`
  The `gpt-4o-audio-preview` model can also be used to
  [generate audio](https://platform.openai.com/docs/guides/audio). To request that this model
  generate both text and audio responses, you can use:

  `["text", "audio"]`

  Allowed values: `text`, `audio`.
- `model` (string, required): Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
  offers a wide range of models with different capabilities, performance
  characteristics, and price points. Refer to the
  [model guide](https://platform.openai.com/docs/models)
  to browse and compare available models.
- `n` (integer (int32) | null): How many chat completion choices to generate for each input message. Note that you will be
  charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to
  minimize costs. Minimum: `0`.
- `parallel_tool_calls` (boolean | null): Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)
  during tool use.
- `prediction` (object | null): Configuration for a [Predicted Output](https://platform.openai.com/docs/guides/predicted-outputs),
  which can greatly improve response times when large parts of the model
  response are known ahead of time. This is most common when you are
  regenerating a file with only minor changes to most of the content.
  - `content` (string | array of object, required): The type of the predicted content you want to provide. This type is
    currently always `content`.

    One of:
    - **string** (string): The content used for a Predicted Output. This is often the text of a file you are regenerating with minor changes.
    - **array of object** (array of object): An array of content parts with a defined type. Supported options differ based on the [model](https://platform.openai.com/docs/models) being used to generate the response. Can contain text inputs.
      - `text` (string, required)
  - `type` (string, required): Value: `content`.
- `presence_penalty` (number (float) | null): Number between -2.0 and 2.0. Positive values penalize new tokens based on
  whether they appear in the text so far, increasing the model's likelihood
  to talk about new topics.
- `prompt_cache_key` (string | null): Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces
  the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
- `reasoning_effort` (string | null): Constrains effort on reasoning for
  [reasoning models](https://platform.openai.com/docs/guides/reasoning).
  Currently supported values are `minimal`, `low`, `medium`, and `high`. Reducing
  reasoning effort can result in faster responses and fewer tokens used
  on reasoning in a response.
  Note: The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. Allowed values: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`.
- `response_format` (object | null)

  An object specifying the format that the model must output.

  Setting to `{ "type": "json_schema", "json_schema": {...} }` enables
  Structured Outputs which ensures the model will match your supplied JSON
  schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).

  Setting to `{ "type": "json_object" }` enables the older JSON mode, which
  ensures the message the model generates is valid JSON. Using `json_schema`
  is preferred for models that support it.

  One of:
  - **type: text** (object): The type of response format being defined: `text`
    - `type` (string, required): Value: `text`.
  - **type: json\_object** (object): The type of response format being defined: `json_object`
    - `type` (string, required): Value: `json_object`.
  - **type: json\_schema** (object): The type of response format being defined: `json_schema`
    - `json_schema` (object, required)
      - `description` (string | null): A description of what the response format is for, used by the model to determine how to respond in the format.
      - `name` (string, required): The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
      - `schema` (any): The schema for the response format, described as a JSON Schema object.
        Learn how to build JSON schemas [here](https://json-schema.org/).
      - `strict` (boolean | null): Whether to enable strict schema adherence when generating the output.
        If set to true, the model will always follow the exact schema defined
        in the `schema` field. Only a subset of JSON Schema is supported when
        `strict` is `true`. To learn more, read the [Structured Outputs
        guide](https://platform.openai.com/docs/guides/structured-outputs).
    - `type` (string, required): Value: `json_schema`.
- `safety_identifier` (string | null)

  A stable identifier used to help detect users of your application that may be violating OpenAI's
  usage policies.

  The IDs should be a string that uniquely identifies each user. We recommend hashing their username
  or email address, in order to avoid sending us any identifying information. [Learn
  more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
- `seed` (integer (int64) | null, deprecated)

  This feature is in Beta.

  If specified, our system will make a best effort to sample deterministically, such that
  repeated requests with the same `seed` and parameters should return the same result.

  Determinism is not guaranteed, and you should refer to the `system_fingerprint` response
  parameter to monitor changes in the backend.
- `service_tier` (string | null)

  Specifies the processing type used for serving the request.
  - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.
  - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.
  - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.
  - When not set, the default behavior is 'auto'.
  When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

  Allowed values: `auto`, `default`, `flex`, `scale`, `priority`.
- `stop` (string | array of string | null)

  Not supported with latest reasoning models `o3` and `o4-mini`.

  Up to 4 sequences where the API will stop generating further tokens. The
  returned text will not contain the stop sequence.
- `store` (boolean | null)

  Whether or not to store the output of this chat completion request for
  use in our [model distillation](https://platform.openai.com/docs/guides/distillation) or
  [evals](https://platform.openai.com/docs/guides/evals) products.

  Supports text and image inputs. Note: image inputs over 8MB will be dropped.
- `stream` (boolean | null): If set to true, the model response data will be streamed to the client
  as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
  See the [Streaming section below](https://platform.openai.com/docs/api-reference/chat/streaming)
  for more information, along with the [streaming responses](https://platform.openai.com/docs/guides/streaming-responses)
  guide for more information on how to handle the streaming events.
- `stream_options` (object | null): Options for streaming response. Only set this when you set `stream: true`.
  - `include_obfuscation` (boolean | null): When true, stream obfuscation will be enabled. Stream obfuscation adds
    random characters to an `obfuscation` field on streaming delta events to
    normalize payload sizes as a mitigation to certain side-channel attacks.
    These obfuscation fields are included by default, but add a small amount
    of overhead to the data stream. You can set `include_obfuscation` to
    false to optimize for bandwidth if you trust the network links between
    your application and the OpenAI API.
  - `include_usage` (boolean | null)

    If set, an additional chunk will be streamed before the `data: [DONE]`
    message. The `usage` field on this chunk shows the token usage statistics
    for the entire request, and the `choices` field will always be an empty
    array.

    All other chunks will also include a `usage` field, but with a null
    value. **NOTE:** If the stream is interrupted, you may not receive the
    final usage chunk which contains the total token usage for the request.
- `temperature` (number (float) | null)

  What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random,
  while lower values like 0.2 will make it more focused and deterministic.

  We generally recommend altering this or `top_p` but not both.
- `tool_choice` (object | null): Controls which (if any) tool is called by the model.
  `none` means the model will not call any tool and instead generates a message.
  `auto` means the model can pick between generating a message or calling one or more tools.
  `required` means the model must call one or more tools.
  Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces
  the model to call that tool.
  `none` is the default when no tools are present. `auto` is the default if tools are present.

  One of:
  - **type: allowed\_tools** (object)
    - `allowed_tools` (array of object, required)
      - `mode` (string, required)

        Constrains the tools available to the model to a pre-defined set.

        `auto` allows the model to pick from among the allowed tools and generate a
        message.

        `required` requires the model to call one or more of the allowed tools.

        Allowed values: `auto`, `required`.
      - `tools` (array of any, required)

        A list of tool definitions that the model should be allowed to call.

        For the Chat Completions API, the list of tool definitions might look like:
        ```json
        [
          { "type": "function", "function": { "name": "get_weather" } },
          { "type": "function", "function": { "name": "get_time" } }
        ]
        ```
    - `type` (string, required): Value: `allowed_tools`.
  - **type: function** (object): Specifies a tool the model should use. Use to force the model to call a specific function.
    - `function` (object, required)
      - `name` (string, required): The name of the function to call.
    - `type` (string, required): Value: `function`.
  - **type: custom** (object)
    - `custom` (object, required)
      - `name` (string, required): The name of the custom tool to call.
    - `type` (string, required): Value: `custom`.
  - **type: mode** (object): Allowed values: `none`, `auto`, `required`.
    - `type` (string, required): Value: `mode`.
- `tools` (array of object | null): A list of tools the model may call. You can provide either
  [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools) or
  [function tools](https://platform.openai.com/docs/guides/function-calling).

  One of:
  - **type: function** (object): A function tool that can be used to generate a response.
    - `function` (object, required)
      - `description` (string | null): A description of what the function does, used by the model to choose when and how to call the function.
      - `name` (string, required): The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
      - `parameters` (any)

        The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.

        Omitting `parameters` defines a function with an empty parameter list.
      - `strict` (boolean | null): Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling).
    - `type` (string, required): Value: `function`.
  - **type: custom** (object): A custom tool that processes input using a specified format.
    - `custom` (object, required)
      - `description` (string | null): Optional description of the custom tool, used to provide more context.
      - `format` (object, required): The input format for the custom tool. Default is unconstrained text.

        One of:
        - **type: text** (object): Unconstrained free-form text.
          - `type` (string, required): Value: `text`.
        - **type: grammar** (object): A grammar defined by the user.
          - `grammar` (object, required)
            - `definition` (string, required): The grammar definition.
            - `syntax` (string, required): The syntax of the grammar definition. One of `lark` or `regex`. Allowed values: `lark`, `regex`.
          - `type` (string, required): Value: `grammar`.
      - `name` (string, required): The name of the custom tool, used to identify it in tool calls.
    - `type` (string, required): Value: `custom`.
- `top_logprobs` (integer (int32) | null): An integer between 0 and 20 specifying the number of most likely tokens to
  return at each token position, each with an associated log probability.
  `logprobs` must be set to `true` if this parameter is used. Minimum: `0`.
- `top_p` (number (float) | null)

  An alternative to sampling with temperature, called nucleus sampling,
  where the model considers the results of the tokens with top\_p probability mass.
  So 0.1 means only the tokens comprising the top 10% probability mass are considered.

  We generally recommend altering this or `temperature` but not both.
- `user` (string | null, deprecated): This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key`
  instead to maintain caching optimizations.
  A stable identifier for your end-users.
  Used to boost cache hit rates by better bucketing similar requests and  to help OpenAI detect and
  prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
- `verbosity` (string | null): Constrains the verbosity of the model's response. Lower values will result in
  more concise responses, while higher values will result in more verbose responses.
  Currently supported values are `low`, `medium`, and `high`. Allowed values: `low`, `medium`, `high`.
- `web_search_options` (object | null): This tool searches the web for relevant results to use in a response.
  Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
  - `search_context_size` (string | null): High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. Allowed values: `low`, `medium`, `high`.
  - `user_location` (object | null): Approximate location parameters for the search.
    - `approximate` (object, required): Approximate location parameters for the search.
      - `city` (string | null): Free text input for the city of the user, e.g. `San Francisco`.
      - `country` (string | null): The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`.
      - `region` (string | null): Free text input for the region of the user, e.g. `California`.
      - `timezone` (string | null): The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`.
    - `type` (string, required): Value: `approximate`.

### Example request

```bash
curl -X POST "https://data.spiceai.io/v1/chat/completions" \
  -H "X-API-Key: <project-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {
        "role": "developer",
        "content": "You are a helpful assistant."
      },
      {
        "role": "user",
        "content": "Hello!"
      }
    ],
    "stream": false
  }'
```

```http
POST /v1/chat/completions HTTP/1.1
Host: data.spiceai.io
X-API-Key: <project-api-key>
Content-Type: application/json
Content-Length: 211

{
  "model": "gpt-4o",
  "messages": [
    {
      "role": "developer",
      "content": "You are a helpful assistant."
    },
    {
      "role": "user",
      "content": "Hello!"
    }
  ],
  "stream": false
}
```

### Responses

**200 OK**

Chat completion generated successfully

Content type: `application/json`

Represents a chat completion response returned by model, based on the provided input.

- `choices` (array of object, required): A list of chat completion choices. Can be more than one if `n` is greater than 1.
  - `finish_reason` (string | null): The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,
    `length` if the maximum number of tokens specified in the request was reached,
    `content_filter` if content was omitted due to a flag from our content filters,
    `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. Allowed values: `stop`, `length`, `tool_calls`, `content_filter`, `function_call`.
  - `index` (integer (int32), required): The index of the choice in the list of choices. Minimum: `0`.
  - `logprobs` (object | null): Log probability information for the choice.
    - `content` (array of object | null): A list of message content tokens with log probability information.
      - `bytes` (array of integer (int32) | null): A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.
      - `logprob` (number (float), required): The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.
      - `token` (string, required): The token.
      - `top_logprobs` (array of object, required): List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.
        - `bytes` (array of integer (int32) | null): A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.
        - `logprob` (number (float), required): The log probability of this token.
        - `token` (string, required): The token.
    - `refusal` (array of object | null)
      - `bytes` (array of integer (int32) | null): A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.
      - `logprob` (number (float), required): The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.
      - `token` (string, required): The token.
      - `top_logprobs` (array of object, required): List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.
        - `bytes` (array of integer (int32) | null): A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.
        - `logprob` (number (float), required): The log probability of this token.
        - `token` (string, required): The token.
  - `message` (object, required): A chat completion message generated by the model.
    - `annotations` (array of object | null)
      - `type` (string, required): Value: `url_citation`.
      - `url_citation` (object, required)
        - `end_index` (integer (int32), required): The index of the last character of the URL citation in the message. Minimum: `0`.
        - `start_index` (integer (int32), required): The index of the first character of the URL citation in the message. Minimum: `0`.
        - `title` (string, required): The title of the web resource.
        - `url` (string, required): The URL of the web resource.
    - `audio` (object | null): If the audio output modality is requested, this object contains data about the audio response from the model. [Learn more](https://platform.openai.com/docs/guides/audio).
      - `data` (string, required): Base64 encoded audio bytes generated by the model, in the format specified in the request.
      - `expires_at` (integer (int64), required): The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations. Minimum: `0`.
      - `id` (string, required): Unique identifier for this audio response.
      - `transcript` (string, required): Transcript of the audio generated by the model.
    - `content` (string | null): The contents of the message.
    - `function_call` (object | null): Deprecated and replaced by `tool_calls`.
      The name and arguments of a function that should be called, as generated by the model.
      - `arguments` (string, required): The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
      - `name` (string, required): The name of the function to call.
    - `reasoning_content` (string | null): Reasoning / chain-of-thought content (e.g. extracted from a `<think>` block),
      kept separate from the user-facing `content`. Populated by reasoning models
      such as GLM, DeepSeek-R1, and QwQ.
    - `refusal` (string | null): The refusal message generated by the model.
    - `role` (string, required): The role of the author of this message. Allowed values: `user`, `assistant`, `system`, `developer`.
    - `tool_calls` (array of object | null): The tool calls generated by the model, such as function calls.

      One of:
      - **type: function** (object)
        - `function` (object, required): The function that the model called.
          - `arguments` (string, required): The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
          - `name` (string, required): The name of the function to call.
        - `id` (string, required): The ID of the tool call.
        - `type` (string, required): Value: `function`.
      - **type: custom** (object)
        - `custom_tool` (object, required): The custom tool that the model called.
          - `input` (string, required): The input for the custom tool call generated by the model.
          - `name` (string, required): The name of the custom tool to call.
        - `id` (string, required): The ID of the tool call.
        - `type` (string, required): Value: `custom`.
- `created` (integer (int32), required): The Unix timestamp (in seconds) of when the chat completion was created. Minimum: `0`.
- `id` (string, required): A unique identifier for the chat completion.
- `model` (string, required): The model used for the chat completion.
- `object` (string, required): The object type, which is always `chat.completion`.
- `service_tier` (string | null): The service tier used for processing the request. This field is only included if the `service_tier` parameter is specified in the request. Allowed values: `auto`, `default`, `flex`, `scale`, `priority`.
- `system_fingerprint` (string | null, deprecated)

  This fingerprint represents the backend configuration that the model runs with.

  Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.
- `usage` (object | null): Usage statistics for the completion request.
  - `completion_tokens` (integer (int32), required): Number of tokens in the generated completion. Minimum: `0`.
  - `completion_tokens_details` (object | null): Breakdown of tokens used in a completion.
    - `accepted_prediction_tokens` (integer (int32) | null): Minimum: `0`.
    - `audio_tokens` (integer (int32) | null): Audio input tokens generated by the model. Minimum: `0`.
    - `reasoning_tokens` (integer (int32) | null): Tokens generated by the model for reasoning. Minimum: `0`.
    - `rejected_prediction_tokens` (integer (int32) | null): When using Predicted Outputs, the number of tokens in the
      prediction that did not appear in the completion. However, like
      reasoning tokens, these tokens are still counted in the total
      completion tokens for purposes of billing, output, and context
      window limits. Minimum: `0`.
  - `prompt_tokens` (integer (int32), required): Number of tokens in the prompt. Minimum: `0`.
  - `prompt_tokens_details` (object | null): Breakdown of tokens used in the prompt.
    - `audio_tokens` (integer (int32) | null): Audio input tokens present in the prompt. Minimum: `0`.
    - `cached_tokens` (integer (int32) | null): Cached tokens present in the prompt. Minimum: `0`.
  - `total_tokens` (integer (int32), required): Total number of tokens used in the request (prompt + completion). Minimum: `0`.

Example:

```json
{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "gpt-4o-mini",
  "system_fingerprint": "fp_44709d6fcb",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "\n\nHello there, how may I assist you today?"
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21,
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  }
}
```

**404 Not Found**

The specified model was not found

**500 Internal Server Error**

An internal server error occurred while processing the chat completion

Content type: `application/json`

Type: `any`

Example:

```json
{
  "error": "An internal server error occurred while processing the chat completion."
}
```

OpenAPI: [spiceai/spiceai v2.3.2](https://github.com/spiceai/spiceai/blob/v2.3.2/.schema/openapi.json)