Skip to main content

HTTP API reference

Extraction and invoice routes accept Authorization: Bearer with a bf_live_ API key or session JWT. Create and revoke bf_live_ keys only from the signed-in dashboard (not documented here). Billing and subscription webhooks are handled in the product UI, not in this catalog.

How the pieces connect

Extract first, then list or update saved rows. Each box links to a topic page with every method and path listed.

Complete endpoint index

MethodPathTopicSummaryDetails
POST/api/extract-invoiceExtractionExtract from a public URL (http or https); JSON body with file_url.View
POST/api/extract-invoice-fileExtractionMultipart upload: file + optional invoice_kind.View
GET/api/invoicesInvoicesPaginated list of stored invoices for the authenticated user.View
GET/api/invoices/[id]InvoicesFetch one invoice by id (path param).View
PATCH/api/invoices/[id]InvoicesUpdate invoice_kind and/or parsed_data fields.View
DELETE/api/invoices/[id]InvoicesDelete a stored invoice.View