OpenPost Image Editor

Create an OpenPost Image Editor design

post/image-editor/designs

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/image-editor/designs
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Request body

$schemastring uri

A URL to the JSON Schema for this object.

client_request_idstring

Stable client request ID used to make design creation idempotent

height_pxinteger required
preset_keystring required
source_media_idstring

Source library image. Reopens its active editing design when one exists.

titlestring required
width_pxinteger required
workspace_idstring required

Example request

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

Response

Created

$schemastring uri

A URL to the JSON Schema for this object.

can_editboolean required
cover_preview_media_idstring
created_atstring required
created_by_idstring required
idstring required
revisioninteger required
updated_atstring required
workspace_idstring required

Changes

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