Overview Use Cases Connectors Authentication Getting Started with the Python SDK API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors dataset deployment deployment_conversations docstore document_retrievers documentation eda external_app feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard holdout_analysis llm_apps model model_monitoring module natural_language_explanation organization pipelines predict checkConstraints classifyImage classifyPDF describeImage executeAgent executeAgentWithBinaryData executeConversationAgent generateImage getAlternativeAssignments getAnomalies getAssignments getChatResponse getChatResponseWithBinaryData getClassification getCluster getCompletion getConversationResponse getConversationResponseWithBinaryData getEntailment getEntitiesFromPDF getEventAnomalyScore getForecast getKNearest getLabels getMatrixAgentSchema getMultipleKNearest getObjectsFromImage getPersonalizedRanking getRankedItems getRecommendations getRelatedItems getSearchResults getSentiment getSummary getTextFromDocument getTimeseriesAnomalies isAnomaly lookupFeatures lookupMatches pauseAutonomousAgent predict predictChurn predictClass predictFraud predictFromDatasets predictLanguage predictLead predictMultiple predictTakeover predictTarget predictWithBinaryData scoreImage startAutonomousAgent transcribeAudio transferStyle prediction_operator project python_function refresh secrets streaming streaming_connectors upload webhooks API Classes API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

Method

executeAgent POST

Copy POST

Executes a deployed AI agent function using the arguments as keyword arguments to the agent execute function.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	deploymentToken	str	The deployment token used to authenticate access to created deployments. This token is only authorized to predict on deployments in this project, so it is safe to embed this model inside of an application or website.
Yes	deploymentId	str	A unique string identifier for the deployment created under the project.
No	arguments	list	Positional arguments to the agent execute function.
No	keywordArguments	dict	A dictionary where each 'key' represents the paramter name and its corresponding 'value' represents the value of that parameter for the agent execute function.

Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY	TYPE	DESCRIPTION
success	Boolean	true if the call succeeded, false if there was an error
	AgentExecutionResult

Exceptions:

TYPE	WHEN
DataNotFoundError	`deploymentId` is not found.

Language: