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

# List canvases

> Returns every canvas (prompt) the caller can access in the authenticated workspace: canvases that belong to an accessible project plus the caller's own personal drafts.



## OpenAPI

````yaml GET /prompt
openapi: 3.0.1
info:
  title: Tela API
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.tela.com
security: []
paths:
  /prompt:
    get:
      tags:
        - Canvas
      summary: List canvases
      description: >
        Returns every canvas (prompt) the caller can access in the authenticated
        workspace: canvases that belong to an

        accessible project plus the caller's own personal drafts. Personal
        drafts have `projectId: null` and are only

        returned when the token carries the identity of the user who created
        them; workspace-only tokens see project

        canvases only. Deleted canvases are never returned.


        Pass `includePromotedVersion=true` to embed the production (promoted)
        version and the most recently created

        version of each canvas. Pass `personal=true` to return only the caller's
        personal drafts.
      parameters:
        - name: projectId
          in: query
          required: false
          description: Restrict results to canvases in this project.
          schema:
            type: string
            format: uuid
        - name: workspaceId
          in: query
          required: false
          description: >-
            Restrict results to this workspace id. Results are always scoped to
            the authenticated workspace, so this is only useful when it matches.
          schema:
            type: string
            format: uuid
        - name: includePromotedVersion
          in: query
          required: false
          description: >-
            When `true`, each canvas includes `promotedVersion` and
            `latestVersion`.
          schema:
            type: boolean
        - name: personal
          in: query
          required: false
          description: >-
            When `true`, only the caller's personal drafts (`projectId` is
            `null`) are returned. Returns an empty list for tokens without a
            user identity.
          schema:
            type: boolean
      responses:
        '200':
          description: List of canvases.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CanvasResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            Missing or invalid credentials, or the caller has no access to the
            workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Query parameters failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    CanvasResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
          maxLength: 256
        projectId:
          type: string
          format: uuid
          nullable: true
          description: >-
            Project the canvas belongs to. `null` for the caller's personal
            drafts.
        inferencesPercentage:
          type: string
          description: >-
            Share of live inferences sampled for review, as a decimal string
            (for example `"0.10"`).
        layoutVersion:
          type: string
          description: Editor layout version (`v1` or `v2`).
        workspaceId:
          type: string
          format: uuid
        customTags:
          type: array
          items:
            type: string
        allowedCredentials:
          type: array
          nullable: true
          description: Credential ids the canvas may use. `null` means unrestricted.
          items:
            type: string
        createdBy:
          type: string
        updatedBy:
          type: string
        deletedBy:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
          nullable: true
        updatedAt:
          type: string
          format: date-time
          nullable: true
        deletedAt:
          type: string
          format: date-time
          nullable: true
        favorited:
          type: boolean
          description: >-
            Whether the calling user favorited the canvas. Only present when the
            token carries a user identity.
        promotedVersion:
          nullable: true
          description: >-
            Production version. Only present when `includePromotedVersion=true`;
            `null` when the canvas has no production or promoted version.
          allOf:
            - $ref: '#/components/schemas/CanvasEmbeddedVersion'
        latestVersion:
          nullable: true
          description: >-
            Most recently created version. Only present when
            `includePromotedVersion=true`; `null` when the canvas has no
            versions.
          allOf:
            - $ref: '#/components/schemas/CanvasEmbeddedVersion'
      required:
        - id
        - title
        - projectId
        - inferencesPercentage
        - layoutVersion
        - workspaceId
        - customTags
        - createdBy
        - updatedBy
      example:
        id: 5f0c1a2e-8b7d-4c3a-9e1f-2d4b6a8c0e12
        title: Invoice extractor
        projectId: 0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d
        inferencesPercentage: '0.10'
        layoutVersion: v2
        workspaceId: 7c8d9e0f-1a2b-4c3d-8e4f-5a6b7c8d9e0f
        customTags:
          - finance
        allowedCredentials: []
        createdBy: ana@example.com
        updatedBy: ana@example.com
        deletedBy: null
        createdAt: '2026-03-02T14:05:11.000Z'
        updatedAt: '2026-08-19T09:41:00.000Z'
        deletedAt: null
        favorited: true
    Error: {}
    CanvasEmbeddedVersion:
      type: object
      description: >-
        Compact version projection embedded in canvas listings when
        `includePromotedVersion=true`. Messages and environments are not
        included; fetch the version resource for those.
      properties:
        id:
          type: string
          format: uuid
        promptId:
          type: string
          format: uuid
        title:
          type: string
        content:
          type: string
          nullable: true
        markdownContent:
          type: string
          nullable: true
        variables:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/VersionVariable'
        configuration:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/VersionConfiguration'
        promoted:
          type: boolean
          nullable: true
        draft:
          type: boolean
          nullable: true
        workspaceId:
          type: string
          format: uuid
        workflowSpec:
          type: string
          nullable: true
          description: Serialized workflow specification for workflow versions.
        isWorkflow:
          type: boolean
          nullable: true
        createdBy:
          type: string
        updatedBy:
          type: string
        deletedBy:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
          nullable: true
        updatedAt:
          type: string
          format: date-time
          nullable: true
        deletedAt:
          type: string
          format: date-time
          nullable: true
      required:
        - id
        - promptId
        - title
        - workspaceId
        - createdBy
        - updatedBy
    VersionVariable:
      type: object
      properties:
        id:
          type: string
          description: Optional stable identifier.
        name:
          type: string
        type:
          type: string
          enum:
            - file
            - text
            - mixed
        required:
          type: boolean
        description:
          type: string
        processingOptions:
          type: object
          properties:
            allowMultimodal:
              type: boolean
          required:
            - allowMultimodal
        content:
          type: string
      required:
        - name
        - type
        - required
    VersionConfiguration:
      type: object
      properties:
        model:
          type: string
        temperature:
          type: number
        budget_tokens:
          type: number
          description: Thinking/reasoning token budget for models that support it.
        type:
          type: string
          enum:
            - chat
            - completion
        structuredOutput:
          $ref: '#/components/schemas/VersionStructuredOutput'
        functions:
          type: array
          items:
            $ref: '#/components/schemas/VersionFunction'
      required:
        - model
        - type
    VersionStructuredOutput:
      type: object
      properties:
        enabled:
          type: boolean
        citations:
          type: boolean
        citationsRationale:
          type: boolean
        schema:
          type: object
          properties:
            type:
              type: string
              enum:
                - object
            title:
              type: string
            description:
              type: string
            properties:
              type: object
              additionalProperties: true
            required:
              type: array
              items:
                type: string
          required:
            - type
            - title
            - description
            - properties
            - required
      required:
        - enabled
    VersionFunction:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        parameters:
          type: object
          properties:
            type:
              type: string
              enum:
                - object
            properties:
              type: object
              additionalProperties: true
            required:
              type: array
              items:
                type: string
          required:
            - type
            - properties
      required:
        - id
        - name
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or UUID

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.