Anthropic Claude

POST

https://api.cometapi.com/v1/messages

Maintainer:Not configured

POST /v1/messages

This endpoint is used to create chat completions through the same format and parameters as Anthropic Claude. This endpoint only supports Claude models. Please view all supported models in Model List and Pricing

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

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.

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

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.

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.

stop

string

optional

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

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": "cometapi-3-7-sonnet",
    "max_tokens": 1024,
    "messages": [
        {
            "role": "user",
            "content": "Hello, world"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cometapi.com/v1/messages' \
--header 'Authorization: Bearer {{api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "cometapi-3-7-sonnet",
    "max_tokens": 1024,
    "messages": [
        {
            "role": "user",
            "content": "Hello, world"
        }
    ]
}'

Responses

🟢200Successful Response

application/json

Body

string

required

Message's unique identifier

type

string

required

Type of the object

role

string

required

Role of the message sender

content

array [object {2}]

required

Actual text content

type

string

optional

Type of content block

text

string

optional

Actual text content

model

string

required

Specific model name and version that generated this response

stop_reason

string

required

Reason why the model stopped generating content

usage

object

required

Object about API call resource usage, mainly token statistics

input_tokens

integer

required

Number of tokens input to the model (prompts and historical messages, etc.)

output_tokens

integer

required

Number of tokens in the output content generated by the model

cache_creation_input_tokens

integer

required

Number of input tokens used to create the cache

cache_read_input_tokens

integer

required

Number of input tokens read from the cache

Example

{
    "id": "chatcmpl-a1568ee22c7a4f31848f3dc16c2f3",
    "type": "message",
    "role": "assistant",
    "content": [
        {
            "type": "text",
            "text": "Hello! It's nice to meet you. I'm Claude, an AI assistant. How can I help you today? Feel free to ask me anything you'd like - I'm happy to assist with a wide range of topics and tasks."
        }
    ],
    "model": "claude-3-5-sonnet-20240620",
    "stop_reason": "end_turn",
    "stop_sequence": null,
    "usage": {
        "input_tokens": 3,
        "output_tokens": 52,
        "cache_creation_input_tokens": 0,
        "cache_read_input_tokens": 0
    }
}

Models

Quick Tutorial - Complete Process in One Go

Anthropic Claude

POST /v1/messages#

Request

Request samples

Responses

POST /v1/messages