Workflow Activities

This page lists the public workflow activities that are available in the platform.

activities

Create Document Type From Interaction Run

Activity ID: createDocumentTypeFromInteractionRun

Parameter	Type	Optional	Description
run	ExecutionRun	No	The execution run object to use. Required. Not required in params since it is usually fetched
updateObjectId	string	Yes	If defined then update the object type with the created type

DSL

{
  "type": "activity",
  "name": "createDocumentTypeFromInteractionRun",
  "params": {
    "run": {
      "id": "string",
      "parent": "string | ExecutionRun",
      "evaluation": "inline object",
      "result": "R",
      "parameters": "P",
      "tags": "string[]",
      "interaction": "Interaction",
      "environment": "ExecutionEnvironmentRef",
      "modelId": "string",
      "result_schema": "JSONSchema4",
      "ttl": "number",
      "status": "ExecutionRunStatus",
      "finish_reason": "string",
      "prompt": "any",
      "token_use": "ExecutionTokenUsage",
      "chunks": "number",
      "execution_time": "number",
      "created_at": "Date",
      "updated_at": "Date",
      "account": "AccountRef",
      "project": "ProjectRef",
      "config": "InteractionExecutionConfiguration",
      "error": "InteractionExecutionError",
      "source": "RunSource",
      "output_modality": "Modalities",
      "created_by": "string",
      "updated_by": "string",
      "workflow": "ExecutionRunWorkflow"
    },
    "updateObjectId": "string"
  },
  "output": "renditions"
}

Create Or Update Document From Interaction Run

Activity ID: createOrUpdateDocumentFromInteractionRun

Parameter	Type	Optional	Description
run_id	string	Yes	The execution run object to use. Required. Not required in params since it is usually fetched
object_type	string	Yes	The document type to use. Required if update_existing_id is false. Not required in params since it is usually fetched
update_existing_id	string	Yes	The id of the document to update. If not provided, a new document will be created
fallback_name	string	Yes	The name of the object to use. If not provided, the name will be generated from the interaction result
parent	string	Yes	The name of the parent object to use. If not provided, the document will be created at the root level
update_text_from_property	string	Yes	The name of the property to use for the text. If not provided, the text will be set to the result of the interaction

DSL

{
  "type": "activity",
  "name": "createOrUpdateDocumentFromInteractionRun",
  "params": {
    "run_id": "string",
    "object_type": "string",
    "update_existing_id": "string",
    "fallback_name": "string",
    "parent": "string",
    "update_text_from_property": "string"
  },
  "output": "renditions"
}

Update Document From Interaction Run

Activity ID: updateDocumentFromInteractionRun

Parameter	Type	Optional	Description
run	ExecutionRun	Yes	The execution run object to use. Required. Not required in params since it is usually fetched

DSL

{
  "type": "activity",
  "name": "updateDocumentFromInteractionRun",
  "params": {
    "run": {
      "id": "string",
      "parent": "string | ExecutionRun",
      "evaluation": "inline object",
      "result": "R",
      "parameters": "P",
      "tags": "string[]",
      "interaction": "Interaction",
      "environment": "ExecutionEnvironmentRef",
      "modelId": "string",
      "result_schema": "JSONSchema4",
      "ttl": "number",
      "status": "ExecutionRunStatus",
      "finish_reason": "string",
      "prompt": "any",
      "token_use": "ExecutionTokenUsage",
      "chunks": "number",
      "execution_time": "number",
      "created_at": "Date",
      "updated_at": "Date",
      "account": "AccountRef",
      "project": "ProjectRef",
      "config": "InteractionExecutionConfiguration",
      "error": "InteractionExecutionError",
      "source": "RunSource",
      "output_modality": "Modalities",
      "created_by": "string",
      "updated_by": "string",
      "workflow": "ExecutionRunWorkflow"
    }
  },
  "output": "renditions"
}

Chunk Document

Activity ID: chunkDocument

Parameter	Type	Optional	Description
force	boolean	Yes	If true, force chunking even if the document is already chunked
interactionName	string	Yes	The interaction name to use for chunking If not set, the default interaction will be used
docPartType	string	Yes	The object type to use for the document parts If not set, the type of the document will be used
createParts	boolean	Yes	If true, create parts as document objects

