# Studio By Ai21 Labs

AI21 Studio provides API access to Jurassic-1 large-language-models. Our models power text generation and comprehension features in thousands of live applications.

- **Category:** ai models
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 57
- **Triggers:** 0
- **Slug:** `STUDIO_BY_AI21_LABS`
- **Version:** 00000000_00

## Tools

### Check Can Iframe

**Slug:** `STUDIO_BY_AI21_LABS_CHECK_CAN_IFRAME`

Tool to check if a URL can be embedded in an iframe. Use when you need to verify iframe compatibility before embedding external content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL to check for iframe compatibility |

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

### Compare Text

**Slug:** `STUDIO_BY_AI21_LABS_COMPARE_TEXT`

Tool to compare two text strings and identify differences. Use when you need to analyze changes between an original text and its modified version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `modified_text` | string | Yes | The modified text to compare with the original |
| `original_text` | string | Yes | The original text to compare against |

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

### Create Aftersales Parts Classification Batch

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_AFTERSALES_PARTS_BATCH`

Tool to create a batch job for Fnac Aftersales parts classification. Use when you need to classify multiple aftersales cases to determine which parts are needed for repairs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cases` | array | Yes | Array of aftersales cases for parts classification. The array cannot be empty. |

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

### Create Assistant Route

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_ASSISTANT_ROUTE`

Tool to create a new route for an AI21 Studio assistant. Use when you need to define a new conversational path or query pattern for an assistant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the route. |
| `plan_id` | string | Yes | The unique identifier of the plan to associate with this route. |
| `examples` | array | Yes | A list of example queries or scenarios for this route. |
| `description` | string | Yes | A description of the route's purpose. |
| `assistant_id` | string | Yes | The unique identifier of the assistant to create a route for. |

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

### Create Assistant

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_ASSISTANTS`

Tool to create a new AI assistant in AI21 Studio. Use when you need to set up a new assistant with custom configuration, tools, and behavior.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the assistant to create |
| `tools` | array | No | List of tool definitions (HTTP, MCP, file search, or web search tools) available to the assistant |
| `avatar` | string | No | Avatar image URL or identifier for the assistant |
| `budget` | string | No | Budget level for the assistant. Defaults to 'medium' |
| `models` | array | No | List of model identifiers the assistant can use |
| `description` | string | No | Description of the assistant's purpose and capabilities |
| `optimization` | string | No | Optimization strategy for the assistant |
| `requirements` | array | No | List of requirements for the assistant |
| `system_prompt` | string | No | System prompt that defines the assistant's behavior and personality |
| `assistant_type` | string | No | Type of the assistant. Defaults to 'default' |
| `workflow_config` | object | No | Configuration for workflow integration. |
| `config_overrides` | object | No | Configuration overrides for the assistant |
| `starter_questions` | array | No | List of starter questions to help users interact with the assistant |

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

### Create Assistant Plan

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_ASSISTANTS_ASSISTANT_ID_PLANS`

Tool to create a new plan for an AI21 Studio assistant. Use when you need to add a new plan with Python code to an assistant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The Python code for the plan to be created. |
| `schemas` | array | No | Optional array of schema objects associated with the plan. |
| `assistant_id` | string | Yes | The unique identifier of the assistant to create a plan for. |

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

### Create Demo

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_DEMO`

Tool to create a new demo in AI21 Studio. Use when you need to set up a new demo with specified visibility and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the demo to create. |
| `config` | object | No | Demo configuration as a JSON object. Optional configuration settings for the demo. |
| `status` | string ("active" | "inactive") | Yes | Status of the demo (active or inactive). |
| `visibility` | string ("public" | "private") | Yes | Visibility level of the demo (public or private). |
| `ui_component_name` | string | Yes | Name of the UI component associated with this demo. |

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

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_GENERATION_REQUIREMENTS`

Tool to generate requirements from a query or task description. Use when you need to break down a high-level task into specific requirements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | The query or task description to generate requirements from. For example, 'Build a task management system' or 'Create a user authentication system'. |

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

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_GENERATION_THREAD_NAME`

