Octri API
GET/api/v1/projects/{projectId}/docs/pages/{slug}

Get a documentation page

Retrieves a generated documentation page for a project by its slug. Use the projectId from listProjects and the slug from listDocPages to identify the page.

2 parameters
projectIdstringrequired

The project's unique identifier, obtained from listProjects.

slugstringrequired

The page's slug, obtained from listDocPages.

3 status codes
200Returns the page object with its generated content.
pageobjectrequired
401Returned when the API key is missing or invalid.
errorobjectrequired
404Returned when the project or requested page does not exist in the organisation.
errorobjectrequired

Error handling

A 401 is returned when the API key is missing or invalid. A 404 is returned when the project or page does not exist in the organisation. The projectId path parameter must identify a project, and the slug path parameter must identify a page in that project.