DSL

{
  "type": "activity",
  "name": "chunkDocument",
  "params": {
    "force": "boolean",
    "interactionName": "string",
    "docPartType": "string",
    "createParts": "boolean"
  },
  "output": "renditions"
}

Create Pdf Document From Source

Activity ID: createPdfDocumentFromSource

Create a new PDF by extracting pages from a source PDF @returns

Parameter	Type	Optional
target_object_type	string	No
title	string	No
filename	string	Yes
pages	number[]	No
parent	string	Yes

DSL

{
  "type": "activity",
  "name": "createPdfDocumentFromSource",
  "params": {
    "target_object_type": "string",
    "title": "string",
    "filename": "string",
    "pages": "number[]",
    "parent": "string"
  },
  "output": "renditions"
}

Execute Interaction

Activity ID: executeInteraction

Parameter	Type	Optional	Description
interactionName	string	No
prompt_data	Record<string, any>	No
static_prompt_data	Record<string, any>	Yes	Additional prompt data passed by the workflow configuration. This will be merged with prompt_data if any. You should use `import: ["static_prompt_data"]` to import the workflow prompt data as static_prompt_data param. Otherwise the workflow prompt data will be ignored.
truncate	Record<string, number \| inline object>	Yes

DSL

{
  "type": "activity",
  "name": "executeInteraction",
  "params": {
    "interactionName": "string",
    "prompt_data": "Record<string, any>",
    "static_prompt_data": "Record<string, any>",
    "truncate": "Record<string, number | inline object>"
  },
  "output": "renditions"
}

Extract Document Text

Activity ID: extractDocumentText

DSL

{
  "type": "activity",
  "name": "extractDocumentText",
  "params": {},
  "output": "renditions"
}

Generate Document Properties

Activity ID: generateDocumentProperties

Parameter	Type	Optional	Description
typesHint	string[]	Yes
truncate	number \| inline object	Yes	truncate the input doc text to the specified max_tokens
interactionName	string	Yes
use_vision	boolean	Yes

DSL

{
  "type": "activity",
  "name": "generateDocumentProperties",
  "params": {
    "typesHint": "string[]",
    "truncate": "number | inline object",
    "interactionName": "string",
    "use_vision": "boolean"
  },
  "output": "renditions"
}

Generate Embeddings

Activity ID: generateEmbeddings

Parameter	Type	Optional	Description
model	string	Yes	The model to use for embedding generation If not set, the default model for the project will be used
environment	string	Yes	The environment to use for embedding generation If not set, the default environment for the project will be used
force	boolean	Yes	If true, force embedding generation even if the document already has embeddings
type	SupportedEmbeddingTypes	No	The embedding type to generate
parts	DocPart[]	Yes	The DocParts to use for long documents

DSL

{
  "type": "activity",
  "name": "generateEmbeddings",
  "params": {
    "model": "string",
    "environment": "string",
    "force": "boolean",
    "type": "SupportedEmbeddingTypes",
    "parts": [
      {
        "line_number_start": "number",
        "line_number_end": "number",
        "name": "string",
        "type": "string"
      }
    ]
  },
  "output": "renditions"
}

Generate Image Rendition

Activity ID: generateImageRendition

DSL

{
  "type": "activity",
  "name": "generateImageRendition",
  "params": {},
  "output": "renditions"
}

Generate Video Rendition

Activity ID: generateVideoRendition

DSL

{
  "type": "activity",
  "name": "generateVideoRendition",
  "params": {},
  "output": "renditions"
}

Generate Or Assign Content Type

Activity ID: generateOrAssignContentType

Parameter	Type	Optional	Description
typesHint	string[]	Yes
truncate	number \| inline object	Yes	truncate the input doc text to the specified max_tokens
interactionNames	inline object	Yes	The name of the interaction to execute @default SelectDocumentType

DSL

{
  "type": "activity",
  "name": "generateOrAssignContentType",
  "params": {
    "typesHint": "string[]",
    "truncate": "number | inline object",
    "interactionNames": {
      "selectDocumentType": "string",
      "generateMetadataModel": "string"
    }
  },
  "output": "renditions"
}

