Wiki Generation API - DeepWiki-Open

Overview

The DeepWikiOpen API provides endpoints for generating comprehensive documentation from repositories using AI-powered analysis. All endpoints require authentication and support JSON request/response formats. Base URL: https://api.deepwikiopen.com/v1 Authentication: All endpoints require an API key in the Authorization header.

POST /wiki/generate

Generate comprehensive wiki documentation from a repository URL or uploaded codebase.

string

required

The GitHub repository URL to analyze and generate documentation for

string

Custom name for the project (defaults to repository name)

object

Generation configuration options

Show config properties

boolean

default:"true"

Include code examples in generated documentation

integer

default:"5"

Maximum directory depth to analyze (1-10)

array

File patterns to exclude from analysis (e.g., [“.test.js”, “node_modules/”])

boolean

default:"false"

Include private/internal functions in documentation

string

default:"markdown"

Output format: “markdown”, “html”, or “json”

string

Optional webhook URL for completion notifications

Request Example

curl -X POST "https://api.deepwikiopen.com/v1/wiki/generate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "repository_url": "https://github.com/username/awesome-project",
    "project_name": "Awesome Project",
    "config": {
      "include_code_examples": true,
      "max_depth": 3,
      "exclude_patterns": ["*.test.js", "dist/*"],
      "output_format": "markdown"
    },
    "webhook_url": "https://your-domain.com/webhooks/wiki-complete"
  }'

import requests

url = "https://api.deepwikiopen.com/v1/wiki/generate"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
data = {
    "repository_url": "https://github.com/username/awesome-project",
    "project_name": "Awesome Project",
    "config": {
        "include_code_examples": True,
        "max_depth": 3,
        "exclude_patterns": ["*.test.js", "dist/*"],
        "output_format": "markdown"
    }
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
print(f"Task ID: {result['task_id']}")

const response = await fetch('https://api.deepwikiopen.com/v1/wiki/generate', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    repository_url: 'https://github.com/username/awesome-project',
    project_name: 'Awesome Project',
    config: {
      include_code_examples: true,
      max_depth: 3,
      exclude_patterns: ['*.test.js', 'dist/*'],
      output_format: 'markdown'
    }
  })
});

const result = await response.json();
console.log('Task ID:', result.task_id);

Response

string

required

Unique identifier for tracking the generation task

string

required

Unique project identifier for accessing results

string

required

Current task status: “queued”, “processing”, “completed”, or “failed”

integer

Estimated completion time in seconds

boolean

Whether webhook notification was successfully registered

Response Example

{
  "task_id": "task_12345abcde",
  "project_id": "proj_awesome_project_67890",
  "status": "queued",
  "estimated_duration": 180,
  "webhook_registered": true,
  "created_at": "2024-01-15T10:30:00Z"
}

GET /wiki/projects

Retrieve a list of all processed repositories and their current status.

integer

default:"1"

Page number for pagination

integer

default:"20"

Number of projects per page (max: 100)

string

Filter by status: “completed”, “processing”, “failed”

string

Search projects by name or repository URL

Request Example

curl -X GET "https://api.deepwikiopen.com/v1/wiki/projects?page=1&limit=10&status=completed" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

url = "https://api.deepwikiopen.com/v1/wiki/projects"
headers = {"Authorization": "Bearer YOUR_API_KEY"}
params = {
    "page": 1,
    "limit": 10,
    "status": "completed"
}

response = requests.get(url, headers=headers, params=params)
projects = response.json()

const params = new URLSearchParams({
  page: '1',
  limit: '10',
  status: 'completed'
});

