spicyapiDocumentação
Primeiros passos
Conteúdo principal

Prepare sua conta

Saia do zero e chegue a uma chave de API funcionando em uns quinze minutos. Cadastre-se, confirme o e-mail, adicione saldo, crie uma chave e faça uma chamada de teste grátis, com cada tela explicada.

Esta página leva você em linha reta de "não tenho nada" até "minha chave funciona". Você não precisa escrever código. Vai clicar pelo console em spicyapi.ai/console e, no final, colar um único comando num terminal.

Antes da primeira geração, você precisa de três coisas:

Você precisa dePor quêOnde se configura
Uma conta com e-mail confirmadoEnquanto o e-mail não for confirmado, toda chamada de API é recusada com 403, mesmo com uma chave válidaPasso 1
Um saldo acima de zeroAs gerações são pagas com um saldo pré-pago em dólares americanos. Contas novas começam com US$ 0 e não há plano gratuito, então a primeira geração numa conta vazia é recusada com 40201 (saldo insuficiente)Passo 2
Uma chave de API guardada no seu próprio computador ou servidorA chave diz à SpicyAPI a qual conta uma requisição pertence e de qual saldo sai o pagamentoPasso 4

O que nesta página custa dinheiro

Só adicionar saldo (passo 2) e, se você ligar, a recarga automática (passo 3) tiram dinheiro de você. Criar a conta, criar chaves e a chamada de teste do passo 6 são grátis. O saldo só é usado quando você executa uma geração, e uma geração que falha ou estoura o tempo devolve o dinheiro automaticamente.

Antes de começar

  • Idade. É preciso ter pelo menos 18 anos para ter uma conta.
  • Onde você está. A SpicyAPI não está disponível na China continental nem em algumas outras regiões. O cadastro e os pagamentos verificam de onde vêm, e requisições dessas regiões são recusadas. Veja Responsabilidade sobre conteúdo e uso.
  • O cadastro pode ficar fechado por um tempo. As contas são abertas em lotes. Se a página de cadastro disser Abrimos contas em lotes, escolha Solicitar acesso e você será avisado quando puder criar a conta. Mesmo sem conta, dá para ler o catálogo de modelos, os schemas e os preços.

Passo a passo

Crie sua conta e confirme seu e-mail

Abra spicyapi.ai/register. Há três formas de se cadastrar:

OpçãoO que você informaBom saber
Continuar com o Google ou Continuar com o GitHubNada: você aprova na página do Google ou do GitHubÉ usado o e-mail dessa conta. Se o provedor já tiver confirmado esse e-mail, não chega nenhum e-mail de confirmação separado. A conta fica sem senha até você definir uma em Configurações → Senha (mais tarde você vai precisar dela para encerrar a conta ou passar a propriedade de uma equipe)
Conta com e-mailEndereço de e-mail e uma senha com pelo menos 12 caracteresEnviamos um link de confirmação para o seu e-mail

Marque a concordância com os termos de serviço e a política de privacidade e escolha Criar conta.

O que você deve ver: numa conta com e-mail, uma página com o título Confira sua caixa de entrada. Abra o e-mail e clique no link. A página E-mail verificado confirma, e Ir para o console leva você para dentro.

O que acabou de acontecer: sua conta existe, mas só pode chamar a API depois que o e-mail for confirmado. Até lá, o console mostra o aviso E-mail não confirmado — as chamadas de API estão bloqueadas.

  • O link funciona uma vez e expira em 24 horas. Se tiver expirado, abra o link mesmo assim e use Enviar outro link de verificação, ou escolha Confirmar no aviso do console.
  • Não chegou nada depois de alguns minutos? Olhe a pasta de spam e depois use Enviar de novo.

Adicione saldo

Abra Faturamento no console: spicyapi.ai/console/billing. Em Adicionar saldo:

  1. Escolha um valor. Selecione um dos valores prontos (por exemplo US$ 10, US$ 25, US$ 50 ou US$ 100) ou Outro valor e digite o seu. O console mostra o menor e o maior valor que você pode adicionar num único pagamento. Pagamentos online aceitam no máximo duas casas decimais.
  2. Veja se há bônus. Alguns valores vêm com um bônus promocional, mostrado como +US$ … de bônus antes de você pagar. O bônus entra como um lançamento separado, ao lado do valor que você pagou.
  3. Escolha uma forma de pagamento e siga a aba correspondente abaixo.