Get Object From Store

Activity ID: getObjectFromStore

We are using a union type for the status parameter since typescript enums breaks the workflow code generation @param objectId @param status

Parameter	Type	Optional	Description
select	string	Yes

DSL

{
  "type": "activity",
  "name": "getObjectFromStore",
  "params": {
    "select": "string"
  },
  "output": "renditions"
}

Handle Dsl Error

Activity ID: handleDslError

Parameter	Type	Optional	Description
errorMessage	string	No

DSL

{
  "type": "activity",
  "name": "handleDslError",
  "params": {
    "errorMessage": "string"
  },
  "output": "renditions"
}

Convert Pdf To Structured Text

Activity ID: convertPdfToStructuredText

Parameter	Type	Optional	Description
force	boolean	Yes

DSL

{
  "type": "activity",
  "name": "convertPdfToStructuredText",
  "params": {
    "force": "boolean"
  },
  "output": "renditions"
}

Transcribe Media

Activity ID: transcribeMedia

Parameter	Type	Optional	Description
environmentId	string	Yes
force	boolean	Yes

DSL

{
  "type": "activity",
  "name": "transcribeMedia",
  "params": {
    "environmentId": "string",
    "force": "boolean"
  },
  "output": "renditions"
}

Notify Webhook

Activity ID: notifyWebhook

Parameter	Type	Optional
target_url	string	No
method	GET \| POST	No
payload	Record<string, any>	No
headers	Record<string, string>	Yes

DSL

{
  "type": "activity",
  "name": "notifyWebhook",
  "params": {
    "target_url": "string",
    "method": "GET | POST",
    "payload": "Record<string, any>",
    "headers": "Record<string, string>"
  },
  "output": "renditions"
}

Set Document Status

Activity ID: setDocumentStatus

We are using a union type for the status parameter since typescript enums breaks the workflow code generation @param objectId @param status

Parameter	Type	Optional	Description
status	ContentObjectStatus	No

DSL

{
  "type": "activity",
  "name": "setDocumentStatus",
  "params": {
    "status": "ContentObjectStatus"
  },
  "output": "renditions"
}

Analyse Page Layout

Activity ID: analysePageLayout

Parameter	Type	Optional
page_number	number	No
expected_zones	string[]	Yes
debug	boolean	Yes
page_as_image	boolean	Yes
ocr	boolean	Yes
interaction_name	string	Yes
table_types	string[]	Yes

DSL

{
  "type": "activity",
  "name": "analysePageLayout",
  "params": {
    "page_number": "number",
    "expected_zones": "string[]",
    "debug": "boolean",
    "page_as_image": "boolean",
    "ocr": "boolean",
    "interaction_name": "string",
    "table_types": "string[]"
  },
  "output": "renditions"
}

Analyse Page With Interaction

Activity ID: analysePageWithInteraction

Parameter	Type	Optional
page_number	number	No
interaction_name	string	No
complexity_level	PageComplexityLevel	Yes
reconstruct_lines	boolean	Yes
upload_result	boolean	Yes
page_as_image	boolean	Yes
prompt_data	P	Yes

DSL

{
  "type": "activity",
  "name": "analysePageWithInteraction",
  "params": {
    "page_number": "number",
    "interaction_name": "string",
    "complexity_level": "PageComplexityLevel",
    "reconstruct_lines": "boolean",
    "upload_result": "boolean",
    "page_as_image": "boolean",
    "prompt_data": "P"
  },
  "output": "renditions"
}

Assemble Document

Activity ID: assembleDocument

Parameter	Type	Optional
layouts	AnalyzeLayoutActivityResult[]	No
tables	AnalyzePageWithInteractionResult[]	No
images	AnalyzePageWithInteractionResult[]	No
visuals	AnalyzePageWithInteractionResult[]	No
table_format	efficient \| normal	No
debug	boolean	Yes

DSL

