POST
/v1/ingest/rows/{rowId}/processProcess a deal
Scope processing. Processes every file on the deal.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokenkeyoptional
Stored only in this browser for the key security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
rowIdpath · stringrequired
The deal's row id.
Request body
application/jsonidempotencyKeystringoptional
replacebooleanoptional
Responses
200application/json
Already started with these files.
{
"data": {
"job": {
"id": "",
"status": "started",
"externalJobId": "",
"idempotencyKey": "string",
"requestedBy": "string",
"requestedAt": "2026-01-01T00:00:00Z",
"finishedAt": "2026-01-01T00:00:00Z",
"finished": true,
"events": [
{
"seq": 1,
"event": "string",
"at": "2026-01-01T00:00:00Z",
"detail": {}
}
],
"documents": [
{
"id": "",
"fileId": "",
"fileName": "string",
"documentType": "string",
"attemptNo": 1,
"outcome": "pending",
"reason": "string",
"contentSha256": "string",
"at": "2026-01-01T00:00:00Z",
"extractions": [
{
"jobId": "",
"kind": "string",
"source": "string",
"engine": "string",
"modelVersion": "string",
"confidenceBps": 1,
"fields": [
{
"field": "string",
"value": "string",
"confidenceBps": 1,
"page": 1
}
],
"notes": [
"string"
]
}
]
}
],
"findings": "string"
},
"created": true
}
}dataoptional
201application/json
Started.
{
"data": {
"job": {
"id": "",
"status": "started",
"externalJobId": "",
"idempotencyKey": "string",
"requestedBy": "string",
"requestedAt": "2026-01-01T00:00:00Z",
"finishedAt": "2026-01-01T00:00:00Z",
"finished": true,
"events": [
{
"seq": 1,
"event": "string",
"at": "2026-01-01T00:00:00Z",
"detail": {}
}
],
"documents": [
{
"id": "",
"fileId": "",
"fileName": "string",
"documentType": "string",
"attemptNo": 1,
"outcome": "pending",
"reason": "string",
"contentSha256": "string",
"at": "2026-01-01T00:00:00Z",
"extractions": [
{
"jobId": "",
"kind": "string",
"source": "string",
"engine": "string",
"modelVersion": "string",
"confidenceBps": 1,
"fields": [
{
"field": "string",
"value": "string",
"confidenceBps": 1,
"page": 1
}
],
"notes": [
"string"
]
}
]
}
],
"findings": "string"
},
"created": true,
"documentCount": 1
}
}dataoptional
400application/json
The deal has no documents to process.
{
"error": {
"message": "string"
}
}errorrequired
401application/json
No key, or an unknown or revoked one.
{
"error": {
"message": "string"
}
}errorrequired
402application/json
A key issued from Settings → Developer, on a workspace without the Enterprise plan.
{
"error": {
"message": "string"
}
}errorrequired
403application/json
The key was not given processing, or is a board key.
{
"error": {
"message": "string"
}
}errorrequired
404application/json
No job or deal with that id that this key can reach.
{
"error": {
"message": "string"
}
}errorrequired
409application/json
would_supersede: send replace: true to go ahead.
{
"error": {
"message": "string",
"code": "would_supersede"
},
"superseded": [
"string"
]
}erroroptional
supersededarray<string>optional
The fields a re-run would replace.
429application/json
Over 120 requests a minute; wait Retry-After seconds.
{
"error": {
"message": "string"
}
}errorrequired