v1

latestOpenAPI 3.0.32026-07-172892106.1 KB

fim

Fim Completion

FIM completion.

post/fim/completions

Request body

top_pnumber

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.

random_seedinteger nullable

The seed to use for random sampling. If set, different calls will generate deterministic results.

max_tokensinteger nullable

The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length.

streamboolean

Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.

temperaturenumber nullable

What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 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. The default value varies depending on the model you are targeting. Call the /models endpoint to retrieve the appropriate value.

modelstring required

ID of the model to use. Only compatible for now with:

codestral-2405
codestral-latest

suffixstring nullable

Optional text/code that adds more context for the model. When given a prompt and a suffix the model will fill what is between them. When suffix is not provided, the model will simply execute completion starting with prompt.

promptstring required

The text/code to complete.

min_tokensinteger nullable

The minimum number of tokens to generate in the completion.

Example request

{
  "model": "[\"codestral-2405\"]",
  "suffix": "[\"return a+b\"]",
  "prompt": "[\"def\"]"
}

Response

Successful Response

modelstring required

idstring required

objectstring required

createdinteger

Example response

{
  "usage": {
    "completion_tokens": 34,
    "prompt_tokens": 16,
    "total_tokens": 50
  },
  "model": "codestral-latest",
  "id": "cmpl-e5cc70bb28c444948073e77776eb30ef",
  "object": "chat.completion",
  "created": 1702256327,
  "choices": [
    {
      "finish_reason": "stop"
    }
  ]
}