{
  "type": "activity",
  "name": "assembleDocument",
  "params": {
    "layouts": [
      {
        "model": "string",
        "environment": "string"
      }
    ],
    "tables": [
      {
        "page_number": "number",
        "run_id": "string",
        "status": "ExecutionRunStatus",
        "tokens": "ExecutionTokenUsage",
        "result_path": "string",
        "run_result": "R"
      }
    ],
    "images": [
      {
        "page_number": "number",
        "run_id": "string",
        "status": "ExecutionRunStatus",
        "tokens": "ExecutionTokenUsage",
        "result_path": "string",
        "run_result": "R"
      }
    ],
    "visuals": [
      {
        "page_number": "number",
        "run_id": "string",
        "status": "ExecutionRunStatus",
        "tokens": "ExecutionTokenUsage",
        "result_path": "string",
        "run_result": "R"
      }
    ],
    "table_format": "efficient | normal",
    "debug": "boolean"
  },
  "output": "renditions"
}

Count Pages

Activity ID: countPages

Parameter	Type	Optional	Description
update_metadata	boolean	Yes

DSL

{
  "type": "activity",
  "name": "countPages",
  "params": {
    "update_metadata": "boolean"
  },
  "output": "renditions"
}

Store Pages As Images And Json

Activity ID: storePagesAsImagesAndJson

Parameter	Type	Optional	Description
page_numbers	number[]	Yes

DSL

{
  "type": "activity",
  "name": "storePagesAsImagesAndJson",
  "params": {
    "page_numbers": "number[]"
  },
  "output": "renditions"
}

Perform Ocr

Activity ID: performOcr

Parameter	Type	Optional	Description
page_number	number	No
language	string	Yes

DSL

{
  "type": "activity",
  "name": "performOcr",
  "params": {
    "page_number": "number",
    "language": "string"
  },
  "output": "renditions"
}

Get Table Mappings

Activity ID: getTableMappings

Parameter	Type	Optional
item_name	string	No
target_schema	string	No
instructions	string	Yes
models	MagicModel[]	Yes
page_numbers	number[]	Yes
table_ids	number[]	Yes
process_as_csv	boolean	Yes

DSL

{
  "type": "activity",
  "name": "getTableMappings",
  "params": {
    "item_name": "string",
    "target_schema": "string",
    "instructions": "string",
    "models": [
      {
        "environment": "string",
        "model": "string"
      }
    ],
    "page_numbers": "number[]",
    "table_ids": "number[]",
    "process_as_csv": "boolean"
  },
  "output": "renditions"
}

Get Tables Ids

Activity ID: getTablesIds

Parameter	Type	Optional
update_metadata	boolean	Yes
item_name	string	No
instructions	string	Yes
models	MagicModel[]	Yes

DSL

{
  "type": "activity",
  "name": "getTablesIds",
  "params": {
    "update_metadata": "boolean",
    "item_name": "string",
    "instructions": "string",
    "models": [
      {
        "environment": "string",
        "model": "string"
      }
    ]
  },
  "output": "renditions"
}

Process Tables

Activity ID: processTables

Parameter	Type	Optional	Description
run_ids	string[]	No

DSL

{
  "type": "activity",
  "name": "processTables",
  "params": {
    "run_ids": "string[]"
  },
  "output": "renditions"
}

Generate Excel Preview

Activity ID: generateExcelPreview

Parameter	Type	Optional
analyze	boolean	Yes
analyze_prompt	string	Yes
pages	number[]	Yes
max_lines	number	Yes

DSL

{
  "type": "activity",
  "name": "generateExcelPreview",
  "params": {
    "analyze": "boolean",
    "analyze_prompt": "string",
    "pages": "number[]",
    "max_lines": "number"
  },
  "output": "renditions"
}

Post Update Message

Activity ID: postUpdateMessage

Parameter	Type	Optional
type	AgentMessageType	No
message	string	No
details	any	Yes
workstream_id	string	Yes
timestamp	number	Yes
workflow_run_id	string	Yes

DSL

{
  "type": "activity",
  "name": "postUpdateMessage",
  "params": {
    "type": "AgentMessageType",
    "message": "string",
    "details": "any",
    "workstream_id": "string",
    "timestamp": "number",
    "workflow_run_id": "string"
  },
  "output": "renditions"
}

Generate Pdf Rendition

Activity ID: generatePdfRendition

Parameter	Type	Optional	Description
page_numbers	number[]	Yes

DSL

