Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.driftless.icu/llms.txt

Use this file to discover all available pages before exploring further.

Base URL:
https://api.driftless.icu/api/v1
Most endpoints require either a Clerk session from the dashboard or an API key from the CLI.
curl https://api.driftless.icu/api/v1/workspaces/acme/repos \
  -H "x-api-key: drift_your_api_key_here"
Treat API keys as secrets. Driftless stores keys encrypted and only shows the raw value once when created.

Public endpoints

MethodPathPurpose
GET/healthRuntime health check
GET/versionAPI version and deploy metadata
POST/workspacesWorkspace bootstrap
GET/blog/postsPublic blog index
GET/blog/posts/:slugPublic blog post
POST/webhooks/githubGitHub App webhook receiver
POST/webhooks/clerkClerk webhook receiver

Auth and identity

MethodPathPurpose
GET/meCurrent identity and workspace context
POST/auth/api-keysCreate an API key
GET/auth/api-keysList API keys for the workspace
DELETE/auth/api-keys/:idRevoke an API key

Workspaces

MethodPathPurpose
GET/workspaces/:slugGet workspace details
PATCH/workspaces/:slugUpdate workspace settings
GET/workspaces/:slug/healthWorkspace health summary
GET/workspaces/:slug/membersList members
POST/workspaces/:slug/membersInvite a member
DELETE/workspaces/:slug/members/:memberIdRemove a member

Repositories and scans

MethodPathPurpose
GET/workspaces/:slug/reposList repositories
POST/workspaces/:slug/reposRegister a repository
GET/workspaces/:slug/repos/:idGet repository details
PATCH/workspaces/:slug/repos/:idUpdate repository metadata
DELETE/workspaces/:slug/repos/:idDelete a repository
POST/workspaces/:slug/repos/:id/componentsUpload extracted components
POST/workspaces/:slug/repos/:id/baselineUpload a baseline scan
POST/workspaces/:slug/repos/:id/scanUpload a scan result
GET/workspaces/:slug/repos/:id/architecture-summaryArchitecture summary
GET/workspaces/:slug/repos/:id/components/:componentNameComponent detail
POST/workspaces/:slug/repos/:id/context/loadMatch files to context
GET/workspaces/:slug/repos/:id/graph/fileFile graph
GET/workspaces/:slug/repos/:id/graph/impactImpact graph

Topics

The API keeps the legacy route name watchers for compatibility. The product language is topics.
MethodPathPurpose
GET/workspaces/:slug/watchersList topics
POST/workspaces/:slug/watchersCreate a topic
GET/workspaces/:slug/watchers/searchSearch topics
GET/workspaces/:slug/watchers/auditContext health audit
GET/workspaces/:slug/watchers/eventsTopic event timeline
POST/workspaces/:slug/watchers/match-filesMatch files to topics
GET/workspaces/:slug/watchers/graphTopic graph
GET/workspaces/:slug/watchers/:watcherSlugGet topic detail
PATCH/workspaces/:slug/watchers/:watcherSlugUpdate a topic
DELETE/workspaces/:slug/watchers/:watcherSlugDelete a topic
POST/workspaces/:slug/watchers/:watcherSlug/relationsAdd a relation
GET/workspaces/:slug/watchers/:watcherSlug/relationsList relations
DELETE/workspaces/:slug/watchers/:watcherSlug/relations/:relationIdDelete a relation

Integrations and PR activity

MethodPathPurpose
GET/workspaces/:slug/integrationsList integrations
POST/workspaces/:slug/integrationsCreate or connect an integration
DELETE/workspaces/:slug/integrations/:idRemove an integration
GET/workspaces/:slug/pr-activityObserved pull request activity