Workflow Activities

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

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

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

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

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

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

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

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

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

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

Parameter	Type	Optional	Description
select	string	Yes

Parameter	Type	Optional	Description
errorMessage	string	No

Parameter	Type	Optional	Description
force	boolean	Yes

Parameter	Type	Optional	Description
environmentId	string	Yes
force	boolean	Yes

Parameter	Type	Optional
maxResolution	number	Yes
thumbnailSize	number	Yes
posterSize	number	Yes
generateAudio	boolean	Yes

Parameter	Type	Optional
webhook	string \| WebHookSpec	No
workflow_id	string	No
workflow_type	string	No
workflow_run_id	string	No
event_name	string	No
detail	Record<string, any>	Yes
method	GET \| POST	No
headers	Record<string, string>	Yes

Parameter	Type	Optional	Description
status	ContentObjectStatus	No

Parameter	Type	Optional
interactionIdOrEndpoint	string	No
environmentId	string	Yes
modelId	string	Yes

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

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
fileId	string	Yes
contentType	string	Yes

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

Parameter	Type	Optional
pageCount	number	No
concurrency	number	Yes
debug	boolean	Yes

Parameter	Type	Optional
update_metadata	boolean	Yes
max_pages	number	Yes
use_clean_pdf	boolean	No

Parameter	Type	Optional
annotate	boolean	No
page_numbers	number[]	Yes
artifacts	ArtifactType[]	Yes
use_clean_pdf	boolean	No

Parameter	Type	Optional	Description
max_file_size	number	Yes
skip_clean_threshold	number	Yes

Parameter	Type	Optional
page_number	number	No
language	string	Yes
use_clean_pdf	boolean	No

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

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

Parameter	Type	Optional	Description
run_ids	string[]	No

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

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

Parameter	Type	Optional	Description
page_numbers	number[]	Yes

Parameter	Type	Optional	Description
prefix	string	No

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

Reduces sections using overlap detection and LLM-based reduction. This activity can be used for both partition-level reduction and final combination. It takes multiple arrays of sections, combines overlapping sections, and uses an LLM to merge continuous sections with similar topics.

Parameter	Type	Optional
reduceInteractionName	string	Yes
sectionResults	any[][]	No
tags	string[]	Yes

DSL

{
  "type": "activity",
  "name": "reduceSections",
  "params": {
    "reduceInteractionName": "string",
    "sectionResults": "any[][]",
    "tags": "string[]"
  },
  "output": "renditions"
}

Save Sections

Activity ID: saveSections

Saves sections to a document's metadata. This activity updates the document's metadata with the provided sections.

Parameter	Type	Optional	Description
objectId	string	No
sections	TextSection[]	No

DSL

{
  "type": "activity",
  "name": "saveSections",
  "params": {
    "objectId": "string",
    "sections": [
      {
        "description": "string",
        "first_line_index": "number",
        "last_line_index": "number"
      }
    ]
  },
  "output": "renditions"
}

Process Chunk

Activity ID: processChunk

Downloads chunk content from GCP storage. Used to retrieve chunks uploaded by splitTextIntoChunks.

Parameter	Type	Optional
chunk	ChunkMetadata	No
interactionName	string	No
globalChunkIndex	number	No
wfRunId	string	No

DSL

{
  "type": "activity",
  "name": "processChunk",
  "params": {
    "chunk": {
      "chunkIndex": "number",
      "fileId": "string",
      "size": "number",
      "firstLineNumber": "number",
      "lastLineNumber": "number"
    },
    "interactionName": "string",
    "globalChunkIndex": "number",
    "wfRunId": "string"
  },
  "output": "renditions"
}

Fetch Interaction Run Result

Activity ID: fetchInteractionRunResult

Parameter	Type	Optional	Description
run_id	string	No
status	string	No

DSL

{
  "type": "activity",
  "name": "fetchInteractionRunResult",
  "params": {
    "run_id": "string",
    "status": "string"
  },
  "output": "renditions"
}

Create Checkpoint

Activity ID: createCheckpoint

Parameter	Type	Optional	Description
tools	ToolDefinition[]	Yes
tool_reference	ToolReference	Yes

DSL

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

Resume Conversation

Activity ID: resumeConversation

Parameter	Type	Optional
results	ToolResult[]	No
tools	ToolDefinition[]	Yes
tool_reference	ToolReference	Yes
user_message	string	Yes

DSL

{
  "type": "activity",
  "name": "resumeConversation",
  "params": {
    "results": [
      {
        "tool_use_id": "string"
      }
    ],
    "tools": [
      {
        "name": "string",
        "description": "string",
        "input_schema": "inline object"
      }
    ],
    "tool_reference": {
      "storage_key": "string",
      "tool_count": "number",
      "stored_at": "string"
    },
    "user_message": "string"
  },
  "output": "renditions"
}

Start Conversation

Activity ID: startConversation

Parameter	Type	Optional
payload	AsyncConversationExecutionPayload	No
tools	ToolDefinition[]	Yes
tool_reference	ToolReference	Yes

DSL

