Hi, I'm Veda

Your AI assistant for Docs

Ask me anything — I know every endpoint, guide, and changelog entry

Veda

Getting Started with DocPilot API

1. Authenticate with an API Key

First, you need an API key for your project. Create one using:

bash
curl -X POST https://api.docpilot.io/projects/{project_id}/api-keys \
  -H "Authorization: Bearer YOUR_CLERK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Integration"}'

Important: The API returns the full key only once (format: dp_ + 32 random characters). Store it securely immediately—you cannot retrieve it later.

2. Check API Health

Verify the API is running:

bash
curl https://api.docpilot.io/health

This confirms that Supabase and Neo4j dependencies are operational.

3. Generate Documentation

If you have a GitHub repository, use the Generating Documentation from a GitHub Repository guide to:

Obtain OAuth authorization from GitHub
Complete the callback handshake
Select and link your repository
Trigger the generation job
Poll for completion

4. Poll Generation Status

After triggering a generation job, monitor progress:

bash
curl https://api.docpilot.io/projects/{project_id}/generation-status/{job_id} \
  -H "Authorization: Bearer YOUR_API_KEY"

Poll every 5-10 seconds until the job completes.

5. Explore Advanced