Overview

The AIPREP API lets you generate AI-powered educational videos programmatically. Submit a text query, track generation progress via polling or real-time SSE, and retrieve the final video URL.

Base URL

https://api.aiprep.in/api/v1

All API requests must be made over HTTPS.

Authentication

Authenticate using your API key in the X-API-Key header:

curl -H "X-API-Key: your-api-key" \
  https://api.aiprep.in/api/v1/generate

Keep your API key secure. Do not expose it in client-side code or commit it to version control. All requests should be made from your server.

Rate Limits

API key requests are subject to the following default limits:

• Per minute — 10 requests
• Per hour — 100 requests
• Per day — 300 requests

When you exceed the rate limit, the API returns a 429 Too Many Requests response.

Integration Flow

1. POST /generate           → Get job_id (instant, ~300ms)
2. GET /jobs/{job_id}/stream → Subscribe to real-time SSE updates
   — or —
   GET /jobs/{job_id}        → Poll for job status
3. Use video_url from completed job

Error Handling

All errors follow a consistent format:

{
  "detail": "Error message describing what went wrong"
}

Validation errors return an array of issues:

{
  "detail": [
    {
      "loc": ["body", "query"],
      "msg": "String should have at least 5 characters",
      "type": "string_too_short"
    }
  ]
}

Common HTTP Status Codes

• 200 — Success
• 401 — Missing or invalid API key
• 404 — Job or resource not found
• 422 — Validation error (bad request body)
• 429 — Rate limit exceeded
• 500 — Internal server error

Endpoints

• Generate Video — POST /generate
• Job Status — GET /jobs/{job_id}
• Stream Updates (SSE) — GET /jobs/{job_id}/stream
• Stop Job — POST /jobs/{job_id}/stop