# Hume AI Integration via LowCodeAPI

**Last Updated**: February 10, 2026

## Overview
Empathic AI platform for emotion recognition and understanding human emotional expression

**Categories:**
- {'id': 'emotion-ai', 'name': 'Emotion AI'}

## Base Endpoint
https://api.lowcodeapi.com/humeai

**Important**: Always include the provider name in the URL path after `api.lowcodeapi.com/`

## Authentication
**Type:** 

**Official Documentation:** https://dev.hume.ai/reference/empathic-voice-interface-evi/tools/list-tools

## URL Format (Important)

LowCodeAPI supports two URL formats. **Always try the New Format first**, then fall back to Old Format if needed.

### New Format (Priority)
- Path parameters stay in the URL path
- Do NOT include path parameters as query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/{id}?api_token=XXX`

### Old Format (Fallback)
- Path parameters become query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/id?id={id}&api_token=XXX`

### Decision Flow for AI Agents
1. Always use **New Format** first - keep path parameters in the URL path
2. If you get a 404 or error, try **Old Format** with sanitized path
3. Log which format worked for future requests to this provider

## API Categories

## Common Endpoints

### Chat

**Method:** GET
**LowCodeAPI Path:** /v0/batch/jobs

**New Format URL:**
https://api.lowcodeapi.com/humeai/v0/batch/jobs?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/humeai/v0/batch/jobs?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| access_token | string |  |
| api_key | string |  |
| config_id | string |  |
| config_version | number |  |
| resumed_chat_group_id | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/humeai/v0/batch/jobs?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://dev.hume.ai/reference/empathic-voice-interface-evi/chat/chat

### Start inference job

**Method:** POST
**LowCodeAPI Path:** /v0/batch/jobs

**New Format URL:**
https://api.lowcodeapi.com/humeai/v0/batch/jobs?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/humeai/v0/batch/jobs?api_token=YOUR_API_TOKEN

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| type | enum |  |
| direction | enum |  |
| limit | number |  |
| sort_by | enum |  |
| status | enum |  |
| timestamp_ms | number |  |
| when | enum |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/humeai/v0/batch/jobs?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://dev.hume.ai/reference/expression-measurement-api/batch/start-inference-job

### Get job details

**Method:** GET
**LowCodeAPI Path:** /v0/batch/jobs/:id

**New Format URL:**
https://api.lowcodeapi.com/humeai/v0/batch/jobs/:id?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/humeai/v0/batch/jobs/id?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/humeai/v0/batch/jobs/:id?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://dev.hume.ai/reference/expression-measurement-api/batch/get-job-details

### Get job predictions

**Method:** GET
**LowCodeAPI Path:** /v0/batch/jobs/:id/predictions

**New Format URL:**
https://api.lowcodeapi.com/humeai/v0/batch/jobs/:id/predictions?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/humeai/v0/batch/jobs/id/predictions?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/humeai/v0/batch/jobs/:id/predictions?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://dev.hume.ai/reference/expression-measurement-api/batch/get-job-predictions

### Get job artifacts

**Method:** GET
**LowCodeAPI Path:** /v0/batch/jobs/:id/artifacts

**New Format URL:**
https://api.lowcodeapi.com/humeai/v0/batch/jobs/:id/artifacts?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/humeai/v0/batch/jobs/id/artifacts?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/humeai/v0/batch/jobs/:id/artifacts?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://dev.hume.ai/reference/expression-measurement-api/batch/get-job-artifacts

### List chat_groups

**Method:** GET
**LowCodeAPI Path:** /v0/evi/chat_groups

**New Format URL:**
https://api.lowcodeapi.com/humeai/v0/evi/chat_groups?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/humeai/v0/evi/chat_groups?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| ascending_order | boolean |  |
| page_number | number |  |
| page_size | number |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/humeai/v0/evi/chat_groups?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://dev.hume.ai/reference/empathic-voice-interface-evi/chat-groups/list-chat-groups

### List chat events from a specific chat_group

**Method:** GET
**LowCodeAPI Path:** /v0/evi/chat_groups/:id/events

**New Format URL:**
https://api.lowcodeapi.com/humeai/v0/evi/chat_groups/:id/events?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/humeai/v0/evi/chat_groups/id/events?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| ascending_order | boolean |  |
| page_number | number |  |
| page_size | number |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/humeai/v0/evi/chat_groups/:id/events?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://dev.hume.ai/reference/empathic-voice-interface-evi/chat-groups/list-chat-group-events

### List chats

**Method:** GET
**LowCodeAPI Path:** /v0/evi/chats

**New Format URL:**
https://api.lowcodeapi.com/humeai/v0/evi/chats?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/humeai/v0/evi/chats?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| ascending_order | boolean |  |
| page_number | number |  |
| page_size | number |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/humeai/v0/evi/chats?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://dev.hume.ai/reference/empathic-voice-interface-evi/chats/list-chats

### List chat events

**Method:** GET
**LowCodeAPI Path:** /v0/evi/chats/:id

