Complete reference for all data types, enumerations, and models used across the xpander.ai SDK
AgentExecutionStatus
Pending
: Task is queued and waiting to startExecuting
: Task is currently being executedPaused
: Task execution is temporarily pausedError
: Task encountered an error during executionFailed
: Task execution failed to complete successfullyCompleted
: Task finished successfullyStopped
: Task was manually stoppedOutputFormat
Text
: Plain text outputJson
: JSON-formatted outputMarkdown
: Markdown-formatted outputHtml
: HTML-formatted outputTaskUpdateEventType
TaskCreated
: Task was createdTaskUpdated
: Task status or data was updatedTaskFinished
: Task execution completedToolCallRequest
: Agent is requesting to use a toolToolCallResult
: Tool execution result is availableSubAgentTrigger
: A sub-agent is triggered during executionAgentExecutionInput
text
(Optional[str]): The main prompt or instruction textfiles
(Optional[List[str]]): URLs of files to process with the taskuser
(Optional[User]): User details associated with task executiontext
or files
must be provided (validated automatically).
TaskUpdateEvent
type
(TaskUpdateEventType): The type of eventtask_id
(str): Unique identifier of the associated taskorganization_id
(str): Organization identifiertime
(datetime): Timestamp when the event occurreddata
(Union[Task, ToolCallRequest, ToolCallResult]): Event-specific data payloadToolCallRequest
request_id
(str): Unique identifier for this specific requestoperation_id
(str): Unique identifier for the operationtool_call_id
(Optional[str]): Tool call identifiergraph_node_id
(Optional[str]): Graph node identifiertool_name
(Optional[str]): Name of the tool being requestedpayload
(Optional[Any]): Input parameters for the toolToolCallResult
request_id
(str): Unique identifier for the original requestoperation_id
(str): Unique identifier for the operationtool_call_id
(Optional[str]): Tool call identifiergraph_node_id
(Optional[str]): Graph node identifiertool_name
(Optional[str]): Name of the tool that was executedpayload
(Optional[Any]): Original payload from the requestresult
(Optional[Any]): Result data from the tool executionis_error
(Optional[bool]): Whether the tool execution resulted in an errorToolInvocationResult
result
(Any): The actual result data from the tool executionis_success
(bool): Whether the tool execution was successfulerror
(Optional[str]): Error message if execution failedexecution_time
(float): Time taken for execution in secondsKnowledgeBaseDocumentItem
id
(str): Unique identifier for the documentdocument_url
(str): URL where the document was originally locatedadded_at
(datetime): Timestamp when the document was addedKnowledgeBaseSearchResult
content
(str): The matching content from the knowledge basescore
(float): Relevance score for the search result (0.0 to 1.0)