Ocoya
API

Integre a publicação social no seu produto.

Uma API REST simples, com especificação OpenAPI publicada, permite integrar a publicação social com IA em qualquer app, fluxo de trabalho ou agente que construa.

POST /v1/post
curl -X POST https://app.ocoya.com/api/_public/v1/post \
-H "X-API-Key: $OCOYA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"socialProfileIds": ["sp_8f2a1c"],
"caption": "New summer menu is here ☀️",
"media": ["https://cdn.example.com/summer.jpg"],
"scheduledAt": "2026-09-01T09:00:00Z"
}'
201 Created
{
"id": "post_8f2a1c",
"status": "SCHEDULED",
"scheduledAt": "2026-09-01T09:00:00Z"
}

REST + OpenAPI simples

Recursos REST previsíveis com especificação OpenAPI publicada — gere um cliente em qualquer linguagem.

Autenticação por chave de API

Envie um cabeçalho X-API-Key — crie e revogue chaves por marca nas definições.

IA incluída

A mesma geração de publicações e campanhas com IA da app, disponível a partir do seu backend.

O mesmo motor da app

Cada endpoint espelha o que faz funcionar a própria Ocoya — sem nada guardado.

OpenAPI

Uma especificação a partir da qual pode gerar um cliente.

Toda a superfície v1 está disponível como documento OpenAPI, por isso não tem de ler texto e escrever objetos de pedido à mão. Gere um cliente tipado na linguagem com que já trabalha ou aponte o Postman, o Insomnia ou as suas próprias ferramentas diretamente para ela.

  • Clientes tipados em qualquer linguagem suportada pelos geradores
  • Os formatos de pedido e resposta mantêm-se sincronizados com a API
  • Use-a nas suas ferramentas de API atuais sem alterações
openapi.jsonv1
{
"openapi": "3.1.0",
"paths": {
"/v1/post": { ... },
"/v1/campaigns": { ... }
}
}
TypeScriptPythonGoRubyPHPJava

Gere um cliente tipado na linguagem que já usa ou aponte as suas ferramentas de API diretamente para a especificação.

Assíncrona por defeito

Tarefas longas respondem de imediato.

A geração de campanhas com IA é colocada em fila em vez de correr dentro do seu pedido. A chamada devolve logo o id da campanha; consulte o recurso e as publicações vão aparecendo à medida que são escritas, para que nada na sua app fique à espera de um modelo.

  • A criação de campanhas responde de imediato com um id
  • Consulte o recurso da campanha para ver as publicações a surgir
  • A geração com IA usa os mesmos créditos da app
POST /v1/campaignsgenerating
// returns immediately
{ "id": "cmp_8fa2", "status": "generating", "posts": 8 }
Publicação 1 — Instagram
Publicação 2 — LinkedIn
Publicação 3 — X
Publicação 4 — Instagram
Publicação 5 — TikTok

A chamada responde de imediato. Consulte o recurso da campanha e as publicações aparecem à medida que são geradas — nada bloqueia o seu pedido.

Recursos

Tudo o que a app faz, disponível diretamente.

Oito recursos REST cobrem toda a plataforma — publicação, campanhas com IA, recursos da marca, fluxos de trabalho e marcas.

/v1/post

Crie, agende, atualize e publique publicações nas redes ligadas.

/v1/campaigns

Coloque em fila a geração de campanhas com IA e acompanhe as publicações à medida que surgem.

/v1/social-profiles

Liste os perfis ligados e inicie novas ligações sociais.

/v1/hashtag-libraries

Obtenha conjuntos de hashtags selecionados para associar às publicações de forma programática.

/v1/studio-templates

Liste os modelos de design reutilizáveis do Studio para novos conteúdos.

/v1/workflow

Inspecione, ative ou desative e execute fluxos de trabalho de automação a pedido.

/v1/brands

Enumere as marcas e delimite corretamente cada chamada.

/v1/me

Inspecione o token — quem sou e a que tenho acesso?

Ciclo de vida da publicação

Sabe sempre em que ponto está uma publicação.

Cada publicação tem um de oito estados e pode filtrar por qualquer um deles. Consulte uma campanha enquanto é gerada, retenha publicações até serem aprovadas ou alerte os seus sistemas assim que algo precisar de uma pessoa.

As falhas nunca desaparecem em silêncio — NEEDS_ATTENTION e ERROR incluem o motivo indicado pela rede, para que o possa mostrar na sua própria interface.

GET /v1/post?statuses=

8 valores
GENERATING
DRAFT
PENDING_INTERNAL_APPROVAL
PENDING_CLIENT_APPROVAL
SCHEDULED
POSTED
NEEDS_ATTENTION
ERROR

Pedidos nesta janela

60s

RateLimit-Limit

60

RateLimit-Remaining

17

RateLimit-Reset

38

429 Too Many Requests
{
"message": "You've exceeded the request limit."
}
Limites

Limites previsíveis, cabeçalhos padrão.

60 pedidos por minuto por defeito. Cada resposta inclui os cabeçalhos padrão RateLimit-* para que o seu cliente abrande antes de receber um 429 — sem adivinhas, sem limitações não documentadas.

Leia o orçamento restante em cada respostaUm 429 diz exatamente quando tentar de novoA publicação em massa corre no servidor, não pedido a pedido
Onboarding

Deixe os seus utilizadores ligarem as próprias contas.

Peça um URL de ligação e entregue-o ao seu utilizador. Ele aprova na própria rede e o perfil fica na sua marca, pronto a publicar — nunca toca num token social e ele nunca vê a Ocoya.

É isto que torna a API viável para um produto com clientes próprios, e não apenas para automatizar a sua própria conta.

1A sua appPOST /v1/social-profiles/connection-url
2OcoyaDevolve um URL de início OAuth de utilização única
3O seu utilizadorAprova no Instagram, X, LinkedIn…
4A sua appO perfil aparece em /v1/social-profiles

Os seus utilizadores nunca veem um login da Ocoya — a ligação fica na sua marca.

Está antes a construir um agente de IA?

A mesma plataforma está disponível através do MCP — mais de 20 ferramentas que o seu agente pode chamar diretamente, sem código de ligação REST.

Explorar o MCP
Perguntas

A API: respostas.

Crie uma chave de API em Settings → API e envie-a no cabeçalho X-API-Key para o URL base https://app.ocoya.com/api/_public/v1. As chaves são delimitadas por marca e podem ser revogadas a qualquer momento — mantenha-as no servidor.

Comece a integrar a publicação social.

Obtenha o seu token da API e faça a primeira chamada em minutos.