Chat

POST

https://api.cometapi.com/v1/chat/completions

Maintainer:Not configured

The endpoint POST https://api.cometapi.com/v1/chat/completions is used to send a request to generate chat completions. The request should include a model parameter specifying the model to use, a list of messages containing the role and content of the messages, and a stream parameter to indicate whether to stream the response.

Request Body

model (string): Specifies the model to use for generating completions.

messages (array): Contains the role and content of the messages for which completions are to be generated.

role (string): Specifies the role of the message (e.g., "user", "assistant", "system").

content (string): The content of the message for which completions are to be generated.

stream (boolean): Indicates whether to stream the response.

Request

Header Params

Authorization

string

required

Example:

Bearer {{api-key}}

Body Params application/json

model

string

required

ID of the model to be used.For more information on which models are available for the Chat API, see the Model Endpoint Compatibility Table:https://platform.openai.com/docs/models/model-endpoint-compatibility

messages

array [object {2}]

required

In Chat Format:https://platform.openai.com/docs/guides/text?api-mode=chat Generate a chat completion message.

role

string

optional

role

content

string

optional

stream

boolean

optional

If set, a partial message increment will be sent, as in ChatGPT. When the token is available, the token will be sent as a data-only server send event data: [DONE] and the stream is terminated by the message. For sample code, see the OpenAI Cookbook.

temperature

integer

optional

What sampling temperature to use, between 0 and 1. Higher values (e.g. 0.8) will make the output more random, while lower values (e.g. 0.2) will make the output more focused and deterministic. We usually recommend changing this or top_p but not both.

top_p

integer

optional

An alternative to temperature sampling, called kernel sampling, where the model considers the results of markers with top_p probability mass. So 0.1 means that only the markers that make up the top 10% probability mass are considered. We usually recommend changing either this or TEMPERATURE but not both.

integer

optional

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

stop

string

optional

The API will stop generating more tokens for up to 4 sequences.

max_tokens

integer

optional

Maximum number of tokens generated for chat completion. The total length of input tokens and generated tokens is limited by the length of the model context.

presence_penalty

number

optional

A number between -2.0 and 2.0. Positive values penalize new tokens based on whether or not they have appeared in the text so far, thus increasing the likelihood that the model will talk about new topics. See more about frequency and presence penalties:https://platform.openai.com/docs/api-reference/parameter-details

frequency_penalty

number

optional

logit_bias

null

optional

Modifies the likelihood that the specified token will appear in the completion. Accepts a json object that maps markers (specified by the marker ID in the tagger) to an associated deviation value from -100 to 100. Mathematically, the deviations are added to the logits generated by the model before sampling. The exact effect varies from model to model, but values between -1 and 1 should reduce or increase the likelihood of selection; values like -100 or 100 should result in prohibited or exclusive selection of the associated token.

user

string

optional

Unique identifiers that represent your end users can help OpenAI monitor and detect abuse. Learn more:https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids

Example

{
    "model": "gpt-4o",
    "messages": [
        {
            "role": "user",
            "content": "Hello!"
        }
    ],
    "stream": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cometapi.com/v1/chat/completions' \
--header 'Authorization: Bearer {{api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "gpt-4o",
    "messages": [
        {
            "role": "user",
            "content": "Hello!"
        }
    ],
    "stream": false
}'

Responses

🟢200Successful Response

application/json

Body

string

required

A unique identifier for the chat completion.

object

string

required

The object type, which is always chat.completion.

created

integer

required

The Unix timestamp (in seconds) of when the chat completion was created.

model

string

required

The model used for the chat completion.

system_fingerprint

string

required

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

choices

array [object {3}]

required

A list of chat completion choices.

index

integer

optional

The index of the choice in the list of choices.

message

object

optional

A chat completion message generated by the model.

finish_reason

string

optional

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 insufficient_system_resource if the request is interrupted due to insufficient resource of the inference system.

usage

object

required

Usage statistics for the completion request.

completion_tokens

integer

required

Number of tokens in the generated completion.

completion_tokens_details

object

required

Breakdown of tokens used in a completion.

prompt_tokens

integer

required

Number of tokens in the prompt. It equals prompt_cache_hit_tokens + prompt_cache_miss_tokens.

prompt_tokens_details

object

required

Breakdown of tokens used in a promt.

total_tokens

integer

required

Total number of tokens used in the request (prompt + completion).

Example

{
    "id": "chatcmpl-AreYSBEwmzB0kY3GxzBEhE1Olct83",
    "object": "chat.completion",
    "created": 1737350640,
    "model": "gpt-4o-2024-08-06",
    "system_fingerprint": "fp_f3927aa00d",
    "choices": [
        {
            "index": 0,
            "message": {
                "content": "Hello! How can I assist you today?",
                "role": "assistant"
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "completion_tokens": 9,
        "completion_tokens_details": {},
        "prompt_tokens": 9,
        "prompt_tokens_details": {},
        "total_tokens": 18
    }
}

Error Codes & Handling

response

Chat

Request Body#

Request

Request samples

Responses

Request Body