Projects API

Overview

The Projects API lets you manage documentation projects programmatically. All endpoints require authentication and are scoped to your organization.

Base path: https://api.holydocs.com/api/v1/projects

List Projects

Retrieve all projects in your organization.

bash
GET /api/v1/projects

Copy as context

bash
curl https://api.holydocs.com/api/v1/projects \  -H "Authorization: Bearer $HOLYDOCS_API_KEY"

bash
holydocs status# or list projects via the API helper:holydocs api get /projects

ts
// Project-management helpers are not part of the current JS SDK.// Use the CLI API helper or call the REST endpoint directly.// Example:// holydocs api get /projects

Query Parameters

Response

json
{  "data": [    {      "id": "proj_abc123",      "orgId": "org_xyz",      "name": "My API Docs",      "slug": "my-api-docs",      "subdomain": "my-api-docs",      "customDomain": "docs.mycompany.com",      "repoProvider": "github",      "repoOwner": "myorg",      "repoName": "api-docs",      "repoBranch": "main",      "repoPath": "/",      "createdAt": 1708200000000,      "updatedAt": 1708200000000    }  ],  "meta": {    "total": 5,    "page": 1,    "perPage": 20,    "totalPages": 1  }}

Get Project

Retrieve a single project by ID.

bash
GET /api/v1/projects/:projectId

Response

json
{  "data": {    "id": "proj_abc123",    "orgId": "org_xyz",    "name": "My API Docs",    "slug": "my-api-docs",    "subdomain": "my-api-docs",    "customDomain": "docs.mycompany.com",    "repoProvider": "github",    "repoOwner": "myorg",    "repoName": "api-docs",    "repoBranch": "main",    "repoPath": "/",    "configJson": "{...}",    "createdAt": 1708200000000,    "updatedAt": 1708200000000  }}

Create Project

Create a new documentation project.

bash
POST /api/v1/projects

Request Body

json
{  "name": "My API Docs",  "slug": "my-api-docs",  "subdomain": "my-api-docs",  "customDomain": "docs.mycompany.com",  "repoProvider": "github",  "repoOwner": "myorg",  "repoName": "api-docs",  "repoBranch": "main",  "repoPath": "/"}

Fields

Response

json
{  "data": {    "id": "proj_abc123",    "name": "My API Docs",    "slug": "my-api-docs",    "createdAt": 1708200000000  }}

The slug must be unique within your organization. Creating a project with a duplicate slug returns a 409 ALREADY_EXISTS error.

Update Project

Update an existing project's settings.

bash
PATCH /api/v1/projects/:projectId

Request Body

All fields are optional. Only include the fields you want to update:

json
{  "name": "Updated Docs Name",  "repoBranch": "release/v2",  "configJson": "{\"name\":\"Updated\",\"colors\":{\"primary\":\"#FBBF24\"}}"}

Response

json
{  "data": {    "id": "proj_abc123",    "name": "Updated Docs Name",    "updatedAt": 1708200500000  }}

Delete Project

Permanently delete a project and all associated data.

bash
DELETE /api/v1/projects/:projectId

This action is irreversible. All deployments, assets, AI indices, analytics data, and custom domain configuration will be permanently deleted. The Git repository is not affected.

Response

json
{  "data": {    "deleted": true,    "id": "proj_abc123"  }}

Error Codes