{
  "type": "activity",
  "name": "generatePdfRendition",
  "params": {
    "page_numbers": "number[]"
  },
  "output": "renditions"
}

Clean Up Cached Files

Activity ID: cleanUpCachedFiles

Parameter	Type	Optional	Description
prefix	string	No

DSL

{
  "type": "activity",
  "name": "cleanUpCachedFiles",
  "params": {
    "prefix": "string"
  },
  "output": "renditions"
}

Render Markdown Document

Activity ID: renderMarkdownDocument

Parameter	Type	Optional
format	pdf \| docx	No
template	string	Yes
options	string[]	Yes

DSL

{
  "type": "activity",
  "name": "renderMarkdownDocument",
  "params": {
    "format": "pdf | docx",
    "template": "string",
    "options": "string[]"
  },
  "output": "renditions"
}

Create Checkpoint

Activity ID: createCheckpoint

Parameter	Type	Optional	Description
tools	ToolDefinition[]	No

DSL

{
  "type": "activity",
  "name": "createCheckpoint",
  "params": {
    "tools": [
      {
        "name": "string",
        "description": "string",
        "input_schema": "inline object"
      }
    ]
  },
  "output": "renditions"
}

Resume Conversation

Activity ID: resumeConversation

Parameter	Type	Optional
results	inline object[]	No
tools	ToolDefinition[]	No
user_message	string	Yes

DSL

{
  "type": "activity",
  "name": "resumeConversation",
  "params": {
    "results": [
      {
        "tool_use_id": "string",
        "content": "string",
        "files": "string[]"
      }
    ],
    "tools": [
      {
        "name": "string",
        "description": "string",
        "input_schema": "inline object"
      }
    ],
    "user_message": "string"
  },
  "output": "renditions"
}

Start Conversation

Activity ID: startConversation

Parameter	Type	Optional	Description
payload	AsyncConversationExecutionPayload	No
tools	ToolDefinition[]	No

DSL

{
  "type": "activity",
  "name": "startConversation",
  "params": {
    "payload": {
      "type": "conversation",
      "tools": "string[]",
      "max_iterations": "number",
      "interactive": "boolean",
      "disable_interaction_tools": "boolean",
      "search_scope": "string",
      "collection_id": "string",
      "checkpoint_tokens": "number",
      "task_id": "string",
      "interactionParamsSchema": "JSONSchema4"
    },
    "tools": [
      {
        "name": "string",
        "description": "string",
        "input_schema": "inline object"
      }
    ]
  },
  "output": "renditions"
}

Generate Tools

Activity ID: generateTools

Generate dynamic tools as interaction tools and dynamic descriptions @param payload

Parameter	Type	Optional	Description
generate_interaction_tools	boolean	No
include_interactions	string[]	Yes	Optionally filter by interaction endpoint name to includes only the specified interactions
exclude_interactions	string[]	Yes	Optionally filter by interaction endpoint name to excludes the specified interactions If both includes and excludes are provided the includes will be done first.

DSL

{
  "type": "activity",
  "name": "generateTools",
  "params": {
    "generate_interaction_tools": "boolean",
    "include_interactions": "string[]",
    "exclude_interactions": "string[]"
  },
  "output": "renditions"
}

Execute Tool Plugin

Activity ID: executeToolPlugin

Generate dynamic tools as interaction tools and dynamic descriptions @param payload

Parameter	Type	Optional
plugin	string	No
src	string	No
tool_use	ToolUse	No

DSL

{
  "type": "activity",
  "name": "executeToolPlugin",
  "params": {
    "plugin": "string",
    "src": "string",
    "tool_use": {
      "id": "string",
      "tool_name": "string",
      "tool_input": "ParamsT | "
    }
  },
  "output": "renditions"
}

Fetch Documents Activity

Activity ID: fetchDocumentsActivity

Parameter	Type	Optional	Description
input	FetchDocumentsToolParams	No

DSL

{
  "type": "activity",
  "name": "fetchDocumentsActivity",
  "params": {
    "input": {
      "ids": "string[]",
      "analyze": "boolean",
      "analyzer_prompt": "string",
      "properties_only": "boolean",
      "content_only": "boolean",
      "instrument": "boolean",
      "visual": "boolean"
    }
  },
  "output": "renditions"
}

