Get started with DocsCI

Sign up & create your org

Create a free account at snippetci.com/signup. Create an org matching your GitHub organization name.

Import your GitHub repo

Import any public GitHub repo by URL. DocsCI auto-detects your docs folder structure.

POST https://snippetci.com/api/repos
{
  "repo_url": "https://github.com/your-org/your-repo",
  "org_id": "<your-org-id>",
  "docs_path": "docs/",
  "sdk_languages": ["python", "typescript"]
}

Add the GitHub Actions workflow

Copy the template to .github/workflows/docsci.yml and add DOCSCI_API_KEY as a repository secret.

Import your OpenAPI spec (optional)

Point DocsCI at your staging API spec. It checks all docs examples against the live schema on every run.

POST https://snippetci.com/api/openapi-import
{
  "source_url": "https://api.your-company.com/openapi.json",
  "org_id": "<your-org-id>"
}

Trigger your first run

DocsCI fetches your docs, extracts code snippets, executes them in hermetic sandboxes, and generates AI fix suggestions for failures.

POST https://snippetci.com/api/runs
{
  "repo_id": "<your-repo-id>",
  "branch": "main"
}