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

# Route dashboard capture

> Sort a Voice Design recording made on a dashboard into layout changes
and questions for an agent.



## OpenAPI

````yaml https://raw.githubusercontent.com/lightdash/lightdash/refs/heads/main/packages/backend/src/generated/swagger.json post /api/v1/org/aiRouter/capture/{projectUuid}
openapi: 3.0.0
info:
  title: Lightdash API
  version: 3.345.0
  description: >
    Open API documentation for all public Lightdash API endpoints. #
    Authentication Authenticate using the Authorization header with either
    'ApiKey <personal-access-token>' or 'Bearer <service-account-token>'. Create
    a Personal Access Token by following this guide:
    https://docs.lightdash.com/references/personal_tokens Self-hosted
    provisioning can use the admin token configured with
    LD_SETUP_SERVICE_ACCOUNT_TOKEN to create scoped service accounts through the
    Service Accounts API.
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
  - url: /
security: []
tags:
  - name: My Account
    description: These routes allow users to manage their own user account.
  - name: Organizations
    description: >-
      Each user is a member of a single organization. These routes allow users
      to manage their organization. Most actions are only available to admin
      users.
  - name: Projects
    description: >-
      Projects belong to a single organization. These routes allow users to
      manage their projects, browse content, and execute queries. Users inside
      an organization might have access to a project from an organization-level
      role or they might be granted access to a project directly.
  - name: Spaces
    description: >-
      Spaces allow you to organize charts and dashboards within a project. They
      also allow granular access to content by allowing you to create private
      spaces, which are only accessible to the creator and admins.
  - name: Roles & Permissions
    description: >-
      These routes allow users to manage roles and permissions for their
      organization.
    externalDocs:
      url: https://docs.lightdash.com/references/roles
  - name: Service Accounts
    description: >-
      Create and manage machine credentials for your organization. Requires
      organization administration permission. Use predefined organization
      scopes, a custom organization role, or grants to selected projects.
      Credentials cannot grant more access than the caller holds.
  - name: Query
    description: >-
      These routes allow users to execute and manage queries against their data
      warehouse. This includes metric queries, SQL queries, and retrieving query
      results.
