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

# OpenUI Cloud

OpenUI Cloud by Thesys generates interactive user interfaces and manages conversations and artifacts through OpenAI-compatible APIs.

- **Category:** ai content generation
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `OPENUI`
- **Version:** 00000000_00

## Tools

### Create Conversation

**Slug:** `OPENUI_CREATE_CONVERSATION`

Create a managed OpenUI conversation that can receive persisted turns from Generate UI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Human-readable conversation title. Omit to let OpenUI use its default. |

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

**Slug:** `OPENUI_DELETE_CONVERSATION`

Permanently delete one managed OpenUI conversation by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | Conversation to permanently delete. |

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

### Generate UI

**Slug:** `OPENUI_GENERATE_UI`

Generate an OpenUI response from text or structured Responses API input. Supports standalone generation, stored-response chaining, managed conversations, Cloud-native tools, and caller-owned function tools; function calls returned by the model must be executed by the caller and submitted in a later invocation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | string | Yes | Prompt text or Open Responses input items. Structured items may be messages, function calls, or function-call outputs. |
| `model` | string | Yes | Account-enabled OpenUI model ID. Select it explicitly; free-model requests and responses may be used by the provider to improve its services, so review model terms before sending sensitive data. |
| `store` | boolean | No | Persist this response for later chaining. Must be true when conversation_id is supplied; may remain false with previous_response_id. |
| `tools` | array | No | Open Responses tool definitions, including OpenUI Cloud artifact, web search, image search, remote MCP, or standard function tools. |
| `temperature` | number | No | Sampling temperature from 0 to 2. Lower values are more deterministic; higher values are more varied. |
| `tool_choice` | string | No | Tool selection policy: none disables tools, auto lets the model choose, required forces a tool call, or provide a typed function/MCP choice. |
| `instructions` | string | No | System-level guidance for the generated UI and response behavior. |
| `conversation_id` | string | No | Managed conversation ID to continue. When set, store must be true so the turn is persisted. |
| `reasoning_effort` | string ("none" | "minimal" | "low" | "medium" | "high") | No | Model-dependent reasoning effort from none through high. Unsupported levels may be rejected by the selected model. |
| `max_output_tokens` | integer | No | Upper bound on generated output tokens; use a small value for short responses to control cost. |
| `parallel_tool_calls` | boolean | No | Allow the model to request multiple tool calls in one turn. |
| `previous_response_id` | string | No | Stored response ID to continue without a managed conversation. Cannot be combined with conversation_id; the current response may use store=false. |

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

**Slug:** `OPENUI_GET_ARTIFACT`

Retrieve one persisted OpenUI artifact, including its complete renderable content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `artifact_id` | string | Yes | Artifact to retrieve; obtain an ID from List Artifacts or a generated artifact result. |

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

**Slug:** `OPENUI_LIST_ARTIFACTS`

List persisted OpenUI artifacts, optionally filtering by name or artifact kinds, one cursor-controlled page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Artifact name filter. |
| `kinds` | array | No | Artifact kinds to include: slides, report, or both. Values are sent as repeated kind query parameters. |
| `limit` | integer | No | Maximum artifacts to request in this page. |
| `next_cursor` | string | No | Opaque next_cursor returned by the previous page. Pass it unchanged; omit it for the first 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 Conversation Items

**Slug:** `OPENUI_LIST_CONVERSATION_ITEMS`

Read one cursor-controlled page of persisted messages and function-call items from a managed OpenUI conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to request in this page. |
| `order` | string ("asc" | "desc") | No | Chronological sort order. Use asc to match the official OpenUI Cloud adapter. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page. Pass it back unchanged; omit it for the first page. |
| `conversation_id` | string | Yes | Conversation whose persisted items should be returned. |

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

List managed OpenUI conversations visible to the connected organization, one cursor-controlled page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum conversations to request in this page. |
| `next_cursor` | string | No | Opaque next_cursor returned by the previous page; pass it 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 |

### Rename Conversation

**Slug:** `OPENUI_RENAME_CONVERSATION`

Change the title of an existing managed OpenUI conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | New human-readable conversation title. |
| `conversation_id` | string | Yes | Conversation to rename. |

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