API Overview

The Avala API provides programmatic access to datasets, projects, and exports.

Base URL


https://server.avala.ai/api/v1

Authentication

All API requests require authentication via API key in the header:


curl https://server.avala.ai/api/v1/datasets/johndoe/list/ \
  -H "X-Avala-Api-Key: YOUR_API_KEY"

Generate API keys in Mission Control under Settings → Security & Identity.

See Authentication for details.

Available Endpoints

Datasets

Endpoint	Method	Description
`/datasets/{owner}/list/`	GET	List datasets for an owner
`/datasets/{owner}/{slug}/sequences/`	GET	List sequences in a dataset

Projects

Endpoint	Method	Description
`/projects/{owner}/`	GET	List projects for an owner

Exports

Endpoint	Method	Description
`/exports/`	GET	List all exports
`/exports/`	POST	Create a new export

Response Format

All responses are JSON:


{
  "next": "https://server.avala.ai/api/v1/datasets/johndoe/list/?page=2",
  "previous": null,
  "results": [
    {
      "uid": "550e8400-e29b-41d4-a716-446655440000",
      "name": "My Dataset"
    }
  ]
}

For paginated endpoints, use the next URL to fetch additional results.

Error Responses

Authentication Error


{
  "detail": "Invalid API key."
}

HTTP Status: 401 Unauthorized

Permission Error


{
  "detail": "You do not have permission to perform this action."
}

HTTP Status: 403 Forbidden

Not Found


{
  "detail": "Not found."
}

HTTP Status: 404 Not Found

Validation Error


{
  "field_name": ["Error message for this field."]
}

HTTP Status: 400 Bad Request

Interactive API Docs

Explore the API interactively at:


https://server.avala.ai/docs/api/

This provides a Swagger/OpenAPI interface to test endpoints directly.