Muffins AI - Documentação Oficial | Inteligência Artificial Avançada

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": [
    {
      "content": "<string>",
      "id": "<string>"
    }
  ],
  "model": "<string>",
  "stream": false,
  "search": false,
  "temperature": 1
}
'

import requests

url = "https://chat.muffinscorp.com/api/public/chat"

payload = {
    "messages": [
        {
            "content": "<string>",
            "id": "<string>"
        }
    ],
    "model": "<string>",
    "stream": False,
    "search": False,
    "temperature": 1
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [{content: '<string>', id: '<string>'}],
    model: '<string>',
    stream: false,
    search: false,
    temperature: 1
  })
};

fetch('https://chat.muffinscorp.com/api/public/chat', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://chat.muffinscorp.com/api/public/chat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'messages' => [
        [
                'content' => '<string>',
                'id' => '<string>'
        ]
    ],
    'model' => '<string>',
    'stream' => false,
    'search' => false,
    'temperature' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://chat.muffinscorp.com/api/public/chat"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"stream\": false,\n  \"search\": false,\n  \"temperature\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://chat.muffinscorp.com/api/public/chat")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"stream\": false,\n  \"search\": false,\n  \"temperature\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://chat.muffinscorp.com/api/public/chat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"stream\": false,\n  \"search\": false,\n  \"temperature\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>",
  "role": "assistant",
  "createdAt": "2023-11-07T05:31:56Z",
  "creditsUsed": 123,
  "creditsRemaining": 123,
  "model": "<string>"
}

{
  "error": "Invalid API Key",
  "code": "AUTH_FAILED",
  "success": false,
  "message": "<string>",
  "traceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "details": "<string>"
}

{
  "error": "Invalid API Key",
  "code": "AUTH_FAILED",
  "success": false,
  "message": "<string>",
  "traceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "details": "<string>"
}

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": [
    {
      "content": "<string>",
      "id": "<string>"
    }
  ],
  "model": "<string>",
  "stream": false,
  "search": false,
  "temperature": 1
}
'

import requests

url = "https://chat.muffinscorp.com/api/public/chat"

payload = {
    "messages": [
        {
            "content": "<string>",
            "id": "<string>"
        }
    ],
    "model": "<string>",
    "stream": False,
    "search": False,
    "temperature": 1
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [{content: '<string>', id: '<string>'}],
    model: '<string>',
    stream: false,
    search: false,
    temperature: 1
  })
};

fetch('https://chat.muffinscorp.com/api/public/chat', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://chat.muffinscorp.com/api/public/chat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'messages' => [
        [
                'content' => '<string>',
                'id' => '<string>'
        ]
    ],
    'model' => '<string>',
    'stream' => false,
    'search' => false,
    'temperature' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://chat.muffinscorp.com/api/public/chat"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"stream\": false,\n  \"search\": false,\n  \"temperature\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://chat.muffinscorp.com/api/public/chat")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"stream\": false,\n  \"search\": false,\n  \"temperature\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://chat.muffinscorp.com/api/public/chat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"stream\": false,\n  \"search\": false,\n  \"temperature\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>",
  "role": "assistant",
  "createdAt": "2023-11-07T05:31:56Z",
  "creditsUsed": 123,
  "creditsRemaining": 123,
  "model": "<string>"
}

{
  "error": "Invalid API Key",
  "code": "AUTH_FAILED",
  "success": false,
  "message": "<string>",
  "traceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "details": "<string>"
}

{
  "error": "Invalid API Key",
  "code": "AUTH_FAILED",
  "success": false,
  "message": "<string>",
  "traceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "details": "<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 array length: 1

Show child attributes

model

string

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

Pattern: ^[a-z-]+$

stream

boolean

default:false

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

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

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.

Documentação da API

Exemplos de Endpoint

Create Chat

Authorizations

Body

Response