{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"73c7c3e7-e7ae-403d-ac99-317ee72188f6","name":"Blueprint Pro.AI Partners Api","description":"# How to use it?\n\n### Get the credentials\n\nThe Blueprint Pro.AI Partners Api works with the well-known industry-standard protocol for authorization OAuth 2.0.\n\nTo call all operations in the Api you will need to get an **access_token** through the endpoint POST /v1/oauth/token sending your **client_id** and **client_secret** provided by a Blueprint Pro.AI Api Administrator.\n\n### Setup notifications\n\nThe Blueprint Pro.AI platform can send real-time notifications to all partner platforms.\n\nYou can use the /v1/events/subscriptions route to subscribe and receive notifications about all order events as soon as they occur.\n\nSee [Events Schemas ](#f7cd8570-6c85-4417-a882-42a230989e3d) for more details about the events and check also [Webhook Signature](#9ca1c2fc-4c14-441b-84bd-657f04c26d37) to see how to verify the authenticity and integrity of the payload.\n\n### Get avaiable services\n\nTo create a new order, you must specify which materials it will include (e.g., wood, roofing).  \nThere are two types of services:\n\n1. Individual services, which correspond to each specific material type.\n    \n2. Service packages, which combine multiple services into a single bundle.\n    \n\nYou can get the list of all avaiable services in GET /v1/services.\n\n### Submitt a new order\n\nYou can submit a new order in POST /v1/orders endpoint.\n\nYou need to inform:\n\n- _PdfFile:_ the blueprint file itself.\n    \n- _Services_: the takeoff service types that you want for the blueprint.\n    \n- _TakeoffName:_ The identification of the takeoff.\n    \n- _PartnerOrderId:_ Your custom identification, to help you find the order in you own platform.\n    \n- _ZipCode:_ Blueprint Zip Code\n    \n- _AdditionalFile:_ Blueprint additional file\n    \n- WorkspaceId: Code of the workspace where the order will be created\n    \n- PdfFileUrl: URL of the location where the blueprints to be sent are stored\n    \n- AdditionalFileUrl: URL of the location where the additional files you want to send are stored\n    \n- AduName: Adu Name\n    \n- AduFileUrl: URL of the location where the ADU files are stored\n    \n- AduFile: ADU PDF file\n    \n- IsRemodel: Flag for remodel projects  \n    \n\nThe Api will return a **requestId**, that you can use later to query for the order status.\n\nContact Support:  \nName: Blueprint Pro AI Development Team  \nEmail: [dev@blueprintpro.ai](https://mailto:dev@blueprintpro.ai)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"38375438","team":6475826,"collectionId":"73c7c3e7-e7ae-403d-ac99-317ee72188f6","publishedId":"2sAYkEqfVM","public":true,"publicUrl":"https://stg-sandbox.blueprintpro.ai","privateUrl":"https://go.postman.co/documentation/38375438-73c7c3e7-e7ae-403d-ac99-317ee72188f6","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"31CF02"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Blueprint Pro.AI Api for partners integration."},{"name":"title","value":"Blueprint PRO AI - SandBox API"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/d5e67445-f4d1-4c20-86ef-79bf637a1c94/Ymx1ZXByaW50LXByby1sb2dvc192M19tYWluLWxvZ29fMS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"31CF02"}},{"name":"light","logo":"https://content.pstmn.io/caf61b5e-77aa-4751-9c15-54999db58950/Ymx1ZXByaW50LXByby1sb2dvc192M19ibHVlLWxvZ28tZm9yLWxpZ2h0LWJnXzEucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"31CF02"}}]}},"version":"8.11.4","publishDate":"2025-12-03T19:33:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Blueprint PRO AI - SandBox API","description":"Blueprint Pro.AI Api for partners integration."},"logos":{"logoLight":"https://content.pstmn.io/caf61b5e-77aa-4751-9c15-54999db58950/Ymx1ZXByaW50LXByby1sb2dvc192M19ibHVlLWxvZ28tZm9yLWxpZ2h0LWJnXzEucG5n","logoDark":"https://content.pstmn.io/d5e67445-f4d1-4c20-86ef-79bf637a1c94/Ymx1ZXByaW50LXByby1sb2dvc192M19tYWluLWxvZ29fMS5wbmc="}},"statusCode":200},"environments":[{"name":"partners.api.staging.blueprintpro.ai","id":"7535e8fb-7655-4d9a-bac3-df11284fb29b","owner":"38375438","values":[{"key":"partnersUrl","value":"https://partners.api.staging.blueprintpro.ai","enabled":true,"type":"default"},{"key":"access_token","value":"eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjYjI5ZTlmOS1mMWU2LTRmOWUtYTk5Mi0yNzg0MTM0NmMyMTMiLCJqdGkiOiI2ZDI3OWQwMi00YWNhLTQ4OGUtYjJlMi1hOTUzMDdkMzI3ODEiLCJpYXQiOiIxNzU0NTc1NDMwIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQVBJQ0xJRU5UIiwiaHR0cHM6Ly9ibHVlcHJpbnRwcm9haS5jb20vY2xhaW1zL3dvcmtzcGFjZUlkIjoiNSIsImh0dHBzOi8vYmx1ZXByaW50cHJvYWkuY29tL2NsYWltcy93b3Jrc3BhY2VOYW1lIjoiQXRsYW50YSIsImh0dHBzOi8vYmx1ZXByaW50cHJvYWkuY29tL2NsYWltcy9jb21wYW55TmFtZSI6IlRoZSBIb21lIERlcG90LFx1MjAyRkluYyIsIm5iZiI6MTc1NDU3NTQzMCwiZXhwIjoxNzU0NTc5MDMwLCJpc3MiOiJodHRwczovL3d3dy5ibHVlcHJpbnRwcm8uYWkvIiwiYXVkIjoiaHR0cHM6Ly9hcGkuc3RhZ2luZy5ibHVlcHJpbnRwcm8uYWkvIn0.6D8taMpKpYEz3zOdc0BFNEElxOz5QRw4qWJcKJ2BKyU","enabled":true,"type":"default"},{"key":"partnersClientId","value":"","enabled":true,"type":"default"},{"key":"partnersClientSecret","value":"","enabled":true,"type":"default"},{"enabled":true,"key":"baseUrl","value":"","type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/bf374bfa7d1a68ec2ba3ae28a64301f2671db839f431c79bbf48b942e639f058","favicon":"https://blueprintpro.ai/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"partners.api.staging.blueprintpro.ai","value":"38375438-7535e8fb-7655-4d9a-bac3-df11284fb29b"}],"canonicalUrl":"https://stg-sandbox.blueprintpro.ai/view/metadata/2sAYkEqfVM"}