Login Sign Up Contact

Login Sign Up Contact

Events›Get VAPID public key

Help Center Documentation codeOpenAPI

OpenAPI

Help Center
Documentation
OpenAPI

Ai

POSTEdit content using AI POSTGenerate an image with AI and store it as an asset

Api Keys

GETList API keys POSTCreate API key DELDelete API key

Asset

GETGet all assets for a documentation POSTUpload an asset GETGet asset by ID PUTUpdate asset metadata DELDelete an asset GETServe asset file

Auth

POSTActivate customer account POSTExchange API key for access token POSTChange password POSTRequest password reset POSTLogin with email and password POSTLogout (revoke refresh token)POSTRefresh access token POSTRegister a new customer POSTResend activation code POSTReset password with token POSTSet password with invitation token (maintainers)

Connected Apps

GETList connected apps POSTRevoke a connected app

Customers

GETGet customer billing info PUTUpdate an existing customer

Docentry

GETGet all doc entries for a section POSTCreate a new doc entry POSTBatch create doc entries POSTReorder doc entries GETGet doc entries tree for a section GETGet doc entry by ID PUTUpdate doc entry DELDelete doc entry POSTMove doc entry to a different parent or section

Documentation

POSTCreate a new documentation GETGet all documentations for an organization GETGet documentation by ID PUTUpdate documentation DELDelete documentation PUTUpdate documentation configuration POSTInitialize a pending documentation with a default scaffold POSTInitialize a pending documentation from an AI prompt POSTInitialize a pending documentation by importing files POSTInitialize a pending documentation by importing an OpenAPI/Swagger spec POSTInitialize a pending documentation from a GitHub repository POSTInitialize a pending documentation with a preset template POSTInitialize a pending documentation by importing a website GETResolve popular-article entry ids to titles + version coords

Documentation Backup

GETList all backups for a documentation POSTMake a backup of a documentation GETGet the configured backup repository for a documentation PUTSet the backup repository for a documentation POSTRestore a documentation from a previous backup

Documentation Usage

GETGet documentation usage GETList documentation usages by organization

Events

DELDelete an event (simplified endpoint)POSTList events for a project (simplified endpoint)GETGet VAPID public key GETList events for a project POSTCreate a new event DELDelete an event

Git Provider

POSTHandle OAuth callback from git provider GETGet git provider installation URL GETList git provider installations GETGet git provider installation by ID DELDelete git provider installation GETList repositories from git providers POSTSync repositories from git provider GETGet repository by ID GETGet file content from repository GETGet repository file tree

Lifetimedeals

POSTCreate lifetime deal checkout

Oauth

POSTGet S2S access token

Organization

GETGet all organizations for current user POSTCreate a new organization GETGet organization by ID PUTUpdate organization DELDelete organization POSTComplete onboarding for organization POSTUpload organization logo

Organization Usage

GETGet organization usage

Organization Users

GETList my pending invitations POSTAccept my invitation GETGet all users in organization GETGet active users in organization POSTInvite user to organization GETGet pending invites in organization DELRemove user from organization PATCHUpdate user role in organization PATCHAdd/remove doc grants on a member (readers only for now)

Plans

GETList all plans GETGet plan by ID

Promotioncodes

GETGet lifetime deal code by Stripe session id POSTActivate promotion code GETValidate promotion code

Publish

POSTStart a publish job GETGet publish history GETGet latest publish GETGet publish job status POSTSearch a documentation

Push Notifications

POSTSubscribe to push notifications (simplified endpoint)POSTSubscribe to push notifications

Resources

POSTFinalize a direct upload POSTRequest a signed upload URL for a file resource

Roles

Section

GETGet all sections for a version POSTCreate a new section POSTReorder sections GETGet section by ID PUTUpdate section DELDelete section GETGet a section's source-of-truth summary

Subscription

GETGet feature value GETValidate if a feature is enabled GETValidate if a feature limit allows more usage

Subscriptions

GETGet organization subscription POSTGet checkout URL GETGet customer portal URL POSTReconcile local subscription state with Stripe

Support

GETList support tickets POSTCreate support ticket GETGet support ticket POSTAdd message to ticket

Tasks

GETGet public roadmap items (no auth)GETGet changelogs GETGet changelog by version POSTCreate a customer idea GETGet ideas configuration POSTVote for a roadmap item DELRemove vote from a roadmap item GETGet public roadmap items GETGet public statuses

Users

GETGet current user profile PUTUpdate current user profile DELDelete current user profile POSTUpload profile picture GETGet user profile picture

Version

GETGet all versions for a documentation POSTCreate a new version GETGet version by ID PUTUpdate version DELDelete version POSTSet version as default POSTSet version deprecated status POSTSet version as latest

Wizardprogress

GETGet wizard progress for a documentation POSTUpsert wizard progress DELDelete wizard progress

Default

POSTImport an asset from a URL

Preferences

GETGet a user preference PUTSet a user preference DELDelete a user preference GETList all user preferences

Get VAPID public key

GET

/control-plane/api/v1/v1/event/vapid-public-key

Responses

200

OK

Example:

{
  "key": "value"
}

List events for a project (simplified endpoint)List events for a project

Powered by GitDoc

© 2026 GitDocAI. All rights reserved.

On this page

Assistant

Ask anything about the docs.

Press ⌥I to toggle this panel.

ESC

Ask Assistant