Skip to Content
DocsReferenceAPI Reference

API Reference

All routes are served from the DriftGrid Next.js app.

Projects

MethodRouteAuthPurpose
GET/api/clientsOptionalList all clients and projects
GET/api/manifest/{client}/{project}OptionalRead project manifest
PUT/api/manifest/{client}/{project}OptionalUpdate manifest
POST/api/create-projectNoScaffold a new project

Versioning

MethodRouteAuthPurpose
POST/api/iterateNoDrift up — create new version
POST/api/branchNoDrift right — create new concept
POST/api/pasteNoPaste version into a concept

Rounds

MethodRouteAuthPurpose
POST/api/roundsNoClose, create, or copy-to round

Actions (via action field in body):

  • close — finalize round with selects
  • create — new round from selected versions
  • copy-to — copy a version to an existing round

Annotations

MethodRouteAuthPurpose
GET/api/annotations?client=X&project=Y&conceptId=Z&versionId=WNoRead prompts on a version
POST/api/annotationsNoCreate a prompt/annotation
PATCH/api/annotationsNoUpdate (resolve, edit, set status)
DELETE/api/annotationsNoRemove an annotation

Sharing (Cloud Only)

MethodRouteAuthPurpose
POST/api/shareYesCreate share link
GET/api/share?client=X&project=YYesList share links

Public Share Endpoints (No Auth)

MethodRoutePurpose
GET/api/s/{token}/manifestRead manifest via share token
GET/api/s/{token}/html/{path}Read HTML via share token
GET/api/s/{token}/thumbs/{path}Read thumbnails via share token
GET/api/s/{token}/commentsRead client comments
POST/api/s/{token}/commentsAdd client comment
PATCH/api/s/{token}/commentsResolve/unresolve comment

Assets

MethodRouteAuthPurpose
GET/api/html/{client}/{project}/{path}OptionalServe HTML file
GET/api/thumbs/{client}/{project}/{file}OptionalServe thumbnail
POST/api/thumbs-generateNoGenerate single thumbnail
POST/api/bake-editsNoApply client text edits to HTML
Last updated on
CLI ReferenceManifest Schema