Skip to main content
POST
Start an import run over a set of uploaded files

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required

Body

application/json
fileIds
string[]
required

Ids of the uploaded files to read. PDFs are split page by page, images are read whole; any other file type is refused.

Response

200 - application/json
chunksDone
number
required
chunksFailed
number
required
chunksRunning
number
required
chunksTotal
number | null
required

Null until planning has opened every file.

completedAt
string | null
required
createdAt
string
required
entityCount
number
required
error
string | null
required
fileIds
string[]
required

Files the run was asked for, known before anything is opened.

files
object[]
required
inputTokens
number
required
noteCount
number
required
outputTokens
number
required
relationshipCount
number
required
runId
string
required
status
enum<string>
required
Available options:
queued,
planning,
running,
succeeded,
failed,
cancelled