Aceitos: Visa, Mastercard, American Express e JCB, além de Apple Pay e Google Pay quando o seu navegador e o seu aparelho forem compatíveis.

  1. Selecione Cartão e escolha Continuar para a Stripe · US$ ….
  2. Abre-se uma página de checkout segura. Informe o cartão ali e pague. A SpicyAPI nunca vê nem guarda o número do seu cartão.
  3. Você volta para Faturamento.

O que você deve ver: primeiro Pagamento enviado, depois uma confirmação de que o valor entrou no seu saldo. O Saldo disponível aumenta, e o Histórico do saldo mostra um lançamento de Recarga (e um de Bônus, se houver).

Quanto tempo leva: normalmente alguns segundos. O saldo só muda depois que a confirmação assinada do processador de pagamentos chega até nós, então atualize a página depois de um instante se ele ainda não tiver mudado.

Se algo der errado:

  • Checkout cancelado significa que nada foi cobrado e o seu saldo não mudou. Basta tentar de novo.
  • Fechou a página de checkout antes de pagar? Nada foi cobrado. O pedido não pago em Pedidos de recarga se encerra sozinho; é só começar uma nova recarga.
  • Um cartão emitido numa região que não podemos atender não entra no seu saldo. O pedido fica pendente e a nossa equipe o analisa; fale com o Suporte informando o ID do pedido.

Outras mensagens que podem aparecer:

  • Recarga indisponível ou Não é possível criar um pedido de recarga agora: as recargas estão temporariamente fechadas, ou você tem pedidos pendentes demais. Conclua ou cancele os antigos em Pedidos de recarga, ou tente de novo mais tarde.
  • A conexão caiu e não dá para saber o resultado: confira Pedidos de recarga antes de tentar de novo, para não pagar duas vezes.

Opcional: ligue a recarga automática

A recarga automática cobra um cartão salvo por você quando o seu saldo fica baixo, para que trabalhos longos não parem no meio com 40201. Ela só funciona com cartão.

  1. Em Faturamento, encontre Recarga automática e escolha Salvar forma de pagamento com segurança.
  2. Informe o cartão na página segura que se abre. Os dados do cartão ficam com o processador de pagamentos.
  3. De volta ao Faturamento, você vê Estamos verificando sua forma de pagamento e depois Forma de pagamento salva. Se aparecer Este cartão não pode ser usado aqui, nada foi salvo; tente outro cartão.
  4. Preencha três campos:
    • Recarregar abaixo de: o saldo que dispara uma cobrança.
    • Valor por recarga: quanto cada cobrança adiciona. Precisa estar dentro da mesma faixa de uma recarga normal.
    • Teto mensal: o máximo que a recarga automática pode cobrar num mês do calendário. Não pode ser menor que o valor por recarga.
  5. Marque a autorização e escolha Ligar a recarga automática.

O que você deve ver: A recarga automática ficou ligada com estes limites. O cartão mostra a regra, por exemplo "Recarrega US$ 50 assim que seu saldo fica abaixo de US$ 10", e Usado neste mês.

As regras, exatamente:

  • Verificamos o seu saldo mais ou menos a cada 30 segundos a 2 minutos. Quando o seu saldo disponível fica igual ou abaixo do valor de disparo, cobramos o valor configurado no cartão salvo.
  • Cada cobrança é um pedido de recarga normal, marcado como Automática. Ela recebe o mesmo bônus que uma recarga manual do mesmo valor, e você pode emitir fatura para ela.
  • O teto mensal conta meses do calendário em UTC. Quando ele se esgota, a recarga automática espera até o dia 1º do mês seguinte. Cobranças que falham não contam para o teto.
  • Se uma cobrança falhar, tentamos de novo depois de 1 hora e outra vez depois de 6 horas. Se a terceira tentativa seguida também falhar, a recarga automática se desliga sozinha. Se o banco recusar o cartão de forma definitiva (por exemplo, um cartão roubado ou cancelado), ela se desliga na hora. Uma cobrança bem-sucedida zera a contagem.
  • Depois que ela se desligou sozinha, resolva o problema do cartão (ou salve um novo) e ligue-a de novo.
  • Desligar a recarga automática interrompe as cobranças futuras a qualquer momento. Isso nunca altera o seu saldo nem as recargas que já foram feitas.

Combine com um alerta de saldo baixo

Em Notificações, ligue o Alerta de saldo baixo e escolha um valor de referência. Você recebe uma notificação (e um e-mail, nas contas que têm endereço de e-mail) quando o saldo fica abaixo dele, mesmo que a recarga automática esteja desligada ou tenha falhado.

