Usar a ReOpenly a partir de um agente

Um agente, um script ou um job de CI pode operar a plataforma inteira com uma chave de API: criar projetos, carregar dados, treinar, hospedar, servir, compartilhar, buscar e ler a cobrança. Três passos exigem uma pessoa, e algumas configurações da conta recusam a chave de API de propósito. Esta página lista os dois casos e depois como encontrar e chamar todo o resto.

O que exige uma pessoa

Passo	Por quê	O que o agente faz no lugar
Criar a conta	O cadastro acontece no navegador e termina com a pessoa aceitando os Termos. Esse aceite precisa ser dela.	Pedir à pessoa que se cadastre em reopenly.com.
Emitir a primeira chave de API	A primeira chave é criada a partir de uma sessão conectada.	Com uma chave, o agente cria, rotaciona e revoga chaves sozinho com POST /api/v1/keys.
Pagar por créditos	POST /api/v1/credits/checkout retorna uma página de pagamento que uma pessoa conclui.	Entregar a url retornada à pessoa e consultar GET /api/v1/credits/checkout/status.

O que uma chave de API não altera

Estas rotas respondem 403 a uma chave de API, para que uma chave vazada não assuma a conta: nome de exibição, senha e e-mail (PATCH /api/v1/me/profile, POST /api/v1/me/password, POST /api/v1/me/email e seu passo de verificação), e as escolhas de privacidade em /api/v1/me/preferences.

Encontrar a API

• /llms.txt indexa o site, e /docs/llms.txt lista cada operação pública com uma página em Markdown.
• O documento OpenAPI, em inglês e português. Cada operação diz o que faz, quando usar e o que retorna; cada requisição e resposta JSON traz um exemplo conferido contra a API; e uma operação que não exige chave informa isso com security: [].
• GET /api/v1/me retorna o slug do seu workspace, o owner_slug de toda URL de projeto sua. GET /api/v1/base-models lista os modelos que você pode treinar e os limites de cada configuração.

O que um agente faz com uma chave

Tarefa	Operações principais
Usar um modelo base, sem projeto	GET /api/openai/v1/models, depois POST /api/openai/v1/chat/completions ou POST /api/openai/v1/embeddings (você paga pelo uso; nada é salvo)
Curar dados de chat	POST .../chats/bulk, GET .../tags
Curar dados de embeddings	POST .../datasets, POST .../examples, importação de arquivos
Treinar	GET .../training-jobs/estimate-messages ou POST .../training-jobs/preview, depois POST .../training-jobs e GET .../training-jobs/{job_id}
Controlar uma execução	cancel antes de o treino começar, pause depois, e então resume ou finish
Hospedar e servir	POST .../models, depois as rotas compatíveis com OpenAI
Compartilhar	POST .../models/{model_slug}/shares; quem recebe encontra em GET /api/v1/models
Buscar	POST .../search/indexes, depois .../query
Coletar dados de treino de buscas	POST .../retrieval-events, depois .../promote
Acompanhar o gasto	GET /api/v1/credits, GET /api/v1/credits/usage

Repetir com segurança

• Inferência: repita automaticamente só quando o code do erro for model_warming ou overloaded. Qualquer outro é permanente, um erro seu ou uma requisição que pode já ter sido cobrada.
• Treino: POST .../training-jobs não recebe chave de idempotência. Uma conta executa um treinamento não concluído por vez, então um segundo início responde 409 training_slot_occupied; depois de um timeout, liste os treinamentos antes de tentar de novo. .../resume e .../retry exigem o cabeçalho Idempotency-Key.
• Pagamento: envie um Idempotency-Key novo por tentativa de compra.
• Importações: .../confirm recebe um idempotency_key no corpo.
• Buscas registradas: o event_id é a chave de idempotência; reenviar o mesmo corpo retorna 200.

Todo erro de /api/v1 é {"detail": {"code", "message"}}: decida pelo code e mostre a message. Veja Erros.