Manage the individual pages and folders (entries) that make up your documentation. Using the DocEntry API, you can programmatically create, read, update, organize, and delete content within a specific documentation section.

Because entries belong to a specific section, version, and documentation project, every API request requires a specific set of path parameters to locate the exact content you want to manage.

flowchart LR
    Org["Organization"] --> Doc["Documentation"]
    Doc --> Ver["Version"]
    Ver --> Sec["Section"]
    Sec --> Ent["Doc Entry"]
    Ent -.-> Sub["Child Entry (Optional)"]

Retrieving Content

You can retrieve entries as a flat list, a hierarchical tree, or fetch a single specific entry by its ID.

Creating and Modifying Entries

When adding content, you can create entries one by one or use the batch endpoint to upload multiple pages simultaneously.

Organizing Your Documentation

As your documentation grows, you may need to restructure your table of contents. The API provides dedicated endpoints for moving and reordering entries without needing to update each entry individually.

Workflow: Building a section programmatically

If you are migrating content from another system or generating documentation automatically, you can use these endpoints together to build out a complete section.

1. 1

   Create the parent categories

   Use the POST /.../entry endpoint to create your top-level folders. Save the returned entry_id for each folder.

2. 2

   Batch upload the pages

   Use the POST /.../entry/batch endpoint to upload multiple pages at once. Map each page to its respective parent folder using the entry_ids you saved in step 1.

3. 3

   Set the display order

   Call POST /.../entry/reorder with an array of entry IDs in the exact order you want them to appear in your documentation sidebar.