Projects API
List and manage annotation projects.
List Projects
GET /api/v1/projects/{owner_name}/Returns projects belonging to an owner that are visible to the current user.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
owner_name | string | Username of the project owner |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Filter by project name |
ordering | string | Field to order results by |
cursor | string | Pagination cursor |
limit | integer | Results per page |
Example
cURL
curl "https://server.avala.ai/api/v1/projects/johndoe/" \
-H "X-Avala-Api-Key: $AVALA_API_KEY"Response
{
"next": null,
"previous": null,
"results": [
{
"uid": "proj-uuid-001",
"name": "Object Detection",
"task_type": "image-annotation",
"status": "active",
"is_active": true,
"visibility": "private",
"is_imported": false,
"owner_name": "johndoe",
"short_description": "Detect vehicles and pedestrians",
"industry_icon": "automotive"
}
]
}Project Fields
| Field | Type | Description |
|---|---|---|
uid | UUID | Unique identifier |
name | string | Project name (1-100 chars) |
task_type | string | Type of annotation task |
status | string | Current project status |
is_active | boolean | Whether project is active |
visibility | string | public or private |
is_imported | boolean | Whether project was imported |
owner_name | string | Owner’s username |
short_description | string | Brief description |
industry_icon | string | Industry category icon |
Task Types
| Type | Description |
|---|---|
image-annotation | 2D image annotation (boxes, polygons, segmentation) |
video-annotation | Video frame-by-frame annotation |
point-cloud-annotation | 3D point cloud annotation with cuboids |
point-cloud-objects | 3D object detection in point clouds |
Project Statuses
| Status | Description |
|---|---|
pending-approval | Awaiting approval to start |
active | Currently active and accepting annotations |
paused | Temporarily paused |
canceled | Canceled and no longer active |
archived | Archived for historical reference |
completed | All tasks completed |
Error Responses
Not Found
{
"detail": "Not found."
}HTTP Status: 404
Permission Denied
{
"detail": "You do not have permission to perform this action."
}HTTP Status: 403
Last updated on