const response = await fetch(`https://api.deepwikiopen.com/v1/wiki/projects?${params}`, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const projects = await response.json();

Response

array

required

Array of project objects

Show Project object properties

string

Unique project identifier

string

Display name of the project

string

Original repository URL

string

Current project status

string

ISO timestamp of creation

string

ISO timestamp of completion (if applicable)

integer

Number of files processed

integer

Number of documentation pages generated

object

required

Pagination information

Show Pagination properties

integer

Current page number

integer

Total number of pages

integer

Total number of projects

boolean

Whether there are more pages

GET /wiki/

Retrieve the complete wiki documentation for a specific project.

string

required

The unique project identifier

string

default:"json"

Response format: “json”, “markdown”, or “html”

boolean

default:"true"

Include project metadata in response

Request Example

curl -X GET "https://api.deepwikiopen.com/v1/wiki/proj_awesome_project_67890?format=json" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

project_id = "proj_awesome_project_67890"
url = f"https://api.deepwikiopen.com/v1/wiki/{project_id}"
headers = {"Authorization": "Bearer YOUR_API_KEY"}
params = {"format": "json", "include_metadata": True}

response = requests.get(url, headers=headers, params=params)
wiki_data = response.json()

const projectId = 'proj_awesome_project_67890';
const params = new URLSearchParams({
  format: 'json',
  include_metadata: 'true'
});

const response = await fetch(`https://api.deepwikiopen.com/v1/wiki/${projectId}?${params}`, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const wikiData = await response.json();

Response

string

required

Project identifier

string

required

Project display name

string

required

Original repository URL

string

required

ISO timestamp of wiki generation

array

required

Array of documentation pages

Show Page object properties

string

Unique page identifier

string

Page title

string

Page content (format depends on query parameter)

string

File path in repository

string

Page type: “overview”, “api”, “guide”, “reference”

integer

Display order

object

Project metadata (if include_metadata=true)

Show Metadata properties

object

Programming language distribution

integer

Total files processed

number

Project complexity rating (0-10)

string

Last commit hash from repository

DELETE /wiki/

Delete a project’s cached wiki data and generated documentation.

string

required

The unique project identifier to delete

Request Example

curl -X DELETE "https://api.deepwikiopen.com/v1/wiki/proj_awesome_project_67890" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

project_id = "proj_awesome_project_67890"
url = f"https://api.deepwikiopen.com/v1/wiki/{project_id}"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.delete(url, headers=headers)
result = response.json()

const projectId = 'proj_awesome_project_67890';

const response = await fetch(`https://api.deepwikiopen.com/v1/wiki/${projectId}`, {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const result = await response.json();

Response

boolean

required

Whether the deletion was successful

string

required

The deleted project identifier

string

required

Confirmation message

string

required

ISO timestamp of deletion

Response Example

{
  "success": true,
  "project_id": "proj_awesome_project_67890",
  "message": "Project wiki data successfully deleted",
  "deleted_at": "2024-01-15T14:30:00Z"
}

POST /wiki/regenerate

Force regenerate wiki documentation for an existing project with updated configuration.

string

required

The project identifier to regenerate

object

Updated generation configuration (same structure as /wiki/generate)

boolean

default:"false"

Force refresh from repository (ignore cache)

string

Optional webhook URL for completion notifications

Request Example

curl -X POST "https://api.deepwikiopen.com/v1/wiki/regenerate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "proj_awesome_project_67890",
    "config": {
      "include_code_examples": true,
      "max_depth": 5,
      "output_format": "html"
    },
    "force_refresh": true
  }'

import requests

url = "https://api.deepwikiopen.com/v1/wiki/regenerate"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
data = {
    "project_id": "proj_awesome_project_67890",
    "config": {
        "include_code_examples": True,
        "max_depth": 5,
        "output_format": "html"
    },
    "force_refresh": True
}

response = requests.post(url, headers=headers, json=data)
result = response.json()

const response = await fetch('https://api.deepwikiopen.com/v1/wiki/regenerate', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    project_id: 'proj_awesome_project_67890',
    config: {
      include_code_examples: true,
      max_depth: 5,
      output_format: 'html'
    },
    force_refresh: true
  })
});

const result = await response.json();

Response

Same response structure as POST /wiki/generate.

GET /wiki/status/

Check the status of a wiki generation task and get progress updates.

string

required

The task identifier returned from generation request

Request Example

curl -X GET "https://api.deepwikiopen.com/v1/wiki/status/task_12345abcde" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

task_id = "task_12345abcde"
url = f"https://api.deepwikiopen.com/v1/wiki/status/{task_id}"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.get(url, headers=headers)
status = response.json()

const taskId = 'task_12345abcde';

const response = await fetch(`https://api.deepwikiopen.com/v1/wiki/status/${taskId}`, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const status = await response.json();

Response

string

required

The task identifier

string

required

Associated project identifier

string

required

Current status: “queued”, “processing”, “completed”, “failed”

object

Progress information (when status is “processing”)

Show Progress properties

integer

Completion percentage (0-100)

string

Current processing step

integer

Number of files processed so far

integer

Total files to process

integer

Estimated seconds remaining

object

Results (when status is “completed”)

Show Result properties

string

URL to access generated wiki

integer

Number of pages created

integer

Total processing time in seconds

object

Error information (when status is “failed”)

Show Error properties

string

Error code

string

Error description

string

Additional error details

string

required

ISO timestamp when task was created

string

required

ISO timestamp of last status update

Response Example (Processing)

{
  "task_id": "task_12345abcde",
  "project_id": "proj_awesome_project_67890",
  "status": "processing",
  "progress": {
    "percentage": 65,
    "current_step": "Generating API documentation",
    "files_processed": 42,
    "total_files": 65,
    "estimated_remaining": 45
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:32:15Z"
}

Authentication

All API endpoints require authentication using an API key passed in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Getting an API Key

Sign up for a DeepWikiOpen account at console.deepwikiopen.com
Navigate to the API Keys section
Generate a new API key
Store it securely (it won’t be shown again)

Rate Limiting

API requests are rate limited to prevent abuse:

Standard Plan: 100 requests per hour
Pro Plan: 1,000 requests per hour
Enterprise Plan: 10,000 requests per hour

Rate limit headers are included in all responses:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1642248000

When rate limited, you’ll receive a 429 status code:

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Limit resets at 2024-01-15T11:00:00Z"
  }
}

