---
title: "Preview text as publishing images"
method: POST
path: "/publications/preview-text-card"
tags: ["Publications"]
---

# Preview text as publishing images

`POST /publications/preview-text-card`

## Request

- Base URL: `https://app.openpo.st/api/v1`
- URL: `https://app.openpo.st/api/v1/publications/preview-text-card`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `openpost_session`

## Request body

- PreviewTextCardInputBody
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `attachment_count` integer: Following attachments; adds a next-slide arrow
  - `output_profile` string: Provider format, including instagram.story for a vertical Story
  - `settings` object: Text card style settings, also accepted in rendition and Social Set defaults
  - `social_account_id` string, required: Connected account whose name, handle and profile photo appear on the card
  - `text` string, required: Effective destination text

## Response `200`

OK

- PreviewTextCardOutputBody
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `images` TextCardPreviewImage[], nullable, required
    - `data_url` string, required: Private JPEG preview generated by the publishing renderer
    - `height` integer, required
    - `width` integer, required

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Too Many Requests
- `500`: Internal Server Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/openpo/apis/openpost-api.md) · [All operations](https://skmtc.dev/openpo/apis/openpost-api/llms.txt) · [OpenAPI document](https://skmtc.dev/openpo/apis/openpost-api/revisions/67d3964458a7?raw)