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

# List canvases

> Lists the canvases the caller can see - their own and every canvas shared with the organisation - most recently updated first, without content. `query` matches the title, `kind` is dashboard or page, and `pinned=true` keeps the caller's pinned canvases. Pass `next_cursor` back as `cursor` for the next page. With `source_conversation_id` and `source_artifact_id` the list is a lookup instead: `items` holds the one canvas saved from that chat artifact when the caller can see it, or is empty, and `next_cursor` is null.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/canvases
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - name: Canvas Datasets
    description: >-
      Read the fixed, named datasets canvas dashboards bind their charts, tables
      and stats to.
  - name: Canvases
    description: >-
      Keep dashboards and pages in the organisation's canvas library, with
      revision history, undo and pins.
  - name: Canvas Pages
    description: >-
      Publish a chat canvas artifact at a public pages address and take it down
      again.
  - name: Cloud Delegation
    description: >-
      Platform browser consent and organisation-bound connections for Ankra
      Cloud.
  - name: Organisation IAM
    description: >-
      Custom organisation roles and scoped role assignments for member and
      service-account identities.
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - name: Ankra Cloud Clusters
    description: >-
      Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud
      servers: a private network, a NAT router and a bastion per cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Pipelines
    description: >-
      Pipeline definitions, the approval of the authority they declare, and the
      caches pipelines keep between runs.
  - name: Workspaces
    description: >-
      Personal workspaces on the organisation's CI pool where a repository's
      heavy commands run, and the repository profiles they are built from.
  - name: Deploy Targets
    description: >-
      Environments, the hosts registered to receive deployments, and the
      releases deployed to them.
  - name: Deploy Provenance
    description: >-
      Whether an application's deploys verify signed provenance from the
      organisation's own pipeline, the keys that provenance is signed with, and
      a dry-run that verifies images without deploying.
  - name: Backups
    description: >-
      Backup vaults, restore points, protection posture and captures for stacks
      and application deployments; a completed capture is not a verified
      restore.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Services
    description: >-
      Versioned service packages and explicit sharing. Runtime admission is
      separate from publication.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Management
    description: >-
      Customer agent lifecycle, authenticated identity and organisation
      automation controls.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Remediation
    description: >-
      The organisation's auto-remediation policy: what the AI lanes may fix by
      themselves, and who approves the rest.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: AI Memory
    description: >-
      What the assistant has learned about you: your cross-session memories and
      learned profile.
  - name: MCP Servers
    description: >-
      Register the MCP servers the organisation's AI agents can call, choose
      their tools and grant them to roles.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Decisions
    description: >-
      The decision ledger behind the Security and Cost queues: proposals a
      surface computed, the approve and set-aside decisions people took on them,
      and the receipts of running them.
  - name: Usage
    description: >-
      What your organisation used of Ankra - vCPU-hours, playgrounds, managed
      services, hosted logs and metrics, and AI - per meter and period, with how
      completely it was measured and whether a published rate applies.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account
    description: >-
      Your own account: the contact email Ankra mails when it differs from your
      sign-in address.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - name: Ankra Cloud Credentials
    description: >-
      Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud
      lanes.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: Object Storage Buckets
    description: >-
      Buckets Ankra creates and manages on an organisation's own provider
      credentials.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Avura
    description: >-
      The linked Avura organization, the domains it shares with Ankra Platform,
      and their DNS records.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: Secret Slots
    description: >-
      Store secrets in Vault and reference them by ${SECRET_SLOT:<slot_id>}
      sentinel instead of by value.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /api/v1/org/canvases:
    get:
      tags:
        - Canvases
      summary: List canvases
      description: >-
        Lists the canvases the caller can see - their own and every canvas
        shared with the organisation - most recently updated first, without
        content. `query` matches the title, `kind` is dashboard or page, and
        `pinned=true` keeps the caller's pinned canvases. Pass `next_cursor`
        back as `cursor` for the next page. With `source_conversation_id` and
        `source_artifact_id` the list is a lookup instead: `items` holds the one
        canvas saved from that chat artifact when the caller can see it, or is
        empty, and `next_cursor` is null.
      operationId: list_canvases_api_v1_org_canvases_get
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            type: string
            title: Cursor
          description: The next_cursor of the previous page.
        - in: query
          name: limit
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
            title: Limit
        - in: query
          name: query
          required: false
          schema:
            type: string
            maxLength: 200
            title: Query
          description: Case-insensitive text the title contains.
        - in: query
          name: kind
          required: false
          schema:
            type: string
            enum:
              - dashboard
              - page
            title: Kind
        - in: query
          name: pinned
          required: false
          schema:
            type: boolean
            default: false
            title: Pinned
        - in: query
          name: source_conversation_id
          required: false
          description: >-
            With source_artifact_id, looks up the one canvas saved from that
            chat artifact. Give both or neither; the pair cannot be combined
            with cursor, query, kind or pinned.
          schema:
            type: string
            maxLength: 128
            title: Source Conversation Id
        - in: query
          name: source_artifact_id
          required: false
          description: >-
            With source_conversation_id, looks up the one canvas saved from that
            chat artifact.
          schema:
            type: string
            maxLength: 128
            title: Source Artifact Id
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Ankra-Organisation-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CanvasListResult'
        '400':
          description: >-
            Rejected query; the reason is invalid_cursor or invalid_request
            (including a source pair given half, malformed, or combined with
            cursor, query, kind or pinned).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/CanvasProblem'
        '401':
          description: Unauthorized
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    CanvasListResult:
      type: object
      title: CanvasListResult
      required:
        - items
        - next_cursor
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CanvasSummary'
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
    CanvasProblem:
      type: object
      title: CanvasProblem
      required:
        - type
        - title
        - status
        - detail
        - reason
        - code
        - message
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
          description: The machine code, the same as reason.
        reason:
          type: string
        code:
          type: string
        message:
          type: string
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    CanvasSummary:
      type: object
      title: CanvasSummary
      required:
        - id
        - kind
        - title
        - visibility
        - owner_user_id
        - is_owner
        - is_pinned
        - language
        - draft_revision_id
        - published_revision_id
        - source_conversation_id
        - source_artifact_id
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        kind:
          type: string
          enum:
            - dashboard
            - page
        title:
          type: string
        visibility:
          type: string
          enum:
            - private
            - organisation
        owner_user_id:
          type: string
          format: uuid
        is_owner:
          type: boolean
        is_pinned:
          type: boolean
          description: Whether the caller pinned the canvas.
        language:
          type: string
          enum:
            - json
            - html
            - svg
            - markdown
          description: The language of the draft revision.
        draft_revision_id:
          anyOf:
            - type: string
            - type: 'null'
        published_revision_id:
          anyOf:
            - type: string
            - type: 'null'
        source_conversation_id:
          anyOf:
            - type: string
            - type: 'null'
        source_artifact_id:
          anyOf:
            - type: string
            - type: 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object

````

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