Referência da API
Versão da API 2026-11-09 · Baixar YAML OpenAPI 3.1
A autenticação usa uma chave de produto com escopo do espaço de trabalho: Authorization: Bearer pk_v1_…. As chaves carregam escopos explícitos e uma allowlist opcional de contas; elas nunca podem criar outras chaves nem alterar cobranças.
Todas as mutações exigem um cabeçalho Idempotency-Key; edições e agendamentos também exigem expectedVersion. Publish e schedule retornam 202 Accepted com um ID de entrega por destino: 202 nunca afirma que algo foi publicado. Verifique os resultados via GET /posts/{id}, webhooks do cliente ou sondagem limitada com backoff.
Os erros usam o envelope normalizado do contrato v1: code, message seguro, fieldErrors, destinationErrors, retryable, retryAfterSeconds e requestId. Por opção de design, não há código de erro de crédito ou cota de publicação.
Autenticação
Envie uma chave de produto do workspace como "Authorization: Bearer pk_v1_…". Cada operação lista os escopos exigidos. Veja autenticação e permissões.
GET /capabilities
Formatos e opções elegíveis para destinos permitidos
Requer o escopo accounts:read.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"accounts"
],
"summary": "Formatos e opções elegíveis para destinos permitidos",
"description": "Requer o escopo `accounts:read`.",
"responses": {
"200": {
"description": "Capability list",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"capabilities",
"requestId"
],
"properties": {
"capabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Capability"
}
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /accounts
Lista as contas de destino visíveis para esta chave
Honra a allowlist de contas da chave. Requer o escopo accounts:read.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"accounts"
],
"summary": "Lista as contas de destino visíveis para esta chave",
"description": "Honra a allowlist de contas da chave. Requer o escopo `accounts:read`.",
"parameters": [
{
"$ref": "#/components/parameters/cursor"
},
{
"$ref": "#/components/parameters/limit"
}
],
"responses": {
"200": {
"description": "Account page",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"accounts",
"requestId"
],
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /accounts/{id}/tiktok/settings
Lê as configurações verificadas do criador do TikTok para uma conta conectada permitida
Requer accounts:read e a allowlist de contas da chave. Esta leitura nunca fornece consentimento humano de publicação.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"accounts"
],
"summary": "Lê as configurações verificadas do criador do TikTok para uma conta conectada permitida",
"description": "Requer accounts:read e a allowlist de contas da chave. Esta leitura nunca fornece consentimento humano de publicação.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Current typed creator settings; a person must confirm choices in the composer",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"settings",
"humanConfirmationRequired",
"requestId"
],
"properties": {
"settings": {
"$ref": "#/components/schemas/TikTokCreatorSettings"
},
"humanConfirmationRequired": {
"type": "boolean",
"const": true
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /media/upload-intents
Reserva bytes e retorna instruções de upload direto
Requer o escopo media:write mais uma Idempotency-Key. Os bytes são enviados DIRETAMENTE ao armazenamento de objetos privado usando as instruções retornadas; eles nunca passam por esta API. Não existe URL pública permanente de mídia.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"media"
],
"summary": "Reserva bytes e retorna instruções de upload direto",
"description": "Requer o escopo `media:write` mais uma Idempotency-Key. Os bytes são enviados DIRETAMENTE ao armazenamento de objetos privado usando as instruções retornadas; eles nunca passam por esta API. Não existe URL pública permanente de mídia.\n",
"parameters": [
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadIntentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Upload instructions created",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadIntentResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /media/{id}
Status e expiração da mídia (sem URL pública permanente)
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"media"
],
"summary": "Status e expiração da mídia (sem URL pública permanente)",
"parameters": [
{
"$ref": "#/components/parameters/id"
}
],
"responses": {
"200": {
"description": "Media status",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"media",
"requestId"
],
"properties": {
"media": {
"$ref": "#/components/schemas/MediaStatus"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /media/{id}/upload-parts
Renova de uma a 64 URLs de PUT multipart em uma sessão de upload existente
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"media"
],
"summary": "Renova de uma a 64 URLs de PUT multipart em uma sessão de upload existente",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"fromPart",
"toPart"
],
"properties": {
"fromPart": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"toPart": {
"type": "integer",
"minimum": 1,
"maximum": 10000
}
}
}
}
}
},
"responses": {
"200": {
"description": "Fresh upload URLs; toPart must be at least fromPart and at most fromPart + 63",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"sessionId",
"parts",
"requestId"
],
"properties": {
"sessionId": {
"type": "string",
"format": "uuid"
},
"requestId": {
"type": "string"
},
"parts": {
"type": "array",
"items": {
"type": "object",
"required": [
"partNumber",
"url",
"expiresAt"
],
"properties": {
"partNumber": {
"type": "integer"
},
"url": {
"type": "string",
"format": "uri"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
}
}
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /media/{id}/abandon
Abandona um upload incompleto e libera a sua reserva de armazenamento
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"media"
],
"summary": "Abandona um upload incompleto e libera a sua reserva de armazenamento",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Abandoned; failed external cleanup remains durably queued",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"abandoned",
"requestId"
],
"properties": {
"abandoned": {
"type": "boolean",
"const": true
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /media/{id}/finalize
Verifica o objeto enviado e o torna utilizável
Requer o escopo media:write mais uma Idempotency-Key. O servidor verifica tamanho/MIME e assinaturas limitadas contra a cópia FINAL imutável; as reservas de bytes são liquidadas exatamente uma vez. Envie apenas a identidade da sessão (mais os recibos das partes multipart quando aplicável): o servidor observa todos os metadados por si mesmo.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"media"
],
"summary": "Verifica o objeto enviado e o torna utilizável",
"description": "Requer o escopo `media:write` mais uma Idempotency-Key. O servidor verifica tamanho/MIME e assinaturas limitadas contra a cópia FINAL imutável; as reservas de bytes são liquidadas exatamente uma vez. Envie apenas a identidade da sessão (mais os recibos das partes multipart quando aplicável): o servidor observa todos os metadados por si mesmo.\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinalizeRequest"
}
}
}
},
"responses": {
"200": {
"description": "Finalized",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"media",
"requestId"
],
"properties": {
"media": {
"$ref": "#/components/schemas/FinalizeResult"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /posts
Cria um rascunho
Requer o escopo posts:write mais uma Idempotency-Key. Os corpos são analisados com o DraftInputSchema estrito do contrato v1; contas de destino duplicadas são rejeitadas. O salvamento é permissivo: valide antes de publicar.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"posts"
],
"summary": "Cria um rascunho",
"description": "Requer o escopo `posts:write` mais uma Idempotency-Key. Os corpos são analisados com o DraftInputSchema estrito do contrato v1; contas de destino duplicadas são rejeitadas. O salvamento é permissivo: valide antes de publicar.\n",
"parameters": [
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftInput"
}
}
}
},
"responses": {
"201": {
"description": "Draft created",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"post",
"requestId"
],
"properties": {
"post": {
"$ref": "#/components/schemas/DraftSaveResult"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /posts
Lista publicações
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"posts"
],
"summary": "Lista publicações",
"parameters": [
{
"$ref": "#/components/parameters/cursor"
},
{
"$ref": "#/components/parameters/limit"
},
{
"name": "state",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Post page",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"posts",
"requestId"
],
"properties": {
"posts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostListItem"
}
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /posts/{id}
Status agregado da publicação e por destino
"Aceito pelo provedor" não é "Publicado". Os links nativos aparecem somente após um recibo confirmado; um permalink ausente não é prova de falha.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"posts"
],
"summary": "Status agregado da publicação e por destino",
"description": "\"Aceito pelo provedor\" não é \"Publicado\". Os links nativos aparecem somente após um recibo confirmado; um permalink ausente não é prova de falha.\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
}
],
"responses": {
"200": {
"description": "Post status",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"post",
"requestId"
],
"properties": {
"post": {
"$ref": "#/components/schemas/PostStatus"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}PATCH /posts/{id}
Edita um rascunho (com verificação de versão)
Requer Idempotency-Key e expectedVersion. Uma versão desatualizada retorna 409 revision_conflict com a versão atual em error.details.currentVersion.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"posts"
],
"summary": "Edita um rascunho (com verificação de versão)",
"description": "Requer Idempotency-Key e expectedVersion. Uma versão desatualizada retorna 409 revision_conflict com a versão atual em `error.details.currentVersion`.\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftUpdateInput"
}
}
}
},
"responses": {
"200": {
"description": "Updated draft",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"post",
"requestId"
],
"properties": {
"post": {
"$ref": "#/components/schemas/DraftSaveResult"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /posts/{id}/validate
Validação estruturada por destino (sem mutação)
Retorna 200 com validation.valid=false quando os destinos têm problemas (nunca um status de erro para problemas de conteúdo).
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"posts"
],
"summary": "Validação estruturada por destino (sem mutação)",
"description": "Retorna 200 com `validation.valid=false` quando os destinos têm problemas (nunca um status de erro para problemas de conteúdo).\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expectedVersion": {
"type": "integer",
"minimum": 1
}
}
}
}
}
},
"responses": {
"200": {
"description": "Validation result",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"validation",
"requestId"
],
"properties": {
"validation": {
"$ref": "#/components/schemas/ValidationResult"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /posts/{id}/publish
Publicar agora (202)
Requer o escopo posts:publish mais uma Idempotency-Key. O expectedVersion opcional aplica a mesma garantia de concorrência otimista da edição. Retorna um ID de entrega por destino; nunca afirma Publicado.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"posts"
],
"summary": "Publicar agora (202)",
"description": "Requer o escopo `posts:publish` mais uma Idempotency-Key. O `expectedVersion` opcional aplica a mesma garantia de concorrência otimista da edição. Retorna um ID de entrega por destino; nunca afirma Publicado.\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"expectedVersion": {
"type": "integer",
"minimum": 1
}
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted for dispatch",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptedOperation"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /posts/{id}/schedule
Agendar a revisão congelada (202)
Requer o escopo posts:publish mais Idempotency-Key e expectedVersion. Um único instante para todo o lote; deve estar no futuro e dentro do horizonte de 90 dias (aplicado pelo serviço compartilhado). revisionId deve ser nulo na V1: selecionar uma revisão arbitrária não é suportado e é rejeitado.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"posts"
],
"summary": "Agendar a revisão congelada (202)",
"description": "Requer o escopo `posts:publish` mais Idempotency-Key e expectedVersion. Um único instante para todo o lote; deve estar no futuro e dentro do horizonte de 90 dias (aplicado pelo serviço compartilhado). `revisionId` deve ser nulo na V1: selecionar uma revisão arbitrária não é suportado e é rejeitado.\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleRequest"
}
}
}
},
"responses": {
"202": {
"description": "Scheduled",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptedOperation"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /deliveries/{id}/cancel
Cancela um trabalho de destino se estiver seguramente não reivindicado
Requer o escopo posts:publish mais Idempotency-Key. Entregas já enviadas retornam 409 too_late_to_cancel com o estado real.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"deliveries"
],
"summary": "Cancela um trabalho de destino se estiver seguramente não reivindicado",
"description": "Requer o escopo `posts:publish` mais Idempotency-Key. Entregas já enviadas retornam 409 too_late_to_cancel com o estado real.\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"responses": {
"200": {
"description": "Cancellation result",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"delivery",
"requestId"
],
"properties": {
"delivery": {
"type": "object",
"required": [
"deliveryId",
"canceled",
"state"
],
"properties": {
"deliveryId": {
"type": "string"
},
"canceled": {
"type": "boolean"
},
"state": {
"type": "string"
}
}
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /deliveries/{id}/retry
Repete um destino com falha conhecida
Requer o escopo posts:publish mais Idempotency-Key. Resultados desconhecidos ou entregas bem-sucedidas são recusados: repetir poderia duplicar a publicação.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"deliveries"
],
"summary": "Repete um destino com falha conhecida",
"description": "Requer o escopo `posts:publish` mais Idempotency-Key. Resultados desconhecidos ou entregas bem-sucedidas são recusados: repetir poderia duplicar a publicação.\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"responses": {
"200": {
"description": "Retry accepted",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"delivery",
"requestId"
],
"properties": {
"delivery": {
"type": "object",
"required": [
"deliveryId",
"state"
],
"properties": {
"deliveryId": {
"type": "string"
},
"state": {
"type": "string"
}
}
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /usage
Plano, uso de contas/assentos/armazenamento, atividade e informações de taxa
Requer o escopo usage:read. Não contém NENHUM contador de publicações restantes de qualquer tipo: publicar é ilimitado em todos os planos pagos.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"usage"
],
"summary": "Plano, uso de contas/assentos/armazenamento, atividade e informações de taxa",
"description": "Requer o escopo `usage:read`. Não contém NENHUM contador de publicações restantes de qualquer tipo: publicar é ilimitado em todos os planos pagos.\n",
"responses": {
"200": {
"description": "Usage snapshot",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"usage",
"requestId"
],
"properties": {
"usage": {
"$ref": "#/components/schemas/Usage"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /webhooks
Registra um destino de eventos do cliente
Requer o escopo webhooks:manage mais Idempotency-Key. Apenas HTTPS; a validação de SSRF (esquema, credenciais, endereço resolvido por DNS dentro dos limites) é executada antes do armazenamento. O segredo de assinatura é retornado apenas na PRIMEIRA resposta de criação: um replay idempotente retorna o endpoint sem o segredo. A criação também enfileira um evento de verificação direcionado.
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"webhooks"
],
"summary": "Registra um destino de eventos do cliente",
"description": "Requer o escopo `webhooks:manage` mais Idempotency-Key. Apenas HTTPS; a validação de SSRF (esquema, credenciais, endereço resolvido por DNS dentro dos limites) é executada antes do armazenamento. O segredo de assinatura é retornado apenas na PRIMEIRA resposta de criação: um replay idempotente retorna o endpoint sem o segredo. A criação também enfileira um evento de verificação direcionado.\n",
"parameters": [
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWebhookRequest"
}
}
}
},
"responses": {
"201": {
"description": "Endpoint created (secret shown once)",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"webhook",
"requestId"
],
"properties": {
"webhook": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookEndpoint"
},
{
"type": "object",
"properties": {
"secret": {
"type": [
"string",
"null"
],
"description": "Present only on the first successful creation; null on replay."
}
}
}
]
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /webhooks
Lista os destinos de eventos (sem segredos)
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"webhooks"
],
"summary": "Lista os destinos de eventos (sem segredos)",
"responses": {
"200": {
"description": "Endpoint list",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"webhooks",
"requestId"
],
"properties": {
"webhooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookEndpoint"
}
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}DELETE /webhooks/{id}
Remove um destino de eventos
Requer o escopo webhooks:manage e Idempotency-Key (repetições são seguras).
Os detalhes da operação incluem parâmetros, corpos de requisição, respostas e referências de componentes. Definições referenciadas aparecem abaixo.
{
"tags": [
"webhooks"
],
"summary": "Remove um destino de eventos",
"description": "Requer o escopo `webhooks:manage` e Idempotency-Key (repetições são seguras).",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"responses": {
"204": {
"description": "Deleted",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}Definições compartilhadas
securitySchemes
productKey
{
"type": "http",
"scheme": "bearer",
"bearerFormat": "pk_v1_… (product key; NOT a Supabase key)"
}parameters
id
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}cursor
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
}limit
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 25
}
}idempotencyKey
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": "Mesma chave + mesmo corpo normalizado repete o resultado registrado; mesma chave + corpo diferente retorna 409 idempotency_conflict.\n"
}headers
requestId
{
"description": "ID de correlação por requisição, também ecoado nos envelopes de erro.",
"schema": {
"type": "string"
}
}retryAfter
{
"description": "Segundos até a próxima janela de limite de taxa.",
"schema": {
"type": "integer"
}
}responses
Forbidden
{
"description": "A chave não tem o escopo exigido, ou o recurso pertence a outro espaço de trabalho.",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}PaymentRequired
{
"description": "Problema de titularidade (assinatura inativa, teste expirado, limite de contas/assentos/armazenamento).",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}NotFound
{
"description": "O recurso não existe no espaço de trabalho de quem chamou.",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}Conflict
{
"description": "Conflito de versão/idempotência/cancelamento/consentimento/estado de entrega.",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}Validation
{
"description": "O corpo da requisição ou o conteúdo do destino falhou na validação.",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}RateLimited
{
"description": "Limite técnico de taxa por espaço de trabalho. Apenas controle de velocidade: nunca uma cota de publicação.",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
},
"Retry-After": {
"$ref": "#/components/headers/retryAfter"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}ServerError
{
"description": "5XX seguro (provedor indisponível ou erro interno inesperado). Nunca contém diagnósticos brutos.",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}schemas
Error
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"required": [
"code",
"message",
"requestId"
],
"properties": {
"code": {
"type": "string",
"enum": [
"unauthenticated",
"forbidden_scope",
"account_not_allowed",
"account_limit",
"seat_limit",
"storage_limit",
"subscription_inactive",
"trial_expired",
"validation_failed",
"unsupported_format",
"consent_required",
"reconnect_required",
"destination_identity_changed",
"revision_conflict",
"idempotency_conflict",
"too_late_to_cancel",
"media_expired",
"media_deleting",
"rate_limited",
"provider_unavailable",
"submission_unknown",
"destination_conflict",
"not_found",
"internal_error"
]
},
"message": {
"type": "string"
},
"fieldErrors": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"code",
"message"
],
"properties": {
"field": {
"type": "string"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"destinationErrors": {
"type": "array",
"items": {
"type": "object",
"required": [
"accountId",
"code",
"message"
],
"properties": {
"accountId": {
"type": "string"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"retryable": {
"type": "boolean"
},
"retryAfterSeconds": {
"type": "integer"
},
"details": {
"type": "object",
"additionalProperties": true,
"description": "Machine-readable extras, e.g. currentVersion for revision_conflict."
},
"requestId": {
"type": "string"
},
"requiresAction": {
"type": "object",
"description": "Session UI handoff for human consent; never contains credentials or grants access.",
"required": [
"type",
"url",
"accountIds"
],
"properties": {
"type": {
"type": "string",
"const": "human_consent"
},
"url": {
"type": "string",
"format": "uri-reference"
},
"accountIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Verified key workspace; the browser must verify membership before switching its selected workspace."
}
}
}
}
}
}
}Account
{
"type": "object",
"required": [
"id",
"network",
"destinationType",
"displayName",
"connectionState"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"network": {
"type": "string",
"example": "instagram"
},
"destinationType": {
"type": "string",
"example": "professional_account"
},
"displayName": {
"type": "string"
},
"connectionState": {
"type": "string",
"example": "connected"
},
"capabilityVersion": {
"type": [
"string",
"null"
]
}
}
}Capability
{
"type": "object",
"required": [
"accountId",
"network"
],
"properties": {
"accountId": {
"type": "string"
},
"network": {
"type": "string"
},
"networkEnabled": {
"type": "boolean"
},
"accountConnected": {
"type": "boolean"
},
"capabilityVersion": {
"type": [
"string",
"null"
]
},
"formats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"text",
"single_image",
"image_set",
"video"
]
},
"maxMediaCount": {
"type": "integer"
},
"maxBytes": {
"type": [
"integer",
"null"
]
},
"requiredFields": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"eligibleVisibility": {
"type": "array",
"items": {
"type": "string"
}
},
"requiresActionReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"verifiedAt": {
"type": "string"
}
}
}UploadIntentRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"filename",
"declaredMime",
"declaredBytes"
],
"properties": {
"filename": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"declaredMime": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "image/jpeg"
},
"declaredBytes": {
"type": "integer",
"minimum": 1,
"maximum": 524288000
},
"width": {
"type": "number",
"minimum": 0
},
"height": {
"type": "number",
"minimum": 0
},
"durationMs": {
"type": "number",
"minimum": 0
}
}
}UploadIntent
{
"type": "object",
"required": [
"assetId",
"sessionId",
"objectKey",
"method",
"expiresAt",
"maxBytes"
],
"description": "Arquivos abaixo de 50 MB retornam `method: presigned_put` com um `uploadUrl` de vida curta e os `headers` exigidos. Arquivos de 50 MB ou mais retornam `method: multipart_initiated` com `partSizeBytes` e um array `parts` de URLs de partes pré-assinadas; envie cada parte e finalize com o recibo de ETag de todas as partes.\n",
"properties": {
"assetId": {
"type": "string",
"format": "uuid"
},
"sessionId": {
"type": "string"
},
"objectKey": {
"type": "string",
"description": "Opaque storage key; never a public URL"
},
"method": {
"type": "string",
"enum": [
"presigned_put",
"multipart_initiated"
]
},
"uploadUrl": {
"type": "string",
"description": "Short-lived; upload bytes directly with the documented method"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Required request headers for the presigned PUT (e.g. content-type)"
},
"partSizeBytes": {
"type": "integer",
"description": "Required part size for multipart uploads"
},
"parts": {
"type": "array",
"description": "Presigned part URLs (multipart_initiated only); request fresh pages when they expire",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"partNumber",
"url",
"expiresAt"
],
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1
},
"url": {
"type": "string"
},
"expiresAt": {
"type": "string"
}
}
}
},
"expiresAt": {
"type": "string"
},
"maxBytes": {
"type": "integer"
}
}
}UploadIntentResponse
{
"allOf": [
{
"$ref": "#/components/schemas/UploadIntent"
},
{
"type": "object",
"required": [
"requestId"
],
"properties": {
"requestId": {
"type": "string"
}
}
}
]
}TikTokCreatorSettings
{
"type": "object",
"additionalProperties": false,
"required": [
"privacyLevels",
"maxDurationSeconds",
"allowComments",
"allowDuet",
"allowStitch",
"directPublishingAllowed",
"inboxAllowed",
"nativeAccountId"
],
"properties": {
"privacyLevels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"PUBLIC_TO_EVERYONE",
"MUTUAL_FOLLOW_FRIENDS",
"FOLLOWER_OF_CREATOR",
"SELF_ONLY"
]
}
},
"maxDurationSeconds": {
"type": "number",
"exclusiveMinimum": 0
},
"allowComments": {
"type": "boolean"
},
"allowDuet": {
"type": "boolean"
},
"allowStitch": {
"type": "boolean"
},
"directPublishingAllowed": {
"type": "boolean"
},
"inboxAllowed": {
"type": "boolean"
},
"nativeAccountId": {
"type": "string"
},
"creatorName": {
"type": "string"
},
"creatorAvatarUrl": {
"type": "string",
"format": "uri"
}
}
}MediaStatus
{
"type": "object",
"required": [
"id",
"originalName",
"mimeType",
"bytes",
"uploadState",
"createdAt",
"deletionState"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"originalName": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"bytes": {
"type": "integer"
},
"uploadState": {
"type": "string",
"enum": [
"pending",
"uploading",
"finalized",
"rejected"
]
},
"createdAt": {
"type": "string"
},
"deleteAfter": {
"type": [
"string",
"null"
],
"description": "Dynamic deletion date, or null while kept for scheduled posts."
},
"deletionState": {
"type": "string",
"enum": [
"active",
"deleting",
"deleted"
]
}
}
}FinalizeRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"sessionId"
],
"description": "Fatos observados com autoridade do chamador (bytes/MIME/checksum) NÃO são aceitos: o próprio servidor inspeciona a cópia FINAL imutável. Uploads multipart devem incluir um recibo de ETag para cada parte.\n",
"properties": {
"sessionId": {
"type": "string",
"format": "uuid"
},
"multipart": {
"type": "object",
"additionalProperties": false,
"required": [
"parts"
],
"properties": {
"parts": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"partNumber",
"etag"
],
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1
},
"etag": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
}
}
}
}
}
}FinalizeResult
{
"type": "object",
"required": [
"assetId",
"finalizeOperationId",
"bytes"
],
"properties": {
"assetId": {
"type": "string",
"format": "uuid"
},
"finalizeOperationId": {
"type": "string"
},
"bytes": {
"type": "integer"
},
"expiresAt": {
"type": [
"string",
"null"
]
}
}
}DraftInput
{
"type": "object",
"additionalProperties": false,
"required": [
"caption",
"destinations"
],
"properties": {
"caption": {
"type": "string",
"maxLength": 70000
},
"mediaIds": {
"type": "array",
"maxItems": 10,
"items": {
"type": "string",
"format": "uuid"
},
"default": []
},
"brandFolderId": {
"type": [
"string",
"null"
],
"format": "uuid",
"default": null
},
"destinations": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"items": {
"$ref": "#/components/schemas/DraftDestination"
}
}
}
}DraftDestination
{
"type": "object",
"additionalProperties": false,
"required": [
"accountId",
"format"
],
"properties": {
"accountId": {
"type": "string",
"format": "uuid"
},
"format": {
"type": "string",
"enum": [
"text",
"single_image",
"image_set",
"video"
]
},
"overrides": {
"type": "object",
"additionalProperties": false,
"properties": {
"caption": {
"type": "string"
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"title": {
"type": "string"
},
"options": {
"type": "object",
"additionalProperties": true,
"description": "Validated against an allowlisted per-network schema; never a raw vendor bag."
}
}
}
}
}DraftUpdateInput
{
"allOf": [
{
"$ref": "#/components/schemas/DraftInput"
},
{
"type": "object",
"required": [
"expectedVersion"
],
"properties": {
"expectedVersion": {
"type": "integer",
"minimum": 1
}
}
}
]
}DraftSaveResult
{
"type": "object",
"required": [
"postId",
"version",
"createdAt",
"updatedAt"
],
"properties": {
"postId": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
}PostListItem
{
"type": "object",
"required": [
"postId",
"version",
"status",
"updatedAt"
],
"properties": {
"postId": {
"type": "string"
},
"version": {
"type": "integer"
},
"status": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
}ValidationResult
{
"type": "object",
"required": [
"valid",
"revisionVersion",
"destinationResults"
],
"properties": {
"valid": {
"type": "boolean"
},
"revisionVersion": {
"type": "integer"
},
"destinationResults": {
"type": "array",
"items": {
"type": "object",
"required": [
"accountId",
"valid",
"requiresAction"
],
"properties": {
"accountId": {
"type": "string"
},
"valid": {
"type": "boolean"
},
"requiresAction": {
"type": "boolean",
"description": "True when the network requires an explicit human/consent step."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}AcceptedOperation
{
"type": "object",
"required": [
"revisionId",
"version",
"operationId",
"deliveryIds",
"scheduledAt",
"timezone",
"requestId"
],
"properties": {
"revisionId": {
"type": "string"
},
"version": {
"type": "integer"
},
"operationId": {
"type": "string"
},
"deliveryIds": {
"type": "array",
"items": {
"type": "string"
}
},
"scheduledAt": {
"type": "string"
},
"timezone": {
"type": "string"
},
"requestId": {
"type": "string"
},
"warnings": {
"type": "array",
"description": "Non-blocking notices preserved on replay, including key_expires_before_schedule when a key expires at or before dispatch.",
"items": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}ScheduleRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"scheduledAt",
"timezone",
"expectedVersion"
],
"properties": {
"scheduledAt": {
"type": "string",
"format": "date-time",
"example": "2027-01-12T15:00:00Z"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"example": "America/Indiana/Indianapolis"
},
"expectedVersion": {
"type": "integer",
"minimum": 1
},
"revisionId": {
"type": [
"string",
"null"
],
"description": "Must be null in V1 (schedules the current revision); non-null is rejected."
}
}
}PostStatus
{
"type": "object",
"required": [
"postId",
"version",
"status",
"deliveries"
],
"properties": {
"postId": {
"type": "string"
},
"version": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"in_progress",
"published",
"partially_published",
"needs_attention",
"canceled"
]
},
"deliveries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"accountId": {
"type": "string"
},
"network": {
"type": "string"
},
"state": {
"type": "string"
},
"dueAt": {
"type": "string"
},
"nativePostUrl": {
"type": [
"string",
"null"
],
"description": "Only after a confirmed result."
},
"unresolvedExternalOutcome": {
"type": "boolean"
},
"cancelRequestedAt": {
"type": [
"string",
"null"
]
},
"retryCount": {
"type": "integer"
},
"publishedAt": {
"type": [
"string",
"null"
]
}
}
}
}
}
}Usage
{
"type": "object",
"description": "Não existe contador de publicações restantes em lugar nenhum deste esquema: publicar é ilimitado em todos os planos pagos. Os números de atividade são métricas operacionais.\n",
"required": [
"plan",
"accounts",
"members",
"storage",
"scheduling",
"rateLimit",
"activity"
],
"properties": {
"plan": {
"type": "object",
"required": [
"id",
"label",
"status"
],
"properties": {
"id": {
"type": "string",
"enum": [
"trial",
"creator",
"studio",
"operator"
]
},
"label": {
"type": "string"
},
"version": {
"type": "integer"
},
"interval": {
"type": [
"string",
"null"
],
"enum": [
"month",
"year",
null
]
},
"status": {
"type": "string"
},
"paidThrough": {
"type": [
"string",
"null"
]
},
"trialEndsAt": {
"type": [
"string",
"null"
]
}
}
},
"accounts": {
"type": "object",
"required": [
"connected",
"reserved",
"maxConnected"
],
"properties": {
"connected": {
"type": "integer"
},
"reserved": {
"type": "integer"
},
"maxConnected": {
"type": "integer"
}
}
},
"members": {
"type": "object",
"required": [
"active",
"max"
],
"properties": {
"active": {
"type": "integer"
},
"max": {
"type": "integer"
}
}
},
"storage": {
"type": "object",
"required": [
"activeBytes",
"reservedBytes",
"maxActiveBytes"
],
"properties": {
"activeBytes": {
"type": "integer"
},
"reservedBytes": {
"type": "integer"
},
"maxActiveBytes": {
"type": "integer"
}
}
},
"scheduling": {
"type": "object",
"required": [
"horizonDays"
],
"properties": {
"horizonDays": {
"type": "integer",
"example": 90
}
}
},
"rateLimit": {
"type": "object",
"required": [
"requestsPerMinute",
"note"
],
"properties": {
"requestsPerMinute": {
"type": "integer",
"example": 120
},
"note": {
"type": "string",
"example": "Technical speed limit: not a posting allowance."
}
}
},
"activity": {
"type": "object",
"description": "Operational metrics only; never an allowance or balance.",
"required": [
"deliveriesAttemptedLast30Days",
"deliveriesPublishedLast30Days"
],
"properties": {
"deliveriesAttemptedLast30Days": {
"type": "integer"
},
"deliveriesPublishedLast30Days": {
"type": "integer"
}
}
}
}
}CreateWebhookRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"example": "https://example.com/hooks/autoposted"
},
"eventTypes": {
"oneOf": [
{
"type": "string",
"const": "all"
},
{
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
],
"description": "Omit or \"all\" for every event; an array filters by event type."
},
"description": {
"type": "string"
}
}
}WebhookEndpoint
{
"type": "object",
"required": [
"id",
"url",
"eventTypes",
"enabled",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"url": {
"type": "string",
"format": "uri"
},
"eventTypes": {
"oneOf": [
{
"type": "string",
"const": "all"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"enabled": {
"type": "boolean"
},
"verifiedAt": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string"
}
}
}