Media

Render and save a meme

post/memes/render

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/memes/render
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Request body

$schemastring uri

A URL to the JSON Schema for this object.

alt_textstring

Alternative text saved with the media

captionsstring[] nullable required

Caption values in template order

filenamestring

Output filename; its extension must match the rendered format (.jpg for jpg or jpeg). Defaults to the template-based filename.

format'png' | 'jpg' | 'jpeg' | 'gif' | 'webp'

Rendered image format

overlay_media_idsstring[] nullable

Workspace media IDs for replaceable image slots

parent_media_idstring

Prior generated media when this is an edited version

retention_class'library' | 'temporary'

Keep in the library or manage as temporary post media

template_idstring required

OpenPost meme template ID

workspace_idstring required

Workspace ID

Example request

{
  "$schema": "https://example.com/api/v1/schemas/RenderMemeInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "https://example.com/api/v1/schemas/RenderMemeOutputBody.json",
  "media": {
    "$schema": "https://example.com/api/v1/schemas/MediaUploadResult.json"
  },
  "recipe": {
    "$schema": "https://example.com/api/v1/schemas/MemeRecipeResponse.json"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.