PixIA API Documentation

API de IA brasileira em nuvem, compatível com OpenAI v1.

Base URLhttps://api.pixia.cloud

AuthAuthorization: Bearer PIXIA_API_KEY

Quick Start

Faça uma chamada de chat em modo síncrono.

curl https://api.pixia.cloud/v1/chat/completions \
  -H "Authorization: Bearer $PIXIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gemma2:2b",
    "messages": [{"role":"user","content":"Olá, PixIA"}]
  }'

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.PIXIA_API_KEY,
  baseURL: "https://api.pixia.cloud/v1",
});

const out = await client.chat.completions.create({
  model: "gemma2:2b",
  messages: [{ role: "user", content: "Olá, PixIA" }],
});

Streaming (SSE)

Use stream: true para receber resposta em chunks.

curl https://api.pixia.cloud/v1/chat/completions \
  -N \
  -H "Authorization: Bearer $PIXIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model":"gemma2:2b",
    "messages":[{"role":"user","content":"Explique SSE"}],
    "stream": true
  }'

const stream = await client.chat.completions.create({
  model: "gemma2:2b",
  messages: [{ role: "user", content: "Explique SSE" }],
  stream: true
});

for await (const chunk of stream) {
  process.stdout.write(chunk.choices?.[0]?.delta?.content || "");
}

Endpoints

Contratos principais disponíveis para integração.

`GET /v1/models`

Lista os modelos disponíveis para uso.

`POST /v1/chat/completions`

Chat completion compatível com OpenAI v1 (sync e stream).

`POST /v1/embeddings`

Geração de embeddings para string única ou lista de strings.

`GET /v1/usage`

Relatório de uso da API key autenticada com filtros de paginação e período.

Embeddings

curl https://api.pixia.cloud/v1/embeddings \
  -H "Authorization: Bearer $PIXIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "nomic-embed-text",
    "input": ["texto A", "texto B"]
  }'

import requests

url = "https://api.pixia.cloud/v1/embeddings"
headers = {
    "Authorization": f"Bearer {PIXIA_API_KEY}",
    "Content-Type": "application/json",
}
payload = {"model": "nomic-embed-text", "input": ["texto A", "texto B"]}
resp = requests.post(url, json=payload, headers=headers, timeout=60)
print(resp.json())

Usage & Billing

Consultar extrato de uso da chave autenticada.

curl "https://api.pixia.cloud/v1/usage?limit=100&skip=0" \
  -H "Authorization: Bearer $PIXIA_API_KEY"

# since em timestamp (ms)
curl "https://api.pixia.cloud/v1/usage?since=1739577600000" \
  -H "Authorization: Bearer $PIXIA_API_KEY"

Status Codes

`200`

Sucesso.

`400`

Payload inválido (ex.: input embeddings inválido).

`401`

API key ausente ou inválida.

`402`

Créditos insuficientes.

`500`

Falha interna de processamento.

`504`

Timeout de processamento.