REST API
All endpoints in this section are served from /api/public/* on your environment’s base URL and require the Authorization: Bearer <TOKEN> header described in Authentication & API keys. Response envelopes generally follow the shape { "data": ..., "error": "..." } on error paths, or a bare data/meta object on success.
Endpoints
Every REST endpoint in this guide, with the page that covers it.
Use cases
| Endpoint | Description |
|---|---|
GET /api/public/use-cases | List use cases |
POST /api/public/use-cases | Create a use case |
PATCH /api/public/use-cases/{caseId} | Update a use case |
POST /api/public/use-cases/filter | Filter use cases with background filters |
There is no single-record GET for a use case. See the PATCH notes for what to call instead.
The fields these endpoints read and write are described in Use case object model.
Solutions
| Endpoint | Description |
|---|---|
GET /api/public/solutions | List all solutions |
POST /api/public/solutions | Create a solution |
GET /api/public/solutions/{solutionId} | Get one solution |
PATCH /api/public/solutions/{solutionId} | Update a solution |
GET /api/public/solutions/checklist/{solutionId} | Get a solution’s checklists |
GET /api/public/use-case-solutions/{solutionId} | Get the use-case/solution link record |
Trying a call by hand
Every AlignAI environment also publishes a live, authenticated Swagger UI at /api/swagger — see In-product Swagger / OpenAPI reference.
Last updated on