Inveeze API Reference

Welcome to the Inveeze REST API. This API allows you to programmatically ingest documents, trigger pipelines, and retrieve results.

Base URL

All API requests should be made to: https://api.inveeze.com/v1

(For local development, use http://localhost:3000/api)

---

Authentication

Authenticate your requests by including your API Key in the Authorization header.

Authorization: Bearer <YOUR_API_KEY>

You can generate API Keys in the Dashboard under Settings > Integrations.

---

Endpoints

1. Upload Document

Upload a PDF or image for processing.

• Endpoint: POST /documents
• Content-Type: multipart/form-data

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | file | File | Yes | The document file (PDF, PNG, JPG). | | pipelineId | UUID | Yes | The ID of the pipeline to process this document. |

Example Request

curl -X POST https://api.inveeze.com/v1/documents \
  -H "Authorization: Bearer sk_live_..." \
  -F "file=@invoice.pdf" \
  -F "pipelineId=e5f7513d-..."

Example Response

{
  "id": "doc_12345",
  "status": "ingested",
  "originalFilename": "invoice.pdf",
  "ingestedAt": "2024-12-08T10:00:00Z"
}

---

2. Trigger Pipeline Run

Manually trigger a pipeline run for an ingested document.

• Endpoint: POST /pipelines/run
• Content-Type: application/json

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | pipelineId | UUID | Yes | The pipeline ID. | | documentId | UUID | Yes | The document ID to process. |

Example Request

curl -X POST https://api.inveeze.com/v1/pipelines/run \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "pipelineId": "e5f7513d-...",
    "documentId": "doc_12345"
  }'

---

3. Get Document Status

Retrieve the status and extraction results of a document.

• Endpoint: GET /documents/:id

Example Response

{
  "id": "doc_12345",
  "status": "review_required",
  "results": {
    "invoiceNumber": "INV-1001",
    "total": 1500.00
  }
}

---

Rate Limits

The API is currently limited to 100 requests per minute per tenant.