HTTP API
This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built. It lists 309 operations on 219 paths and 538 schemas. The document is OpenAPI 3.1.1.
Use the HTTP API shows how to sign in, how to send a version with a write and how to read an error.
These paths are not in the OpenAPI document: /health, /mcp, /llms.txt, /llms-full.txt and /skills/vellum/SKILL.md. Bootstrap environment describes /health. MCP tools describes /mcp.
| Area | Operations | Paths |
|---|---|---|
| Auth | 7 | /api/auth/register/api/auth/methods/api/auth/login/api/auth/logout/api/auth/me/api/auth/external/{provider}/api/auth/external/complete |
| Agent tokens | 3 | /api/workspaces/{workspaceId}/agent-tokens/api/workspaces/{workspaceId}/agent-tokens/{tokenId} |
| Workspaces | 4 | /api/workspaces/api/workspaces/{id} |
| Members | 10 | /api/workspaces/{workspaceId}/members/api/workspaces/{workspaceId}/members/{memberUserId}/api/workspaces/{workspaceId}/invitations/api/workspaces/{workspaceId}/invitations/{invitationId}/api/invitations/api/invitations/{invitationId}/open/api/invitations/{invitationId}/accept/api/invitations/{invitationId}/decline |
| Projects | 5 | /api/workspaces/{workspaceId}/projects/api/projects/{projectId} |
| Facts | 2 | /api/projects/{projectId}/facts/{entityType}/{entityId}/accept/api/projects/{projectId}/facts/{entityType}/{entityId}/mark-unknown |
| Elements | 5 | /api/projects/{projectId}/elements/api/projects/{projectId}/elements/{elementId} |
| Relationships | 5 | /api/projects/{projectId}/relationships/api/projects/{projectId}/relationships/{relationshipId} |
| Messages | 5 | /api/projects/{projectId}/messages/api/projects/{projectId}/messages/{messageId} |
| Export | 4 | /api/projects/{projectId}/export/api/projects/{projectId}/export/structurizr/api/projects/{projectId}/views/{viewId}/export/svg/api/projects/{projectId}/views/{viewId}/export/mermaid |
| Import | 1 | /api/projects/{projectId}/import |
| Operations | 4 | /api/projects/{projectId}/operations/api/projects/{projectId}/operations/{operationId} |
| Channels | 4 | /api/projects/{projectId}/channels/api/projects/{projectId}/channels/{channelId} |
| Subscriptions | 4 | /api/projects/{projectId}/subscriptions/api/projects/{projectId}/subscriptions/{subscriptionId} |
| Bindings | 4 | /api/projects/{projectId}/bindings/api/projects/{projectId}/bindings/{bindingId} |
| Revisions | 7 | /api/projects/{projectId}/revisions/api/projects/{projectId}/revisions/{revisionId}/api/projects/{projectId}/revisions/{revisionId}/model/api/projects/{projectId}/model/compare |
| Agent | 1 | /api/agent/capabilities |
| GitHub | 2 | /api/workspaces/{workspaceId}/github/test/api/workspaces/{workspaceId}/github/credential |
| Git hosts | 1 | /api/workspaces/{workspaceId}/git-hosts/{host}/test |
| Imports | 14 | /api/projects/{projectId}/imports/{importId}/impact/api/projects/{projectId}/imports/{importId}/impact/report/api/projects/{projectId}/imports/{importId}/impact/checks/api/projects/{projectId}/imports/api/projects/{projectId}/imports/{importId}/api/projects/{projectId}/imports/{importId}/cancel/api/projects/{projectId}/imports/{importId}/resume/api/projects/{projectId}/imports/{importId}/track/api/projects/{projectId}/imports/{importId}/proposals/api/projects/{projectId}/imports/{importId}/proposals/{proposalId}/api/projects/{projectId}/imports/{importId}/proposals/decide/api/projects/{projectId}/imports/{importId}/evidence/api/projects/{projectId}/imports/{importId}/source |
| Variants | 4 | /api/projects/{projectId}/variants/api/projects/{projectId}/variants/{variantId} |
| Views | 6 | /api/projects/{projectId}/views/api/projects/{projectId}/views/{viewId}/api/projects/{projectId}/views/{viewId}/layout |
| Spaces | 4 | /api/projects/{projectId}/spaces/api/projects/{projectId}/spaces/{spaceId} |
| Documents | 5 | /api/projects/{projectId}/docs/api/projects/{projectId}/docs/{docId} |
| Drafts | 4 | /api/projects/{projectId}/drafts/api/projects/{projectId}/drafts/{draftId}/api/projects/{projectId}/drafts/{draftId}/abandon |
| Merge | 2 | /api/projects/{projectId}/drafts/{draftId}/merge/preview/api/projects/{projectId}/drafts/{draftId}/merge/execute |
| Comments | 10 | /api/projects/{projectId}/threads/api/projects/{projectId}/threads/{threadId}/api/projects/{projectId}/threads/{threadId}/replies/api/projects/{projectId}/threads/{threadId}/comments/{commentId}/api/projects/{projectId}/threads/{threadId}/resolve/api/projects/{projectId}/threads/{threadId}/reopen/api/projects/{projectId}/threads/{threadId}/raise-question/api/projects/{projectId}/threads/{threadId}/raise-decision |
| Inbox | 3 | /api/inbox/api/inbox/{itemId}/read/api/inbox/read-all |
| Schemas | 5 | /api/projects/{projectId}/schemas/api/projects/{projectId}/schemas/{schemaId} |
| Scenarios | 6 | /api/projects/{projectId}/scenarios/api/projects/{projectId}/scenarios/{scenarioId}/api/projects/{projectId}/scenarios/{scenarioId}/run |
| Setup | 2 | /api/setup/status/api/setup |
| Instance | 6 | /api/instance/api/instance/settings/api/instance/audit/api/instance/keys/rotate/api/instance/diagnostics |
| Settings | 6 | /api/workspaces/{workspaceId}/settings/api/workspaces/{workspaceId}/secrets/api/workspaces/{workspaceId}/secrets/{name}/api/workspaces/{workspaceId}/audit |
| AI | 4 | /api/workspaces/{workspaceId}/ai/usage/api/workspaces/{workspaceId}/ai/providers/{providerId}/test/api/instance/ai/prices |
| AI design | 16 | /api/projects/{projectId}/ai/flow-proposals/api/projects/{projectId}/ai/flow-proposals/submit/api/projects/{projectId}/ai/flow-proposals/{proposalId}/api/projects/{projectId}/ai/flow-proposals/{proposalId}/accept/api/projects/{projectId}/ai/flow-proposals/{proposalId}/reject/api/projects/{projectId}/ai/flow-proposals/{proposalId}/missing/{alias}/create/api/projects/{projectId}/ai/architecture-proposals/api/projects/{projectId}/ai/architecture-proposals/from-document/api/projects/{projectId}/ai/architecture-proposals/submit/api/projects/{projectId}/ai/architecture-proposals/{proposalId}/api/projects/{projectId}/ai/architecture-proposals/{proposalId}/decide/api/projects/{projectId}/ai/explain |
| Sources | 22 | /api/projects/{projectId}/sources/api/projects/{projectId}/sources/upload/api/projects/{projectId}/sources/{sourceId}/api/projects/{projectId}/sources/{sourceId}/archive/api/projects/{projectId}/sources/kinds/api/projects/{projectId}/sources/repositories/api/projects/{projectId}/sources/bulk/api/projects/{projectId}/sources/{sourceId}/scans/api/projects/{projectId}/sources/{sourceId}/traces/api/projects/{projectId}/sources/{sourceId}/newrelic/key/api/projects/{projectId}/sources/{sourceId}/newrelic/test/api/projects/{projectId}/sources/newrelic/test/api/projects/{projectId}/sources/{sourceId}/snapshots/api/projects/{projectId}/sources/{sourceId}/snapshots/compare/api/projects/{projectId}/sources/{sourceId}/documents/api/projects/{projectId}/sources/{sourceId}/bindings/api/projects/{projectId}/sources/push/api/projects/{projectId}/sources/{sourceId}/accept |
| Promises | 18 | /api/projects/{projectId}/promises/api/projects/{projectId}/promises/prefix/api/projects/{projectId}/promises/{promiseId}/api/projects/{projectId}/promises/{promiseId}/revise/api/projects/{projectId}/promises/{promiseId}/approve/api/projects/{projectId}/promises/{promiseId}/runs/api/projects/{projectId}/promises/{promiseId}/obligations/api/projects/{projectId}/promises/{promiseId}/obligations/generate/api/projects/{projectId}/promises/{promiseId}/obligations/{obligationKey}/api/projects/{projectId}/promises/{promiseId}/obligations/{obligationKey}/run/api/projects/{projectId}/promises/{promiseId}/obligations/{obligationKey}/evidence/api/projects/{projectId}/impact-gate |
| Build | 4 | /api/projects/{projectId}/build/export/api/projects/{projectId}/build/manifest/api/projects/{projectId}/build/brief/api/projects/{projectId}/build/verify |
| Stress | 12 | /api/projects/{projectId}/stress/requirements/api/projects/{projectId}/stress/defaults/api/projects/{projectId}/stress/profiles/api/projects/{projectId}/stress/profiles/{profileId}/api/projects/{projectId}/stress/profiles/{profileId}/runs/api/projects/{projectId}/stress/runs/{runId}/api/projects/{projectId}/stress/compare |
| LoadTests | 16 | /api/projects/{projectId}/load-tests/targets/api/projects/{projectId}/load-tests/targets/{targetId}/api/projects/{projectId}/load-tests/targets/{targetId}/authorise/api/projects/{projectId}/load-tests/targets/{targetId}/authorisation/api/projects/{projectId}/load-tests/targets/{targetId}/override/api/projects/{projectId}/load-tests/scripts/api/projects/{projectId}/load-tests/scripts/{scriptId}/api/projects/{projectId}/load-tests/results/api/projects/{projectId}/load-tests/results/{resultId}/api/projects/{projectId}/load-tests/compare/estimate/api/projects/{projectId}/load-tests/compare/results |
| Costs | 15 | /api/projects/{projectId}/costs/api/projects/{projectId}/costs/copy/api/projects/{projectId}/costs/resources/api/projects/{projectId}/costs/resources/{resourceId}/api/projects/{projectId}/costs/assumptions/api/projects/{projectId}/costs/assumptions/{assumptionId}/api/projects/{projectId}/costs/estimate/api/projects/{projectId}/costs/compare/api/projects/{projectId}/costs/estimates/api/projects/{projectId}/costs/estimates/{estimateId}/api/projects/{projectId}/costs/prices |
| Prices | 13 | /api/workspaces/{workspaceId}/prices/api/workspaces/{workspaceId}/prices/{priceId}/api/workspaces/{workspaceId}/prices/csv/api/workspaces/{workspaceId}/prices/azure/meters/api/workspaces/{workspaceId}/prices/azure/api/workspaces/{workspaceId}/prices/aws/services/api/workspaces/{workspaceId}/prices/aws/regions/api/workspaces/{workspaceId}/prices/aws/prices/api/workspaces/{workspaceId}/prices/aws/api/workspaces/{workspaceId}/prices/gcp/services/api/workspaces/{workspaceId}/prices/gcp/skus/api/workspaces/{workspaceId}/prices/gcp |
| Review | 13 | /api/projects/{projectId}/review/rules/api/projects/{projectId}/review/findings/api/projects/{projectId}/review/snapshots/api/projects/{projectId}/review/snapshots/{snapshotId}/api/projects/{projectId}/review/dispositions/api/projects/{projectId}/review/critiques/api/projects/{projectId}/review/critiques/{critiqueId}/api/projects/{projectId}/review/critiques/{critiqueId}/proposed-decisions/{index}/keep/api/projects/{projectId}/review/critiques/{critiqueId}/questions/{index}/keep |
| Decisions | 9 | /api/projects/{projectId}/decisions/api/projects/{projectId}/decisions/export/api/projects/{projectId}/decisions/{decisionId}/api/projects/{projectId}/decisions/{decisionId}/export/api/projects/{projectId}/decisions/{decisionId}/accept/api/projects/{projectId}/decisions/{decisionId}/reject |
| Questions | 6 | /api/projects/{projectId}/questions/api/projects/{projectId}/questions/keep/api/projects/{projectId}/questions/{questionId}/answer/api/projects/{projectId}/questions/{questionId}/drop/api/projects/{projectId}/questions/{questionId} |
| Sharing | 4 | /api/projects/{projectId}/share-links/api/projects/{projectId}/share-links/{linkId}/api/projects/{projectId}/share-links/{linkId}/revoke |
| Shared pages | 2 | /api/share/{token}/api/share/{token}/unlock |
Types lists each request and answer type with its fields.