Folders & Schemas
Two organizational primitives sit under v1.
Two organizational primitives sit under v1: folders for grouping documents (e.g. by applicant), and schemas for defining custom extraction shapes that override the default vocabulary output.
Folders
| Method | Path | Description |
|---|---|---|
POST | /api/v1/folders | Create a folder |
GET | /api/v1/folders | List folders |
GET | /api/v1/folders/{id}/documents | List documents in a folder |
Custom Extraction Schemas
Plan requirement
Custom Extraction Schemas require an Enterprise, Unlimited, or Custom plan. Maximum 20 schemas per organization.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/schemas | List custom schemas |
GET | /api/v1/schemas/{id} | Get a single schema |
POST | /api/v1/schemas | Create a custom schema |
PUT | /api/v1/schemas/{id} | Update a schema |
DELETE | /api/v1/schemas/{id} | Delete a schema |