Stormz

Developer


Workshop illustration

Get an illustration

Return the illustration for a specific workshop

GET /v1/workshops/:workshop_id/illustration

Response

200 OK
{
  "id": "5746ef3593a109587c000b03",
  "name": "whales.jpg",
  "align": "left",
  "public_url": "https://your-amazon-container.s3.amazonaws.com/TpfQ1KCsS3SbT2ShNNLn_whales.jpg",
  "crop_url": "https://www.filepicker.io/api/file/fTSkBHq0RKS5DCaaEAAc/convert?policy=your_policy&signature=your_signature&fit=crop&rotate=exif&w={{width}}&h={{height}}",
  "resize_url": "https://www.filepicker.io/api/file/fTSkBHq0RKS5DCaaEAAc/convert?policy=your_policy&signature=your_signature&fit=max&rotate=exif&w={{width}}&h={{height}}"
}

Create an illustration

POST /v1/workshops/:workshop_id/illustration

Parameters

Name Type Description
name string name of the illustration
align string alignment of the illustration: either ‘left’ or ‘above’
blob.url string url to the image
blob.mimetype string mimetype of the image
blob.key string amazon key of the resource
blob.container string amazon container name

Example

{
  "name": "whales.jpg",
  "blob": {
    "url": "https://www.filepicker.io/api/file/fTSkBHq0RKS5DCaaEAAc",
    "mimetype": "image/jpeg",
    "key": "TpfQ1KCsS3SbT2ShNNLn_whales.jpg",
    "container": "your-amazon-container"
  }
}

Response

201 Created

Update an illustration

PUT /v1/workshops/:workshop_id/illustration

Parameters

Name Type Description
align string alignment of the illustration: either ‘left’ or ‘above’

Example

{
  "align": "above"
}

Response

204 No Content

Delete an illustration

DELETE /v1/workshops/:workshop_id/illustration

Response

204 No Content