Studio By Ai21 Labs

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.

AI Models Developer Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (57)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Check Can IframeSTUDIO_BY_AI21_LABS_CHECK_CAN_IFRAMEAcción

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

Parámetros de entrada

urlstringObligatorio
The URL to check for iframe compatibility

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Compare TextSTUDIO_BY_AI21_LABS_COMPARE_TEXTAcción

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

Parámetros de entrada

modified_textstringObligatorio
The modified text to compare with the original
original_textstringObligatorio
The original text to compare against

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Aftersales Parts Classification BatchSTUDIO_BY_AI21_LABS_CREATE_AFTERSALES_PARTS_BATCHAcción

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.

Parámetros de entrada

casesobject[]Obligatorio
Array of aftersales cases for parts classification. The array cannot be empty.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Assistant RouteSTUDIO_BY_AI21_LABS_CREATE_ASSISTANT_ROUTEAcción

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.

Parámetros de entrada

namestringObligatorio
The name of the route.
plan_idstringObligatorio
The unique identifier of the plan to associate with this route.
examplesstring[]Obligatorio
A list of example queries or scenarios for this route.
descriptionstringObligatorio
A description of the route's purpose.
assistant_idstringObligatorio
The unique identifier of the assistant to create a route for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create AssistantSTUDIO_BY_AI21_LABS_CREATE_ASSISTANTSAcción

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.

Parámetros de entrada

namestringObligatorio
Name of the assistant to create
toolsobject[]
List of tool definitions (HTTP, MCP, file search, or web search tools) available to the assistant
avatarstring
Avatar image URL or identifier for the assistant
budgetstring
Budget level for the assistant. Defaults to 'medium'
modelsstring[]
List of model identifiers the assistant can use
descriptionstring
Description of the assistant's purpose and capabilities
optimizationstring
Optimization strategy for the assistant
requirementsobject[]
List of requirements for the assistant
system_promptstring
System prompt that defines the assistant's behavior and personality
assistant_typestring
Type of the assistant. Defaults to 'default'
workflow_configobject
Configuration for workflow integration.
config_overridesobject
Configuration overrides for the assistant
starter_questionsobject[]
List of starter questions to help users interact with the assistant

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Assistant PlanSTUDIO_BY_AI21_LABS_CREATE_ASSISTANTS_ASSISTANT_ID_PLANSAcción

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.

Parámetros de entrada

codestringObligatorio
The Python code for the plan to be created.
schemasobject[]
Optional array of schema objects associated with the plan.
assistant_idstringObligatorio
The unique identifier of the assistant to create a plan for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create DemoSTUDIO_BY_AI21_LABS_CREATE_DEMOAcción

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

Parámetros de entrada

namestringObligatorio
Name of the demo to create.
configobject
Demo configuration as a JSON object. Optional configuration settings for the demo.
statusstringObligatorioenum
Status of the demo (active or inactive).
activeinactive
visibilitystringObligatorioenum
Visibility level of the demo (public or private).
publicprivate
ui_component_namestringObligatorio
Name of the UI component associated with this demo.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate RequirementsSTUDIO_BY_AI21_LABS_CREATE_GENERATION_REQUIREMENTSAcción

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

Parámetros de entrada

querystringObligatorio
The query or task description to generate requirements from. For example, 'Build a task management system' or 'Create a user authentication system'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate Thread NameSTUDIO_BY_AI21_LABS_CREATE_GENERATION_THREAD_NAMEAcción

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.

Parámetros de entrada

querystringObligatorio
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?'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Kirsh Grant Compliance PreviewSTUDIO_BY_AI21_LABS_CREATE_KIRSH_GRANT_COMPLIANCE_PREVIEWAcción

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

Parámetros de entrada

grant_idsinteger[]Obligatorio
List of grant IDs (as integers) to check for compliance

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Kirsh Grant Metadata PreviewSTUDIO_BY_AI21_LABS_CREATE_KIRSH_GRANT_PREVIEWAcción

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.

Parámetros de entrada

grant_idintegerObligatorio
The unique identifier for the grant to retrieve metadata

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create MCP StorageSTUDIO_BY_AI21_LABS_CREATE_MCP_STORAGEAcción

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.

Parámetros de entrada

