REST API v2 Overview
v2 has been available since March 2024.
The Send AI REST API v2 is an iterative expansion focused first on high‑impact document lifecycle primitives:
- Uploads – ingesting and organizing documents.
- Tasks – human + AI validation workflow operations.
More surface area (projects, teams, classification, segmentation, reporting/export, webhooks management, etc.) will arrive incrementally. We intentionally release narrow vertical slices so you can adopt new capabilities without waiting for a “big bang” rewrite.
Available groups
| Group | Purpose | Notes |
|---|---|---|
| Uploads | Create, fetch, move uploaded documents | More mutation endpoints (delete, tag, batch) are planned. |
| Tasks | Retrieve & transition workflow tasks | Additional moderation & batch operations coming. |
Roadmap candidates
Planned / under consideration (subject to change):
- Project / Team metadata endpoints
- Bulk upload + async job status
- Batch task operations (multi approve / discard)
- Classification & segmentation model results read endpoints
- Export & reporting endpoints
- Fine‑grained webhook subscription management
If a method you need is missing, let us know: open a GitHub issue or contact support via the platform UI. Early requests heavily influence ordering.
Versioning & stability
- New non‑breaking endpoints may appear at any time (additive).
- Response fields may be added (please use tolerant deserializers).
- Breaking changes will trigger a new major version (v3+) with deprecation notice for v2.
Base URL & Auth
Use the same base domain and auth scheme as other API docs (bearer token / API key). See Authentication if you have not configured credentials.
Next steps
Dive into the specific resource groups below:
- Uploads
- Tasks
Or return to the higher‑level API section for conceptual material.