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

# List overlays

> Retrieve overlays from a comparison job.

Returns a paginated list of overlays. Filter by project, job, drawing, or whether changes have been detected. See [Filtering](/api-reference/filtering#overlays) for all available query parameters.


## OpenAPI

````yaml GET /overlays
openapi: 3.1.0
info:
  title: Bedrock API
  version: 1.0.0
  description: >-
    REST API for construction document management and computer vision
    intelligence.
  contact:
    name: Bedrock Support
    url: https://bedrock.cv
    email: support@bedrock.cv
servers:
  - url: https://api.bedrock.cv
security:
  - BearerAuth: []
  - ApiKeyAuth: []
paths:
  /overlays:
    get:
      tags:
        - CMS
      summary: List overlays
      description: Return overlays with optional filters.
      operationId: listOverlays
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
        - $ref: '#/components/parameters/CursorParam'
        - $ref: '#/components/parameters/LimitParam'
        - name: block_a_id
          in: query
          required: false
          schema:
            type: string
          description: Filter by block A
        - name: block_b_id
          in: query
          required: false
          schema:
            type: string
          description: Filter by block B
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OverlaySummary'
                  _meta:
                    type: object
                    properties:
                      next:
                        type: string
                        nullable: true
                      prev:
                        type: string
                        nullable: true
                      limit:
                        type: integer
              example:
                data:
                  - id: ovl_01JABCD123
                    block_a_id: blk_01JABCD100
                    block_b_id: blk_01JABCD200
                    job_id: job_01JABCD123
                    uri: gs://bedrock-files/overlays/ovl_01JABCD123.png
                    addition_uri: gs://bedrock-files/overlays/ovl_01JABCD123_add.png
                    deletion_uri: gs://bedrock-files/overlays/ovl_01JABCD123_del.png
                    aligned_a_uri: gs://bedrock-files/overlays/ovl_01JABCD123_a.png
                    aligned_b_uri: gs://bedrock-files/overlays/ovl_01JABCD123_b.png
                    score: 0.87
                    summary:
                      added_area: 1240
                      removed_area: 560
                      changed_percent: 4.2
                    changes:
                      - type: addition
                        description: New partition wall added at grid line C-4
                    clashes: []
                    created_at: '2024-06-17T09:00:00Z'
                _meta:
                  next: >-
                    eyJpZCI6ImN1cnNvcl8xMjM0NTYiLCJjcmVhdGVkX2F0IjoiMjAyNC0wNi0xNVQxMDozMDowMFoifQ==
                  prev: null
                  limit: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    ApiVersionHeader:
      name: X-API-Version
      in: header
      required: false
      schema:
        type: string
        default: '2026-01-01'
      description: API version
    CursorParam:
      name: cursor
      in: query
      required: false
      schema:
        type: string
      description: Pagination cursor
    LimitParam:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 20
        minimum: 1
        maximum: 100
      description: Number of items per page
  schemas:
    OverlaySummary:
      type: object
      properties:
        id:
          type: string
        block_a_id:
          type: string
        block_b_id:
          type: string
        job_id:
          type: string
          nullable: true
        uri:
          type: string
          nullable: true
        addition_uri:
          type: string
          nullable: true
        deletion_uri:
          type: string
          nullable: true
        aligned_a_uri:
          type: string
          nullable: true
        aligned_b_uri:
          type: string
          nullable: true
        score:
          type: number
          nullable: true
        summary:
          type: object
          additionalProperties:
            type: object
          nullable: true
        changes:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              description:
                type: string
        clashes:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              description:
                type: string
        created_at:
          type: string
          format: date-time
      required:
        - id
        - block_a_id
        - block_b_id
        - job_id
        - uri
        - addition_uri
        - deletion_uri
        - aligned_a_uri
        - aligned_b_uri
        - score
        - summary
        - changes
        - clashes
        - created_at
      example:
        id: ovl_01JABCD123
        block_a_id: blk_01JABCD100
        block_b_id: blk_01JABCD200
        job_id: job_01JABCD123
        uri: gs://bedrock-files/overlays/ovl_01JABCD123.png
        addition_uri: gs://bedrock-files/overlays/ovl_01JABCD123_add.png
        deletion_uri: gs://bedrock-files/overlays/ovl_01JABCD123_del.png
        aligned_a_uri: gs://bedrock-files/overlays/ovl_01JABCD123_a.png
        aligned_b_uri: gs://bedrock-files/overlays/ovl_01JABCD123_b.png
        score: 0.87
        summary:
          added_area: 1240
          removed_area: 560
          changed_percent: 4.2
        changes:
          - type: addition
            description: New partition wall added at grid line C-4
        clashes: []
        created_at: '2024-06-17T09:00:00Z'
    ApiError:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        request_id:
          type: string
        instance:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - type
        - title
        - status
        - detail
      example:
        type: https://docs.bedrock.cv/errors/bad-request
        title: Bad Request
        status: 400
        detail: One or more request fields are invalid.
        instance: /projects
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            type: https://docs.bedrock.cv/errors/authentication
            title: Unauthorized
            status: 401
            detail: Invalid or missing API key.
            code: UNAUTHORIZED
            request_id: req_01JABCD123
    RateLimited:
      description: Rate limited
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            type: https://docs.bedrock.cv/errors/rate-limit
            title: Rate limited
            status: 429
            detail: Rate limit exceeded. Try again in 60 seconds.
            code: RATE_LIMITED
            request_id: req_01JABCD123
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'API key prefixed with `sk_`. Example: `Authorization: Bearer sk_xxx`'
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````