Automate your documentation lifecycle and manage content visibility programmatically using the GitDocAI API. Whether you are integrating with a CI/CD pipeline or building a custom content management dashboard, these endpoints allow you to trigger publish jobs, manage versioning, and organize your documentation sections.

The Publishing Lifecycle

Publishing documentation is an asynchronous process. Instead of waiting for a build to finish in a single request, you trigger a job and then check its status until it completes.

flowchart LR
    A["Update Sections"] --> B["Trigger Publish"]
    B --> C{"Check Status"}
    C -->|"In Progress"| C
    C -->|"Completed"| D["Live Documentation"]

Triggering a Publish Job

You can easily integrate documentation publishing into your automated deployment scripts.

1. 1

   Start the publish job

   Call the publish endpoint to initiate a new documentation build.

   curl -X POST "https://api.gitdocai.com/documentations/{documentation_id}/publish" 
     -H "Authorization: Bearer YOUR_API_KEY"

2. 2

   Monitor the status

   Use the status endpoint to check the progress of your build.

   curl -X GET "https://api.gitdocai.com/documentations/{documentation_id}/publish/status" 
     -H "Authorization: Bearer YOUR_API_KEY"

3. 3

   Review the history (Optional)

   Fetch the publish history to audit past builds and deployments.

Publishing Endpoints

Managing Versions

Versions allow you to maintain multiple iterations of your documentation simultaneously (for example, v1.0 and v2.0). Using the API, you can control which version users see by default and gracefully phase out older versions.

Organizing Sections

Sections define the structure, hierarchy, and navigation of your documentation within a specific version. You can programmatically create, update, delete, and reorder these sections.

Section Endpoints

Managing Documentations

Use the API to create, configure, and initialize entire documentation projects at the organization level.

Wizard Progress

Track and manage the setup wizard progress for new documentation projects.

Task Management

Monitor the status of background tasks, such as AI initialization or large content migrations.