Search Documents Activity

Activity ID: searchDocumentsActivity

Parameter	Type	Optional	Description
input	SearchDocumentsToolParams	No

DSL

{
  "type": "activity",
  "name": "searchDocumentsActivity",
  "params": {
    "input": {
      "query": "Record<string, any>",
      "select": "string",
      "limit": "number",
      "offset": "number",
      "sort": "Record<string, any>",
      "count_only": "boolean",
      "summary": "string",
      "analyze": "boolean",
      "analyzer_prompt": "string",
      "all_revisions": "boolean"
    }
  },
  "output": "renditions"
}

Update Document Activity

Activity ID: updateDocumentActivity

Parameter	Type	Optional	Description
input	UpdateDocumentToolParams	No

DSL

{
  "type": "activity",
  "name": "updateDocumentActivity",
  "params": {
    "input": {
      "id": "string",
      "edits": "StructuredEdit[]",
      "create_revision": "boolean",
      "revision_label": "string",
      "properties": "Record<string, any>",
      "location": "string",
      "type": "string",
      "track_changes": "boolean",
      "author": "string",
      "instrumentation": "inline object"
    }
  },
  "output": "renditions"
}

Web Search Activity

Activity ID: webSearchActivity

Parameter	Type	Optional	Description
input	WebSearchToolParams	No

DSL

{
  "type": "activity",
  "name": "webSearchActivity",
  "params": {
    "input": {
      "query": "string",
      "num_results": "number",
      "include_snippets": "boolean",
      "safe_search": "boolean",
      "fetch_content": "boolean",
      "fetch_top_n": "number",
      "analyze_content": "boolean",
      "analyzer_prompt": "string"
    }
  },
  "output": "renditions"
}

Get Object Type Activity

Activity ID: getObjectTypeActivity

Parameter	Type	Optional	Description
input	GetObjectTypeToolParams	No

DSL

{
  "type": "activity",
  "name": "getObjectTypeActivity",
  "params": {
    "input": {
      "id": "string"
    }
  },
  "output": "renditions"
}

Create Or Update Type Activity

Activity ID: createOrUpdateTypeActivity

Parameter	Type	Optional	Description
input	CreateOrUpdateTypeToolParams	No

DSL

{
  "type": "activity",
  "name": "createOrUpdateTypeActivity",
  "params": {
    "input": {
      "id": "string"
    }
  },
  "output": "renditions"
}

Disable Type Activity

Activity ID: disableTypeActivity

Parameter	Type	Optional	Description
input	DisableTypeToolParams	No

DSL

{
  "type": "activity",
  "name": "disableTypeActivity",
  "params": {
    "input": {
      "id": "string"
    }
  },
  "output": "renditions"
}

Create Collection Activity

Activity ID: createCollectionActivity

Parameter	Type	Optional	Description
input	CreateCollectionToolParams	No

DSL

{
  "type": "activity",
  "name": "createCollectionActivity",
  "params": {
    "input": {
      "name": "string",
      "description": "string",
      "type": "string",
      "tags": "string[]",
      "properties": "Record<string, any>",
      "parent": "string | "
    }
  },
  "output": "renditions"
}

Update Collection Activity

Activity ID: updateCollectionActivity

Parameter	Type	Optional	Description
input	UpdateCollectionToolParams	No

DSL

{
  "type": "activity",
  "name": "updateCollectionActivity",
  "params": {
    "input": {
      "id": "string",
      "name": "string",
      "description": "string",
      "type": "string",
      "tags": "string[]",
      "properties": "Record<string, any>",
      "parent": "string | "
    }
  },
  "output": "renditions"
}

Add To Collection Activity

Activity ID: addToCollectionActivity

Parameter	Type	Optional	Description
input	AddToCollectionToolParams	No

DSL

{
  "type": "activity",
  "name": "addToCollectionActivity",
  "params": {
    "input": {
      "collectionId": "string",
      "objectIds": "string[]"
    }
  },
  "output": "renditions"
}

Remove From Collection Activity

Activity ID: removeFromCollectionActivity

Parameter	Type	Optional	Description
input	RemoveFromCollectionToolParams	No

