> ## 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.

# Hex

> Data workspace API for running projects, managing notebooks, and embedding analytics.

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](https://learn.hex.tech/docs/api-integrations/api/reference) for full documentation.

<Warning>This provider requires your own credentials — connect your API key or OAuth account before use.</Warning>

<Info>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/\&#123;path\&#125](https://app.hex.tech/api/v1/\&#123;path\&#125);. See [https://learn.hex.tech/docs/api-integrations/api/reference](https://learn.hex.tech/docs/api-integrations/api/reference) for full reference. The endpoints below are curated examples.</Info>

## Endpoints

### Trigger a project run with optional input parameters

**POST** `https://app.hex.tech/api/v1/projects/{project_id}/runs` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}/runs', { body: {"inputParams":{}} });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    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":{}}'
    ```
  </Tab>
</Tabs>

### Get the status of a project run

**GET** `https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id}` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id}', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    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"
    ```
  </Tab>
</Tabs>

### List projects in the workspace

**GET** `https://app.hex.tech/api/v1/projects` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://app.hex.tech/api/v1/projects', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapp.hex.tech%2Fapi%2Fv1%2Fprojects" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### Get project details

**GET** `https://app.hex.tech/api/v1/projects/{project_id}` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    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"
    ```
  </Tab>
</Tabs>

### Cancel a running project execution

**POST** `https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id}/cancel` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}/runs/{run_id}/cancel', { method: 'POST' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    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"
    ```
  </Tab>
</Tabs>

### Replace project configuration

**PUT** `https://app.hex.tech/api/v1/projects/{project_id}` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}', { method: 'PUT', body: {"name":"Project Name","description":"Full replacement"} });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    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"}'
    ```
  </Tab>
</Tabs>

### Update project metadata

**PATCH** `https://app.hex.tech/api/v1/projects/{project_id}` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}', { method: 'PATCH', body: {"name":"Updated Project Name"} });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    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"}'
    ```
  </Tab>
</Tabs>

### Delete a project

**DELETE** `https://app.hex.tech/api/v1/projects/{project_id}` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://app.hex.tech/api/v1/projects/{project_id}', { method: 'DELETE' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    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"
    ```
  </Tab>
</Tabs>

## Next Steps

<CardGroup cols={2}>
  <Card title="All Providers" icon="grid" href="/gateway/supported-providers">
    Browse all supported AI providers
  </Card>

  <Card title="Forward Proxy" icon="route" href="/gateway/forward-proxy">
    Learn how to construct proxy URLs and authenticate requests
  </Card>
</CardGroup>