docsloth.dev
API reference
84 operations, generated from the published contract. The cloud API mirrors the same envelope and adds commercial endpoints.
Conventions
- Base URL
- http://localhost:4310 in local mode; api.docsloth.dev for managed tenants
- Auth
- Authorization: Bearer <session or OIDC token> plus X-Docsloth-Organization: <uuid>
- Idempotency
- Mutations accept Idempotency-Key (8–128 chars). Same key with a different body is 409.
- Concurrency
- Updates accept If-Match with the resource ETag; a stale write is 412.
- Errors
- application/problem+json with type, title, status, detail, code and requestId.
- Budgets
- 429 budget_exhausted is distinct from 422 validation so clients can react correctly.
- Events
- Job events stream over SSE with monotonic sequence numbers and Last-Event-ID resume.
Operations (84)
| Method | Path | Operation |
|---|---|---|
GET | /healthz | health |
GET | /v1/software | listSoftware |
POST | /v1/software | createSoftware |
GET | /v1/software/{software_id} | getSoftware |
PATCH | /v1/software/{software_id} | updateSoftware |
DELETE | /v1/software/{software_id} | deleteSoftware |
GET | /v1/software/{software_id}/sources | listSources |
POST | /v1/software/{software_id}/sources | attachSource |
DELETE | /v1/software/{software_id}/sources/{source_id} | detachSource |
PATCH | /v1/software/{software_id}/sources/{source_id} | updateSource |
POST | /v1/software/{software_id}/jobs | createJob |
GET | /v1/software/{software_id}/jobs | listJobs |
GET | /v1/jobs/{job_id} | getJob |
GET | /v1/jobs/{job_id}/events | streamJobEvents |
POST | /v1/jobs/{job_id}/cancel | cancelJob |
GET | /v1/software/{software_id}/graph | getGraph |
GET | /v1/software/{software_id}/facts | listFacts |
GET | /v1/evidence/{evidence_id} | getEvidence |
GET | /v1/software/{software_id}/releases | listReleases |
POST | /v1/software/{software_id}/releases | createRelease |
GET | /v1/software/{software_id}/programs | listPrograms |
POST | /v1/software/{software_id}/programs | createProgram |
PUT | /v1/programs/{program_id} | updateProgram |
GET | /v1/programs/{program_id} | getProgram |
DELETE | /v1/programs/{program_id} | deleteProgram |
GET | /v1/programs/{program_id}/pages | listPages |
POST | /v1/programs/{program_id}/pages | createPage |
GET | /v1/pages/{page_id} | getPage |
DELETE | /v1/pages/{page_id} | deletePage |
POST | /v1/pages/{page_id}/patches | patchPage |
GET | /v1/jobs/{job_id}/checks | getChecks |
POST | /v1/software/{software_id}/publish | publish |
GET | /v1/software/{software_id}/publications | listPublications |
POST | /v1/software/{software_id}/rollback | rollback |
GET | /v1/publications/{publication_id}/secret-findings | getPublicationSecretFindings |
GET | /v1/answers/{answer_id}/secret-findings | getAnswerSecretFindings |
POST | /v1/software/{software_id}/secret-findings/acknowledge | acknowledgeSecretFindings |
GET | /v1/approvals | listApprovals |
POST | /v1/approvals/{approval_id}/decision | decideApproval |
GET | /v1/resources | listResources |
POST | /v1/resources | createResource |
PUT | /v1/resources/{resource_id} | updateResource |
DELETE | /v1/resources/{resource_id} | deleteResource |
POST | /v1/resources/{resource_id}/credentials | setCredential |
POST | /v1/resources/{resource_id}/test | testResource |
GET | /v1/models | listModels |
POST | /v1/models | bindModel |
POST | /v1/capabilities | requestCapability |
POST | /v1/executions | execute |
GET | /v1/executions/{execution_id} | getExecution |
POST | /v1/executions/{execution_id}/cancel | cancelExecution |
POST | /v1/context | getContext |
POST | /v1/chat | chat |
GET | /v1/software/{software_id}/components | listInstalledComponents |
POST | /v1/software/{software_id}/components | installComponent |
POST | /v1/exports | createExport |
POST | /v1/imports | createImport |
GET | /.well-known/docsloth.json | discovery |
GET | /v1/published/{publication_id}/pages/{page_id} | getPublishedPage |
GET | /v1/installations | listSourceInstallations |
GET | /v1/installations/{installation_id}/repositories | listSourceCandidates |
POST | /v1/authorizations | startAuthorization |
POST | /v1/authorizations/callback | completeAuthorization |
GET | /v1/webhook-hooks | listWebhookHooks |
POST | /v1/webhook-hooks | createWebhookHook |
DELETE | /v1/webhook-hooks/{hook_id} | revokeWebhookHook |
GET | /v1/software/{software_id}/environments | listEnvironments |
POST | /v1/software/{software_id}/environments | createEnvironment |
PUT | /v1/environments/{environment_id} | updateEnvironment |
POST | /v1/deployment-events | acceptDeploymentEvent |
POST | /v1/editor/requests | planEditorChange |
GET | /v1/editor/plans/{plan_id} | getEditorPlan |
POST | /v1/forge | createComponentCandidate |
GET | /v1/forge/{forge_id} | getComponentCandidate |
POST | /v1/media/uploads | requestMediaUpload |
POST | /v1/media/{media_id}/complete | completeMediaUpload |
GET | /v1/software/{software_id}/media | listMedia |
DELETE | /v1/media/{media_id} | deleteMedia |
GET | /v1/pages/{page_id}/revisions | listPageRevisions |
POST | /v1/feedback | submitFeedback |
POST | /v1/shares | shareAnswer |
DELETE | /v1/shares/{share_id} | revokeShare |
GET | /v1/exports/{export_id} | getExport |
POST | /v1/agents/install-plan | createAgentInstallPlan |
Actions
Actions
- Inspect schema
Opens the shared JSON Schema document and its download; every request and response model below is defined there.
- Use sandbox request
Sandbox requests run against a local engine with your own bootstrap token; this build has no hosted sandbox, so the action navigates to the documented setup.