Skip to main content
GET
/
overlays
List overlays
curl --request GET \
  --url https://api.bedrock.cv/overlays \
  --header 'Authorization: Bearer <token>'
{
  "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
  }
}
Returns a paginated list of overlays. Filter by project, job, drawing, or whether changes have been detected. See Filtering for all available query parameters.

Authorizations

Authorization
string
header
required

API key prefixed with sk_. Example: Authorization: Bearer sk_xxx

Headers

X-API-Version
string
default:2026-01-01

API version

Query Parameters

cursor
string

Pagination cursor

limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
block_a_id
string

Filter by block A

block_b_id
string

Filter by block B

Response

Success

data
object[]
_meta
object