OCocoya
Studio designs

Render a Studio design

Changed on

Renders a Studio design as a PNG with its fields filled in and returns the image URL. The design itself is not changed.

post/studio-designs/{designId}/render

Request

  • Base URL
    https://www.app.ocoya.com/api/_public/v1
  • Auth
    API key in header X-API-Key

Path parameters

designIdstring required
Example:design_123

Studio design ID, from GET /studio-designs.

Query parameters

brandIdstring required
Example:cmayvq3hk00017apshay5qezu

Ocoya brand ID. Get one from GET /brands.

Request body

fieldsobject

Values keyed by field ID from GET /studio-designs/{designId}: text for text fields, an image URL for image fields, a CSS colour for colour fields. Fields left out keep the design's own content.

Example request

{
  "fields": {
    "pixy-cmte4jx8o00ml3570hpuny2ze": "Summer sale, 20% off"
  }
}

Response

Success

idstring required

Studio design ID.

namestring required

Design name.

urlstring required

The rendered PNG. Pass it in mediaUrls to POST /post to use it in a post.

mimetypestring required

Always image/png.

Example response

{
  "id": "design_123",
  "name": "Weekly offer",
  "url": "https://perma.pixy.art/render.png",
  "mimetype": "image/png"
}

Changes