auth_valuestring
Authentication value (API token or header value, required if authentication_type is not 'none')
server_urlstringObligatorio
URL of the MCP server to connect to
server_labelstringObligatorio
Human-readable label for the MCP server
workspace_idstring
UUID of the workspace to associate with this MCP storage
allowed_toolsstring[]
List of tool names allowed for this MCP storage. If not specified, all tools are allowed
auth_header_namestring
Name of the authentication header (required if authentication_type is 'custom-header')
authentication_typestringenum
Authentication type for MCP server.
nonetoken-apicustom-header

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create SecretSTUDIO_BY_AI21_LABS_CREATE_SECRETAcción

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

Parámetros de entrada

secret_namestringObligatorio
The identifier for the secret. This name will be used to reference the secret later.
secret_valuestringObligatorio
The confidential data to be stored securely. This is the actual secret value that will be encrypted and saved.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check Kirsh Grant ComplianceSTUDIO_BY_AI21_LABS_CREATE_SOLUTIONS_KIRSH_GRANT_COMPLIANCEAcción

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

Parámetros de entrada

grant_idsinteger[]Obligatorio
Array of grant IDs to check for compliance. Each ID must be a valid integer.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Website ConnectorSTUDIO_BY_AI21_LABS_CREATE_WEBSITE_CONNECTORAcción

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.

Parámetros de entrada

typestringObligatorioenum
Type of connector: 'sitemap' for a sitemap URL, or 'urls' for a list of specific URLs
sitemapurls
valueanyObligatorio
Either a single sitemap URL (when type='sitemap') or a list of webpage URLs (when type='urls')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete AssistantSTUDIO_BY_AI21_LABS_DELETE_ASSISTANTAcción

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

Parámetros de entrada

assistant_idstringObligatorio
Unique identifier of the assistant to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Assistant RouteSTUDIO_BY_AI21_LABS_DELETE_ASSISTANT_ROUTEAcción

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

Parámetros de entrada

route_idstringObligatorio
The unique identifier of the route to delete
assistant_idstringObligatorio
The unique identifier of the assistant whose route should be deleted

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DemoSTUDIO_BY_AI21_LABS_DELETE_DEMOAcción

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

Parámetros de entrada

demo_idstringObligatorio
Unique identifier of the demo to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete MCP StorageSTUDIO_BY_AI21_LABS_DELETE_MCP_STORAGEAcción

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.

Parámetros de entrada

mcp_idstringObligatorio
Unique identifier of the MCP storage configuration to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete SecretSTUDIO_BY_AI21_LABS_DELETE_SECRETAcción

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

Parámetros de entrada

secret_idstringObligatorio
Unique identifier of the secret to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Website ConnectorSTUDIO_BY_AI21_LABS_DELETE_WEBSITE_CONNECTORAcción

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

Parámetros de entrada

connector_idstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Download Modified DocumentSTUDIO_BY_AI21_LABS_DOWNLOAD_MODIFIED_DOCUMENTAcción

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.

Parámetros de entrada

contentstringObligatorio
The document content to be downloaded. This is the text content of the document.
filenamestringObligatorio
The filename for the downloaded document. Include the file extension (e.g., 'document.txt', 'report.pdf').

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get AssistantSTUDIO_BY_AI21_LABS_GET_ASSISTANTAcción

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.

Parámetros de entrada

assistant_idstringObligatorio
The unique identifier of the assistant to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Assistant RouteSTUDIO_BY_AI21_LABS_GET_ASSISTANT_ROUTEAcción

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.

Parámetros de entrada

route_idstringObligatorio
The unique identifier of the route to retrieve
assistant_idstringObligatorio
The unique identifier of the assistant

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Assistants By MCPSTUDIO_BY_AI21_LABS_GET_ASSISTANTS_BY_MCPAcción

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.

Parámetros de entrada

mcp_idstringObligatorio
The unique identifier of the MCP storage to retrieve assistants for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Batch Prediction StatusSTUDIO_BY_AI21_LABS_GET_BATCH_STATUSAcción

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.

Parámetros de entrada

batch_idstringObligatorio
UUID format batch identifier returned from POST /solutions/fd_aftersales/parts-classification/batch. Used to query the status of a batch prediction job.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get DemoSTUDIO_BY_AI21_LABS_GET_DEMOAcción

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.

Parámetros de entrada

demo_idstringObligatorio
The unique identifier of the demo to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Grant Kirsh MetadataSTUDIO_BY_AI21_LABS_GET_KIRSH_GRANT_METADATAAcción

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

Parámetros de entrada

grant_idintegerObligatorio
The grant ID to retrieve metadata for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Library Batch StatusSTUDIO_BY_AI21_LABS_GET_LIBRARY_BATCH_STATUSAcción

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.

