Chat Completions

post https://api.egp.scale.com/v4/beta/chat/completions

Description

Interact with the LLM model using a chat completions interface. The LLM model will respond with an assistant message.

{
    "model": "gpt-4o",
    "messages": [
        { "role": "system", "content": "You are a name generator. Do not generate anything else than names" },
        { "role": "user", "content": "Generate 5 names" },
    ]
}

Body Params

top_k

integer

Only sample from the top K options for each subsequent token

frequency_penalty

number

-2 to 2

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far.

function_call

object

Deprecated in favor of tool_choice. Controls which function is called by the model.

functions

array of objects

Deprecated in favor of tools. A list of functions the model may generate JSON inputs for.

Functions

logit_bias

object

Modify the likelihood of specified tokens appearing in the completion. Maps tokens to bias values from -100 to 100.

logprobs

boolean

Whether to return log probabilities of the output tokens or not.

max_completion_tokens

integer

An upper bound for the number of tokens that can be generated, including visible output tokens and reasoning tokens.

max_tokens

integer

Deprecated in favor of max_completion_tokens. The maximum number of tokens to generate.

metadata

object

Developer-defined tags and values used for filtering completions in the dashboard.

modalities

array of strings

Output types that you would like the model to generate for this request.

Modalities

integer

How many chat completion choices to generate for each input message.

parallel_tool_calls

boolean

Whether to enable parallel function calling during tool use.

prediction

object

Static predicted output content, such as the content of a text file being regenerated.

presence_penalty

number

-2 to 2

Number between -2.0 and 2.0. Positive values penalize tokens based on whether they appear in the text so far.

reasoning_effort

string

For o1 models only. Constrains effort on reasoning. Values: low, medium, high.

response_format

object

An object specifying the format that the model must output.

seed

integer

If specified, system will attempt to sample deterministically for repeated requests with same seed.

stop

Up to 4 sequences where the API will stop generating further tokens.

store

boolean

Whether to store the output for use in model distillation or evals products.

stream

boolean

If true, partial message deltas will be sent as server-sent events.

stream_options

object

Options for streaming response. Only set this when stream is true.

temperature

number

0 to 2

What sampling temperature to use. Higher values make output more random, lower more focused.

tool_choice

Controls which tool is called by the model. Values: none, auto, required, or specific tool.

tools

array of objects

A list of tools the model may call. Currently, only functions are supported. Max 128 functions.

Tools

top_logprobs

integer

0 to 20

Number of most likely tokens to return at each position, with associated log probability.

top_p

number

0 to 1

Alternative to temperature. Only tokens comprising top_p probability mass are considered.

audio

object

Parameters for audio output. Required when audio output is requested with modalities: ['audio'].

model

string

required

model specified as model_vendor/model, for example openai/gpt-4o

messages

array of objects

required

openai standard message format

Messages*

Responses

200Successful Response

422Validation Error