Skip to main content
Version: 1.0.0

fidocs-api

Endpoints for uploading documents and retrieving pipeline output. A pipeline is a sequence of steps that transforms the input document into a structured output.

Prerequisites​

  • You must first register with fidocs as an Enterprise Partner. Please contact us at support@fidocs.ai to sign up for API access.
  • A Partner user can create Customer groups, each of which is issued an API key and manages its own page balance.
    • Use this API key as the X-API-Key header to make requests on behalf of a Customer of your Enterprise.
    • Each request will be billed to the Customer's page balance.
    • Note that a Customer group contains Client users.
      • Provide the clientId with each upload Request.
      • Clients track their document and page usage, but the page balance is shared by the Customer group.

Endpoints​

  • There are currently two endpoints available:
    • /upload
      • Uploads a PDF or image document to fidocs and begins execution of a specified pipeline.
      • Returns a jobId in the response.
      • When the job is complete, posts the completion or error status to the specified callbackURL.
    • /results
      • Returns the output of the pipeline for the requested jobId.
      • If the job is complete, the extracted data is returned.

Authentication​

Security Scheme Type:

apiKey

Header parameter name:

X-API-Key