Parámetros de entrada

batch_idstringObligatorio
The UUID of the batch to retrieve status for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get MCP StorageSTUDIO_BY_AI21_LABS_GET_MCP_STORAGEAcción

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.

Parámetros de entrada

mcp_idstringObligatorio
The unique identifier of the MCP storage configuration to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Output ExplanationSTUDIO_BY_AI21_LABS_GET_OUTPUT_EXPLANATIONAcción

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.

Parámetros de entrada

execution_idstringObligatorio
The unique identifier of the execution to get the output explanation for.
force_regenerateboolean
Set to true to regenerate the explanation even if a cached version exists. Defaults to false.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get PlanSTUDIO_BY_AI21_LABS_GET_PLANAcción

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

Parámetros de entrada

plan_idstringObligatorio
Unique identifier for the plan to retrieve.
assistant_idstringObligatorio
Unique identifier for the assistant that owns the plan.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Website Connector By IDSTUDIO_BY_AI21_LABS_GET_WEBSITE_CONNECTOR_BY_IDAcción

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.

Parámetros de entrada

connector_idstringObligatorio
The unique identifier of the website connector to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Website Connector StatusSTUDIO_BY_AI21_LABS_GET_WEBSITE_CONNECTOR_STATUSAcción

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.

Parámetros de entrada

website_idstringObligatorio
The unique identifier of the website to retrieve status for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Website Connector URL StatusSTUDIO_BY_AI21_LABS_GET_WEBSITE_CONNECTOR_URL_STATUSAcción

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.

Parámetros de entrada

url_idstringObligatorio
Unique identifier of the URL whose status is being queried.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Ingest Website ConnectorSTUDIO_BY_AI21_LABS_INGEST_WEBSITE_CONNECTORAcción

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.

Parámetros de entrada

labelsstring[]
Optional list of labels to tag the ingested content for organization and filtering.
sitemap_urlstringObligatorio
URL of the XML sitemap to ingest. Must be a valid, accessible, and well-formed sitemap URL.
client_configstring
Optional client configuration string for advanced ingestion settings.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Ingest Website Connector URLSTUDIO_BY_AI21_LABS_INGEST_WEBSITE_CONNECTOR_URLAcción

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.

Parámetros de entrada

urlstringObligatorio
The website URL to ingest and process for the website connector

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List AssistantsSTUDIO_BY_AI21_LABS_LIST_ASSISTANTSAcción

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

Parámetros de entrada

workspace_idsstring[]
Filter assistants by workspace IDs. If provided, only assistants belonging to the specified workspaces will be returned.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Website ConnectorsSTUDIO_BY_AI21_LABS_LIST_CONNECTORS_WEBSITEAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List DemosSTUDIO_BY_AI21_LABS_LIST_DEMOSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Library FilesSTUDIO_BY_AI21_LABS_LIST_LIBRARY_FILESAcción

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.

Parámetros de entrada

namestring
Filter files by name. Only files matching this name will be returned.
pathstring
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.
labelstring[]
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.
limitinteger
Maximum number of files to return. Default is 500000.
offsetinteger
Number of files to skip before returning results. Use for pagination.
statusstringenum
Status of a library file.
DB_RECORD_CREATEDUPLOADEDUPLOAD_FAILEDPROCESSEDPROCESSING_FAILED

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List MCP StorageSTUDIO_BY_AI21_LABS_LIST_MCP_STORAGEAcción

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.

Parámetros de entrada

workspace_idstring
Filter MCP storage by workspace ID. If provided, only MCP storage configurations belonging to the specified workspace will be returned.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ModelsSTUDIO_BY_AI21_LABS_LIST_MODELSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List PlansSTUDIO_BY_AI21_LABS_LIST_PLANSAcción

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

Parámetros de entrada

assistant_idstringObligatorio
The unique identifier of the assistant whose plans to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List SecretsSTUDIO_BY_AI21_LABS_LIST_SECRETSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Workspace ModelsSTUDIO_BY_AI21_LABS_LIST_SETTINGS_MODELSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Available ModelsSTUDIO_BY_AI21_LABS_LIST_SETTINGS_MODELS_AVAILABLEAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify AssistantSTUDIO_BY_AI21_LABS_MODIFY_ASSISTANTAcción

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.

Parámetros de entrada

