Extraction

curl -X GET https://api.tableflow.com/v2/extractions/uT2bJNWN75YPU95r \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "id": "uT2bJNWN75YPU95r",
  "workspace_id": "dk4g1tUg1uHLs8YU",
  "template_id": "JlLZVabDjYWzu7C9",
  "template_name": "Invoice Template",
  "file_name": "acme-invoice-apr2023.pdf",
  "file_size": 245872,
  "file_type": {
    "key": "document",
    "extension": "pdf",
    "mime_type": "application/pdf"
  },
  "status": "completed",
  "status_history": [
    {
      "status": "processing",
      "time": 1682366228,
      "message": "File uploaded"
    },
    {
      "status": "completed",
      "time": 1682366240,
      "message": "Extraction completed"
    }
  ],
  "created_at": 1682366228,
  "updated_at": 1682366240,
  "data": {
    "fields": {
      "values": {
        "invoice_number": "INV-20230415",
        "invoice_date": "2023-04-15",
        "customer_name": "Acme Corporation",
        "payment_terms": "Net 30",
        "total_amount": "1245.75"
      },
      "validations": {}
    },
    "tables": {
      "line_items": {
        "pagination": {
          "offset": 0,
          "limit": 100,
          "total": 2,
          "next_offset": null,
          "filter": "all"
        },
        "rows": [
          {
            "index": 0,
            "values": {
              "description": "Ergonomic Office Chair",
              "quantity": "1",
              "unit_price": "249.99",
              "amount": "249.99"
            },
            "validations": {}
          },
          {
            "index": 1,
            "values": {
              "description": "Wireless Keyboard",
              "quantity": "2",
              "unit_price": "59.95",
              "amount": "119.90"
            },
            "validations": {}
          }
        ]
      }
    }
  },
  "stats": {
    "fields": {
      "valid": 5,
      "invalid": 0,
      "total": 5
    },
    "tables": {
      "line_items": {
        "rows": {
          "valid": 2,
          "invalid": 0,
          "total": 2
        },
        "columns": {
          "total": 4
        }
      }
    }
  },
  "template": {
    "id": "JlLZVabDjYWzu7C9",
    "name": "Invoice Template",
    "fields": [
      {
        "key": "invoice_number",
        "name": "Invoice Number",
        "data_type": "string"
      }
    ],
    "tables": [
      {
        "key": "line_items",
        "name": "Line Items",
        "columns": [
          {
            "key": "description",
            "name": "Description",
            "data_type": "string"
          }
        ]
      }
    ]
  }
}

GET

extractions

{id}

curl -X GET https://api.tableflow.com/v2/extractions/uT2bJNWN75YPU95r \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "id": "uT2bJNWN75YPU95r",
  "workspace_id": "dk4g1tUg1uHLs8YU",
  "template_id": "JlLZVabDjYWzu7C9",
  "template_name": "Invoice Template",
  "file_name": "acme-invoice-apr2023.pdf",
  "file_size": 245872,
  "file_type": {
    "key": "document",
    "extension": "pdf",
    "mime_type": "application/pdf"
  },
  "status": "completed",
  "status_history": [
    {
      "status": "processing",
      "time": 1682366228,
      "message": "File uploaded"
    },
    {
      "status": "completed",
      "time": 1682366240,
      "message": "Extraction completed"
    }
  ],
  "created_at": 1682366228,
  "updated_at": 1682366240,
  "data": {
    "fields": {
      "values": {
        "invoice_number": "INV-20230415",
        "invoice_date": "2023-04-15",
        "customer_name": "Acme Corporation",
        "payment_terms": "Net 30",
        "total_amount": "1245.75"
      },
      "validations": {}
    },
    "tables": {
      "line_items": {
        "pagination": {
          "offset": 0,
          "limit": 100,
          "total": 2,
          "next_offset": null,
          "filter": "all"
        },
        "rows": [
          {
            "index": 0,
            "values": {
              "description": "Ergonomic Office Chair",
              "quantity": "1",
              "unit_price": "249.99",
              "amount": "249.99"
            },
            "validations": {}
          },
          {
            "index": 1,
            "values": {
              "description": "Wireless Keyboard",
              "quantity": "2",
              "unit_price": "59.95",
              "amount": "119.90"
            },
            "validations": {}
          }
        ]
      }
    }
  },
  "stats": {
    "fields": {
      "valid": 5,
      "invalid": 0,
      "total": 5
    },
    "tables": {
      "line_items": {
        "rows": {
          "valid": 2,
          "invalid": 0,
          "total": 2
        },
        "columns": {
          "total": 4
        }
      }
    }
  },
  "template": {
    "id": "JlLZVabDjYWzu7C9",
    "name": "Invoice Template",
    "fields": [
      {
        "key": "invoice_number",
        "name": "Invoice Number",
        "data_type": "string"
      }
    ],
    "tables": [
      {
        "key": "line_items",
        "name": "Line Items",
        "columns": [
          {
            "key": "description",
            "name": "Description",
            "data_type": "string"
          }
        ]
      }
    ]
  }
}

Retrieves extraction data by ID, including fields, tables, and document information.

Usage Notes

This endpoint returns extraction data including all fields
For tables, it includes up to 100 rows per table (the default pagination limit)
For tables with more than 100 rows, use the pagination information from each table and the Get Extraction Table Rows endpoint to retrieve additional rows

Request

string

required

The ID of the extraction to retrieve.

curl -X GET https://api.tableflow.com/v2/extractions/uT2bJNWN75YPU95r \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

string

The unique identifier for the extraction.

workspace_id

string

The ID of the workspace this extraction belongs to.

