Documentation Index Fetch the complete documentation index at: https://lava.so/docs/llms.txt
Use this file to discover all available pages before exploring further.
Data workspace API for running projects, managing notebooks, and embedding analytics. Best for triggering data pipeline runs, polling execution status, and generating embeddable analytics URLs. Unlike Jupyter (local notebooks), Hex is a collaborative cloud platform with scheduling, SQL cells, and a project-level API.
8 example endpoints available through Lava’s AI Gateway. See the Hex API docs for full documentation.
This provider requires your own credentials — connect your API key or OAuth account before use.
Endpoints POST https://app.hex.tech/api/v1/projects/{project_id}/runs — Freeconst data = await lava . gateway ( 'https://app.hex.tech/api/v1/projects/{project_id}/runs' , { body: { "inputParams" : {}} });
curl -X POST "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapp.hex.tech%2Fapi%2Fv1%2Fprojects%2F%7Bproject_id%7D%2Fruns" \ -H "Authorization: Bearer $LAVA_SECRET_KEY " \ -H "Content-Type: application/json" \ -d '{"inputParams":{}}'
Get the status of a project run GET https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id} — Freeconst data = await lava . gateway ( 'https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id}' , { method: 'GET' });
curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapp.hex.tech%2Fapi%2Fv1%2Fprojects%2F%7Bproject_id%7D%2Fruns%2F%7Brun_id%7D" \ -H "Authorization: Bearer $LAVA_SECRET_KEY "
List projects in the workspace GET https://app.hex.tech/api/v1/projects — Freeconst data = await lava . gateway ( 'https://app.hex.tech/api/v1/projects' , { method: 'GET' });
curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapp.hex.tech%2Fapi%2Fv1%2Fprojects" \ -H "Authorization: Bearer $LAVA_SECRET_KEY "
Get project details GET https://app.hex.tech/api/v1/projects/{project_id} — Freeconst data = await lava . gateway ( 'https://app.hex.tech/api/v1/projects/{project_id}' , { method: 'GET' });
curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapp.hex.tech%2Fapi%2Fv1%2Fprojects%2F%7Bproject_id%7D" \ -H "Authorization: Bearer $LAVA_SECRET_KEY "
Cancel a running project execution POST https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id}/cancel — Freeconst data = await lava . gateway ( 'https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id}/cancel' , { method: 'POST' });
curl -X POST "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapp.hex.tech%2Fapi%2Fv1%2Fprojects%2F%7Bproject_id%7D%2Fruns%2F%7Brun_id%7D%2Fcancel" \ -H "Authorization: Bearer $LAVA_SECRET_KEY " \ -H "Content-Type: application/json"
Replace project configuration PUT https://app.hex.tech/api/v1/projects/{project_id} — Freeconst data = await lava . gateway ( 'https://app.hex.tech/api/v1/projects/{project_id}' , { method: 'PUT' , body: { "name" : "Project Name" , "description" : "Full replacement" } });
curl -X PUT "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapp.hex.tech%2Fapi%2Fv1%2Fprojects%2F%7Bproject_id%7D" \ -H "Authorization: Bearer $LAVA_SECRET_KEY " \ -H "Content-Type: application/json" \ -d '{"name":"Project Name","description":"Full replacement"}'
PATCH https://app.hex.tech/api/v1/projects/{project_id} — Freeconst data = await lava . gateway ( 'https://app.hex.tech/api/v1/projects/{project_id}' , { method: 'PATCH' , body: { "name" : "Updated Project Name" } });
curl -X PATCH "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapp.hex.tech%2Fapi%2Fv1%2Fprojects%2F%7Bproject_id%7D" \ -H "Authorization: Bearer $LAVA_SECRET_KEY " \ -H "Content-Type: application/json" \ -d '{"name":"Updated Project Name"}'
Delete a project DELETE https://app.hex.tech/api/v1/projects/{project_id} — Freeconst data = await lava . gateway ( 'https://app.hex.tech/api/v1/projects/{project_id}' , { method: 'DELETE' });
curl -X DELETE "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapp.hex.tech%2Fapi%2Fv1%2Fprojects%2F%7Bproject_id%7D" \ -H "Authorization: Bearer $LAVA_SECRET_KEY " \ -H "Content-Type: application/json"
Next Steps
All Providers Browse all supported AI providers
Forward Proxy Learn how to construct proxy URLs and authenticate requests