Tool to generate a thread name from a query or conversation context. Use when you need to create a descriptive title for a conversation thread.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | The query or conversation context to generate a thread name from. For example, 'What is the weather like today?' or 'How do I implement authentication?'. |

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

### Create Kirsh Grant Compliance Preview

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_KIRSH_GRANT_COMPLIANCE_PREVIEW`

Tool to preview grant compliance for Kirsh grants. Use when you need to check compliance status for specific grant IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `grant_ids` | array | Yes | List of grant IDs (as integers) to check for compliance |

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

### Kirsh Grant Metadata Preview

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_KIRSH_GRANT_PREVIEW`

Tool to retrieve grant metadata from the Kirsh preview endpoint. Use when you need to fetch grant information including grant name and associated organization details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `grant_id` | integer | Yes | The unique identifier for the grant to retrieve metadata |

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

### Create MCP Storage

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_MCP_STORAGE`

Tool to create MCP (Model Context Protocol) storage in AI21 Studio. Use when you need to register and configure an MCP server connection for your workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `auth_value` | string | No | Authentication value (API token or header value, required if authentication_type is not 'none') |
| `server_url` | string | Yes | URL of the MCP server to connect to |
| `server_label` | string | Yes | Human-readable label for the MCP server |
| `workspace_id` | string | No | UUID of the workspace to associate with this MCP storage |
| `allowed_tools` | array | No | List of tool names allowed for this MCP storage. If not specified, all tools are allowed |
| `auth_header_name` | string | No | Name of the authentication header (required if authentication_type is 'custom-header') |
| `authentication_type` | string ("none" | "token-api" | "custom-header") | No | Authentication type for MCP server. |

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

### Create Secret

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_SECRET`

Tool to save a secret in AI21 Studio. Use when you need to securely store sensitive information like API keys or passwords.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secret_name` | string | Yes | The identifier for the secret. This name will be used to reference the secret later. |
| `secret_value` | string | Yes | The confidential data to be stored securely. This is the actual secret value that will be encrypted and saved. |

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

### Check Kirsh Grant Compliance

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_SOLUTIONS_KIRSH_GRANT_COMPLIANCE`

Tool to check compliance for Kirsh grant IDs. Use when you need to verify compliance status for one or more grants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `grant_ids` | array | Yes | Array of grant IDs to check for compliance. Each ID must be a valid integer. |

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

### Create Website Connector

**Slug:** `STUDIO_BY_AI21_LABS_CREATE_WEBSITE_CONNECTOR`

Tool to create a website connector in AI21 Studio. Use when you need to index website content via sitemap or specific URLs for RAG or grounding purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("sitemap" | "urls") | Yes | Type of connector: 'sitemap' for a sitemap URL, or 'urls' for a list of specific URLs |
| `value` | string | Yes | Either a single sitemap URL (when type='sitemap') or a list of webpage URLs (when type='urls') |

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

**Slug:** `STUDIO_BY_AI21_LABS_DELETE_ASSISTANT`

Tool to delete an assistant by its unique ID. Use when you need to permanently remove an assistant from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_id` | string | Yes | Unique identifier of the assistant to 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 |

### Delete Assistant Route

**Slug:** `STUDIO_BY_AI21_LABS_DELETE_ASSISTANT_ROUTE`

Tool to delete a route from an AI21 Studio assistant. Use when you need to remove a routing configuration from an assistant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `route_id` | string | Yes | The unique identifier of the route to delete |
| `assistant_id` | string | Yes | The unique identifier of the assistant whose route should be deleted |

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

**Slug:** `STUDIO_BY_AI21_LABS_DELETE_DEMO`

Tool to delete a demo by its unique ID. Use when removing a specific demo from AI21 Studio.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `demo_id` | string | Yes | Unique identifier of the demo to 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 |

### Delete MCP Storage

**Slug:** `STUDIO_BY_AI21_LABS_DELETE_MCP_STORAGE`

Tool to delete an MCP (Model Context Protocol) storage configuration by its unique ID. Use when you need to permanently remove an MCP server configuration from AI21 Studio.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mcp_id` | string | Yes | Unique identifier of the MCP storage configuration to 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 |

### Delete Secret

