Assessor.io API v2 (public) - Template authoring
The external-agent door onto the same template-authoring pipeline the in-app BIMei AI Assistant uses: retrieval over Action Statements and library items, reading templates/scales/labels, and the Blueprint create -> run assistant -> validate -> compile flow. Every operation here is scoped to the accountId in the path and to one of four scopes: statements:read, templates:read, templates:write, blueprints:write. ONLY A HUMAN PUBLISHES. No operation in this file can set a template Active, distribute it, or attach it to a campaign. POST …/blueprints/{blueprintId}/compile is the only write that creates a template at all, and it is always created Draft.
Getting a token, the scopes and the response envelope are explained in Make your first API call and Public API (v2).
Contract Summary
- Version:
1.3.1 - Visibility:
public - Operations:
11 - Tags:
PublicRetrieval, PublicTemplates, PublicBlueprints
Operations
| Method | Path | Summary | Operation ID |
|---|---|---|---|
| GET | /api/v2/public/accounts/{accountId}/retrieval | Search Action Statements, library items and prior template questions. | v2SearchRetrieval |
| GET | /api/v2/public/accounts/{accountId}/templates | List the account's assessment templates. | v2ListTemplates |
| GET | /api/v2/public/accounts/{accountId}/templates/{templateId} | Read one template (body + metadata). | v2GetTemplate |
| POST | /api/v2/public/accounts/{accountId}/templates/validate | Run the authoring Check against a template body, without saving it. | v2ValidateTemplate |
| GET | /api/v2/public/accounts/{accountId}/scales | List answer scales usable in this account. | v2ListScales |
| GET | /api/v2/public/accounts/{accountId}/labels | List the account's visible label vocabulary. | v2ListLabels |
| POST | /api/v2/public/accounts/{accountId}/blueprints | Start a Blueprint from pasted brief text. | v2CreateBlueprint |
| GET | /api/v2/public/accounts/{accountId}/blueprints/{blueprintId} | Read a Blueprint's full state. | v2GetBlueprint |
| POST | /api/v2/public/accounts/{accountId}/blueprints/{blueprintId}/validate | Run the Blueprint readiness gate, without compiling. | v2ValidateBlueprint |
| POST | /api/v2/public/accounts/{accountId}/blueprints/{blueprintId}/aia | Run the BIMei AI Assistant over a Blueprint. | v2RunBlueprintAssistant |
| POST | /api/v2/public/accounts/{accountId}/blueprints/{blueprintId}/compile | Compile a ready Blueprint into a Draft template. | v2CompileBlueprint |