{
  "type": "activity",
  "name": "startConversation",
  "params": {
    "payload": {
      "type": "conversation",
      "visibility": "private | project",
      "tool_names": "string[]",
      "max_iterations": "number",
      "interactive": "boolean",
      "disable_interaction_tools": "boolean",
      "search_scope": "string",
      "collection_id": "string",
      "checkpoint_tokens": "number",
      "task_id": "string",
      "debug_mode": "boolean",
      "max_nested_conversation_depth": "number"
    },
    "tools": [
      {
        "name": "string",
        "description": "string",
        "input_schema": "inline object"
      }
    ],
    "tool_reference": {
      "storage_key": "string",
      "tool_count": "number",
      "stored_at": "string"
    }
  },
  "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 Remote Tool

Activity ID: executeRemoteTool

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

Parameter	Type	Optional
app_name	string	No
settings	Record<string, any>	Yes
src	string	No
type	http \| js \| mcp	No
tool_use	ToolUse	No

DSL

{
  "type": "activity",
  "name": "executeRemoteTool",
  "params": {
    "app_name": "string",
    "settings": "Record<string, any>",
    "src": "string",
    "type": "http | js | mcp",
    "tool_use": {
      "id": "string",
      "tool_name": "string",
      "tool_input": "ParamsT | "
    }
  },
  "output": "renditions"
}

Get Conversation Topic

Activity ID: getConversationTopic

Parameter	Type	Optional	Description
workflow_run_id	string	No
environment	string	No	The environment ID to use to resolve the driver.
options	StatelessExecutionOptions	No	The options to use on the next call.

DSL

{
  "type": "activity",
  "name": "getConversationTopic",
  "params": {
    "workflow_run_id": "string",
    "environment": "string",
    "options": {
      "include_original_response": "boolean",
      "model_options": "TextFallbackOptions | ImagenOptions | VertexAIClaudeOptions | VertexAIGeminiOptions | NovaCanvasOptions | BaseConverseOptions | BedrockClaudeOptions | BedrockPalmyraOptions | BedrockGptOssOptions | TwelvelabsPegasusOptions | OpenAiThinkingOptions | OpenAiTextOptions | GroqDeepseekThinkingOptions",
      "output_modality": "Modalities"
    }
  },
  "output": "renditions"
}

Fetch Document Activity

Activity ID: fetchDocumentActivity

Parameter	Type	Optional	Description
input	FetchDocumentToolParams	No

DSL

{
  "type": "activity",
  "name": "fetchDocumentActivity",
  "params": {
    "input": {
      "id": "string",
      "mode": "FetchMode",
      "section_indices": "number[]",
      "token_range": "TokenRange",
      "page_range": "PageRange",
      "analyzer_prompt": "string",
      "visual": "boolean",
      "max_tokens": "number"
    }
  },
  "output": "renditions"
}

Search Documents Activity

Activity ID: searchDocumentsActivity

Parameter	Type	Optional	Description
input	SearchDocumentsToolParams	No

DSL

{
  "type": "activity",
  "name": "searchDocumentsActivity",
  "params": {
    "input": {
      "query": "inline object",
      "facets": "inline object[]",
      "select": "string",
      "limit": "number",
      "offset": "number",
      "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 Properties Activity

Activity ID: updateCollectionPropertiesActivity

Parameter	Type	Optional	Description
input	UpdateCollectionToolParams	No

DSL

{
  "type": "activity",
  "name": "updateCollectionPropertiesActivity",
  "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"
}

Update Document Properties Activity

Activity ID: updateDocumentPropertiesActivity

Parameter	Type	Optional	Description
input	UpdateDocumentPropertiesToolParams	No

DSL

{
  "type": "activity",
  "name": "updateDocumentPropertiesActivity",
  "params": {
    "input": {
      "documentId": "string",
      "properties": "Record<string, any>",
      "create_revision": "boolean",
      "revision_label": "string"
    }
  },
  "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",
      "additional_packages": "string[]",
      "objectIds": "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"
}

Merge Document Activity

Activity ID: mergeDocumentActivity

Parameter	Type	Optional	Description
input	MergeDocumentToolParams	No

DSL

{
  "type": "activity",
  "name": "mergeDocumentActivity",
  "params": {
    "input": {
      "output_name": "string",
      "input_document_ids": "string[]",
      "separator": "string",
      "properties": "Record<string, any>",
      "parent": "string",
      "location": "string",
      "type": "string",
      "summary": "string"
    }
  },
  "output": "renditions"
}

Create Content Object Activity

Activity ID: createContentObjectActivity

Parameter	Type	Optional	Description
input	CreateContentObjectToolParams	No

DSL

{
  "type": "activity",
  "name": "createContentObjectActivity",
  "params": {
    "input": {
      "url": "string",
      "name": "string",
      "properties": "Record<string, any>",
      "tags": "string[]",
      "location": "string",
      "collection_id": "string"
    }
  },
  "output": "renditions"
}

Search Conversations Activity

Activity ID: searchConversationsActivity

Parameter	Type	Optional	Description
input	SearchConversationsToolParams	No

DSL

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

Analyze Conversation Tool Activity

Activity ID: analyzeConversationToolActivity

Parameter	Type	Optional	Description
input	AnalyzeConversationToolParams	No

DSL

{
  "type": "activity",
  "name": "analyzeConversationToolActivity",
  "params": {
    "input": {
      "workflow_run_id": "string",
      "workflow_id": "string",
      "analyzer_prompt": "string",
      "result_schema": "Record<string, any>"
    }
  },
  "output": "renditions"
}