**Slug:** `STUDIO_BY_AI21_LABS_DELETE_SECRET`

Tool to delete a secret by its unique ID. Use when you need to permanently remove a secret from AI21 Studio.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secret_id` | string | Yes | Unique identifier of the secret to 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 |

### Delete Website Connector

**Slug:** `STUDIO_BY_AI21_LABS_DELETE_WEBSITE_CONNECTOR`

Permanently delete a website connector by its unique identifier. Use when you need to remove a website connector that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `connector_id` | string | Yes | Unique identifier of the website connector to delete. Format: UUID string (e.g., '45fd5bfc-bf64-41db-8dab-787b18c97229'). WARNING: This permanently deletes the website connector and its configuration. |

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

### Download Modified Document

**Slug:** `STUDIO_BY_AI21_LABS_DOWNLOAD_MODIFIED_DOCUMENT`

Tool to download a modified document from AI21 Labs Studio. Use when you need to generate and download a document with specific content and filename.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | string | Yes | The document content to be downloaded. This is the text content of the document. |
| `filename` | string | Yes | The filename for the downloaded document. Include the file extension (e.g., 'document.txt', 'report.pdf'). |

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

**Slug:** `STUDIO_BY_AI21_LABS_GET_ASSISTANT`

Tool to retrieve an assistant by its unique identifier. Use when you need to get details about a specific assistant including its configuration, tools, and settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_id` | string | Yes | The unique identifier of the assistant 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 Assistant Route

**Slug:** `STUDIO_BY_AI21_LABS_GET_ASSISTANT_ROUTE`

Tool to retrieve details of a specific route for an AI21 Studio assistant. Use when you need to get information about a particular route configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `route_id` | string | Yes | The unique identifier of the route to retrieve |
| `assistant_id` | string | Yes | The unique identifier of the assistant |

#### 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 Assistants By MCP

**Slug:** `STUDIO_BY_AI21_LABS_GET_ASSISTANTS_BY_MCP`

Tool to retrieve all assistants associated with a specific MCP (Model Context Protocol) storage configuration. Use when you need to list assistants that are connected to a particular MCP server.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mcp_id` | string | Yes | The unique identifier of the MCP storage to retrieve assistants for. |

#### 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 Batch Prediction Status

**Slug:** `STUDIO_BY_AI21_LABS_GET_BATCH_STATUS`

Tool to check the status of a Fnac Aftersales parts classification batch prediction job. Use when you need to monitor the progress or retrieve results of a previously submitted batch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | UUID format batch identifier returned from POST /solutions/fd_aftersales/parts-classification/batch. Used to query the status of a batch prediction job. |

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

**Slug:** `STUDIO_BY_AI21_LABS_GET_DEMO`

Tool to retrieve a demo by its unique ID. Use when you need to fetch details about a specific demo including its name, status, visibility, and configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `demo_id` | string | Yes | The unique identifier of the demo 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 |

### Grant Kirsh Metadata

**Slug:** `STUDIO_BY_AI21_LABS_GET_KIRSH_GRANT_METADATA`

Tool to retrieve Kirsh grant metadata by grant ID. Use when you need to fetch grant information including grant name and organization details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `grant_id` | integer | Yes | The grant ID to retrieve metadata for |

#### 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 Library Batch Status

**Slug:** `STUDIO_BY_AI21_LABS_GET_LIBRARY_BATCH_STATUS`

Tool to get the ingestion status of a library batch. Use when you need to check the processing status of documents in a batch upload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | The UUID of the batch to retrieve status for |

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

**Slug:** `STUDIO_BY_AI21_LABS_GET_MCP_STORAGE`

Tool to retrieve a specific MCP (Model Context Protocol) storage configuration by its unique ID. Use when you need to get details about a particular MCP server including its URL, label, authentication settings, and allowed tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mcp_id` | string | Yes | The unique identifier of the MCP storage configuration 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 Output Explanation

**Slug:** `STUDIO_BY_AI21_LABS_GET_OUTPUT_EXPLANATION`

