Documents

Create and analyze a document asynchronously

Creates a document, debits quota, renders page images when possible, starts semantic analysis, and returns 202 for polling. Poll GET /api/v1/documents/{id} until status changes.

post/api/v1/documents

Request

  • Base URL: https://www.ifillpdf.com
  • URL: https://www.ifillpdf.com/api/v1/documents
  • Auth: HTTP bearer

Request body

OR

Example request

{
  "suggested_entities": [
    {
      "id": "declarant",
      "label": "Declarant",
      "color": "#6D7BFF"
    }
  ]
}

Response

Analysis started.

document_idstring uuid required
status'analyzing' required
page_countinteger required
page_images_readyboolean
page_images_countinteger
preview_image_urlstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.