Import report
curl --request POST \
--url https://api.roofkit.ai/api/v1/reports/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Length: <content-length>' \
--header 'Content-Type: multipart/form-data' \
--header 'Idempotency-Key: <idempotency-key>' \
--form files=@example-file \
--form external_report_id=vendor-123import requests
url = "https://api.roofkit.ai/api/v1/reports/import"
files = { "files": ("example-file", open("example-file", "rb")) }
payload = { "external_report_id": "vendor-123" }
headers = {
"Idempotency-Key": "<idempotency-key>",
"Content-Length": "<content-length>",
"Authorization": "Bearer <token>"
}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('files', '@./report.xml');
form.append('external_report_id', 'vendor-123');
const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'Content-Length': '<content-length>',
Authorization: 'Bearer <token>'
}
};
options.body = form;
fetch('https://api.roofkit.ai/api/v1/reports/import', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roofkit.ai/api/v1/reports/import",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@./report.xml\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_report_id\"\r\n\r\nvendor-123\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Length: <content-length>",
"Content-Type: multipart/form-data",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.roofkit.ai/api/v1/reports/import"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@./report.xml\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_report_id\"\r\n\r\nvendor-123\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Content-Length", "<content-length>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.roofkit.ai/api/v1/reports/import")
.header("Idempotency-Key", "<idempotency-key>")
.header("Content-Length", "<content-length>")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@./report.xml\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_report_id\"\r\n\r\nvendor-123\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roofkit.ai/api/v1/reports/import")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Length"] = '<content-length>'
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@./report.xml\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_report_id\"\r\n\r\nvendor-123\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"report_id": "<string>",
"baseline_revision_id": "<string>",
"working_revision_id": "<string>",
"assistant_thread_id": "<string>"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "FORBIDDEN",
"message": "API key does not include the required scope: leads.write.",
"request_id": "req_123",
"details": {
"required_scope": "leads.write",
"missing_scopes": [
"leads.write"
]
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}Reports
Import report
Imports one standalone PDF or a legacy XML/CSV/XLSX/DXF report package. The API key supplies the workspace; tenant selector fields are rejected.
POST
/
api
/
v1
/
reports
/
import
Import report
curl --request POST \
--url https://api.roofkit.ai/api/v1/reports/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Length: <content-length>' \
--header 'Content-Type: multipart/form-data' \
--header 'Idempotency-Key: <idempotency-key>' \
--form files=@example-file \
--form external_report_id=vendor-123import requests
url = "https://api.roofkit.ai/api/v1/reports/import"
files = { "files": ("example-file", open("example-file", "rb")) }
payload = { "external_report_id": "vendor-123" }
headers = {
"Idempotency-Key": "<idempotency-key>",
"Content-Length": "<content-length>",
"Authorization": "Bearer <token>"
}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('files', '@./report.xml');
form.append('external_report_id', 'vendor-123');
const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'Content-Length': '<content-length>',
Authorization: 'Bearer <token>'
}
};
options.body = form;
fetch('https://api.roofkit.ai/api/v1/reports/import', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roofkit.ai/api/v1/reports/import",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@./report.xml\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_report_id\"\r\n\r\nvendor-123\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Length: <content-length>",
"Content-Type: multipart/form-data",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.roofkit.ai/api/v1/reports/import"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@./report.xml\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_report_id\"\r\n\r\nvendor-123\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Content-Length", "<content-length>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.roofkit.ai/api/v1/reports/import")
.header("Idempotency-Key", "<idempotency-key>")
.header("Content-Length", "<content-length>")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@./report.xml\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_report_id\"\r\n\r\nvendor-123\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roofkit.ai/api/v1/reports/import")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Content-Length"] = '<content-length>'
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@./report.xml\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_report_id\"\r\n\r\nvendor-123\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"report_id": "<string>",
"baseline_revision_id": "<string>",
"working_revision_id": "<string>",
"assistant_thread_id": "<string>"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "FORBIDDEN",
"message": "API key does not include the required scope: leads.write.",
"request_id": "req_123",
"details": {
"required_scope": "leads.write",
"missing_scopes": [
"leads.write"
]
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}Required scopes:
reports.writeAuthorizations
Use Authorization: Bearer rk_live_....
Headers
A unique value for each new request, such as a UUID. Send the same value to retry a request safely. The same key and payload replay the first response with Idempotency-Replayed: true.
Required string length:
1 - 160Required for multipart report imports before request parsing. Most HTTP clients compute this automatically for multipart form uploads.
Required range:
x >= 1Body
multipart/form-data