REST · JSONv1 · Stable

Firegent API

Programmatically manage document templates and retrieve processed documents together with their extracted, structured data. Everything below is available to any authenticated Firegent account.

Read the docs Log in to get your API key

Introduction

The Firegent API is organized around REST. It uses standard HTTP verbs, returns JSON-encoded responses, and uses standard HTTP status codes to indicate the success or failure of a request.

Every response is wrapped in the same envelope so your integration only needs one parsing path.

Field	Description
`status`	HTTP status code of the response, repeated in the body
`data`	The requested resource, or a list of resources
`meta`	Pagination info and related resource links, when applicable

All requests must be made over HTTPS and must identify the desired format with an Accept: application/json header (or a .pdf suffix for binary attachments).

BASE URL

https://qwikiconnect.firegent.com/v1

RESPONSE ENVELOPE

Authentication

Firegent authenticates every request using your account email and personal API token, sent as request headers. There is no OAuth flow and no API keys shared between accounts — your token is tied to your user.

Header	Description
`X-User-Email`required	The email address of your Firegent account
`X-User-Token`required	Your personal API token

Requests without valid credentials receive a 401 Unauthorized response. Keep your token secret — anyone with it can access your templates and documents.

curl https://qwikiconnect.firegent.com/v1/documents \ 
  -H 'Accept: application/json' \ 
  -H 'X-User-Email: jane.doe@acmecorp.com' \ 
  -H 'X-User-Token: 7f3a9c2e1b6d4f805c9e2a17b3d6f402'

401Unauthorized

Errors & status codes

Firegent uses conventional HTTP status codes to indicate the outcome of a request: codes in the 2xx range indicate success, 4xx indicates an error with the request, and 5xx indicates an error on our end.

Status	Meaning	Example body
200	Everything worked as expected	{ "status": 200, "data": ... }
401	Missing or invalid `X-User-Email` / `X-User-Token`	{ "error": "You need to sign in or sign up before continuing." }
403	Authenticated, but the resource does not belong to your account	{ "status": 403, "message": "Forbidden access, please contact your admin", "data": [] }
404	The requested record could not be found	{ "status": 404, "message": "Record not found, make sure the record identifier", "data": [] }
429	Too many requests — see rate limits below	(empty body, see the Retry-After header)
500	Something went wrong on our end	–

Rate limits & pagination

Rate limits

Requests are limited to 100 requests per 10 minutes per IP address. If you go over this limit, requests receive a 429 Too Many Requests response until the window resets.

Pagination

List endpoints accept page and limit query parameters (default limit is 50) and return pagination details under meta.pagination.

Field	Description
`current / previous / next`	Page numbers relative to the current page
`total_pages`	Total number of pages available

List templates

Returns a paginated list of the templates available to your account, most recently created first.

Query parameters

Parameter	Description
`page`optional	Page number to retrieve
`limit`optional	Number of templates per page (default 50)

GET/v1/templates

curl 'https://qwikiconnect.firegent.com/v1/templates?page=1&limit=10' \ 
  -H 'Accept: application/json' \ 
  -H 'X-User-Email: jane.doe@acmecorp.com' \ 
  -H 'X-User-Token: 7f3a9c2e1b6d4f805c9e2a17b3d6f402'

200OK

The Template object

Attributes

Field	Description
`id`	Unique identifier for the template
`name`	Template name
`shortcode`	Short identifying code for the template
`total_pages`	Number of pages the template defines
`created_at / updated_at`	Timestamps

THE TEMPLATE OBJECT

Retrieve a template

Retrieves a single template by ID.

Path parameters

Parameter	Description
`id`required	The ID of the template to retrieve

GET/v1/templates/:id

curl https://qwikiconnect.firegent.com/v1/templates/64f1a2b3c4d5e6f7a8b9c0d1 \ 
  -H 'Accept: application/json' \ 
  -H 'X-User-Email: jane.doe@acmecorp.com' \ 
  -H 'X-User-Token: 7f3a9c2e1b6d4f805c9e2a17b3d6f402'

200OK

List a template's documents

Returns every document processed against a given template.

Parameters

Parameter	Description
`template_id`required	The ID of the template, passed in the path
`tname`optional	Filter results to documents with an exact matching name

GET/v1/templates/:template_id/documents

