Whether you are building a custom documentation portal, integrating help content into your app, or syncing content from an external source, the GitDocAI API provides powerful endpoints for retrieving and managing your documentation entries.

This guide covers how to fetch documentation structures, retrieve specific entries, and manage your content programmatically.

Understanding the Content Hierarchy

Before making API requests, it is helpful to understand how GitDocAI structures documentation. Every entry lives within a specific hierarchy, and you will need the corresponding IDs to construct your API requests.

flowchart LR
    A["Organization"] --> B["Documentation"]
    B --> C["Version"]
    C --> D["Section"]
    D --> E["Entry"]

Retrieving Content

Use the following GET endpoints to fetch your documentation data.

1. List all Documentations

To get started, you might want to retrieve all documentation projects associated with your organization.

GET /v1/documentation/{organization_id}/list

2. Fetch a Section's Entry Tree

When building a sidebar navigation or a table of contents, fetching entries one by one is inefficient. Instead, use the tree endpoint to retrieve the entire nested structure of entries for a specific section in a single call.

GET /v1/documentation/{organization_id}/{documentation_id}/version/{version_id}/section/{section_id}/entry/tree

3. Get a Specific Entry

To retrieve the actual content and metadata of a single documentation entry, use its unique entry_id.

GET /v1/documentation/{organization_id}/{documentation_id}/version/{version_id}/section/{section_id}/entry/{entry_id}

4. List all Entries in a Section

If you need a flat list of all documentation entries for a specific section rather than a nested tree, use the base entry endpoint.

GET /v1/documentation/{organization_id}/{documentation_id}/version/{version_id}/section/{section_id}/entry

Managing Entries and Structure

Beyond retrieving content, the API offers comprehensive endpoints for creating, updating, and organizing your documentation entries.

Managing Top-Level Documentation

If you need to manage the documentation projects themselves (rather than the entries inside them), GitDocAI provides a set of top-level endpoints.