Error Responses

All endpoints follow consistent error response format:

HTTP Status Codes

Code	Description
200	Success
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
429	Rate Limited
500	Internal Server Error
503	Service Unavailable

Error Response Format

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "details": "Additional error context",
    "request_id": "req_12345abcde"
  }
}

Common Error Codes

Code	Description
`INVALID_API_KEY`	API key is missing or invalid
`PROJECT_NOT_FOUND`	Specified project doesn’t exist
`TASK_NOT_FOUND`	Specified task doesn’t exist
`INVALID_REPOSITORY_URL`	Repository URL is malformed or inaccessible
`GENERATION_FAILED`	Wiki generation failed due to processing error
`RATE_LIMIT_EXCEEDED`	Too many requests within time window
`INSUFFICIENT_CREDITS`	Not enough API credits remaining

Webhooks

When providing a webhook_url in generation requests, DeepWikiOpen will send HTTP POST notifications when tasks complete:

Webhook Payload

{
  "event": "wiki.generation.completed",
  "task_id": "task_12345abcde",
  "project_id": "proj_awesome_project_67890",
  "status": "completed",
  "result": {
    "wiki_url": "https://api.deepwikiopen.com/v1/wiki/proj_awesome_project_67890",
    "pages_generated": 15,
    "processing_time": 142
  },
  "timestamp": "2024-01-15T10:35:00Z"
}

Webhook Security

Webhooks include a signature header for verification:

X-DeepWiki-Signature: sha256=1234567890abcdef...

Verify the signature using your webhook secret (available in your dashboard).

SDK Examples

Python SDK

from deepwikiopen import DeepWikiClient

client = DeepWikiClient(api_key="YOUR_API_KEY")

# Generate wiki
task = client.generate_wiki(
    repository_url="https://github.com/username/repo",
    config={
        "include_code_examples": True,
        "max_depth": 3
    }
)

# Wait for completion
result = client.wait_for_completion(task.task_id)
print(f"Wiki generated: {result.wiki_url}")

Node.js SDK

const { DeepWikiClient } = require('deepwikiopen');

const client = new DeepWikiClient({ apiKey: 'YOUR_API_KEY' });

// Generate wiki
const task = await client.generateWiki({
  repositoryUrl: 'https://github.com/username/repo',
  config: {
    includeCodeExamples: true,
    maxDepth: 3
  }
});

// Poll for completion
const result = await client.waitForCompletion(task.taskId);
console.log(`Wiki generated: ${result.wikiUrl}`);

Support

For API support and questions:

Documentation: docs.deepwikiopen.com
Support Email: support@deepwikiopen.com
Status Page: status.deepwikiopen.com
Community Discord: discord.gg/deepwikiopen

​Overview

​POST /wiki/generate

​Request Example

​Response

​GET /wiki/projects

​Request Example

​Response

​GET /wiki/

​Request Example

​Response

​DELETE /wiki/

​Request Example

​Response

​POST /wiki/regenerate

​Request Example

​Response

​GET /wiki/status/

​Request Example

​Response

​Authentication

​Getting an API Key

​Rate Limiting

​Error Responses

​HTTP Status Codes

​Error Response Format

​Common Error Codes

​Webhooks

​Webhook Payload

​Webhook Security

​SDK Examples

​Python SDK

​Node.js SDK

​Support

Overview

POST /wiki/generate

Request Example

Response

GET /wiki/projects

Request Example

Response

GET /wiki/

Request Example

Response

DELETE /wiki/

Request Example

Response

POST /wiki/regenerate

Request Example

Response

GET /wiki/status/

Request Example

Response

Authentication

Getting an API Key

Rate Limiting

Error Responses

HTTP Status Codes

Error Response Format

Common Error Codes

Webhooks

Webhook Payload

Webhook Security

SDK Examples

Python SDK

Node.js SDK

Support