Pular para o conteúdo
FreshApp Demo

API ABERTA

Gere a partir do seu próprio código

Use os modelos do site a partir do seu servidor. Crie uma geração com uma chave de API, acompanhe até ela terminar e baixe os arquivos.

Ler a documentação da APIGerenciar chaves de API

A API gasta apenas créditos pagos: um pacote de créditos pago ou uma assinatura paga ativa a libera. Guarde suas chaves no seu servidor.

EXEMPLO DE REQUISIÇÃO

Crie sua primeira geração

export API_ORIGIN='https://demo.freshapp.ai'
export API_KEY='sk_YOUR_API_KEY'

curl --fail-with-body "$API_ORIGIN/api/v1/generations" \
  -H "Authorization: Bearer $API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: order-1001' \
  -d '{"model":"seed-audio-1.0","input":{"prompt":"Um farol em um penhasco ao amanhecer, mar calmo, luz suave."}}'

# Read it every 5 to 10 seconds until its status ends.
curl --fail-with-body "$API_ORIGIN/api/v1/generations/GENERATION_ID" \
  -H "Authorization: Bearer $API_KEY"

# A delivered output's url is a signed link: no key needed.
curl --fail-with-body -o result "OUTPUT_URL"

Primeiro defina API_KEY com a sua chave. Envie uma Idempotency-Key nova a cada nova requisição, e a mesma quando reenviar essa requisição.

COMO FUNCIONA

Três passos da requisição ao arquivo

  1. Crie uma geração

    Envie o id de um modelo e a entrada dele com sua chave de API e uma Idempotency-Key. A resposta é a geração, na fila, com os créditos que ela reserva.

  2. Acompanhe

    Consulte a geração a cada 5 a 10 segundos até ela ter sucesso, sucesso parcial, falhar ou ser cancelada. O que ela não usou volta na liquidação.

  3. Baixe os arquivos

    Cada saída entregue aponta para o arquivo dela neste site. Os links que uma chave recebe são assinados e abrem por uma hora sem a chave.

PERMISSÕES E LIMITES

Chaves que só fazem o que você permite

  • Uma chave só lê (lista, consulta e baixa) ou também pode gerar (cria e cancela), e uma lista de IPs permitidos pode prendê-la aos seus servidores.

  • Uma requisição reserva no máximo 150 créditos, a requisição mais cara dos modelos ativados; a configuração da chave ou o max_credits da requisição só podem baixá-lo.

  • Uma chave gasta no máximo 5.000 créditos por dia UTC, e todas as chaves de uma conta juntas 10.000, a menos que você defina outros limites na página de chaves de API.

  • Por chave e por conta: 20 criações e cancelamentos e 240 consultas e downloads por minuto, e no máximo 2 gerações rodando ao mesmo tempo.

ARQUIVOS

O arquivo OpenAPI e um cliente TypeScript

O arquivo OpenAPI 3.1 descreve cada operação, a entrada de cada modelo ativado e cada código de erro. O cliente TypeScript não precisa de mais nada: mantém a mesma Idempotency-Key entre as tentativas e acompanha uma geração até o fim, e o hook do React consulta com ele.

Ler a documentação da APIArquivo OpenAPI 3.1Cliente TypeScriptHook do React para acompanhar

PERGUNTAS FREQUENTES

Perguntas sobre a API