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

# Charla

Charla is a live chat and AI customer-support platform whose public API manages property contacts, conversation exports, and knowledge base articles and categories.

- **Category:** communication
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `CHARLA`
- **Version:** 00000000_00

## Tools

### Create Knowledge Base Article

**Slug:** `CHARLA_CREATE_KB_ARTICLE`

Create a knowledge base article. Charla generates its URL slug from the title and may use it for chatbot training according to the property's AI settings. Defaults to a private draft.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Article title. Omit only when Charla should store an untitled article. |
| `status` | string ("Draft" | "Published") | No | Initial publication status. Draft is the safer default. |
| `visibility` | string ("Private" | "Public") | No | Initial article visibility. Private is the safer default. |
| `description` | string | No | Short article summary or description. |
| `category_ids` | array | Yes | IDs of existing knowledge base categories to assign. Use List Knowledge Base Categories to discover them. |
| `content_html` | string | No | Article body as HTML. |

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

### Delete Knowledge Base Article

**Slug:** `CHARLA_DELETE_KB_ARTICLE`

Permanently delete one knowledge base article by ID. This cannot be undone, and deleting an already-missing article fails.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | integer | Yes | Numeric ID of the knowledge base article to permanently delete. Deletion cannot be undone. |

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

**Slug:** `CHARLA_GET_CONTACT`

Return one contact in the connected Charla property by UUID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | UUID of the contact 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 Knowledge Base Article

**Slug:** `CHARLA_GET_KB_ARTICLE`

Return the full content and metadata of one knowledge base article by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | integer | Yes | Numeric ID of the knowledge base article 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 |

### List Contacts

**Slug:** `CHARLA_LIST_CONTACTS`

Return one page of contacts for the connected Charla property, ordered by most recently modified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from the previous response. Omit for the first page and pass it back unchanged to fetch the next page. |

#### 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:** `CHARLA_LIST_CONVERSATIONS`

Export one page of conversations grouped by contact for the connected Charla property, including message history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from the previous response; omit for the first page and pass it back unchanged to fetch the next page. |

#### 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 Knowledge Base Articles

**Slug:** `CHARLA_LIST_KB_ARTICLES`

Return one page of knowledge base article summaries for the connected Charla property, newest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from the previous response. Omit for the first page and pass the returned value back unchanged. |

#### 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 Knowledge Base Categories

**Slug:** `CHARLA_LIST_KB_CATEGORIES`

Return all knowledge base categories available in the connected Charla property.

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

### Update Knowledge Base Article

**Slug:** `CHARLA_UPDATE_KB_ARTICLE`

Replace every writable field of an existing knowledge base article. Charla regenerates the URL slug from the replacement title and may retrain chatbot content according to the property's AI settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Complete replacement title for the article. |
| `status` | string ("Draft" | "Published") | Yes | Replacement publication status. |
| `article_id` | integer | Yes | Numeric ID of the existing article to update. |
| `visibility` | string ("Private" | "Public") | Yes | Replacement article visibility. |
| `description` | string | Yes | Complete replacement article summary. Pass an empty string to clear it. |
| `category_ids` | array | Yes | Complete replacement category ID set. Confirm current associations with List Knowledge Base Articles because a single-article read may omit them. |
| `content_html` | string | Yes | Complete replacement article body as HTML. |

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