DSL

{
  "type": "activity",
  "name": "removeFromCollectionActivity",
  "params": {
    "input": {
      "collectionId": "string",
      "objectIds": "string[]"
    }
  },
  "output": "renditions"
}

Get Collection Activity

Activity ID: getCollectionActivity

Parameter	Type	Optional	Description
input	GetCollectionToolParams	No

DSL

{
  "type": "activity",
  "name": "getCollectionActivity",
  "params": {
    "input": {
      "id": "string"
    }
  },
  "output": "renditions"
}

Search Collections Activity

Activity ID: searchCollectionsActivity

Parameter	Type	Optional	Description
input	SearchCollectionsToolParams	No

DSL

{
  "type": "activity",
  "name": "searchCollectionsActivity",
  "params": {
    "input": {
      "name": "string",
      "limit": "number"
    }
  },
  "output": "renditions"
}

Execute Javascript Code

Activity ID: executeJavascriptCode

Execute JavaScript code in a Temporal activity

Parameter	Type	Optional	Description
input	ExecuteJsCodeToolParams	No

DSL

{
  "type": "activity",
  "name": "executeJavascriptCode",
  "params": {
    "input": {
      "code": "string",
      "comment": "string"
    }
  },
  "output": "renditions"
}

Execute Python Code

Activity ID: executePythonCode

Execute Python code in a Temporal activity

Parameter	Type	Optional	Description
input	ExecutePythonCodeToolParams	No

DSL

{
  "type": "activity",
  "name": "executePythonCode",
  "params": {
    "input": {
      "code": "string",
      "comment": "string"
    }
  },
  "output": "renditions"
}

Plan Activity

Activity ID: planActivity

Parameter	Type	Optional	Description
input	Plan	No

DSL

{
  "type": "activity",
  "name": "planActivity",
  "params": {
    "input": {
      "plan": "PlanTask[]",
      "comment": "string"
    }
  },
  "output": "renditions"
}

Update Plan Activity

Activity ID: updatePlanActivity

Parameter	Type	Optional	Description
input	UpdatePlanParams	No

DSL

{
  "type": "activity",
  "name": "updatePlanActivity",
  "params": {
    "input": {
      "updates": "TaskUpdate[]",
      "summary": "string"
    }
  },
  "output": "renditions"
}

Analyze Spreadsheet

Activity ID: analyzeSpreadsheet

Activity function that analyzes a spreadsheet document in Vertesia using provided JavaScript code

Parameter	Type	Optional	Description
input	AnalyzeSpreadsheetToolParams	No

DSL

{
  "type": "activity",
  "name": "analyzeSpreadsheet",
  "params": {
    "input": {}
  },
  "output": "renditions"
}

Update Spreadsheet

Activity ID: updateSpreadsheet

Activity function that updates a spreadsheet document in Vertesia using provided JavaScript code

Parameter	Type	Optional	Description
input	UpdateSpreadsheetToolParams	No

DSL

{
  "type": "activity",
  "name": "updateSpreadsheet",
  "params": {
    "input": {
      "dry_run": "boolean",
      "create_version": "boolean",
      "version_label": "string"
    }
  },
  "output": "renditions"
}

Create Spreadsheet

Activity ID: createSpreadsheet

Activity function that creates a new spreadsheet document in Vertesia using provided JavaScript code

Parameter	Type	Optional	Description
input	CreateSpreadsheetToolParams	No

DSL

{
  "type": "activity",
  "name": "createSpreadsheet",
  "params": {
    "input": {
      "name": "string",
      "code": "string",
      "summary": "string",
      "type": "string",
      "location": "string",
      "properties": "Record<string, any>"
    }
  },
  "output": "renditions"
}

Analyze Image Activity

Activity ID: analyzeImageActivity

Parameter	Type	Optional	Description
input	AnalyzeImageToolParams	No

DSL

{
  "type": "activity",
  "name": "analyzeImageActivity",
  "params": {
    "input": {
      "object_id": "string",
      "image_path": "string",
      "commands": "ImageMagickCommand[]",
      "instrument_grid": "inline object",
      "summary": "string"
    }
  },
  "output": "renditions"
}