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

# List canvases in a project



## OpenAPI

````yaml /api/openapi.json get /api/v1/projects/{projectId}/canvases
openapi: 3.0.2
info:
  title: Melius API
  version: '1'
  description: >-
    The Melius REST API. Authenticate with an API key as a bearer token
    (`Authorization: Bearer mel_...`) and select the team to act on with the
    `x-team-id` header. Generations run through the same node + run pipeline as
    the app: create a node on a canvas, start a run, poll the run, then read the
    resulting version asset.
servers:
  - url: https://api.melius.com
security:
  - apiKey: []
    teamId: []
paths:
  /api/v1/projects/{projectId}/canvases:
    get:
      tags:
        - canvas
      summary: List canvases in a project
      operationId: canvas.list
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 100
        - name: offset
          in: query
          schema:
            default: 0
            type: integer
            minimum: 0
            nullable: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        teamId:
                          type: string
                          format: uuid
                        projectId:
                          type: string
                          format: uuid
                        title:
                          type: string
                        nodeCount:
                          type: integer
                        sortOrder:
                          type: integer
                        worldConfig:
                          type: object
                          additionalProperties: {}
                        createdByUserId:
                          type: string
                          format: uuid
                          nullable: true
                        previewAssets:
                          type: array
                          items:
                            type: object
                            properties:
                              url:
                                type: string
                              mediaType:
                                type: string
                                enum:
                                  - image
                                  - video
                              thumbnailUrl:
                                type: string
                                nullable: true
                            required:
                              - url
                              - mediaType
                              - thumbnailUrl
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - teamId
                        - projectId
                        - title
                        - nodeCount
                        - sortOrder
                        - worldConfig
                        - createdByUserId
                        - previewAssets
                        - createdAt
                        - updatedAt
                  total:
                    type: integer
                required:
                  - data
                  - total
        '401':
          description: Missing, invalid, expired, or revoked API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - statusCode
                  - message
        '403':
          description: The API key's user is not a member of the requested team.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - statusCode
                  - message
        '429':
          description: Rate limit reached — retry after the `Retry-After` header.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  retryAfterSeconds:
                    type: integer
                required:
                  - statusCode
                  - message
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'A Melius API key (`mel_...`), sent as `Authorization: Bearer <key>`.'
    teamId:
      type: apiKey
      in: header
      name: x-team-id
      description: The team (workspace) to act on. Defaults to the key's team when omitted.

````