curl https://qwikiconnect.firegent.com/v1/templates/64f1a2b3c4d5e6f7a8b9c0d1/documents \ 
  -H 'Accept: application/json' \ 
  -H 'X-User-Email: jane.doe@acmecorp.com' \ 
  -H 'X-User-Token: 7f3a9c2e1b6d4f805c9e2a17b3d6f402'

200OK

List documents

Returns a paginated list of every processed document across all templates on your account.

Query parameters

Parameter	Description
`tname`optional	Comma-separated list of template names to filter by, e.g. "Invoice - Standard,Purchase Order"
`start_date / end_date`optional	Filter by creation date, formatted YYYY-MM-DD (end_date defaults to today)
`page / limit`optional	Pagination controls (default limit 50)
`merge_column / anchor_column`optional	Set merge_column=true with an anchor_column name to merge extracted table rows around that column

GET/v1/documents

curl 'https://qwikiconnect.firegent.com/v1/documents?tname=Invoice+-+Standard&start_date=2026-04-01&end_date=2026-04-30' \ 
  -H 'Accept: application/json' \ 
  -H 'X-User-Email: jane.doe@acmecorp.com' \ 
  -H 'X-User-Token: 7f3a9c2e1b6d4f805c9e2a17b3d6f402'

200OK

The Documents object

A collection of Document objects, along with pagination metadata.

Attributes

Field	Description
`data`	Array of Document objects
`meta.pagination`	current, previous, next, total_pages

THE DOCUMENTS OBJECT

Retrieve a document

Returns a single document, including its extracted data.

Parameters

Parameter	Description
`id`required	The ID of the document
`merge_column / anchor_column`optional	Same behavior as on the list endpoint

GET/v1/documents/:id

curl https://qwikiconnect.firegent.com/v1/documents/64f8b3c2a1d9e6f7c8b9a0d2 \ 
  -H 'Accept: application/json' \ 
  -H 'X-User-Email: jane.doe@acmecorp.com' \ 
  -H 'X-User-Token: 7f3a9c2e1b6d4f805c9e2a17b3d6f402'

200OK

The Document object

This document object contains the metadata of a document plus its extracted content.

Attributes

Field	Description
`id`	Unique identifier for the document
`input_pdf`	Source file name
`document_name`	Name of the document
`tid / tname`	ID and name of the template used to process this document
`pages`	Number of pages in the document
`attachment_link`	URL to fetch the original file, see Document attachment
`data`	Array of per-page extracted data (omitted on the metadata endpoint)

THE DOCUMENT OBJECT

Singleton type

A single extracted field, such as a value that appears once per page — for example an invoice number or a warehouse code.

Attributes

Field	Description
`id`	ID of the data
`type`	Always "singleton"
`field`	Field name
`value`	Value of the field

SINGLETON

Group type

A table of extracted rows, such as invoice line items.

Attributes

Field	Description
`type`	Always "group"
`table`	Array of rows, each with a fields array
`(fields) id / field / value`	ID, name, and value of each field in a row

GROUP

Document metadata

Returns a document's metadata without its extracted data — useful when you only need to check status or attributes.

Parameters

Parameter	Description
`id`required	The ID of the document

GET/v1/documents/:id/metadata

curl https://qwikiconnect.firegent.com/v1/documents/64f8b3c2a1d9e6f7c8b9a0d2/metadata \ 
  -H 'Accept: application/json' \ 
  -H 'X-User-Email: jane.doe@acmecorp.com' \ 
  -H 'X-User-Token: 7f3a9c2e1b6d4f805c9e2a17b3d6f402'

200OK

Document attachment

Returns the original source file for a document, base64-encoded, or a filtered view of specific pages/coordinates.

Parameters

Parameter	Description
`id`required	The ID of the document
`type`optional	Set to "pdf" to fetch the full PDF; otherwise returns page images
`page / coordinate`optional	Restrict the returned data to a specific page or coordinate range

GET/v1/documents/:id/attachment

curl 'https://qwikiconnect.firegent.com/v1/documents/64f8b3c2a1d9e6f7c8b9a0d2/attachment.pdf?type=pdf&page=1' \ 
  -H 'X-User-Email: jane.doe@acmecorp.com' \ 
  -H 'X-User-Token: 7f3a9c2e1b6d4f805c9e2a17b3d6f402'

200OK

The Attachment object

Attributes

Field	Description
`filename`	Name of the source file
`filtered`	The page/coordinate filter that was applied, if any
`data`	Base64-encoded file content

THE ATTACHMENT OBJECT