Skip to main content
POST
/
chat
cURL
curl --request POST \
  --url https://chat.muffinscorp.com/api/public/chat \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "messages": [
    {
      "id": "<string>",
      "role": "user",
      "content": "<string>"
    }
  ],
  "model": "<string>",
  "stream": false,
  "search": false,
  "temperature": 1
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>",
  "role": "assistant",
  "createdAt": "2023-11-07T05:31:56Z",
  "creditsUsed": 123,
  "creditsRemaining": 123,
  "model": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Body

application/json

Dados para geração de resposta

​
messages
object[]
required

Histórico de mensagens para gerar a resposta.

Minimum length: 1
​
model
string

Modelo a ser usado para geração (ex: chat-model-small).

​
stream
boolean
default:false

Se verdadeiro, a resposta será enviada como stream de eventos.

​
search
boolean
default:false

Se verdadeiro, o modelo faz busca pela internet (modelos suportados!)

​
temperature
number
default:1

Controla a aleatoriedade das respostas (0-2). Valores mais altos são mais aleatórios.

Required range: 0 <= x <= 2

Response

Resposta gerada com sucesso.

  • Option 1
  • Option 2

Non-streaming response format

​
id
string<uuid>
required

ID único da interação.

​
content
string
required

Conteúdo completo da resposta do assistente.

​
role
enum<string>
required

Papel do respondente (sempre 'assistant').

Available options:
assistant
​
createdAt
string<date-time>
required

Timestamp de criação da resposta.

​
creditsUsed
integer
required

Créditos consumidos pela operação.

​
creditsRemaining
integer
required

Créditos restantes após a operação.

​
model
string

Modelo usado para gerar a resposta.