Documentation Index
Fetch the complete documentation index at: https://docs.camel-ai.org/llms.txt
Use this file to discover all available pages before exploring further.
class ZapierToolkit(BaseToolkit):
- api_key (str): The API key for authenticating with Zapier’s API.
- base_url (str): The base URL for Zapier’s API endpoints.
- timeout (Optional[float]): The timeout value for API requests in seconds. If None, no timeout is applied. (default: :obj:
None)
init
def __init__(self, timeout: Optional[float] = None):
list_actions
Returns:
Dict[str, Any]: A dictionary containing the list of available
actions.
execute_action
def execute_action(self, action_id: str, instructions: str):
- action_id (str): The ID of the Zapier action to execute.
- instructions (str): Natural language instructions for executing the action. For example: “Send an email to john@example.com with subject ‘Hello’ and body ‘How are you?’”
Returns:
Dict[str, Any]: The result of the action execution, including
status and any output data.
preview_action
def preview_action(self, action_id: str, instructions: str):
- action_id (str): The ID of the Zapier action to preview.
- instructions (str): Natural language instructions for previewing the action. For example: “Send an email to john@example.com with subject ‘Hello’ and body ‘How are you?’”
Returns:
Dict[str, Any]: The preview result showing what parameters would
be used if the action were executed.
get_execution_result
def get_execution_result(self, execution_id: str):
- execution_id (str): The execution ID returned from execute_action.
Returns:
Dict[str, Any]: The execution result containing status, logs,
and any output data from the action execution.
Returns:
List[FunctionTool]: A list of FunctionTool objects representing
the functions in the toolkit.
