Create a chat completion

Creates a completion for the provided messages. Supports streaming via SSE.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Public model id. An OpenAI model is openai/, for example openai/gpt-4o.

messages
array of objects
required

List of messages in the conversation

messages*
boolean

Whether to stream the response

number
-2 to 2
logit_bias
object
boolean
integer
metadata
object
modalities
array of strings
modalities
boolean
number
-2 to 2
string

Prompt cache key. OpenAI provider only. When set, routing keeps the provider on OpenAI and may still change the model.

string
enum

Alias of reasoning.effort. Cannot be sent together with reasoning.effort.

Allowed:
response_format
object

Format for the response

string
string
stream_options
object
boolean

Whether to store the completion. OpenAI provider only. When set, routing keeps the provider on OpenAI and may still change the model.

number
0 to 2
enum
tools
array of objects
tools
integer

Deterministic sampling seed

number
0 to 1

Nucleus sampling parameter

integer
0 to 20

Number of most likely tokens to return at each position

Up to 4 sequences where the API will stop generating tokens

prediction
object

Predicted output content for the model to reference. OpenAI provider only. When set, routing keeps the provider on OpenAI and may still change the model. Can reduce latency.

string
enum

Prompt cache retention policy. OpenAI provider only. When set, routing keeps the provider on OpenAI and may still change the model.

Allowed:
prompt_cache_options
object

Request-wide prompt cache options (OpenAI gpt-5.6+). OpenAI provider only. When set, routing keeps the provider on OpenAI and may still change the model.

web_search_options
object

Web search options for chat completions. Supported on the OpenAI and Gemini providers. The route is limited to a model that can serve the search.

string
string
enum

Response verbosity. OpenAI provider only. When set, routing keeps the provider on OpenAI and may still change the model.

Allowed:
audio
object

Audio output parameters. Supported by OpenAI models that accept audio output.

integer

Number of chat completions to generate when the provider supports it

Headers
string
enum

Force the quality judge on or off for this request. off skips evaluation and ignores judge_effort. Any value other than on or off is ignored and the plugin's enable switch is used.

Allowed:
string
enum

Force task routing on or off for this request. on routes even when the plugin default is off. off uses the caller's model. Any value other than on or off is ignored.

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/event-stream