Import
Read an import run chunk by chunk
Every chunk with the analysis it produced, provenance intact. This is the debug view; the rolled-up output is what an agent reads.
GET
/
project
/
{projectId}
/
import
/
runs
/
{runId}
/
chunks
Read an import run chunk by chunk
curl --request GET \
--url https://backend.branch.flowengineering.com/project/{projectId}/import/runs/{runId}/chunks \
--header 'X-API-Key: <api-key>' \
--header 'customer: <customer>'import requests
url = "https://backend.branch.flowengineering.com/project/{projectId}/import/runs/{runId}/chunks"
headers = {
"customer": "<customer>",
"X-API-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {customer: '<customer>', 'X-API-Key': '<api-key>'}};
fetch('https://backend.branch.flowengineering.com/project/{projectId}/import/runs/{runId}/chunks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"chunks": [
{
"analysis": {
"entities": [
{
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"detail": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"notes": [
{
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"text": "<string>"
}
],
"relationships": [
{
"from": "<string>",
"implied": true,
"provenance": {
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"text": "<string>"
},
"to": "<string>",
"type": "<string>"
}
]
},
"chunkId": "<string>",
"error": "<string>",
"fileId": "<string>",
"filename": "<string>",
"inputTokens": 123,
"kind": "pdf_page",
"outputTokens": 123,
"page": 123,
"status": "pending"
}
],
"progress": {
"chunksDone": 123,
"chunksFailed": 123,
"chunksRunning": 123,
"chunksTotal": 123,
"completedAt": "<string>",
"createdAt": "<string>",
"entityCount": 123,
"error": "<string>",
"fileIds": [
"<string>"
],
"files": [
{
"chunksDone": 123,
"chunksFailed": 123,
"chunksTotal": 123,
"fileId": "<string>",
"filename": "<string>",
"kind": "pdf_page"
}
],
"inputTokens": 123,
"noteCount": 123,
"outputTokens": 123,
"relationshipCount": 123,
"runId": "<string>",
"status": "queued"
}
}⌘I
Read an import run chunk by chunk
curl --request GET \
--url https://backend.branch.flowengineering.com/project/{projectId}/import/runs/{runId}/chunks \
--header 'X-API-Key: <api-key>' \
--header 'customer: <customer>'import requests
url = "https://backend.branch.flowengineering.com/project/{projectId}/import/runs/{runId}/chunks"
headers = {
"customer": "<customer>",
"X-API-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {customer: '<customer>', 'X-API-Key': '<api-key>'}};
fetch('https://backend.branch.flowengineering.com/project/{projectId}/import/runs/{runId}/chunks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"chunks": [
{
"analysis": {
"entities": [
{
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"detail": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"notes": [
{
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"text": "<string>"
}
],
"relationships": [
{
"from": "<string>",
"implied": true,
"provenance": {
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"text": "<string>"
},
"to": "<string>",
"type": "<string>"
}
]
},
"chunkId": "<string>",
"error": "<string>",
"fileId": "<string>",
"filename": "<string>",
"inputTokens": 123,
"kind": "pdf_page",
"outputTokens": 123,
"page": 123,
"status": "pending"
}
],
"progress": {
"chunksDone": 123,
"chunksFailed": 123,
"chunksRunning": 123,
"chunksTotal": 123,
"completedAt": "<string>",
"createdAt": "<string>",
"entityCount": 123,
"error": "<string>",
"fileIds": [
"<string>"
],
"files": [
{
"chunksDone": 123,
"chunksFailed": 123,
"chunksTotal": 123,
"fileId": "<string>",
"filename": "<string>",
"kind": "pdf_page"
}
],
"inputTokens": 123,
"noteCount": 123,
"outputTokens": 123,
"relationshipCount": 123,
"runId": "<string>",
"status": "queued"
}
}