GET
/v1/schemas/huggingface/chat/v1%2Fchat%2Fcompletions
Accept:
Request body
20 properties · 1 required · 16 $defs| property | type | description | constraints |
|---|---|---|---|
| messages* | ChatCompletionInputMessage[] | A list of messages comprising the conversation so far. | |
| frequency_penalty | number | 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. | format: float |
| logit_bias | number[] | UNUSED 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 ge… | |
| logprobs | boolean | 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_tokens | integer | The maximum number of tokens that can be generated in the chat completion. | n ≥ 0 · format: int32 · default: "1024" |
| model | string | [UNUSED] ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API. | |
| n | integer | UNUSED 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. | n ≥ 0 · format: int32 |
| presence_penalty | number | 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 | format: float |
| reasoning_effort | string | Optional. Constrains effort on reasoning for models that support reasoning. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning. Common values: none, minimal, low, medium, high, xhigh. Support and defaults are provider a… | |
| response_format | ChatCompletionInputResponseFormatText | … | ||
| seed | integer | n ≥ 0 · format: int64 | |
| stop | string[] | Up to 4 sequences where the API will stop generating further tokens. | |
| stream | boolean | ||
| stream_options | ChatCompletionInputStreamOptions | ||
| temperature | number | 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. | format: float |
| tool_choice | enum | enum | enum | … | <https://platform.openai.com/docs/guides/function-calling/configuring-function-calling-behavior-using-the-tool_choice-parameter> | |
| tool_prompt | string | A prompt to be appended before the tools | |
| tools | ChatCompletionInputTool[] | A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. | |
| top_logprobs | integer | An integer between 0 and 5 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. | n ≥ 0 · format: int32 |
| top_p | number | 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. | format: float |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"huggingface","endpointId":"v1/chat/completions","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}