Skip to main content
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.
This is a catch-all provider — any valid URL under https://app.hex.tech is supported. Any Hex API endpoint. Construct URL as https://app.hex.tech/api/v1/{path}. See https://learn.hex.tech/docs/api-integrations/api/reference for full reference. The endpoints below are curated examples.

Endpoints

Trigger a project run with optional input parameters

POST https://app.hex.tech/api/v1/projects/{project_id}/runs — Free
const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}/runs', { body: {"inputParams":{}} });

Get the status of a project run

GET https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id} — Free
const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id}', { method: 'GET' });

List projects in the workspace

GET https://app.hex.tech/api/v1/projects — Free
const data = await lava.gateway('https://app.hex.tech/api/v1/projects', { method: 'GET' });

Get project details

GET https://app.hex.tech/api/v1/projects/{project_id} — Free
const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}', { method: 'GET' });

Cancel a running project execution

POST https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id}/cancel — Free
const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id}/cancel', { method: 'POST' });

Replace project configuration

PUT https://app.hex.tech/api/v1/projects/{project_id} — Free
const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}', { method: 'PUT', body: {"name":"Project Name","description":"Full replacement"} });

Update project metadata

PATCH https://app.hex.tech/api/v1/projects/{project_id} — Free
const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}', { method: 'PATCH', body: {"name":"Updated Project Name"} });

Delete a project

DELETE https://app.hex.tech/api/v1/projects/{project_id} — Free
const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}', { method: 'DELETE' });

Next Steps

All Providers

Browse all supported AI providers

Forward Proxy

Learn how to construct proxy URLs and authenticate requests