Documentation Index
Fetch the complete documentation index at: https://docs.shipfastai.dev/llms.txt
Use this file to discover all available pages before exploring further.
The Shipfastai REST API gives you programmatic access to authentication, user management, billing, AI chat, retrieval-augmented generation (RAG), product checkout and download, API key management, and admin features. Every feature exposed in the product is backed by an HTTP endpoint, so you can integrate it into your own frontend or automate workflows from any HTTP client.
Endpoint groups
| Group | Prefix | Description |
|---|
| Auth | /api/auth/ | Registration, login, token refresh, email verification, password reset, OAuth |
| Users | /api/users/ | Profile management, password and email changes, data export, account deletion |
| Billing | /api/billing/ | Stripe subscription checkout, customer portal, subscription status, plan listing, webhooks |
| Checkout & Download | /api/checkout, /api/download | One-time product purchases and encrypted ZIP downloads |
| AI Chat | /api/ai/ | Multi-turn chat and single-prompt completions via OpenAI, Anthropic, or Gemini |
| RAG | /api/rag/ | Document ingestion, semantic search, and retrieval-augmented generation queries |
| API Keys | /api/api-keys/ | Create, list, revoke, and update API keys for programmatic access |
| Contact | /api/contact | Contact form submission with email notifications |
| Admin | /api/admin/ | Platform statistics and user management (superuser only) |
Base URL
| Environment | Base URL |
|---|
| Development | http://localhost:8000 |
| Production | https://<your-deployed-backend-url> |
/api/. For example, the login endpoint is available at http://localhost:8000/api/auth/login.
Interactive docs
When running in development mode, the API server exposes two auto-generated documentation UIs:
- Swagger UI —
http://localhost:8000/docs
- ReDoc —
http://localhost:8000/redoc
Both UIs are generated directly from the live OpenAPI schema and let you make real requests against your local server.
The interactive docs are disabled in production by default (DEBUG=false). To enable them in a deployed environment, set DEBUG=true — but avoid doing this on public-facing production instances.
Authentication
All protected endpoints require a Bearer token in the Authorization header. You obtain a token by calling POST /api/auth/login.
Authorization: Bearer <access_token>
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"email": "user@example.com",
"full_name": "Jane Smith",
"is_verified": true,
"created_at": "2024-01-15T10:30:00Z"
}
Rate limiting
The API applies rate limiting to protect backend resources. The default limits are:
| Scope | Limit |
|---|
| General endpoints | 100 requests per 60 seconds |
AI endpoints (/api/ai/*, /api/rag/*) | Stricter limits configured separately via ai_rate_limit |
429 Too Many Requests. You can configure the thresholds in your backend settings.
Error responses
The API uses standard HTTP status codes. All error bodies follow the same shape:
{
"detail": "error message"
}
| Status | Meaning |
|---|
400 | Bad request — invalid input or missing required field |
401 | Unauthorized — missing or invalid token |
403 | Forbidden — account inactive or insufficient permissions |
404 | Not found — resource does not exist |
422 | Unprocessable entity — request body failed validation |
429 | Too many requests — rate limit exceeded |
500 | Internal server error — unexpected backend error |
Example error response
{
"detail": "Incorrect email or password"
}
{
"detail": [
{
"loc": ["body", "email"],
"msg": "value is not a valid email address",
"type": "value_error.email"
}
]
}