template_id

string

The ID of the template used for extraction.

template_name

string

The name of the template used for extraction.

file_name

string

The name of the uploaded file.

file_size

integer

The size of the uploaded file in bytes.

file_type

object

Information about the file type.

Show file_type

key

string

The file type key (e.g., “document”, “spreadsheet”).

extension

string

The file extension (e.g., “pdf”, “xlsx”).

mime_type

string

The file’s MIME type.

status

string

The current status of the extraction (e.g., “processing”, “completed”, “failed”).

status_history

array

History of status changes for this extraction.

error

string

Error message if the extraction failed.

metadata

object

Additional metadata associated with the extraction.

created_at

integer

Unix timestamp when the extraction was created.

updated_at

integer

Unix timestamp when the extraction was last updated.

data

object

The extracted data.

Show data

fields

object

Field data extracted from the document.

Show fields

values

object

Map of field keys to their extracted values.

validations

object

Map of field keys to arrays of validation issues.

Show validations

{field_key}

array

validate

string

The validation that failed.

severity

string

Severity of the validation issue (“error”, “warn”, “info”).

message

string

Error message describing the validation issue.

tables

object

Map of table keys to their data and pagination information. Note: This endpoint includes up to 100 rows per table. For tables with more rows, use the pagination information and the Get Extraction Table Rows endpoint to retrieve additional rows.

Show tables

{table_key}

object

pagination

object

Pagination information for this table.

Show pagination

offset

integer

Current offset.

limit

integer

Current limit (typically 100 for the main extraction endpoint).

total

integer

Total number of rows in the table.

next_offset

integer

Offset for the next page of results. Will be null if all rows are included.

filter

string

The applied filter (“all”, “valid”, “error”).

rows

array

Array of table rows, limited to first 100 rows. For complete access to all rows, use the Get Extraction Table Rows endpoint.

Show rows

index

integer

The row index (0-based).

values

object

Map of column keys to their cell values.

validations

object

Map of column keys to arrays of validation issues.

stats

object

Statistics about the extraction data.

Show stats

fields

object

Statistics about the extracted fields.

Show fields

valid

integer

Number of fields that passed all validations.

invalid

integer

Number of fields that failed at least one validation.

total

integer

Total number of fields.

tables

object

Map of table keys to their statistics.

Show tables

{table_key}

object

rows

object

Row statistics for this table.

Show rows

valid

integer

Number of rows that passed all validations.

invalid

integer

Number of rows that failed at least one validation.

total

integer

Total number of rows.

columns

object

Column statistics for this table.

Show columns

total

integer

Total number of columns.

cells

object

Map of column keys to their cell statistics.

Show cells

{column_key}

object

valid

integer

Number of cells that passed all validations.

invalid

integer

Number of cells that failed at least one validation.

not_blank

integer

Number of cells that are not blank.

template

object

The template used at the time of extraction.

{
  "id": "uT2bJNWN75YPU95r",
  "workspace_id": "dk4g1tUg1uHLs8YU",
  "template_id": "JlLZVabDjYWzu7C9",
  "template_name": "Invoice Template",
  "file_name": "acme-invoice-apr2023.pdf",
  "file_size": 245872,
  "file_type": {
    "key": "document",
    "extension": "pdf",
    "mime_type": "application/pdf"
  },
  "status": "completed",
  "status_history": [
    {
      "status": "processing",
      "time": 1682366228,
      "message": "File uploaded"
    },
    {
      "status": "completed",
      "time": 1682366240,
      "message": "Extraction completed"
    }
  ],
  "created_at": 1682366228,
  "updated_at": 1682366240,
  "data": {
    "fields": {
      "values": {
        "invoice_number": "INV-20230415",
        "invoice_date": "2023-04-15",
        "customer_name": "Acme Corporation",
        "payment_terms": "Net 30",
        "total_amount": "1245.75"
      },
      "validations": {}
    },
    "tables": {
      "line_items": {
        "pagination": {
          "offset": 0,
          "limit": 100,
          "total": 2,
          "next_offset": null,
          "filter": "all"
        },
        "rows": [
          {
            "index": 0,
            "values": {
              "description": "Ergonomic Office Chair",
              "quantity": "1",
              "unit_price": "249.99",
              "amount": "249.99"
            },
            "validations": {}
          },
          {
            "index": 1,
            "values": {
              "description": "Wireless Keyboard",
              "quantity": "2",
              "unit_price": "59.95",
              "amount": "119.90"
            },
            "validations": {}
          }
        ]
      }
    }
  },
  "stats": {
    "fields": {
      "valid": 5,
      "invalid": 0,
      "total": 5
    },
    "tables": {
      "line_items": {
        "rows": {
          "valid": 2,
          "invalid": 0,
          "total": 2
        },
        "columns": {
          "total": 4
        }
      }
    }
  },
  "template": {
    "id": "JlLZVabDjYWzu7C9",
    "name": "Invoice Template",
    "fields": [
      {
        "key": "invoice_number",
        "name": "Invoice Number",
        "data_type": "string"
      }
    ],
    "tables": [
      {
        "key": "line_items",
        "name": "Line Items",
        "columns": [
          {
            "key": "description",
            "name": "Description",
            "data_type": "string"
          }
        ]
      }
    ]
  }
}

Error Responses

error

string

Error message describing what went wrong.

{
  "error": "No extraction ID provided"
}

Upload File for Extraction Get Extraction Table Rows

Extractions

Flows

Usage Notes

Request

Response

Error Responses

Extractions

Flows

​Usage Notes

​Request

​Response

​Error Responses

Usage Notes

Request

Response

Error Responses