rag-local
Public
Project Files
test-docs / api-documentation.md
All API requests require authentication using an API key. Include the key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
To obtain an API key, visit the developer portal at https://myproject.dev/keys.
Returns a list of all users in your organization.
Parameters:
page (integer): Page number (default: 1)limit (integer): Items per page (default: 20, max: 100)sort (string): Sort field — "name", "created_at", "email"Response:
Creates a new user.
Request body:
Roles: admin, editor, member, viewer
Deletes a user by ID. Requires admin role.
Returns all projects accessible to the authenticated user.
Parameters:
status (string): Filter by status — "active", "archived", "draft"owner (integer): Filter by owner user IDCreates a new project.
Request body:
Visibility options: public, private, team
| Code | Description |
|---|---|
| 400 | Bad Request — Invalid parameters |
| 401 | Unauthorized — Invalid or missing API key |
| 403 | Forbidden — Insufficient permissions |
| 404 | Not Found — Resource does not exist |
| 429 | Too Many Requests — Rate limit exceeded |
| 500 | Internal Server Error |
Register webhook URLs to receive real-time notifications:
Supported events:
{
"users": [
{ "id": 1, "name": "Alice", "email": "alice@example.com" },
{ "id": 2, "name": "Bob", "email": "bob@example.com" }
],
"total": 42,
"page": 1
}
{
"name": "Charlie",
"email": "charlie@example.com",
"role": "member"
}
{
"name": "My Project",
"description": "A test project",
"visibility": "private"
}
POST /api/v2/webhooks
{
"url": "https://your-server.com/webhook",
"events": ["user.created", "project.updated"]
}