Import
Read an import run rolled up across its chunks
Candidate entities merged by name, carrying every type they were called and everything the pages said about them, relationships merged by their ends, and the notes each chunk left. Readable before the run settles; it then covers only the chunks read so far.
GET
/
project
/
{projectId}
/
import
/
runs
/
{runId}
/
output
Read an import run rolled up across its chunks
curl --request GET \
--url https://backend.branch.flowengineering.com/project/{projectId}/import/runs/{runId}/output \
--header 'X-API-Key: <api-key>' \
--header 'customer: <customer>'import requests
url = "https://backend.branch.flowengineering.com/project/{projectId}/import/runs/{runId}/output"
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}/output', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"entities": [
{
"details": [
"<string>"
],
"mentions": [
{
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"chunkId": "<string>",
"fileId": "<string>",
"filename": "<string>",
"page": 123
}
],
"name": "<string>",
"types": [
"<string>"
]
}
],
"notes": [
{
"mention": {
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"chunkId": "<string>",
"fileId": "<string>",
"filename": "<string>",
"page": 123
},
"text": "<string>"
}
],
"relationships": [
{
"evidence": [
"<string>"
],
"from": "<string>",
"implied": true,
"mentions": [
{
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"chunkId": "<string>",
"fileId": "<string>",
"filename": "<string>",
"page": 123
}
],
"to": "<string>",
"type": "<string>"
}
],
"runId": "<string>",
"status": "queued"
}Authorizations
api-keybearer
Headers
Workspace identifier
⌘I
Read an import run rolled up across its chunks
curl --request GET \
--url https://backend.branch.flowengineering.com/project/{projectId}/import/runs/{runId}/output \
--header 'X-API-Key: <api-key>' \
--header 'customer: <customer>'import requests
url = "https://backend.branch.flowengineering.com/project/{projectId}/import/runs/{runId}/output"
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}/output', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"entities": [
{
"details": [
"<string>"
],
"mentions": [
{
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"chunkId": "<string>",
"fileId": "<string>",
"filename": "<string>",
"page": 123
}
],
"name": "<string>",
"types": [
"<string>"
]
}
],
"notes": [
{
"mention": {
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"chunkId": "<string>",
"fileId": "<string>",
"filename": "<string>",
"page": 123
},
"text": "<string>"
}
],
"relationships": [
{
"evidence": [
"<string>"
],
"from": "<string>",
"implied": true,
"mentions": [
{
"boxes": [
{
"height": 123,
"width": 123,
"x": 123,
"y": 123
}
],
"chunkId": "<string>",
"fileId": "<string>",
"filename": "<string>",
"page": 123
}
],
"to": "<string>",
"type": "<string>"
}
],
"runId": "<string>",
"status": "queued"
}