{ "item": [ { "name": "Real estate", "description": "Virtual staging and listing photo edits", "item": [ { "id": "6f62e18b-6def-411c-aacf-4eed23019969", "name": "Virtually stage a room photo", "request": { "name": "Virtually stage a room photo", "description": { "content": "Furnishes an empty (or furnished) room photo in a style while keeping walls, windows, floor and camera exactly as photographed. ~30 s.", "type": "text/plain" }, "url": { "path": [ "v1", "virtual-staging" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"modern\",\n \"room_type\": \"\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nostrud9\": 89799065\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6bd385cf-683d-4075-9e1f-6d0b532388fe", "name": "Job already finished (with ?wait= or an idempotent replay of a finished job).", "originalRequest": { "url": { "path": [ "v1", "virtual-staging" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"modern\",\n \"room_type\": \"\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nostrud9\": 89799065\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee9fd4b7-1b33-40e2-8ad7-a3a61d2758aa", "name": "Job accepted. Poll GET /v1/jobs/{job_id} or wait for the webhook.", "originalRequest": { "url": { "path": [ "v1", "virtual-staging" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"modern\",\n \"room_type\": \"\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nostrud9\": 89799065\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7581c980-931d-4406-bdf6-1acf303ed09f", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "virtual-staging" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"modern\",\n \"room_type\": \"\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nostrud9\": 89799065\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beac7e6f-1e34-4b11-8557-984c68d52bda", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "virtual-staging" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"modern\",\n \"room_type\": \"\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nostrud9\": 89799065\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fea9c290-be5c-4c79-9642-a4b9ecaeb99b", "name": "Not enough credits (code insufficient_credits) or key limit reached (key_limit_reached)", "originalRequest": { "url": { "path": [ "v1", "virtual-staging" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"modern\",\n \"room_type\": \"\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nostrud9\": 89799065\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b214a80-3f1f-403d-9320-a19eff0ecc94", "name": "Idempotency-Key reused with a different request (idempotency_conflict)", "originalRequest": { "url": { "path": [ "v1", "virtual-staging" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"modern\",\n \"room_type\": \"\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nostrud9\": 89799065\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d0db3c0-09b2-44ea-acf2-50f0e4e0f3d9", "name": "Image too large", "originalRequest": { "url": { "path": [ "v1", "virtual-staging" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"modern\",\n \"room_type\": \"\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nostrud9\": 89799065\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44513825-3e78-4c0e-a6ce-887d45686c0c", "name": "Rate limit exceeded (see Retry-After)", "originalRequest": { "url": { "path": [ "v1", "virtual-staging" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"modern\",\n \"room_type\": \"\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nostrud9\": 89799065\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6390605-1aa1-45a6-93c4-ba417f19a5ed", "name": "Edit a listing photo", "request": { "name": "Edit a listing photo", "description": { "content": "Listing photo fixes that keep the property unchanged: remove furniture, declutter, brighten, window glare, day to twilight, blue sky, green lawn, lot lines on drone photos.", "type": "text/plain" }, "url": { "path": [ "v1", "photo-edits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task\": \"window_glare\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"minim_c6\": 41128062,\n \"ullamco_33\": -14045123\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "47b96f17-92ff-43e6-a87c-6a9c9a878bc5", "name": "Job already finished (with ?wait= or an idempotent replay of a finished job).", "originalRequest": { "url": { "path": [ "v1", "photo-edits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task\": \"window_glare\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"minim_c6\": 41128062,\n \"ullamco_33\": -14045123\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66d9afef-888a-4e80-8824-c07c5c14d3f9", "name": "Job accepted. Poll GET /v1/jobs/{job_id} or wait for the webhook.", "originalRequest": { "url": { "path": [ "v1", "photo-edits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task\": \"window_glare\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"minim_c6\": 41128062,\n \"ullamco_33\": -14045123\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a39e581-8b22-46ef-bc11-6147c7aef3b7", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "photo-edits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task\": \"window_glare\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"minim_c6\": 41128062,\n \"ullamco_33\": -14045123\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c960c050-8c38-4dec-b8ca-de740e7a117e", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "photo-edits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task\": \"window_glare\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"minim_c6\": 41128062,\n \"ullamco_33\": -14045123\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "718e412d-47b9-4c8c-a6bf-143f91ec402a", "name": "Not enough credits (code insufficient_credits) or key limit reached (key_limit_reached)", "originalRequest": { "url": { "path": [ "v1", "photo-edits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task\": \"window_glare\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"minim_c6\": 41128062,\n \"ullamco_33\": -14045123\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "017a18b6-e075-4fca-8225-42c699793016", "name": "Idempotency-Key reused with a different request (idempotency_conflict)", "originalRequest": { "url": { "path": [ "v1", "photo-edits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task\": \"window_glare\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"minim_c6\": 41128062,\n \"ullamco_33\": -14045123\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8359f27e-5bf7-4d8f-84c9-89aa365dc216", "name": "Image too large", "originalRequest": { "url": { "path": [ "v1", "photo-edits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task\": \"window_glare\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"minim_c6\": 41128062,\n \"ullamco_33\": -14045123\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21d0492d-05eb-4d5a-a31a-242d9e488a1b", "name": "Rate limit exceeded (see Retry-After)", "originalRequest": { "url": { "path": [ "v1", "photo-edits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task\": \"window_glare\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"minim_c6\": 41128062,\n \"ullamco_33\": -14045123\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Architecture", "description": "Renders from sketches and remodel previews", "item": [ { "id": "6279516c-9db7-4b9a-a68a-b010d76fa819", "name": "Render a sketch", "request": { "name": "Render a sketch", "description": { "content": "Turns an architectural sketch, elevation, massing model or CAD view into a photoreal (or watercolor, line-work, massing) image, keeping form, openings and viewpoint.", "type": "text/plain" }, "url": { "path": [ "v1", "renders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"photoreal\",\n \"lighting\": \"day\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"eiusmod_3\": false,\n \"laborea4\": 36184264,\n \"Ut_c__\": -66505867.799135834\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b562a2ee-5aed-4b74-b946-8fa644dc8892", "name": "Job already finished (with ?wait= or an idempotent replay of a finished job).", "originalRequest": { "url": { "path": [ "v1", "renders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"photoreal\",\n \"lighting\": \"day\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"eiusmod_3\": false,\n \"laborea4\": 36184264,\n \"Ut_c__\": -66505867.799135834\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "425f4f26-51f2-42d0-802e-5a2a4b6a241f", "name": "Job accepted. Poll GET /v1/jobs/{job_id} or wait for the webhook.", "originalRequest": { "url": { "path": [ "v1", "renders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"photoreal\",\n \"lighting\": \"day\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"eiusmod_3\": false,\n \"laborea4\": 36184264,\n \"Ut_c__\": -66505867.799135834\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68b9aaf3-a4d0-45e5-9d02-0ffee5666228", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "renders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"photoreal\",\n \"lighting\": \"day\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"eiusmod_3\": false,\n \"laborea4\": 36184264,\n \"Ut_c__\": -66505867.799135834\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51a2010b-8371-4a4e-a2ed-b37dbf5b7d2c", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "renders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"photoreal\",\n \"lighting\": \"day\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"eiusmod_3\": false,\n \"laborea4\": 36184264,\n \"Ut_c__\": -66505867.799135834\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a8e5afb-8247-48f3-87aa-6ed150a8bbee", "name": "Not enough credits (code insufficient_credits) or key limit reached (key_limit_reached)", "originalRequest": { "url": { "path": [ "v1", "renders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"photoreal\",\n \"lighting\": \"day\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"eiusmod_3\": false,\n \"laborea4\": 36184264,\n \"Ut_c__\": -66505867.799135834\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b184a06-b4a2-4d27-987a-0cf36932fd56", "name": "Idempotency-Key reused with a different request (idempotency_conflict)", "originalRequest": { "url": { "path": [ "v1", "renders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"photoreal\",\n \"lighting\": \"day\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"eiusmod_3\": false,\n \"laborea4\": 36184264,\n \"Ut_c__\": -66505867.799135834\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89cb6362-db13-4de8-8184-664d787f816d", "name": "Image too large", "originalRequest": { "url": { "path": [ "v1", "renders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"photoreal\",\n \"lighting\": \"day\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"eiusmod_3\": false,\n \"laborea4\": 36184264,\n \"Ut_c__\": -66505867.799135834\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89e21214-ee56-406d-80ab-2b11e03f522b", "name": "Rate limit exceeded (see Retry-After)", "originalRequest": { "url": { "path": [ "v1", "renders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"style\": \"photoreal\",\n \"lighting\": \"day\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"eiusmod_3\": false,\n \"laborea4\": 36184264,\n \"Ut_c__\": -66505867.799135834\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b491908-0e05-4c2f-bc6b-10215aeb814d", "name": "Preview a remodel on a photo", "request": { "name": "Preview a remodel on a photo", "description": { "content": "Changes one thing on a photo of a real building (new siding, a pergola, an open kitchen, a different roof) and keeps everything else.", "type": "text/plain" }, "url": { "path": [ "v1", "remodels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"elit_a\": 50248666.49579173\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5c5953d2-5bb4-4e9c-bfa2-8546156c6cc6", "name": "Job already finished (with ?wait= or an idempotent replay of a finished job).", "originalRequest": { "url": { "path": [ "v1", "remodels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"elit_a\": 50248666.49579173\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e966b3c-730d-4c53-acfc-0a6ffa852dd5", "name": "Job accepted. Poll GET /v1/jobs/{job_id} or wait for the webhook.", "originalRequest": { "url": { "path": [ "v1", "remodels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"elit_a\": 50248666.49579173\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "650337ad-115a-4b5a-afe3-017d9d13c1ad", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "remodels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"elit_a\": 50248666.49579173\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48995462-e8d7-4090-aeaa-0e250aaa04ab", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "remodels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"elit_a\": 50248666.49579173\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30dc516b-8d3c-48e5-a0b4-2a9d9b5745ef", "name": "Not enough credits (code insufficient_credits) or key limit reached (key_limit_reached)", "originalRequest": { "url": { "path": [ "v1", "remodels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"elit_a\": 50248666.49579173\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a137a24c-5156-4325-82d2-6f09ab807a82", "name": "Idempotency-Key reused with a different request (idempotency_conflict)", "originalRequest": { "url": { "path": [ "v1", "remodels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"elit_a\": 50248666.49579173\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ea44072-e42a-4ae8-ae16-b6c011204662", "name": "Image too large", "originalRequest": { "url": { "path": [ "v1", "remodels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"elit_a\": 50248666.49579173\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3c69105-b34e-4f96-b8c4-64814f6b6942", "name": "Rate limit exceeded (see Retry-After)", "originalRequest": { "url": { "path": [ "v1", "remodels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"elit_a\": 50248666.49579173\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Floor plans & CAD", "description": "Floor plan redraws (image) and CAD drawings (DXF, DWG, PDF)", "item": [ { "id": "10b39d5a-e9de-4863-9690-6c64e323b1d0", "name": "Redraw a floor plan as a clean 2D plan image", "request": { "name": "Redraw a floor plan as a clean 2D plan image", "description": { "content": "Redraws a hand sketch, photo or scan of a floor plan as a clean, labeled 2D plan image (black walls on white, doors, windows, room names, written dimensions). For measured CAD files use POST /v1/cad.", "type": "text/plain" }, "url": { "path": [ "v1", "floor-plans", "redraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"sed_b\": false\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "db491350-1284-4de3-a922-d9deff6d349e", "name": "Job already finished (with ?wait= or an idempotent replay of a finished job).", "originalRequest": { "url": { "path": [ "v1", "floor-plans", "redraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"sed_b\": false\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "051c4ea7-93f6-45d8-a9b7-e46837d1c025", "name": "Job accepted. Poll GET /v1/jobs/{job_id} or wait for the webhook.", "originalRequest": { "url": { "path": [ "v1", "floor-plans", "redraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"sed_b\": false\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc3eb4cb-9b28-48ad-a6c5-30906d749135", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "floor-plans", "redraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"sed_b\": false\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6222e976-0039-40ba-a2b9-315dd230511a", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "floor-plans", "redraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"sed_b\": false\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ae649f5-0e79-4207-a6fb-0e1c5f426edb", "name": "Not enough credits (code insufficient_credits) or key limit reached (key_limit_reached)", "originalRequest": { "url": { "path": [ "v1", "floor-plans", "redraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"sed_b\": false\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2c1ae7d-cfc5-4a8b-a093-ebc290a5c712", "name": "Idempotency-Key reused with a different request (idempotency_conflict)", "originalRequest": { "url": { "path": [ "v1", "floor-plans", "redraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"sed_b\": false\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24270156-1344-4c79-adb5-137207e1724b", "name": "Image too large", "originalRequest": { "url": { "path": [ "v1", "floor-plans", "redraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"sed_b\": false\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de08150c-3553-47ad-94aa-edcc0a916ad2", "name": "Rate limit exceeded (see Retry-After)", "originalRequest": { "url": { "path": [ "v1", "floor-plans", "redraw" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"\",\n \"image\": \"\",\n \"resolution\": \"2k\",\n \"aspect_ratio\": \"auto\",\n \"notes\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"sed_b\": false\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "889edbb0-9262-4750-8969-6fa0449ec3a2", "name": "Draw a CAD floor plan (DXF, DWG, PDF) from a brief, sketch or photo", "request": { "name": "Draw a CAD floor plan (DXF, DWG, PDF) from a brief, sketch or photo", "description": { "content": "An AI drafter draws a dimensioned, layered CAD floor plan from a text brief and/or a sketch, photo or scan of a plan. Output: DXF (layered), DWG, A3 PDF sheet and PNG. Usually 2-6 minutes. Credits = real usage (minimum 300, at most 2500 per job; 600 must be available to start).", "type": "text/plain" }, "url": { "path": [ "v1", "cad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"brief\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"units\": \"m\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"pariatur_ed3\": true\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4f40480f-984e-4e0a-9d33-30e76df6e8b4", "name": "Job already finished (with ?wait= or an idempotent replay of a finished job).", "originalRequest": { "url": { "path": [ "v1", "cad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"brief\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"units\": \"m\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"pariatur_ed3\": true\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "136f2919-e0ae-433d-93a8-7048876d95f6", "name": "Job accepted. Poll GET /v1/jobs/{job_id} or wait for the webhook.", "originalRequest": { "url": { "path": [ "v1", "cad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"brief\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"units\": \"m\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"pariatur_ed3\": true\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5427b8b4-f59b-4afc-b180-1756989291d1", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "cad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"brief\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"units\": \"m\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"pariatur_ed3\": true\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "824879c0-cea1-40fb-803f-4b49c442a7af", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "cad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"brief\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"units\": \"m\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"pariatur_ed3\": true\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be558f77-5c77-4d9d-bed8-6556ec68ba46", "name": "Not enough credits (code insufficient_credits) or key limit reached (key_limit_reached)", "originalRequest": { "url": { "path": [ "v1", "cad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"brief\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"units\": \"m\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"pariatur_ed3\": true\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1693b99b-2d87-4023-8004-a3ccc04c26ce", "name": "Idempotency-Key reused with a different request (idempotency_conflict)", "originalRequest": { "url": { "path": [ "v1", "cad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"brief\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"units\": \"m\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"pariatur_ed3\": true\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3510b4a2-e9d7-4611-a55a-fe4640256c67", "name": "Image too large", "originalRequest": { "url": { "path": [ "v1", "cad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"brief\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"units\": \"m\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"pariatur_ed3\": true\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b1f69da-2229-4d63-a2c1-d11a8c710334", "name": "Rate limit exceeded (see Retry-After)", "originalRequest": { "url": { "path": [ "v1", "cad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"brief\": \"\",\n \"image_url\": \"\",\n \"image\": \"\",\n \"units\": \"m\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"pariatur_ed3\": true\n },\n \"simulate\": \"failed\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d57fd0f4-6256-47bd-ade9-816ccbfebe8c", "name": "Revise a CAD drawing by instruction", "request": { "name": "Revise a CAD drawing by instruction", "description": { "content": "A new version of a finished CAD job (\"make the kitchen 1 m wider\", \"add a garage on the left\"). Lets your customers customize a plan by chat. Credits = real usage (min 60, max 1200).", "type": "text/plain" }, "url": { "path": [ "v1", "cad", ":job_id", "revise" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "job_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nona\": \"Duis sit aute officia\"\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6bc2264c-5bcb-45b9-a5ad-7b2383692995", "name": "Job already finished (with ?wait= or an idempotent replay of a finished job).", "originalRequest": { "url": { "path": [ "v1", "cad", ":job_id", "revise" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nona\": \"Duis sit aute officia\"\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d94c46d4-06c8-42f7-8ba7-9e41e1476e30", "name": "Job accepted. Poll GET /v1/jobs/{job_id} or wait for the webhook.", "originalRequest": { "url": { "path": [ "v1", "cad", ":job_id", "revise" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nona\": \"Duis sit aute officia\"\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0df88be-57e1-4ee0-bdb4-5bdeb849de0d", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "cad", ":job_id", "revise" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nona\": \"Duis sit aute officia\"\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "581f6879-c265-4691-8116-93c64663de27", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "cad", ":job_id", "revise" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nona\": \"Duis sit aute officia\"\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b2a5b17-c0e5-42b9-88be-103984877f1a", "name": "Not enough credits (code insufficient_credits) or key limit reached (key_limit_reached)", "originalRequest": { "url": { "path": [ "v1", "cad", ":job_id", "revise" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nona\": \"Duis sit aute officia\"\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "915f1018-59a8-4611-a2d8-c379d946f9de", "name": "Idempotency-Key reused with a different request (idempotency_conflict)", "originalRequest": { "url": { "path": [ "v1", "cad", ":job_id", "revise" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nona\": \"Duis sit aute officia\"\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a8f8831-acb2-4283-8ffc-e79770b62905", "name": "Image too large", "originalRequest": { "url": { "path": [ "v1", "cad", ":job_id", "revise" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nona\": \"Duis sit aute officia\"\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ef8a8c5-7bc5-484b-839a-4a979411c81b", "name": "Rate limit exceeded (see Retry-After)", "originalRequest": { "url": { "path": [ "v1", "cad", ":job_id", "revise" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hold the response up to N seconds and return the finished job if it completes in time (also: Prefer: wait=N).", "type": "text/plain" }, "key": "wait", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely: the same key with the same body returns the original job instead of creating (and charging) a new one.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instructions\": \"\",\n \"webhook_url\": \"\",\n \"metadata\": {\n \"nona\": \"Duis sit aute officia\"\n },\n \"simulate\": \"insufficient_credits\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Jobs", "description": "Job status and files", "item": [ { "id": "f199e411-ff24-4a0e-b3c9-953490016c27", "name": "List jobs", "request": { "name": "List jobs", "description": {}, "url": { "path": [ "v1", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "running" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "type", "value": "render" }, { "disabled": false, "description": { "content": "Job id: list older jobs (pagination).", "type": "text/plain" }, "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5bde30b1-4a41-4866-ab75-bc30e39a4461", "name": "Jobs, newest first", "originalRequest": { "url": { "path": [ "v1", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "running" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "type", "value": "render" }, { "disabled": false, "description": { "content": "Job id: list older jobs (pagination).", "type": "text/plain" }, "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": {\n \"const\": \"list\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"canceled\",\n \"mode\": \"live\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"cillum_da8\": 66515219,\n \"ad_b9\": -6334429\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"cad\",\n \"status\": \"running\",\n \"mode\": \"live\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"ut53_\": \"laboris aliquip\",\n \"pariatur_2d\": -36292575\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"has_more\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53ba6d71-3f4f-4f17-b556-f6470e22dae1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "running" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "type", "value": "render" }, { "disabled": false, "description": { "content": "Job id: list older jobs (pagination).", "type": "text/plain" }, "key": "starting_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fa16a32-4612-4429-acf7-023fd69c0991", "name": "Get a job", "request": { "name": "Get a job", "description": { "content": "Status, credits charged and (when succeeded) signed download links valid for 24 hours. Fetch again for fresh links.", "type": "text/plain" }, "url": { "path": [ "v1", "jobs", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "job_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c3fe879f-b72b-4a14-bd3f-acbd7e4fb1d9", "name": "The job", "originalRequest": { "url": { "path": [ "v1", "jobs", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "URL of the job", "type": "text/plain" }, "key": "Location", "value": "" }, { "disabled": false, "description": { "content": "\"true\" when an Idempotency-Key replayed an earlier job", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"job\"\n },\n \"type\": \"virtual_staging\",\n \"status\": \"running\",\n \"mode\": \"test\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"credits_charged\": \"\",\n \"credits_estimate\": \"\",\n \"input\": {\n \"commodoc\": \"dolore quis\",\n \"incididunt_65\": 76472373\n },\n \"output\": {\n \"images\": [\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n },\n {\n \"url\": \"\",\n \"formats\": {\n \"jpg\": \"\",\n \"png\": \"\",\n \"webp\": \"\"\n },\n \"preview_url\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n ],\n \"files\": {\n \"dxf\": \"\",\n \"dwg\": \"\",\n \"pdf\": \"\",\n \"png\": \"\"\n },\n \"version\": \"\",\n \"title\": \"\",\n \"units\": \"\",\n \"sandbox\": \"\",\n \"links_expire_at\": \"\"\n },\n \"error\": null,\n \"metadata\": null,\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13bd02ff-eed1-4077-aa6c-8e8bff1bfbbb", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "jobs", ":job_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8883a19b-e747-4774-a170-d46213473c3a", "name": "Download a result file", "request": { "name": "Download a result file", "description": { "content": "Images: result.jpg, result.png, result.webp, preview.jpg. CAD: plan.dxf, plan.dwg, plan.pdf, plan.png. Authenticate with your key, or use the signed URL from the job (expires and signature query parameters).", "type": "text/plain" }, "url": { "path": [ "v1", "files", ":job_id", ":name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "expires", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "signature", "value": "" }, { "disabled": false, "description": { "content": "0 = inline instead of attachment", "type": "text/plain" }, "key": "download", "value": "1" } ], "variable": [ { "type": "any", "value": "", "key": "job_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "plan.dwg", "key": "name", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "image/jpeg" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "220ad571-0824-45e8-906c-003c710c777f", "name": "The file", "originalRequest": { "url": { "path": [ "v1", "files", ":job_id", ":name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "expires", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "signature", "value": "" }, { "disabled": false, "description": { "content": "0 = inline instead of attachment", "type": "text/plain" }, "key": "download", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "image/jpeg" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "image/jpeg" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "572cf54c-e381-4927-8c9c-cc3864e64de6", "name": "Link expired", "originalRequest": { "url": { "path": [ "v1", "files", ":job_id", ":name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "expires", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "signature", "value": "" }, { "disabled": false, "description": { "content": "0 = inline instead of attachment", "type": "text/plain" }, "key": "download", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46e97edc-1cca-40ad-8ade-4b47067a4448", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "files", ":job_id", ":name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "expires", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "signature", "value": "" }, { "disabled": false, "description": { "content": "0 = inline instead of attachment", "type": "text/plain" }, "key": "download", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "223b74b7-db65-431f-8070-433afb33b1cd", "name": "Not ready, or superseded by a newer CAD version", "originalRequest": { "url": { "path": [ "v1", "files", ":job_id", ":name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "expires", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "signature", "value": "" }, { "disabled": false, "description": { "content": "0 = inline instead of attachment", "type": "text/plain" }, "key": "download", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Webhooks", "description": "Endpoints that receive job.succeeded and job.failed", "item": [ { "id": "02f85d4b-6930-4167-8d12-d0f3448f1a0a", "name": "List webhook endpoints (and the signing secret)", "request": { "name": "List webhook endpoints (and the signing secret)", "description": {}, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "955ce580-3caf-4f01-8feb-466f8357c25f", "name": "Endpoints of this key's mode", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20bf690e-ce4b-49b2-8fca-d54da794c9d8", "name": "Add a webhook endpoint", "request": { "name": "Add a webhook endpoint", "description": { "content": "Receives job.succeeded and job.failed for every job of this mode (live or test). Used by Zapier/Make REST hooks too.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4950a566-b261-4f26-9383-58a56cae58f5", "name": "Created (includes signing_secret)", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2baf20a-b136-4e4a-8c8f-7d785e647c4d", "name": "Invalid URL", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ccb3aa5f-3e48-40be-b705-a5878adf15c3", "name": "Remove a webhook endpoint", "request": { "name": "Remove a webhook endpoint", "description": {}, "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "ab2f7134-51fc-42b8-a98f-4cfcbd05689b", "name": "Deleted", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7a559575-d8fe-4773-8db2-c7ec414ab92d", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "994c88f4-c4a6-4c90-8c64-1ebf4e15ead8", "name": "Send a webhook.test event", "request": { "name": "Send a webhook.test event", "description": {}, "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "d931ab6d-5522-40ec-a320-fa38f793628c", "name": "Delivery result", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account", "description": "Credits, limits and pricing", "item": [ { "id": "aad0c5bf-4d98-42f6-8de1-e1e952dce9e8", "name": "Credits, key and limits", "request": { "name": "Credits, key and limits", "description": {}, "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "55d17837-09d5-451e-9234-69627b340785", "name": "Account", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account_id\": \"\",\n \"mode\": \"\",\n \"credits_balance\": \"\",\n \"key\": {},\n \"limits\": {},\n \"pricing_credits\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87f53a2d-9b8e-4f7c-82b9-f7b0108dfacd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.20.vision" }, { "key": "apiKey", "value": "sk_test_your_sandbox_key" } ], "info": { "_postman_id": "e5b17479-f056-4e90-8f10-80a306a59fa6", "name": "AI Architectures API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Async REST API for real-estate photographers, house-plan sellers, prefab builders and proptech platforms. Create a job, then poll it or receive a signed webhook. White-label: outputs carry no third-party branding. Billing in credits from your account (100 credits per 2K image; CAD by real usage, typically 300-1500 credits). Sandbox keys (sk_test_) return sample outputs for free.\n\nContact Support:\n Name: API support\n Email: support@ai-architectures.com", "type": "text/plain" } } }