---
canonical_url: "https://docs.composio.dev/toolkits/mihu_ai"
markdown_url: "https://docs.composio.dev/toolkits/mihu_ai.md"
product: "platform"
version: null
last_updated: null
---

# Mihu AI

Mihu AI provides workspace APIs for building and operating AI agents across voice, messaging, customer engagement, automation, and analytics.

- **Category:** ai agents
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `MIHU_AI`
- **Version:** 00000000_00

## Tools

### Get Call Analytics

**Slug:** `MIHU_AI_GET_CALL_ANALYTICS`

Return authoritative aggregate call counts, duration, outcomes, handling, and cost for a required half-open time window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string | No | Comma-separated call channel tokens, such as call,whatsapp_call. |
| `end_time` | string | Yes | Exclusive ISO-8601 end timestamp with a UTC offset. |
| `agent_uuid` | string | No | Restrict metrics to this agent UUID. |
| `start_time` | string | Yes | Inclusive ISO-8601 start timestamp with a UTC offset. |
| `granularity` | string | No | Aggregation granularity; Mihu AI currently supports only total. |
| `compare_prev` | boolean | No | Include metrics for the immediately preceding window of equal length. |
| `campaign_uuid` | string | No | Restrict metrics to this campaign UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Task

**Slug:** `MIHU_AI_GET_TASK`

Retrieve one existing asynchronous task when its UUID is already known from another Mihu AI response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uuid` | string | Yes | UUID of the task to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace

**Slug:** `MIHU_AI_GET_WORKSPACE`

Return the connected Mihu AI workspace identity, locale, timezone, and wallet balance.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Agents

**Slug:** `MIHU_AI_LIST_AGENTS`

List workspace agents, optionally filtered by lifecycle status or searched by text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum agents to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `search` | string | No | Search agents using provider text matching. |
| `status` | string ("pending" | "ready" | "in_progress" | "paused" | "completed") | No | Return only agents in this lifecycle status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Appointments

**Slug:** `MIHU_AI_LIST_APPOINTMENTS`

List appointments filtered by schedule, contact, status, or date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("approved" | "pending" | "rejected" | "cancelled") | No | Return appointments with this status. |
| `end_date` | string | No | Include appointments on or before this YYYY-MM-DD date. |
| `start_date` | string | No | Include appointments on or after this YYYY-MM-DD date. |
| `contact_uuid` | string | No | Return appointments for this contact UUID. |
| `schedule_uuid` | string | No | Return appointments for this schedule UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Calls

**Slug:** `MIHU_AI_LIST_CALLS`

List calls filtered by agent, call status, or inbound/outbound/web direction.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum calls to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `status` | string ("in-progress" | "ended" | "missed" | "failed") | No | Return calls with this status. |
| `direction` | string ("Inbound" | "Outbound" | "webCall") | No | Return calls with this direction. |
| `agent_uuid` | string | No | Return calls handled by this agent UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Campaigns

**Slug:** `MIHU_AI_LIST_CAMPAIGNS`

List one page of campaigns, optionally searched by name or description and filtered by lifecycle status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum campaigns to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `search` | string | No | Search campaign name or description. |
| `status` | string ("Active" | "Draft" | "Completed" | "Archived") | No | Return campaigns with this lifecycle status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `MIHU_AI_LIST_CONTACTS`

Search and filter workspace contacts by identity, status, channel, pipeline, campaign, tag, pool, or creation date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum contacts to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `search` | string | No | Search contact name, email, or phone number. |
| `status` | string ("Active" | "Inactive") | No | Return contacts with this status. |
| `date_to` | string | No | Include contacts created on or before this YYYY-MM-DD date. |
| `tag_uuid` | string | No | Return contacts carrying this tag UUID. |
| `date_from` | string | No | Include contacts created on or after this YYYY-MM-DD date. |
| `pool_uuid` | string | No | Return contacts in this pool UUID. |
| `stage_uuid` | string | No | Return contacts currently in this pipeline stage UUID. |
| `campaign_uuid` | string | No | Return contacts whose pool is attached to this campaign UUID. |
| `contact_channel` | string ("Call" | "SMS" | "WhatsApp") | No | Return contacts whose preferred contact channel matches this value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Conversations

**Slug:** `MIHU_AI_LIST_CONVERSATIONS`

Find conversations by contact, exact or partial phone, agent, campaign, task, channel, status, or label. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | Return conversations with this label UUID; the label named Open also includes unlabeled conversations. |
| `limit` | integer | No | Maximum conversations to return in this page (1-100). |
| `phone` | string | No | Partially match a contact phone number. |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `status` | string ("Active" | "Closed") | No | Return conversations with this status. |
| `channel` | string | No | Return conversations on this provider channel name, such as whatsapp, sms, or call. |
| `sort_by` | string ("timestamp" | "created_at" | "updated_at") | No | Field used to sort results; timestamp means last activity. |
| `sort_dir` | string ("asc" | "desc") | No | Sort direction. |
| `task_uuid` | string | No | Return conversations linked through a call to this task UUID. |
| `agent_uuid` | string | No | Return conversations handled by this agent UUID. |
| `contact_uuid` | string | No | Return conversations for this contact UUID. |
| `phone_number` | string | No | Exactly match a contact number digit-by-digit; formatting and a leading plus sign are ignored. |
| `campaign_uuid` | string | No | Return conversations linked through a call to this campaign UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sessions

**Slug:** `MIHU_AI_LIST_SESSIONS`

List one page of conversation sessions filtered by conversation, contact, agent, campaign, task, status, or text/voice type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("text" | "voice") | No | Return text or voice sessions. |
| `limit` | integer | No | Maximum sessions to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `status` | string ("active" | "completed" | "timed_out") | No | Return sessions with this status. |
| `sort_by` | string ("created_at" | "updated_at" | "started_at" | "last_activity_at") | No | Field used to sort sessions. |
| `sort_dir` | string ("asc" | "desc") | No | Sort direction. |
| `task_uuid` | string | No | Return sessions linked through a call to this task UUID. |
| `agent_uuid` | string | No | Return sessions handled by this agent UUID. |
| `contact_uuid` | string | No | Return sessions for this contact UUID. |
| `campaign_uuid` | string | No | Return sessions linked through a call to this campaign UUID. |
| `conversation_uuid` | string | No | Return sessions in this conversation UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |