Projects Guide

What is a Project?

A Project is the primary unit of work inside an organization. Every template, document upload, and processing result belongs to exactly one project. Projects let you segment activity by use case, team, or client — giving you clean separation without needing multiple organizations.

Organization (Your Company)
├── Billing & Credits (shared across all projects)
├── Team Members (org-wide)
│
├── Project: Invoice Processing
│   ├── Templates (extraction configurations)
│   ├── Uploads & Processing History
│   ├── Project Members (subset of org members)
│   └── Project Settings
│
├── Project: Receipt Scanning
│   ├── Templates
│   ├── Uploads & Processing History
│   ├── Project Members
│   └── Project Settings
│
└── Project: Contract Analysis
    ├── Templates
    ├── Uploads & Processing History
    ├── Project Members
    └── Project Settings

Key isolation guarantees:

• Templates created in one project are not visible in another project.
• Processing history is scoped to the project where the document was uploaded.
• Project members are managed independently — an org member must be explicitly added to each project they need access to.
• Credits are billed at the organization level and shared across all projects. There is no per-project credit budget by default.

Creating a Project

1. Navigate to Organization → Projects.
2. Click Create Project.
3. Fill in the required fields:
   • Name — a clear, descriptive name for the project (e.g., "Invoice Processing — APAC").
   • Description — optional, but recommended. Describes the project's purpose for other team members.
4. Optionally expand Advanced Settings to configure project-level controls (see Project Settings below).
5. Click Create — the project is created and you are automatically assigned the Owner role within it.

Project Settings

Navigate to Project → Settings to update project details and configure access controls.

General

Access Controls

These settings control what project members are allowed to do by default:

Project Members

Project membership is separate from organization membership. An organization member must be explicitly added to each project before they can access it.

Project Roles

Every project member is assigned one of four roles:

Member Status

Adding a Member

Only users who are already members of the organization can be added to a project.

1. Go to Project → Members.
2. Click Add Member.
3. Search for the org member by name or email using the search field.
4. Select the user from the results.
5. Choose a Role: Owner, Admin, Member, or Viewer.
6. Optionally add an Invitation message to give context about the project.
7. Click Add — the member is added with active status immediately.

Updating a Member's Role

1. Go to Project → Members.
2. Locate the member in the list.
3. Click the role dropdown next to their name.
4. Select the new role and confirm.

Role changes take effect immediately.

Removing a Member

1. Go to Project → Members.
2. Locate the member in the list.
3. Click Remove next to their name and confirm the action.

Project Statistics

Navigate to Project → Overview or call GET /projects/:id/stats to retrieve a summary of project activity. Statistics available include:

Project Analytics

Navigate to Project → Analytics or call GET /projects/:id/analytics to view time-series usage data for the project. Analytics help you understand processing trends, identify peak usage periods, and plan capacity.

Typical analytics dimensions include:

• Documents processed over time — daily or weekly volume of processing jobs
• Success vs. failure rate — proportion of jobs that completed successfully versus those that errored
• Credits consumed over time — credit burn rate to help forecast billing
• Processing time trends — whether average turnaround is improving or degrading
• Template usage breakdown — which templates are used most frequently

Project-Scoped API Tokens

API tokens can be scoped to a specific project, restricting access to only the data and operations within that project. This is the recommended approach for integrating external systems or automation pipelines with a single project.

How project-scoped tokens differ from org-level tokens:

To create a project-scoped token:

1. Navigate to Organization → API Tokens.
2. Click Create Token.
3. Give the token a descriptive name (e.g., "Invoice Processor — Production").
4. Set the Scope to Project and select the target project.
5. Set an optional expiry date.
6. Click Create and copy the token immediately — it will not be shown again.

Webhook Dashboard per Project

Each project has its own webhook delivery dashboard, giving you visibility into outbound webhook activity scoped to that project's events.

Navigate to Project → Webhooks or call GET /projects/:id/webhook-dashboard to view:

Best Practices

Naming Projects

• Use a consistent naming convention across your organization, such as {Team} — {Document Type} (e.g., "Finance — Invoices", "Operations — Delivery Notes").
• Avoid generic names like "Project 1" or "Test" — they become confusing as the number of projects grows.
• Include the environment in the name when you run separate projects for staging and production (e.g., "Invoice Processing — Production" vs. "Invoice Processing — Staging").

Managing Project Members

• Apply the principle of least privilege — assign Viewer to anyone who only needs to read results, Member to those who process documents, and Admin only to those who need to manage the project.
• Audit project membership periodically, especially after team changes. Remove members who no longer need access.
• Avoid assigning the Owner role to more than two or three people per project. Too many owners dilutes accountability.
• Use project-scoped API tokens for automated integrations rather than sharing personal credentials or org-level tokens.

Organizing Templates

• Group related document types into the same project so that templates and processing history stay together.
• Create separate projects for distinct document workflows (invoices vs. contracts vs. receipts) rather than mixing them in one project with many templates.
• Use the maxTemplatesPerProject setting to enforce a discipline around template hygiene — unused templates should be archived or deleted.

File Retention

• Set fileRetentionDays on projects that handle sensitive documents to ensure uploaded files are automatically purged after a defined period.
• Projects with no retention setting inherit the organization default. Review Organization → Settings to confirm the org-level default meets your compliance requirements.