> ## Documentation Index > Fetch the complete documentation index at: https://docs.postclean.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Ver prévia do post > Mostra, para cada destino ativo, o texto que a rede vai receber depois das regras de formatação dela e o tamanho dele frente ao limite da conta. Nada é publicado. ## OpenAPI ````yaml /openapi.json get /posts/{post}/preview openapi: 3.1.0 info: title: PostClean API version: 2.0.0 description: >- API REST do PostClean. Autentique com uma chave de API do workspace, enviada como token Bearer no cabeçalho `Authorization`. servers: - url: https://post.chatclean.com.br/api description: PostClean security: - bearerAuth: [] tags: - name: Posts description: Criar, ler, atualizar, excluir e pré-visualizar posts. - name: Post notes description: Notas internas de um post, visíveis aos membros do workspace. - name: Approvals description: Aprovar ou rejeitar posts que aguardam aprovação. - name: Recurrence description: Fazer um post se repetir numa frequência. - name: Media and uploads description: Enviar arquivos e anexar mídia aos posts. - name: Social accounts description: Contas sociais conectadas e as opções de cada rede. - name: Channels description: Horários de postagem e fila de um canal. - name: Ideas description: Ideias do quadro Criar. - name: Idea stages description: As colunas (etapas) do quadro de ideias. - name: Analytics description: Métricas do workspace e dos canais. - name: Labels description: Etiquetas para organizar posts e ideias. - name: Signatures description: Textos reutilizáveis para adicionar aos posts. - name: Workspace description: O workspace ao qual a chave de API pertence. - name: API keys description: Chaves de API pessoais deste workspace. - name: Webhooks description: Webhooks de saída e os registros de entrega. - name: Repurposes description: Automações que republicam vídeos postados fora do PostClean. - name: Platform description: Recursos de cada plataforma e tipos de conteúdo. paths: /posts/{post}/preview: parameters: - $ref: '#/components/parameters/PostId' get: tags: - Posts summary: Ver prévia do post description: >- Mostra, para cada destino ativo, o texto que a rede vai receber depois das regras de formatação dela e o tamanho dele frente ao limite da conta. Nada é publicado. operationId: getPostPreview responses: '200': description: A prévia do post. content: application/json: schema: $ref: '#/components/schemas/PostPreview' example: post_id: 9d3c1f2a-6b4e-4c8a-9f1e-2a7b5c8d0e41 original_content: Agora dá para agendar fios no X. Veja como funciona. original_length: 52 platforms: - post_platform_id: 9d3c1f2b-1a2b-4c3d-8e4f-5a6b7c8d9e0f platform: x content_type: x_post sanitized_content: Agora dá para agendar fios no X. Veja como funciona. sanitized_length: 52 max_content_length: 280 truncated: false thread_replies: - text: 2/ As respostas saem logo abaixo do primeiro post. media: [] '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' components: parameters: PostId: name: post in: path required: true description: Id do post. Um post de outro workspace devolve `404`. schema: type: string format: uuid example: 9d3c1f2a-6b4e-4c8a-9f1e-2a7b5c8d0e41 schemas: PostPreview: type: object description: >- Prévia do texto que cada destino ativo do post vai receber. Um post sem destino ativo volta com `platforms` vazio. properties: post_id: type: string format: uuid original_content: type: string description: Texto guardado no post. original_length: type: integer description: Caracteres (code points) do texto guardado. platforms: type: array items: type: object properties: post_platform_id: type: string format: uuid description: Id do destino (`platforms[].id` do post). platform: $ref: '#/components/schemas/Platform' content_type: type: - string - 'null' sanitized_content: type: string description: >- O texto que o PostClean envia para a rede, depois das regras de formatação dela. sanitized_length: type: integer max_content_length: type: integer description: >- Limite de texto da conta (uma conta do X com posts longos tem 25000). truncated: type: boolean description: Se o texto enviado ficou menor que o texto guardado. title: type: string description: 'Só no YouTube: o título do vídeo.' description: type: string description: 'Só no YouTube: a descrição do vídeo.' description_length_bytes: type: integer description: Só no YouTube. O limite é 5000 bytes. thread_replies: type: array description: X, Bluesky e Mastodon, quando o post tem respostas em fio. items: type: object properties: text: type: string description: Texto da resposta como será enviado. media: type: array items: $ref: '#/components/schemas/MediaItem' Platform: type: string enum: - linkedin - linkedin-page - x - tiktok - youtube - facebook - instagram - instagram-facebook - threads - pinterest - bluesky - mastodon - telegram - discord - google_business description: >- Rede de uma conta social. `linkedin-page` é uma página de empresa no LinkedIn, e `instagram-facebook` é uma conta do Instagram conectada por uma Página do Facebook. MediaItem: type: object description: Um item de mídia como fica salvo no post. properties: id: type: string format: uuid description: >- Id da mídia. Passe como `media[].id` para usar o arquivo em outro post. path: type: string description: Caminho no armazenamento, `medias/{uuid}.{ext}`. url: type: string format: uri description: URL pública do arquivo. type: type: - string - 'null' enum: - image - video - document - null description: '`null` em itens antigos, salvos sem tipo.' mime_type: type: - string - 'null' description: Tipo MIME do arquivo. original_filename: type: - string - 'null' description: Nome original do arquivo. size: type: - integer - 'null' description: Tamanho em bytes. meta: $ref: '#/components/schemas/MediaItemMeta' source: type: - string - 'null' enum: - ai - unsplash - google_drive - google_photos - canva - null description: >- De onde o arquivo veio no app. Só aparece em itens adicionados por uma dessas fontes. source_meta: type: - object - 'null' description: Detalhes dessa fonte. Só aparece quando a fonte informou algum. examples: - id: 9d3c1f30-8a9b-4c0d-9e1f-2a3b4c5d6e7f path: medias/9d3c1f30-8a9b-4c0d-9e1f-2a3b4c5d6e7f.jpg url: https://example.com/medias/9d3c1f30-8a9b-4c0d-9e1f-2a3b4c5d6e7f.jpg type: image mime_type: image/jpeg original_filename: lancamento.jpg size: 482113 meta: width: 1080 height: 1350 alt_text: Banner de lançamento do produto ErrorBody: type: object properties: message: type: string description: Corpo de erro com uma mensagem. RateLimitErrorBody: type: object properties: name: type: string const: rate_limit_exceeded message: type: string examples: - Rate limit exceeded. Please retry after 30 seconds. description: Corpo devolvido quando o limite de requisições é excedido. MediaItemMeta: type: object description: >- Configurações editáveis de um item de mídia. As respostas também podem trazer chaves medidas pelo servidor (por exemplo `width`, `height` e `duration`). properties: alt_text: type: string maxLength: 2000 description: >- Descrição de acessibilidade. Vale para imagens; cada rede corta no próprio limite. user_tags: type: array maxItems: 20 description: Pessoas marcadas numa imagem do Instagram (só `instagram_feed`). items: type: object required: - username - x - 'y' properties: username: type: string pattern: ^@?[A-Za-z0-9._]{1,30}$ description: >- Nome de usuário público do Instagram. Um `@` no início é removido. x: type: number minimum: 0 maximum: 1 description: Distância da borda esquerda, de 0 a 1. 'y': type: number minimum: 0 maximum: 1 description: Distância da borda de cima, de 0 a 1. cover_offset_ms: type: integer minimum: 0 description: >- Quadro do vídeo usado como capa, em milissegundos a partir do início. Não pode passar do fim do vídeo. responses: Unauthorized: description: >- Chave de API ausente, inválida, revogada ou expirada. Corpos possíveis: `Unauthenticated.` (sem chave, ou chave inválida ou revogada), `Token expired.` (passou do `expires_at`), `Token not found.` e `No workspace selected.` (a chave não está mais ligada a um workspace). content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: message: Unauthenticated. PaymentRequired: description: >- A conta do workspace não tem assinatura ativa nem período de teste. Corpo: `{"message": "Active subscription required."}`. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: message: Active subscription required. Forbidden: description: >- A requisição não é permitida. Chaves de API só funcionam para administradores do workspace (o dono da conta ou um membro marcado como administrador); fora isso, toda requisição devolve `Insufficient workspace permissions.`. Outros corpos: `Workspace access denied.` (o usuário da chave saiu do workspace), `Personal access token required.` (foi enviado um token OAuth do MCP) e `This action is unauthorized.` (por exemplo, a nota pertence a outro membro). content: application/json: schema: $ref: '#/components/schemas/ErrorBody' NotFound: description: O recurso não existe neste workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' TooManyRequests: description: 'Limite de requisições excedido: 60 por minuto por workspace.' headers: Retry-After: description: Segundos de espera antes de tentar de novo. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorBody' example: name: rate_limit_exceeded message: Rate limit exceeded. Please retry after 30 seconds. securitySchemes: bearerAuth: type: http scheme: bearer description: Chave de API do workspace, criada em Configurações > Chaves de API. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.