> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eversince.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# get canvas

> Read a canvas: its size, slides, and every layer's id, name, kind and box in slide pixels, the ids every operation names. A read stops at about 60,000 characters of layers, whole slides first, says so in cut_short, and next_cursor reads on; slide, layer_ids or types narrow it. response_format detailed returns layers as stored, for matching a look or rewriting text runs. local_only marks a picture only on someone's computer, which the cloud cannot draw until it syncs. With no canvas_id it lists the workspace's canvases, newest edit first, or with find_text those whose text holds the words. history adds the versions undo takes; destinations the named sizes. Free.



## OpenAPI

````yaml /openapi.json post /tools/get_canvas
openapi: 3.1.0
info:
  title: Eversince API
  version: '1'
  description: >-
    Every Eversince tool as one POST call, plus the routes beside them: the tool
    list, account and keys, uploads, webhooks and models. The prose is at
    https://docs.eversince.ai.
servers:
  - url: https://eversince.ai/api/v1
security:
  - bearer: []
tags:
  - name: Discovery
    description: The tool list, the same on the MCP server, the REST API and the CLI.
  - name: Workspace
    description: Jobs, balances, settings, templates, skills and the overview.
  - name: Library
    description: >-
      Items, search, import, reading media, comments, boards, calendars, the
      brand kit and public links.
  - name: Timeline
    description: 'Video editing: timelines, clips, captions, sound, language and rendering.'
  - name: Canvas
    description: 'Still editing: canvases, slides, layers and rendering.'
  - name: Generation
    description: Image, video and audio generation, upscaling, cutouts and models.
  - name: Research
    description: 'What platforms publish: pulling and keeping posts.'
  - name: Account
    description: Balances, keys, workspaces and script sessions.
  - name: Uploads
    description: Files into the library by presigned upload or by URL.
  - name: Webhooks
    description: Job results posted to a URL as they complete.
  - name: Models
    description: Generation models and cost estimates.
paths:
  /tools/get_canvas:
    post:
      tags:
        - Canvas
      summary: get canvas
      description: >-
        Read a canvas: its size, slides, and every layer's id, name, kind and
        box in slide pixels, the ids every operation names. A read stops at
        about 60,000 characters of layers, whole slides first, says so in
        cut_short, and next_cursor reads on; slide, layer_ids or types narrow
        it. response_format detailed returns layers as stored, for matching a
        look or rewriting text runs. local_only marks a picture only on
        someone's computer, which the cloud cannot draw until it syncs. With no
        canvas_id it lists the workspace's canvases, newest edit first, or with
        find_text those whose text holds the words. history adds the versions
        undo takes; destinations the named sizes. Free.
      operationId: get_canvas
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
        - $ref: '#/components/parameters/WorkspaceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                canvas_id:
                  description: >-
                    Leave it out to list the workspace's canvases instead of
                    reading one.
                  type: string
                find_text:
                  description: >-
                    With no canvas_id: only the canvases whose text layers hold
                    these words, whatever the case, each with the layers that
                    do.
                  type: string
                  minLength: 2
                  maxLength: 200
                slide:
                  description: >-
                    One slide, by id or by its place from 0. Default: every
                    slide.
                  anyOf:
                    - type: string
                    - type: integer
                      minimum: 0
                layer_ids:
                  description: Only these layers, wherever they sit, groups walked into.
                  maxItems: 200
                  type: array
                  items:
                    type: string
                types:
                  description: >-
                    Only these kinds of layer; "text" alone is how a translation
                    reads a canvas.
                  type: array
                  items:
                    type: string
                    enum:
                      - image
                      - text
                      - shape
                      - icon
                      - chart
                      - group
                      - adjustment
                response_format:
                  description: >-
                    concise (default): each layer's id, name, kind, box and key
                    facts. detailed: the stored layers whole. shape: the
                    canvas's size and slides without layers.
                  type: string
                  enum:
                    - concise
                    - detailed
                    - shape
                history:
                  description: Include this many saved versions, newest first.
                  type: integer
                  minimum: 1
                  maximum: 50
                destinations:
                  description: >-
                    Include the named sizes (Instagram post, YouTube thumbnail,
                    A4…) with their ids and pixels; works with or without
                    canvas_id.
                  type: boolean
                limit:
                  description: 'Listing only: canvases per page. Default 50.'
                  type: integer
                  minimum: 1
                  maximum: 100
                cursor:
                  description: >-
                    next_cursor from the answer before, with the other fields
                    the same: the next page of the list, or the rest of a canvas
                    a read cut short.
                  type: string
      responses:
        '200':
          description: >-
            Done, or a job started for work that runs longer (follow it with
            get_jobs).
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - data
                  - meta
                properties:
                  ok:
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      cost:
                        $ref: '#/components/schemas/Cost'
                      cloud_processing:
                        $ref: '#/components/schemas/CloudProcessing'
                  media:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        default:
          $ref: '#/components/responses/Error'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
      description: >-
        Retry a paid dispatch safely: the same key returns the job already
        dispatched instead of charging again.
    WorkspaceId:
      name: x-workspace-id
      in: header
      required: false
      schema:
        type: string
      description: The workspace this one call acts in, when it is not the key's own.
  schemas:
    Cost:
      type: object
      description: AI credits the call cost.
      additionalProperties: true
    CloudProcessing:
      type: object
      description: Cloud processing the call used, and what is left.
      properties:
        ran_on:
          const: cloud
        minutes:
          type: number
        queued_minutes:
          type: number
        left_minutes:
          type: number
        bought_minutes:
          type: number
        note:
          type: string
    Error:
      type: object
      required:
        - ok
        - error
      properties:
        ok:
          const: false
        error:
          type: object
          required:
            - code
            - message
            - retryable
          properties:
            code:
              type: string
            message:
              type: string
              description: What went wrong, in words to act on.
            retryable:
              type: boolean
            suggested_action:
              type: string
              description: The next step that works.
            cloud_processing:
              $ref: '#/components/schemas/CloudProcessing'
  responses:
    Error:
      description: The call was refused or failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        An API key (es_live_…) from Settings, under API keys, or an OAuth access
        token.

````