Documentation
The Avaloka API
52 endpoints across ingestion, conversation, analysis, models and integrations. Every call is made against https://app.avaloka.ai with a bearer token from your workspace.
System
Lightweight probes for uptime checks, deploy verification and identity debugging.
- GET
/healthService health probe. - GET
/versionCurrently deployed API version. - GET
/debug/whoamiIdentity and claims for the calling credentials.
Ingestion & storage
Bring data in by uploading files or registering storage you already own.
- POST
/api/uploadUpload one or more CSV files as datasets. - POST
/api/register-existing-storageRegister an existing storage location. - POST
/api/register-existing-folderRegister an existing folder of files. - GET
/buckets/listList objects in a connected bucket.
Threads & conversations
Conversational sessions: create a thread, send messages, read history and inspect the planner.
- POST
/threadsCreate a new thread. - GET
/threadsList threads. - DELETE
/threads/{thread_id}Delete a thread. - POST
/threads/{thread_id}/messagesSend a message to a thread. - GET
/threads/{thread_id}/messagesFetch a thread's message history. - GET
/threads/{thread_id}/pending-turnCheck whether a turn is still in progress. - GET
/threads/{thread_id}/planner-graphRender the planner graph for a thread. - GET
/threads/{thread_id}/codeGet the generated code string for a thread.
Missions & tasks
Plan work from an intent, then track, inspect and cancel the resulting runs.
- POST
/api/missions/planPlan a mission from an intent payload. - GET
/tasksList tasks. - GET
/tasks/{task_id}/infoTask metadata. - GET
/tasks/{task_id}/statusCurrent task status. - GET
/tasks/{task_id}/runsRun history for a task. - GET
/tasks/{task_id}/result/{index}Fetch a specific task result. - DELETE
/tasks/{task_id}Cancel a running task.
Datasets
Inspect, preview and manage the datasets available in your workspace.
- GET
/datasetsList datasets. - GET
/datasets/{dataset_id}Dataset details and schema. - GET
/datasets/{dataset_id}/previewPreview dataset rows. - DELETE
/datasets/{dataset_id}Delete a dataset. - GET
/api/datasets/{dataset_id}/background-task-statusStatus of background processing for a dataset.
Databases
Connect live databases and run governed, sampled queries against them.
- POST
/api/database/connectConnect a database. - POST
/api/database/tables-to-analysisTurn selected tables into an analysis. - POST
/api/v1/database/queryChat-driven sample query over a connected database.
Models & inference
Manage trained models and the inference services that serve them.
- GET
/api/modelsList models. - GET
/api/models/{run_id}Model details for a run. - POST
/api/models/{run_id}/inferenceRun inference against a model. - POST
/api/models/{run_id}/configure-inference-serviceConfigure a hosted inference service. - POST
/api/models/{run_id}/stop-inference-serviceStop a hosted inference service. - DELETE
/api/models/{run_id}Delete a model.
Session assets
Retrieve the code, outputs and job definitions produced during a session.
- GET
/api/assets/{session_id}List assets for a session. - GET
/api/assets/{session_id}/codeSigned URL for the generated code. - GET
/api/assets/{session_id}/outputSigned URL for the run output. - GET
/api/assets/{session_id}/jobJob definition for the session.
Analysis lifecycle
Version, refresh, review and re-run analyses as your data and questions change.
- GET
/analysis/{analysis_id}/codeCode behind an analysis. - POST
/analysis/{analysis_id}/feedbackSubmit feedback on an analysis. - POST
/analysis/{analysis_id}/refreshRefresh an analysis. - GET
/analysis/{analysis_id}/versionsList analysis versions. - POST
/analysis/{analysis_id}/restoreRestore a previous version. - POST
/analysis/{analysis_id}/save-and-executeSave edits and execute the analysis.
Integrations & connections
Connect external tools and manage encrypted connection credentials.
- GET
/api/integrationsList connected integrations. - POST
/api/integrations/github/connectConnect GitHub. - PATCH
/api/integrations/githubUpdate the GitHub connection. - DELETE
/api/integrations/githubDisconnect GitHub. - POST
/api/mcp-connections/{connection_id}/encryptEncrypt MCP connection credentials. - POST
/api/mcp-connections/{connection_id}/decryptDecrypt MCP connection credentials.
Authentication
Send your workspace token on every request. Verify your credentials with GET /debug/whoami before wiring anything else.
curl https://app.avaloka.ai/debug/whoami \ -H "Authorization: Bearer $AVALOKA_TOKEN"