---
title: "Read a post"
method: GET
path: "/post/{embedPostId}"
---

# Read a post

`GET /post/{embedPostId}`

## Request

- Base URL: `https://embed-api.postnitro.ai`
- URL: `https://embed-api.postnitro.ai/post/{embedPostId}`
- Auth: API key in header `embed-api-key`

The design of a post made through the API, by the post's embedPostId (its own, or any edit's), in the shape the import endpoint takes, with its brand's details: read it, change it, send it back with POST /post/edit. Free. Docs: https://postnitro.ai/docs/embed/api/read-design.md

## Path parameters

- `embedPostId` string, required

## Response `200`

The design

- object
  - `success` boolean
  - `data` object
    - `design` DesignContent: A post made through the API, its design in the shape the import endpoint takes
      - `embedPostId` string: The post's id, as asked for
      - `designId` string: The design's id, the one scheduling takes
      - `templateId` string: The template the design was last made with: its own, or the one an edit moved it to
      - `postType` 'CAROUSEL' | 'IMAGE' | 'VIDEO'
      - `name` string
      - `size` union: Aspect ratio, as the output gives it
        - string
        - object
      - `brand` object, nullable: The brand the design shows, in the Brands API's fields
        - `id` string, nullable
        - `name` string, nullable
        - `handle` string, nullable
        - `image` string, nullable
        - `isCompanyDetail` boolean
        - `showName` boolean
        - `showHandle` boolean
        - `showImage` boolean
      - `slides` union: Import's fields (type, heading, sub_heading, description, cta_button, image, background_image, layoutType/layoutConfig): an array for CAROUSEL and VIDEO, one object without type for IMAGE. Text as the design stores it, HTML once edited in the editor; a part turned off is left out
        - object[]
        - object
      - `videoSettings` object: VIDEO only, when it has them. The music is named backgroundMusicId (not audioId); a narrated video gives its voiceover's voice, tone and captions, not its script
        - `motionStyle` string: A built-in style's name, or a saved style's id
        - `sequenceId` string: A saved sequence's id, when the video has one
        - `backgroundMusicId` string
        - `backgroundMusicVolume` number: The music's volume in percent, 0 to 100, when the design keeps one
        - `voiceover` object: A narrated video's voiceover
          - `voice` 'alloy' | 'ash' | 'ballad' | 'coral' | 'echo' | 'fable' | 'nova' | 'onyx' | 'sage' | 'shimmer' | 'verse'
          - `tone` string
          - `captions` boolean
      - `editorUrl` string, nullable

## Other responses

- `404`: No such post for the key, or another workspace's
- `422`: The post has no design yet: still being made, or it failed before making one

---

[API](https://skmtc.dev/postnitro/apis/postnitro-embed-api.md) - [All operations](https://skmtc.dev/postnitro/apis/postnitro-embed-api/llms.txt) - [OpenAPI document](https://skmtc.dev/postnitro/apis/postnitro-embed-api/revisions/428cb3ea3f6a?raw)