API Documentation

Learn how to use the AI Documentation Generator API.

API Reference
Use our API to programmatically generate documentation for your code.

Base URL

https://api.aidocs.example.com/v1

Authentication

Include your API key in the x-api-key header with all requests.

x-api-key: aidocs_your_api_key

List Documentations

Retrieve a list of your documentations.

Request

GET /documentation
x-api-key: aidocs_your_api_key

Query Parameters

  • limit - Number of results to return (default: 10)
  • offset - Offset for pagination (default: 0)

Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "My Project",
      "description": "Project description",
      "type": "readme",
      "language": "javascript",
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-02T00:00:00Z"
    }
  ],
  "meta": {
    "total": 42,
    "limit": 10,
    "offset": 0
  }
}