**New Format URL:**
https://api.lowcodeapi.com/humeai/v0/evi/chats/:id?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/humeai/v0/evi/chats/id?id={id}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| id | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| ascending_order | boolean |  |
| page_number | number |  |
| page_size | number |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/humeai/v0/evi/chats/:id?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://dev.hume.ai/reference/empathic-voice-interface-evi/chats/list-chat-events

### List configs

**Method:** GET
**LowCodeAPI Path:** /v0/evi/configs

**New Format URL:**
https://api.lowcodeapi.com/humeai/v0/evi/configs?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/humeai/v0/evi/configs?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| page_number | number |  |
| page_size | number |  |
| restrict_to_most_recent | boolean |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/humeai/v0/evi/configs?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://dev.hume.ai/reference/empathic-voice-interface-evi/configs/list-configs


## Usage Examples

### Example 1: Basic API Request (New Format)

Making a simple GET request to retrieve resources:

```bash
# Get a list of resources - no path parameters needed
curl -X GET "https://api.lowcodeapi.com/humeai/endpoint?api_token=YOUR_API_TOKEN"
```

### Example 2: Request with Path Parameters (New Format)

Retrieving a specific resource using its ID:

```bash
# Get specific resource by ID - replace RESOURCE_ID with actual ID from previous response
curl -X GET "https://api.lowcodeapi.com/humeai/endpoint/{RESOURCE_ID}?api_token=YOUR_API_TOKEN"
# Note: RESOURCE_ID typically comes from a previous list request or from the provider dashboard
```

### Example 3: POST Request with Body (New Format)

Creating a new resource:

```bash
# Create a new resource
curl -X POST "https://api.lowcodeapi.com/humeai/endpoint?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"field": "value", "another_field": "another_value"}'
```

## Error Handling

LowCodeAPI returns standard HTTP status codes. Common errors:

| Status Code | Description |
|-------------|-------------|
| 200 | Success - Request completed successfully |
| 400 | Bad Request - Invalid parameters or request body |
| 401 | Unauthorized - Invalid or missing API token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Endpoint or resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Server Error - Provider API error |

All error responses include error details:

```json
{
  "data": {
    "error": {
      "message": "Error description",
      "code": "ERROR_CODE"
    }
  }
}
```

## Complete Endpoint Reference

| Endpoint | Method | Category |
|----------|--------|----------|
| Chat | GET | Chat |
| Start inference job | POST | Batch |
| Get job details | GET | Batch |
| Get job predictions | GET | Batch |
| Get job artifacts | GET | Batch |
| List chat_groups | GET | Chat Groups |
| List chat events from a specific chat_group | GET | Chat Groups |
| List chats | GET | Chats |
| List chat events | GET | Chats |
| List configs | GET | Configs |
| Create config | POST | Configs |
| List config versions | GET | Configs |
| Create config version | POST | Configs |
| Delete config | DELETE | Configs |
| Update config name | PATCH | Configs |
| Get config version | GET | Configs |
| Delete config version | DELETE | Configs |
| Update config description | PATCH | Configs |
| List datasets | GET | Datasets |
| Create dataset | POST | Datasets |
| Get dataset | GET | Datasets |
| Create dataset version | POST | Datasets |
| Delete dataset | DELETE | Datasets |
| List dataset versions | GET | Datasets |
| List dataset files | GET | Datasets |
| Get dataset version | GET | Datasets |
| List dataset version files | GET | Datasets |
| List files | GET | Files |
| Create files | POST | Files |
| Upload file | POST | Files |
| Get file | GET | Files |
| Delete file | DELETE | Files |
| Update file name | PATCH | Files |
| Get file predictions | GET | Files |
| Start training job | POST | Jobs |
| Start custom models inference job | POST | Jobs |
| List models | GET | Models |
| Get model details | GET | Models |
| Update model name | PATCH | Models |
| List model versions | GET | Models |
| Get model version | GET | Models |
| Update model description | PATCH | Models |
| Get User Privacy Settings | GET | Privacy |
| Patch User Privacy Settings | PATCH | Privacy |
| Delete User Data | DELETE | Privacy |
| List prompts | GET | Prompts |
| Create prompt | POST | Prompts |
| List prompt versions | GET | Prompts |
| Create prompt version | POST | Prompts |
| Delete prompt | DELETE | Prompts |
| Update prompt name | PATCH | Prompts |
| Get prompt version | GET | Prompts |
| Delete prompt version | DELETE | Prompts |
| Update prompt description | PATCH | Prompts |
| List tools | GET | Tools |
| Create tool | POST | Tools |
| List tool versions | GET | Tools |
| Create tool version | POST | Tools |
| Delete tool | DELETE | Tools |
| Update tool name | PATCH | Tools |
| Get tool version | GET | Tools |
| Delete tool version | DELETE | Tools |
| Update tool description | PATCH | Tools |

## API Definition Endpoints

You can fetch the complete API specification for this provider:

**New Format (OpenAPI spec):**
```bash
curl 'https://backend.lowcodeapi.com/humeai/openapi'
```

**Old Format (API definition):**
```bash
curl 'https://backend.lowcodeapi.com/humeai/definition'
```

## Response Format

All responses are wrapped in a `data` key:

```json
{
  "data": {
    // Actual response from provider (object or array)
  }
}
```