API Reference¶

The AIVA API provides programmatic access to the platform's core features. Use it to automate file uploads, run variant calling pipelines, interact with the AI assistant, manage databases, classify variants, export annotations, and integrate with MCP-compatible clients.

Base URL¶

All API endpoints are relative to:

https://api.aivaportal.com

Authentication¶

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: Bearer <AIVA_API_KEY>

See API Keys for instructions on creating and managing API keys.

Endpoint Summary¶

In This Section¶

Error Handling¶

The API uses standard HTTP status codes:

Error responses include a JSON body:

{
  "detail": "Error message describing the issue."
}

Content Types¶

• File upload requests use multipart/form-data.
• JSON body requests use application/json.
• Responses are application/json unless otherwise noted.
• Streaming endpoints use text/event-stream (Server-Sent Events).