Crie uma chave de API

Abra Chaves de API: spicyapi.ai/console/keys e escolha Criar chave (ou Criar a primeira chave).

Qual conta paga por esta chave

Uma chave pertence ao escopo selecionado no topo da barra lateral esquerda. Se você nunca entrou numa equipe, esse escopo é sempre Pessoal, e a chave gasta o seu próprio saldo. Se você escolher uma equipe ali antes, a chave pertence a essa equipe, e toda tarefa enviada com ela é paga pelo proprietário da equipe. Veja Console e equipes.

Na janela Criar uma chave de API, só o nome é obrigatório. Tudo o que fica em Avançado pode ser alterado depois.

Nome. Dê à chave o nome do que vai usá-la, como production backend ou my laptop. Você vai precisar reconhecê-la quando for revogá-la. Até 120 caracteres.

Limites de gasto (em Avançado, em dólares americanos). Quando um limite é atingido, esta chave recusa novas tarefas com 40202 até o período virar. Suas outras chaves continuam funcionando. O dinheiro reservado para tarefas que ainda estão rodando conta para todos os limites.

CampoO que limitaQuando recomeçaSe você deixar em branco ao criar
Limite diárioQuanto esta chave pode gastar num diaTodo dia às 00:00 UTCSem limite diário. É o primeiro que vale a pena configurar: ele contém uma chave vazada ou um script fora de controle dentro de um dia
Orçamento mensalQuanto esta chave pode gastar num mês do calendárioNo dia 1º de cada mês, às 00:00 UTCSem limite mensal
Limite acumuladoTudo o que esta chave pode gastar enquanto existirNuncaSem limite acumulado

Informe 0 em qualquer limite para ficar sem limite; deixar o campo em branco tem o mesmo efeito.

Zerar um limite o remove

Quando, mais tarde, você escolhe Editar numa chave existente, um campo de limite vazio significa sem limite. Para manter um limite, deixe um número no campo.

Acesso.

  • Modelos permitidos. Deixe em Todos os modelos (sem restrição) e a chave pode chamar todos os modelos, inclusive os que forem adicionados depois. Escolha modelos específicos e a chave recusa qualquer outro modelo com 40301.
  • IPs permitidos. Qualquer endereço aceita chamadas de qualquer lugar. Só estes aceita chamadas apenas dos endereços que você listar: IPv4, IPv6 ou faixas CIDR como 203.0.113.10, 198.51.100.0/24, separados por vírgulas, até 64 itens. Use o endereço público de onde o seu servidor faz as chamadas, e não um endereço de dentro da rede do seu escritório ou da sua casa. Chamadas de qualquer outro lugar são recusadas com 40302. Deixe em Qualquer endereço para um notebook, cujo endereço muda.
  • Validade. Escolha 7, 30 ou 90 dias, 1 ano, Nunca ou uma data exata. A chave para de funcionar no fim desse dia, em UTC, e a partir daí recebe o mesmo 401 de uma chave revogada.

Escolha Criar.

O que você deve ver: uma janela Chave criada mostrando a chave completa, que começa com sk-spicy-. Copie com Copiar a chave ou escolha Salvar como arquivo. Marque Já guardei esta chave em um lugar seguro e depois Concluído.

O que acabou de acontecer: esta é a única vez em que a chave completa aparece. Guardamos apenas um hash irreversível dela, então ninguém, nem a nossa equipe de suporte, consegue mostrá-la de novo. Se você a perder, revogue-a e crie outra.

Trate a chave como a senha do seu saldo

Qualquer pessoa que tenha a chave pode gastar o seu saldo até ser barrada por um limite ou pelo fim do saldo.

  • Guarde-a num gerenciador de senhas, numa variável de ambiente no seu próprio computador (próximo passo) ou nas configurações de segredos do seu servidor.
  • Nunca a coloque numa página da web, numa extensão de navegador, num aplicativo de celular ou num aplicativo de desktop que você entrega para outras pessoas. Tudo o que roda no aparelho de outra pessoa pode ser extraído de lá. Se um site ou aplicativo precisa de gerações, faça-o chamar o seu próprio servidor, e deixe o seu servidor chamar a SpicyAPI.
  • Nunca faça commit dela no Git, não a cole em chats ou e-mails, não a mostre em capturas de tela nem a envie ao suporte.

