Skip to Content

Get Post Output

Setup

GET https://embed-api.postnitro.ai/post/output/{embedPostId}

Retrieves the generated output for a completed post. Call this once Check Post Status reports the post status as COMPLETED.

Headers

  • embed-api-key: your-api-key-here (required)

Path Parameters

ParameterTypeRequiredDescription
embedPostIdstringYesID of the embed post to retrieve

Example Request

curl --location 'https://embed-api.postnitro.ai/post/output/[embed-post-id]' \ --header 'embed-api-key: pn-your-api-key'

Response

The result object always includes designId, name, size, and editorUrl. Rendered artifact fields (type, mimeType, data) are present only for PNG and PDF — a DESIGN response skips rendering, so it omits them.

For DESIGN Response Type

{ "success": true, "data": { "embedPost": { "id": "post123", "postType": "CAROUSEL", "responseType": "DESIGN", "status": "COMPLETED", "credits": 4, "createdAt": "2025-08-03T13:40:49.098Z", "updatedAt": "2025-08-03T13:40:53.425Z" }, "result": { "designId": "design123", "name": "Welcome to the Carousel!", "size": { "id": "4:5", "dimensions": { "width": 1080, "height": 1350 } }, "editorUrl": "https://postnitro.ai/app/carousel-maker/<workspace-identifier>/<designId>" } } }

For PNG Response Type:

{ "success": true, "data": { "embedPost": { "id": "post123", "postType": "CAROUSEL", "responseType": "PNG", "status": "COMPLETED", "credits": 4, "createdAt": "2025-08-03T13:40:49.098Z", "updatedAt": "2025-08-03T13:40:53.425Z" }, "result": { "designId": "design123", "name": "Welcome to the Carousel!", "size": { "id": "4:5", "dimensions": { "width": 1080, "height": 1350 } }, "editorUrl": "https://postnitro.ai/app/carousel-maker/<workspace-identifier>/<designId>", "type": "png", "mimeType": "image/png", "data": [ "image_1_from_postnitro.png", "image_2_from_postnitro.png", "image_3_from_postnitro.png", "image_4_from_postnitro.png" ] } } }

For PDF Response Type:

{ "success": true, "data": { "embedPost": { "id": "post123", "postType": "CAROUSEL", "responseType": "PDF", "status": "COMPLETED", "credits": 4, "createdAt": "2025-08-03T13:59:07.502Z", "updatedAt": "2025-08-03T13:59:12.181Z" }, "result": { "designId": "design123", "name": "Welcome to the Carousel!", "size": { "id": "4:5", "dimensions": { "width": 1080, "height": 1350 } }, "editorUrl": "https://postnitro.ai/app/carousel-maker/<workspace-identifier>/<designId>", "type": "pdf", "mimeType": "application/pdf", "data": "document_from_postnitro.pdf" } } }

Result Object Details

FieldTypeDescription
designIdstringDesign ID to be used in the scheduling API call
namestringDesign name (from template or “Untitled”)
sizeobjectDesign aspect ratio (e.g., “4:5”) and dimensions
editorUrlstringDeep link to open the design in the web editor. Present for all response types. null if the workspace or postType can’t be resolved
typestringFile type in lowercase (“png” or “pdf”). Omitted for DESIGN
mimeTypestringMIME type for the file. Omitted for DESIGN
datastring/arrayPNG: Array of URLs (one per slide)
PDF: Single URL. Omitted for DESIGN

editorUrl structure

<domain>/app/<editor-type>/<workspace-identifier>/<designId>

<editor-type> is derived from postType:

postTypeeditor type
IMAGEimage-maker
CAROUSELcarousel-maker
Last updated on