paths:
  /api/v1/org/aiRouter/capture/{projectUuid}:
    post:
      summary: Route dashboard capture
      description: |-
        Sort a Voice Design recording made on a dashboard into layout changes
        and questions for an agent.
      operationId: routeDashboardCapture
      parameters:
        - in: path
          name: projectUuid
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiCaptureRouteRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCaptureRouteResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      security: []
components:
  schemas:
    ApiCaptureRouteRequest:
      properties:
        images:
          items:
            type: string
          type: array
          description: Screenshots with the marks drawn on, as base64 JPEG, in order.
        looseSpeech:
          items:
            type: string
          type: array
          description: Things said that were not attached to any mark.
        marks:
          items:
            $ref: '#/components/schemas/CaptureRouteMark'
          type: array
        tiles:
          items:
            $ref: '#/components/schemas/CaptureRouteTile'
          type: array
        gridColumns:
          type: number
          format: double
        dashboardName:
          type: string
      required:
        - images
        - looseSpeech
        - marks
        - tiles
        - gridColumns
        - dashboardName
      type: object
    ApiCaptureRouteResponse:
      $ref: '#/components/schemas/ApiSuccess_CaptureRoute_'
    ApiErrorPayload:
      properties:
        error:
          properties:
            data:
              $ref: '#/components/schemas/AnyType'
              description: Optional data containing details of the error
            message:
              type: string
              description: A friendly message summarising the error
            name:
              type: string
              description: Unique name for the type of error
            statusCode:
              type: number
              format: integer
              description: HTTP status code
          required:
            - name
            - statusCode
          type: object
        status:
          type: string
          enum:
            - error
          nullable: false
      required:
        - error
        - status
      type: object
      description: |-
        The Error object is returned from the api any time there is an error.
        The message contains
    CaptureRouteMark:
      properties:
        speech:
          type: string
        inside:
          items:
            properties:
              share:
                type: number
                format: double
              tileUuid:
                type: string
            required:
              - share
              - tileUuid
            type: object
          type: array
          description: >-
            Tiles under the area the mark encloses, with the percent of that
            area on each.
        path:
          items:
            $ref: '#/components/schemas/CaptureRoutePlace'
          type: array
          description: Everything the stroke passed over, in the order it was drawn.
        arrowTo:
          allOf:
            - $ref: '#/components/schemas/CaptureRoutePlace'
          nullable: true
          description: Where an arrow ends. Null for marks that are not arrows.
        at:
          $ref: '#/components/schemas/CaptureRoutePlace'
        shape:
          type: string
        image:
          type: number
          format: double
          description: Which attached screenshot shows this mark, from 1. Zero when none.
        number:
          type: number
          format: double
      required:
        - speech
        - inside
        - path
        - arrowTo
        - at
        - shape
        - image
        - number
      type: object
      description: One drawn mark from a Voice Design recording and the words said with it.
    CaptureRouteTile:
      properties:
        h:
          type: number
          format: double
        w:
          type: number
          format: double
        'y':
          type: number
          format: double
        x:
          type: number
          format: double
        title:
          type: string
        uuid:
          type: string
      required:
        - h
        - w
        - 'y'
        - x
        - title
        - uuid
      type: object
      description: A dashboard tile as the capture router sees it, in grid units.
    ApiSuccess_CaptureRoute_:
      properties:
        results:
          $ref: '#/components/schemas/CaptureRoute'
        status:
          type: string
          enum:
            - ok
          nullable: false
      required:
        - results
        - status
      type: object
    AnyType:
      description: |-
        This AnyType is an alias for any
        The goal is to make it easier to identify any type in the codebase
        without having to eslint-disable all the time
        These are only used on legacy `any` types, don't use it for new types.
        This is added on a separate file to avoid circular dependencies.
    CaptureRoutePlace:
      properties:
        cell:
          properties:
            'y':
              type: number
              format: double
            x:
              type: number
              format: double
          required:
            - 'y'
            - x
          type: object
          nullable: true
        tileUuid:
          type: string
          nullable: true
      required:
        - cell
        - tileUuid
      type: object
      description: 'Where a mark points: a tile, an empty grid cell, or nothing known.'
    CaptureRoute:
      properties:
        edits:
          items:
            $ref: '#/components/schemas/CaptureEdit'
          type: array
        questions:
          items:
            $ref: '#/components/schemas/CaptureQuestion'
          type: array
        layout:
          items:
            $ref: '#/components/schemas/CaptureLayoutOp'
          type: array
      required:
        - edits
        - questions
        - layout
      type: object
    CaptureEdit:
      properties:
        tileUuids:
          items:
            type: string
          type: array
        text:
          type: string
      required:
        - tileUuids
        - text
      type: object
      description: >-
        A change to the dashboard that an agent carries out (a filter, a new
        chart, a rename).
    CaptureQuestion:
      properties:
        tileUuids:
          items:
            type: string
          type: array
        text:
          type: string
      required:
        - tileUuids
        - text
      type: object
      description: A question to hand to the AI agent, with the tiles it is about.
    CaptureLayoutOp:
      anyOf:
        - properties:
            'y':
              type: number
              format: double
            x:
              type: number
              format: double
            tileUuid:
              type: string
            type:
              type: string
              enum:
                - move
              nullable: false
          required:
            - 'y'
            - x
            - tileUuid
            - type
          type: object
        - properties:
            h:
              type: number
              format: double
            w:
              type: number
              format: double
            tileUuid:
              type: string
            type:
              type: string
              enum:
                - resize
              nullable: false
          required:
            - h
            - w
            - tileUuid
            - type
          type: object
        - properties:
            withTileUuid:
              type: string
            tileUuid:
              type: string
            type:
              type: string
              enum:
                - swap
              nullable: false
          required:
            - withTileUuid
            - tileUuid
            - type
          type: object
      description: A layout change the page applies itself, without an agent.

````

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