manage canvases

Create, rename, open and delete canvases, and keep one as a template; get_canvas reads them. create: blank at a destination (a named size from get_canvas destinations: instagram-post is 1080 by 1350, the carousel size; instagram-square, instagram-story, youtube-thumbnail, a4 and more) or at a width and height; from_ref, an image item, at the picture’s own size with it as the one layer; or from_canvas, another canvas, as a copy (a template is a canvas with a flag, so using one is a copy, and a shelf image template comes with its sample pictures) or, with a new size, as a resize laid out again, naming any layer it left off a slide. The response carries the canvas id, name, size, slide count and editor link; a new canvas has one slide, which addLayer uses unless slideId says otherwise. open opens a canvas in the user’s app. delete takes one away; a picture exported from it stays in the library. Free.

POST

/

tools

/

manage_canvases

manage canvases

curl --request POST \
  --url https://eversince.ai/api/v1/tools/manage_canvases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://eversince.ai/api/v1/tools/manage_canvases"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://eversince.ai/api/v1/tools/manage_canvases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {},
  "meta": {
    "request_id": "<string>",
    "cost": {},
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  },
  "media": [
    {}
  ]
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Headers

Idempotency-Key

string

Retry a paid dispatch safely: the same key returns the job already dispatched instead of charging again.

x-workspace-id

string

The workspace this one call acts in, when it is not the key's own.

Body

application/json

create

object

Show child attributes

rename

object

Show child attributes

template

object

Keep a canvas as a starting shape, or stop. Its image layers are the ones a copy fills.

Show child attributes

open

object

Show this canvas in the user's image editor. The call cannot tell whether the app is open to receive it.

Show child attributes

delete

object

Take this canvas away. Every read leaves it out from then on; a picture exported from it is a library item and stays.

Show child attributes

context

string

Optional: one sentence shown to the user beside this action.

Maximum string length: 600

Response

Done, or a job started for work that runs longer (follow it with get_jobs).

ok

any

required

data

object

required

meta

object

required

Show child attributes

media

object[]

manage canvases

curl --request POST \
  --url https://eversince.ai/api/v1/tools/manage_canvases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://eversince.ai/api/v1/tools/manage_canvases"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://eversince.ai/api/v1/tools/manage_canvases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {},
  "meta": {
    "request_id": "<string>",
    "cost": {},
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  },
  "media": [
    {}
  ]
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}