Tool to get output explanation for an execution (cached or generated). Use when you need to retrieve or regenerate the explanation for a specific execution. Set force_regenerate to true to bypass cache.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `execution_id` | string | Yes | The unique identifier of the execution to get the output explanation for. |
| `force_regenerate` | boolean | No | Set to true to regenerate the explanation even if a cached version exists. Defaults to 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 Plan

**Slug:** `STUDIO_BY_AI21_LABS_GET_PLAN`

Tool to retrieve a specific plan from an AI21 Studio assistant. Use when you need to fetch details of a plan by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `plan_id` | string | Yes | Unique identifier for the plan to retrieve. |
| `assistant_id` | string | Yes | Unique identifier for the assistant that owns the plan. |

#### 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 Website Connector By ID

**Slug:** `STUDIO_BY_AI21_LABS_GET_WEBSITE_CONNECTOR_BY_ID`

Tool to retrieve details of a specific website connector by its ID. Use when you need to fetch information about a website connector in AI21 Studio.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `connector_id` | string | Yes | The unique identifier of the website connector 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 Website Connector Status

**Slug:** `STUDIO_BY_AI21_LABS_GET_WEBSITE_CONNECTOR_STATUS`

Tool to retrieve the status of a website connector ingestion. Use when you need to check the processing status of a website that was added to AI21 Studio.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `website_id` | string | Yes | The unique identifier of the website to retrieve status for |

#### 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 Website Connector URL Status

**Slug:** `STUDIO_BY_AI21_LABS_GET_WEBSITE_CONNECTOR_URL_STATUS`

Tool to retrieve the status of a specific URL in the website connector. Use when you need to check the processing status of a URL that was previously ingested.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url_id` | string | Yes | Unique identifier of the URL whose status is being queried. |

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

### Ingest Website Connector

**Slug:** `STUDIO_BY_AI21_LABS_INGEST_WEBSITE_CONNECTOR`

Tool to ingest website content via sitemap URL in AI21 Studio. Use when you need to process and index website pages from a sitemap for RAG, grounding, or document analysis purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `labels` | array | No | Optional list of labels to tag the ingested content for organization and filtering. |
| `sitemap_url` | string | Yes | URL of the XML sitemap to ingest. Must be a valid, accessible, and well-formed sitemap URL. |
| `client_config` | string | No | Optional client configuration string for advanced ingestion settings. |

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

### Ingest Website Connector URL

**Slug:** `STUDIO_BY_AI21_LABS_INGEST_WEBSITE_CONNECTOR_URL`

Tool to ingest a website URL into AI21 Studio's website connector. Use when you need to add a specific URL to be processed and indexed by the website connector for RAG or grounding.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The website URL to ingest and process for the website connector |

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

**Slug:** `STUDIO_BY_AI21_LABS_LIST_ASSISTANTS`

Tool to retrieve all assistants from AI21 Studio. Use when you need to list available assistants, optionally filtered by workspace IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_ids` | array | No | Filter assistants by workspace IDs. If provided, only assistants belonging to the specified workspaces will 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 Website Connectors

**Slug:** `STUDIO_BY_AI21_LABS_LIST_CONNECTORS_WEBSITE`

Tool to retrieve website connector information from AI21 Studio. Use when you need to get details about configured website connectors.

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

**Slug:** `STUDIO_BY_AI21_LABS_LIST_DEMOS`

Tool to retrieve all demos from AI21 Studio. Use when you need to list all available demos including their names, statuses, visibility settings, and configurations.

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

**Slug:** `STUDIO_BY_AI21_LABS_LIST_LIBRARY_FILES`

Tool to list files in the workspace library with optional filtering. Use to retrieve file metadata, search by name/path/status/labels, or paginate through library contents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filter files by name. Only files matching this name will be returned. |
| `path` | string | No | Filter files by path prefix. Use path-like strings to organize files (e.g., 'pets/dogs', 'pets/fish'). Filtering by 'pets/' matches all files with paths starting with 'pets/'. Path matching is prefix-based, not substring-based. |
| `label` | array | No | Filter files by labels. Only files with all specified labels will be returned. Labels are case-sensitive and do not use prefix matching (unlike paths). Maximum of 20 unique labels per account. |
| `limit` | integer | No | Maximum number of files to return. Default is 500000. |
| `offset` | integer | No | Number of files to skip before returning results. Use for pagination. |
| `status` | string ("DB_RECORD_CREATED" | "UPLOADED" | "UPLOAD_FAILED" | "PROCESSED" | "PROCESSING_FAILED") | No | Status of a library file. |

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

