inspect canvas

Pictures of the canvas: real drawn slides with every layer, mask and grade, exactly what an export shows, each with a grid ruled in slide pixels (off under half scale or with grid: false) and the ids of the layers on it. Up to twelve slides a call; scale returns them smaller. Words cut off, off the slide, broken mid-word, overlapping, too small or too faint come back as notes on their slide, empty when none are; a picture that could not be fetched is named in not_drawn. Cloud processing.

POST

/

tools

/

inspect_canvas

inspect canvas

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

import requests

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

payload = { "canvas_id": "<string>" }
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({canvas_id: '<string>'})
};

fetch('https://eversince.ai/api/v1/tools/inspect_canvas', 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,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_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,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_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 default: for a key or a connected agent, one of the workspaces the user allowed it.

Body

application/json

canvas_id

string

required

The canvas id.

slides

(string | integer)[]

Which slides, by id or by place from 0. Default: every slide, up to twelve.

Maximum array length: 12

slide

One slide, by id or place.

grid

boolean

False returns the bare picture. Default true, false under scale 0.5.

scale

number

The picture drawn at this fraction of the slide, 0.25 for a thumbnail as a row shows it; notes and grid stay in slide pixels.

Required range: 0.05 <= x <= 1

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[]

inspect canvas

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

import requests

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

payload = { "canvas_id": "<string>" }
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({canvas_id: '<string>'})
};

fetch('https://eversince.ai/api/v1/tools/inspect_canvas', 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,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_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,
      "charged_minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "held_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}