v6

OpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-011951192.5 KB
PDF File

Index PDF file

Index PDF file (byte array) to the index with the specified apikey and index_id, and return the number of indexed docs.

  • Converts PDF to a JSON document with "title", "body", "url" and "date" fields and indexes it.
  • extracts title from metatag, or first line of text, or from filename
  • extracts creation date from metatag, or from file creation date (Unix timestamp: the number of seconds since 1 January 1970)
  • copies all ingested pdf files to "files" subdirectory in index
post/api/v1/index/{index_id}/file

Path parameters

index_idinteger required

index id

Headers

apikeystring required

YOUR_SECRET_API_KEY

filestring required

filepath from header for JSON 'url' field

datestring required

date (timestamp) from header, as fallback for JSON 'date' field, if PDF date meta tag unaivailable

Response

PDF file indexed, returns the number of indexed documents