namestring
New name for the assistant
toolsobject[]
List of tools available to the assistant (HTTP tools, MCP tools, file search, web search)
avatarstring
Avatar URL or identifier for the assistant
budgetstringenum
Budget level for the assistant.
lowmediumhigh
modelsstring[]
List of model names to use for the assistant
visibilitystringenum
Visibility setting for the assistant.
publicprivate
descriptionstring
New description for the assistant
is_archivedboolean
Whether to archive the assistant. Archived assistants are not active but can be restored.
assistant_idstringObligatorio
The unique identifier of the assistant to modify
optimizationstringenum
Optimization strategy for the assistant.
costlatency
requirementsobject[]
List of requirements for the assistant
system_promptstring
System prompt that defines the assistant's behavior and personality
workflow_configobject
Workflow configuration for the assistant.
config_overridesobject
Configuration overrides for advanced customization of the assistant
response_languagestringenum
Response language for the assistant.
arabicdutchenglishfrenchgermanhebrewitalianportuguesespanishunset

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify Assistant RouteSTUDIO_BY_AI21_LABS_MODIFY_ASSISTANT_ROUTEAcción

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.

Parámetros de entrada

examplesstring[]Obligatorio
List of example strings for the route.
route_idstringObligatorio
The unique identifier of the route to modify.
descriptionstringObligatorio
The modified description for the route.
assistant_idstringObligatorio
The unique identifier of the assistant containing the route to modify.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify Assistant PlanSTUDIO_BY_AI21_LABS_MODIFY_PLANAcción

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

Parámetros de entrada

codestringObligatorio
The Python code that defines the modified plan logic. This is the main content of the plan.
plan_idstringObligatorio
The unique identifier of the plan to modify.
schemasobject[]
Optional array of schema objects that define the structure or validation rules for the plan.
assistant_idstringObligatorio
The unique identifier of the assistant containing the plan to modify.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retry Ingest WebsiteSTUDIO_BY_AI21_LABS_RETRY_INGEST_WEBSITEAcción

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.

Parámetros de entrada

website_idstringObligatorio
The unique UUID identifier of the website to retry ingestion for. Must be a valid UUID format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Run AssistantSTUDIO_BY_AI21_LABS_RUN_ASSISTANTAcción

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.

Parámetros de entrada

inputobject[]Obligatorio
Array of messages representing the conversation input. Each message must have a role and content.
includestring[]
Array of additional fields to include in the response (e.g., 'data_sources', 'requirements_result', 'requirements_result.metadata')
verboseboolean
Enable verbose output for detailed execution information. Defaults to false.
output_typeobject
Specify the structure or type of the expected output
assistant_idstringObligatorio
The unique identifier of the assistant to run
system_promptstring
Optional system prompt to override the assistant's default system prompt
response_languagestringenum
Supported response languages for the assistant.
arabicdutchenglishfrenchgermanhebrewitalianportuguesespanishunset
structured_rag_enabledboolean
Enable structured RAG (Retrieval Augmented Generation) for the assistant. Defaults to false.
dynamic_planning_enabledboolean
Enable dynamic planning for the assistant. Defaults to false.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Sync Website ConnectorSTUDIO_BY_AI21_LABS_SYNC_WEBSITE_CONNECTORAcción

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

Parámetros de entrada

connector_idstringObligatorio
The unique identifier of the website connector to sync.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update DemoSTUDIO_BY_AI21_LABS_UPDATE_DEMOAcción

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.

Parámetros de entrada

namestring
Name of the demo.
configobject
Demo configuration object.
statusstringenum
Status of the demo.
activeinactive
demo_idstringObligatorio
The unique identifier of the demo to update.
visibilitystringenum
Visibility of the demo.
publicprivate
ui_component_namestring
Name of the UI component.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update MCP StorageSTUDIO_BY_AI21_LABS_UPDATE_MCP_STORAGEAcción

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.

Parámetros de entrada

mcp_idstringObligatorio
The unique identifier of the MCP storage configuration to update
server_labelstringObligatorio
Updated label or name for the MCP server

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update SecretSTUDIO_BY_AI21_LABS_UPDATE_SECRETAcción

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

Parámetros de entrada

secret_idstringObligatorio
The unique identifier of the secret to update
secret_namestring
Updated name for the secret
secret_valuestring
Updated value for the secret

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Validate PlanSTUDIO_BY_AI21_LABS_VALIDATE_PLANAcción

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.

Parámetros de entrada

codestringObligatorio
The Python code to validate. This should be a complete function or code block that will be validated for syntax and execution.
schemasobject[]
Optional list of schema objects to validate against the code.
assistant_idstringObligatorio
The unique identifier of the assistant for which to validate the plan.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not