Skip to main content
GET
/
overlays
/
{overlay_id}
Get overlay
curl --request GET \
  --url https://api.bedrock.cv/overlays/{overlay_id} \
  --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"
  }
}

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.

Returns the full details for an overlay, including all image URLs and change data.

​
Image URLs

FieldDescription
uriCombined overlay with changes highlighted
addition_uriOnly additions (green)
deletion_uriOnly deletions (red)
aligned_a_uriSource block aligned to target coordinates
aligned_b_uriTarget block in its native coordinates

​
Running Vision Analysis

The changes and clashes arrays are populated after running Vision API analysis:

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

Path Parameters

​
overlay_id
string
required

Overlay ID

Response

Success

​
data
object
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"
}