Depois, na mesma página:

  • Editar muda o nome, os limites, os modelos permitidos, os IPs permitidos e a validade. As alterações valem na hora.
  • Revogar interrompe a chave imediatamente e não pode ser desfeito. As tarefas que já tinham sido aceitas continuam rodando e continuam sendo cobradas.
  • Você pode ter até 50 chaves ativas num mesmo escopo. Use uma chave por aplicativo ou ambiente, para poder revogar uma sem parar as outras.

Coloque a chave em SPICY_API_KEY

Uma variável de ambiente é um valor com nome que o seu terminal entrega aos programas que ele inicia. O SDK, a CLI e o servidor MCP oficiais, e todos os exemplos desta documentação, leem a sua chave de uma variável chamada SPICY_API_KEY. Assim, a chave nunca precisa ser digitada num comando nem salva dentro de um projeto.

Primeiro abra um terminal: no macOS, aperte Cmd + Espaço, digite Terminal e aperte Enter. No Windows, abra o menu Iniciar, digite PowerShell e abra o Windows PowerShell.

Só para a janela de terminal atual (esquecido quando você a fecha):

export SPICY_API_KEY="sk-spicy-paste-your-key-here"

De forma permanente: adicione essa mesma linha export ao final do arquivo de inicialização do seu shell, que roda toda vez que um terminal é aberto. No macOS, o arquivo é ~/.zshrc; na maioria dos sistemas Linux, é ~/.bashrc.

nano ~/.zshrc

Cole a linha no final, aperte Ctrl + O e depois Enter para salvar, e Ctrl + X para sair. Em seguida, abra uma nova janela de terminal.

Confira sem imprimir a chave inteira:

echo "${SPICY_API_KEY:0:9}"

Esperado: sk-spicy-. Uma linha vazia significa que a variável não está definida nesta janela.

Num servidor, defina SPICY_API_KEY nas configurações de segredos ou de ambiente do seu provedor de hospedagem, e não num arquivo dentro do seu projeto.

Faça uma chamada de teste grátis

Esta chamada consulta o seu saldo. Ela não custa nada, não cria nada e prova três coisas de uma vez: a chave está definida, a chave é válida e a sua conta tem permissão para chamar a API.

curl https://api.spicyapi.ai/api/v1/chat/credit \
  -H "Authorization: Bearer $SPICY_API_KEY"

Esperado: uma resposta como esta (resumida):

{
  "code": 200,
  "msg": "success",
  "data": {
    "available": "25",
    "held": "0",
    "total": "25"
  },
  "request_id": "req_01k..."
}

O que significa: "code": 200 é sucesso. Os valores estão em dólares americanos, escritos como texto. available é o que você pode gastar em novas gerações, held é o que está reservado para gerações ainda em andamento, e total é a soma dos dois. A resposta real também traz um objeto funding, que separa o dinheiro pago de eventuais verbas promocionais; por enquanto, você pode ignorá-lo.

Se aparecer outra coisa:

Você vêSignificadoComo resolver
"code": 401 com Missing credentials…A chave não chegou até nósSPICY_API_KEY não está definida nesta janela. Repita o passo 5 e abra uma nova janela
"code": 401 com API key format is not recognized…O que foi enviado não é uma chave da SpicyAPICopie a chave de novo; ela precisa começar com sk-spicy- e não pode ter espaços nem aspas no meio
"code": 401 com Credentials are invalid or expiredA chave está errada, foi revogada ou passou da validadeConfira o status da chave em Chaves de API ou crie uma nova
"code": 403 com This account cannot call the API right nowA chave está certa, mas a conta ainda não pode usar a API, normalmente porque o e-mail não foi confirmadoConfirme o seu e-mail (passo 1) e tente de novo
"code": 40302A lista de IPs permitidos da chave não inclui o endereço de onde você está chamandoEdite a chave e adicione o seu endereço público, ou volte para Qualquer endereço
"code": 40303O serviço não está disponível onde você estáVeja Responsabilidade sobre conteúdo e uso
"available": "0"Tudo funciona, mas ainda não há dinheiroConclua o passo 2. A sua primeira geração seria recusada com 40201

Prefere não usar curl? A CLI faz o mesmo com spicyapi balance.

Tudo pronto. Antes da primeira geração, confira quanto ela vai custar: toda página de modelo em spicyapi.ai mostra o preço, e a API pode cotar uma tarefa antes de você criá-la.

Próximos passos