**Slug:** `STUDIO_BY_AI21_LABS_LIST_MCP_STORAGE`

Tool to retrieve all MCP (Model Context Protocol) storage configurations from AI21 Studio. Use when you need to list available MCP servers and their configurations, optionally filtered by workspace ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | No | Filter MCP storage by workspace ID. If provided, only MCP storage configurations belonging to the specified workspace will 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 Models

**Slug:** `STUDIO_BY_AI21_LABS_LIST_MODELS`

Tool to retrieve information about all available AI21 models. Use when you need to list models with their specifications, pricing, and capabilities.

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

**Slug:** `STUDIO_BY_AI21_LABS_LIST_PLANS`

Tool to list all plans for a specific assistant. Use when you need to retrieve the plans associated with an assistant ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_id` | string | Yes | The unique identifier of the assistant whose plans 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 Secrets

**Slug:** `STUDIO_BY_AI21_LABS_LIST_SECRETS`

Tool to retrieve all secrets from AI21 Studio secret storage. Use when you need to list stored secrets and their metadata.

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

**Slug:** `STUDIO_BY_AI21_LABS_LIST_SETTINGS_MODELS`

Tool to retrieve all workspace models by organization from AI21 Studio. Use when you need to list available models for the workspace.

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

**Slug:** `STUDIO_BY_AI21_LABS_LIST_SETTINGS_MODELS_AVAILABLE`

Tool to retrieve all available models from AI21 Studio settings. Use when you need to list models that are available for use in the workspace.

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

### Modify Assistant

**Slug:** `STUDIO_BY_AI21_LABS_MODIFY_ASSISTANT`

Tool to modify an existing AI21 Studio assistant. Use when you need to update assistant properties like name, description, models, system prompt, or configuration. At least one field must be provided to update. All fields except assistant_id are optional.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the assistant |
| `tools` | array | No | List of tools available to the assistant (HTTP tools, MCP tools, file search, web search) |
| `avatar` | string | No | Avatar URL or identifier for the assistant |
| `budget` | string ("low" | "medium" | "high") | No | Budget level for the assistant. |
| `models` | array | No | List of model names to use for the assistant |
| `visibility` | string ("public" | "private") | No | Visibility setting for the assistant. |
| `description` | string | No | New description for the assistant |
| `is_archived` | boolean | No | Whether to archive the assistant. Archived assistants are not active but can be restored. |
| `assistant_id` | string | Yes | The unique identifier of the assistant to modify |
| `optimization` | string ("cost" | "latency") | No | Optimization strategy for the assistant. |
| `requirements` | array | No | List of requirements for the assistant |
| `system_prompt` | string | No | System prompt that defines the assistant's behavior and personality |
| `workflow_config` | object | No | Workflow configuration for the assistant. |
| `config_overrides` | object | No | Configuration overrides for advanced customization of the assistant |
| `response_language` | string ("arabic" | "dutch" | "english" | "french" | "german" | "hebrew" | "italian" | "portuguese" | "spanish" | "unset") | No | Response language for the assistant. |

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

### Modify Assistant Route

**Slug:** `STUDIO_BY_AI21_LABS_MODIFY_ASSISTANT_ROUTE`

Tool to modify an existing route within an assistant. Use when you need to update the description or examples of a specific route in an AI21 Studio assistant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `examples` | array | Yes | List of example strings for the route. |
| `route_id` | string | Yes | The unique identifier of the route to modify. |
| `description` | string | Yes | The modified description for the route. |
| `assistant_id` | string | Yes | The unique identifier of the assistant containing the route to modify. |

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

### Modify Assistant Plan

**Slug:** `STUDIO_BY_AI21_LABS_MODIFY_PLAN`

Tool to modify an existing assistant plan in AI21 Studio. Use when you need to update the code or schemas of a plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The Python code that defines the modified plan logic. This is the main content of the plan. |
| `plan_id` | string | Yes | The unique identifier of the plan to modify. |
| `schemas` | array | No | Optional array of schema objects that define the structure or validation rules for the plan. |
| `assistant_id` | string | Yes | The unique identifier of the assistant containing the plan to modify. |

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

### Retry Ingest Website

**Slug:** `STUDIO_BY_AI21_LABS_RETRY_INGEST_WEBSITE`

Tool to retry ingestion of a website in AI21 Studio. Use when a website ingestion has failed and you need to trigger another attempt to ingest the content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `website_id` | string | Yes | The unique UUID identifier of the website to retry ingestion for. Must be a valid UUID format. |

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

### Run Assistant

**Slug:** `STUDIO_BY_AI21_LABS_RUN_ASSISTANT`

Tool to run an AI21 Studio assistant with conversational input. Use when you need to interact with a configured AI21 assistant by providing messages and receiving responses. The assistant processes the input messages and returns a result based on its configuration. Supports multiple languages and optional features like dynamic planning and structured RAG.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | array | Yes | Array of messages representing the conversation input. Each message must have a role and content. |
| `include` | array | No | Array of additional fields to include in the response (e.g., 'data_sources', 'requirements_result', 'requirements_result.metadata') |
| `verbose` | boolean | No | Enable verbose output for detailed execution information. Defaults to false. |
| `output_type` | object | No | Specify the structure or type of the expected output |
| `assistant_id` | string | Yes | The unique identifier of the assistant to run |
| `system_prompt` | string | No | Optional system prompt to override the assistant's default system prompt |
| `response_language` | string ("arabic" | "dutch" | "english" | "french" | "german" | "hebrew" | "italian" | "portuguese" | "spanish" | "unset") | No | Supported response languages for the assistant. |
| `structured_rag_enabled` | boolean | No | Enable structured RAG (Retrieval Augmented Generation) for the assistant. Defaults to false. |
| `dynamic_planning_enabled` | boolean | No | Enable dynamic planning for the assistant. Defaults to 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 |

### Sync Website Connector

**Slug:** `STUDIO_BY_AI21_LABS_SYNC_WEBSITE_CONNECTOR`

Tool to sync a website connector in AI21 Studio. Use when you need to trigger a synchronization of website content for a specific connector.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `connector_id` | string | Yes | The unique identifier of the website connector to sync. |

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

**Slug:** `STUDIO_BY_AI21_LABS_UPDATE_DEMO`

Tool to update an existing demo in Studio by AI21 Labs. Use when you need to modify demo properties such as name, status, visibility, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the demo. |
| `config` | object | No | Demo configuration object. |
| `status` | string ("active" | "inactive") | No | Status of the demo. |
| `demo_id` | string | Yes | The unique identifier of the demo to update. |
| `visibility` | string ("public" | "private") | No | Visibility of the demo. |
| `ui_component_name` | string | No | Name of the UI component. |

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

**Slug:** `STUDIO_BY_AI21_LABS_UPDATE_MCP_STORAGE`

Tool to update an existing MCP (Model Context Protocol) storage configuration in AI21 Studio. Use when you need to modify the server label of an MCP storage configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mcp_id` | string | Yes | The unique identifier of the MCP storage configuration to update |
| `server_label` | string | Yes | Updated label or name for the MCP server |

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

**Slug:** `STUDIO_BY_AI21_LABS_UPDATE_SECRET`

Tool to update an existing secret in AI21 Studio. Use when you need to modify secret properties such as name or value.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secret_id` | string | Yes | The unique identifier of the secret to update |
| `secret_name` | string | No | Updated name for the secret |
| `secret_value` | string | No | Updated value for the secret |

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

### Validate Plan

**Slug:** `STUDIO_BY_AI21_LABS_VALIDATE_PLAN`

Tool to validate Python code for an AI21 Studio assistant plan. Use when you need to verify that code is syntactically correct and executable before using it in an assistant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The Python code to validate. This should be a complete function or code block that will be validated for syntax and execution. |
| `schemas` | array | No | Optional list of schema objects to validate against the code. |
| `assistant_id` | string | Yes | The unique identifier of the assistant for which to validate the plan. |

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