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
}
}Retrieve overlays from a comparison job.
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
}
}API key prefixed with sk_. Example: Authorization: Bearer sk_xxx
API version
Pagination cursor
Number of items per page
1 <= x <= 100Filter by block A
Filter by block B