Regras do saldo

  • Dólares, não pontos. Preços e saldos são em dólares americanos, então o preço na página de um modelo é o que sai do seu saldo. Não há assinatura nem mensalidade.
  • O saldo pago nunca expira. O bônus promocional, como uma recompensa de indicação ou um bônus de recarga, é gasto primeiro e expira na data mostrada em Faturamento.
  • Você paga por tarefa. Quando uma tarefa é aceita, o preço estimado dela é separado ("reservado") do seu saldo disponível. Se a tarefa der certo, você é cobrado pelo que foi realmente usado, nunca mais do que o valor reservado, e o restante volta. Tarefas que falham ou expiram normalmente liberam toda a reserva. Algumas recusas de conteúdo são cobradas pelo orçamento aceito, somente quando a página do modelo informa explicitamente essa exceção. Confira settled e cost para saber o valor final.
  • Saldo não é dinheiro vivo. Recargas não são reembolsáveis e o saldo não pode ser sacado. Se uma cobrança parecer errada, como uma cobrança contrária às condições da página do modelo, uma recarga cobrada em dobro ou um pagamento que nunca chegou ao seu saldo, envie um e-mail para support@spicyapi.ai a partir do endereço da sua conta com o ID da tarefa ou do pedido, a data e o valor. Nós analisamos e corrigimos no seu saldo os erros confirmados. Os detalhes estão na política de reembolso.
  • Bônus não têm valor em dinheiro. Um bônus é lançado separadamente do que você pagou e não é reembolsado nem pago em dinheiro.
  • Bônus promocional e crédito aprovado só aparecem em Detalhes do saldo, dentro de Faturamento, se a sua conta tiver algum deles. O bônus promocional pode valer só para certos modelos e pode expirar. O crédito só fica disponível depois de uma aprovação à parte.
  • Contestações de pagamento pausam os gastos. Se um pagamento com cartão for contestado junto ao seu banco (chargeback), as novas tarefas da conta ficam pausadas enquanto o caso é investigado. Se uma cobrança parecer errada, fale com a gente primeiro; costuma ser mais rápido.
  • Encerrar a conta faz você perder o saldo. Ele não é reembolsado nem sacado, então gaste-o antes. Veja Console e equipes.
  • As chaves de equipe usam o saldo do proprietário. Membros de uma equipe nunca pagam pelas tarefas dela e nunca veem o saldo do proprietário.

Faturas e recibos

Tudo fica em Faturamento → Faturas: spicyapi.ai/console/billing/invoices.

  1. Preencha seus dados de faturamento uma única vez. Escolha Preencher dados de faturamento. Obrigatórios: um nome (da sua organização ou o seu próprio), a linha 1 do endereço, a cidade e o país. A identificação fiscal (por exemplo, um VAT ID da União Europeia) é opcional. Os dados são impressos exatamente como você os digita, e só caracteres latinos, gregos e cirílicos podem ser impressos, então escreva o nome de uma empresa japonesa ou coreana na forma romanizada com que ela foi registrada.
  2. Escolha Nova fatura e indique a que ela se refere:
    • Um pagamento de recarga: uma fatura de pagamento de uma recarga que você já pagou. É este o documento para comprovar o pagamento, por exemplo para pedir reembolso de despesas ou para a contabilidade.
    • Um mês de uso: uma lista detalhada do que você gastou num mês já encerrado. Não é um comprovante de pagamento. Esse dinheiro foi pago quando você fez a recarga, então não apresente os dois documentos pelo mesmo dinheiro.
  3. Escolha Emitir fatura e depois Baixar PDF.

Bom saber:

  • Não é acrescentado VAT nem GST. Toda fatura traz a menção de reverse charge (inversão da responsabilidade pelo imposto), então qualquer imposto devido no seu país fica por sua conta.
  • Cada recarga paga e cada mês encerrado podem ser faturados uma única vez. Se já existir uma fatura, baixe essa em vez de emitir outra.
  • Dados errados? Corrija-os e escolha Emitir de novo: a fatura antiga é marcada como anulada e uma substituta, com número novo, cobre a mesma coisa. Use Cancelar sem substituir só quando a fatura cobre a recarga errada ou o mês errado. Só é permitido um número limitado de alterações de fatura por hora.
  • Os Extratos mensais, mais abaixo na mesma página, são retratos em CSV da movimentação do saldo de um mês, para a sua própria conciliação. Não são recibos nem documentos fiscais.
  • Numa equipe, as faturas pertencem à conta do proprietário da equipe, porque foi ele quem pagou.

Problemas comuns

Nesta página