Skip to content
DocsToSheets

Get an extraction

GET
/api/Extractions/{id}
 
curl --request GET \
  --url https://app.docstosheets.com/api/Extractions/example \
  --header 'Authorization: Bearer <token>'

Returns a single extraction by ID.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

The extraction ID.

Query Parameters

Section titled “Query Parameters ”
mailboxId
string

The mailbox ID (partition key).

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The extraction result.

Media type application/json

The structured data extracted from one document.

object
id
required

The extraction ID.

string
mailboxId
required

The mailbox the document belongs to.

string
documentId
required

The document this extraction was produced from.

string
data
required

The extracted header values, keyed by the field keys of the mailbox config. Value types follow the field type (string, number, boolean, or null when not found).

object
key
additional properties
sections
required

Rows of each repeating section, keyed by the group ID of the mailbox config. Empty for mailboxes without repeating groups.

object
key
additional properties
Array<object>

One row of a repeating section.

object
data
required

The row’s extracted values, keyed by the section’s field keys.

object
key
additional properties
validationStatus
required
One of:
string
Allowed values: valid warning invalid
validationIssues
required

Validation problems in this row, if any.

Array<object>

A validation problem found in an extracted value.

object
fieldKey
required

The field the issue applies to.

string
sectionId

The repeating section containing the field; null for header fields.

string
nullable
rowIndex

The zero-based row index within the section; null for header fields.

integer format: int32
nullable
severity
required
One of:
string
Allowed values: warning error
code
required

Machine-readable issue code.

string
message
required

Human-readable explanation.

string
extractedAt
required

When the extraction completed.

string format: date-time
validationStatus
required
One of:
string
Allowed values: valid warning invalid
validationIssues
required

Field-level validation problems, if any.

Array<object>

A validation problem found in an extracted value.

object
fieldKey
required

The field the issue applies to.

string
sectionId

The repeating section containing the field; null for header fields.

string
nullable
rowIndex

The zero-based row index within the section; null for header fields.

integer format: int32
nullable
severity
required
One of:
string
Allowed values: warning error
code
required

Machine-readable issue code.

string
message
required

Human-readable explanation.

string
notes
required

Exceptional parsing observations from the extraction model; flag the record for review.

Array<object>

An exceptional parsing observation from the LLM; flags the record for review.

object
fieldKey

The field the note refers to; null when it concerns the whole document.

string
nullable
note
required

The observation text.

string
Example 
{
  "data": {
    "invoiceNumber": "INV-1042",
    "vendor": "Acme Corp",
    "total": 129.5
  },
  "sections": {
    "lineItems": [
      {
        "data": {
          "description": "Consulting hours",
          "quantity": 4
        },
        "validationStatus": "valid",
        "validationIssues": []
      }
    ]
  },
  "validationStatus": "valid",
  "validationIssues": [
    {
      "fieldKey": "total",
      "severity": "warning",
      "code": "required_missing",
      "message": "Required field has no value."
    }
  ],
  "notes": [
    {
      "fieldKey": "total",
      "note": "The total is partially illegible; best-effort value extracted."
    }
  ]
}

400

Section titled “400 ”
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404 ”
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}