Agent Functions

toothfairyai@latest…

Manager for agent functions operations.

This manager provides methods to create, update, and manage agent functions.

Example:

>>> client = ToothFairyClient(api_key="...", workspace_id="...")
>>> agent_function = client.agent_functions.create(...)

Accessed via client.agentFunctions.

Methods

Method	HTTP	Endpoint
`create`	POST	`POST /function/create`
`update`	POST	`POST /function/update`
`delete`	DELETE	`DELETE /function/delete/{agent_function_id}`
`get`	GET	`GET /function/get/{agent_function_id}`
`list`	GET	`GET /function/list`
`search`	—	derived

create

Create a new agent function.

def create(
    name: str,
    description: str,
    url: Optional[str] = None,
    request_type: Optional[FunctionRequestType] = None,
    authorisation_type: FunctionAuthorisationTypeRequest = 'none',
    authorisation_key: Optional[str] = None,
    authorisation_id: Optional[str] = None,
    parameters: Optional[Dict[str, Any]] = None,
    model: Optional[str] = None,
    depends_on_before_execution: Optional[List[str]] = None,
    depends_on_after_execution: Optional[List[str]] = None,
    params_as_path: Optional[bool] = None,
    scope: Optional[FunctionScope] = None,
    json_path_extractor: Optional[str] = None,
    headers: Optional[Dict[str, Any]] = None,
    static_args: Optional[Dict[str, Any]] = None,
    custom_execution_code: Optional[str] = None,
    is_mcp_server: Optional[bool] = None,
    is_callback_fn: Optional[bool] = None,
    is_database_script: Optional[bool] = None,
    is_html_fn: Optional[bool] = None,
    is_chat_fn: Optional[bool] = None,
    is_hand_off_fn: Optional[bool] = None,
    is_code_template: Optional[bool] = None,
    is_agent_skill: Optional[bool] = None,
    code_execution_environment_id: Optional[str] = None,
    on_fn_call: Optional[Dict[str, Any]] = None,
    hand_off_agent: Optional[str] = None,
    hand_off_to_original_agent_on_completion: Optional[bool] = None,
    hand_off_to_original_agent_on_failure: Optional[bool] = None,
    hand_off_agent_on_completion: Optional[str] = None,
    hand_off_agent_on_failure: Optional[str] = None,
    agent_skill_script: Optional[str] = None,
    chat_script: Optional[str] = None,
    chat_action: Optional[AgentFunctionChatActionRequest] = None,
    html_url: Optional[str] = None,
    html_script: Optional[str] = None,
    is_html_redirect_fn: Optional[bool] = None,
    html_form_on_successful_submit_message: Optional[str] = None,
    html_form_on_failed_submit_message: Optional[str] = None,
    db_schema_metadata: Optional[Dict[str, Any]] = None,
    pre_execution_script: Optional[str] = None,
    post_execution_script: Optional[str] = None,
    db_script: Optional[str] = None,
    db_connection_id: Optional[str] = None,
    pre_execution_fn_id: Optional[str] = None,
    pre_execution_mapping: Optional[Dict[str, Any]] = None,
    oauth_connection_id: Optional[str] = None,
    handed_off_to_human_on_call: Optional[bool] = None,
    graphql_query: Optional[str] = None,
    graphql_mutation: Optional[str] = None,
    graphql_operation_name: Optional[str] = None,
    users_to_hand_off_to: Optional[List[str]] = None,
    is_global: Optional[bool] = None
) -> AgentFunction

Endpoint: POST /function/create · API service

Request fields

Python kwarg	Wire field	Type	Required	Description
`id`	`id`	`string`	no	Unique identifier
`workspace_id`	`workspaceid`	`string`	yes	Unique workspace identifier (UUID v4)
`name`	`name`	`string`	yes	Name of the resource
`description`	`description`	`string`	yes	Detailed description of purpose and capabilities
`model`	`model`	`string`	no	Model identifier for the function's LLM
`is_callback_fn`	`isCallbackFn`	`boolean`	no	Whether this is a callback function
`is_database_script`	`isDatabaseScript`	`boolean`	no	Whether this function executes a database script
`is_html_fn`	`isHtmlFn`	`boolean`	no	Whether this function renders an HTML form/page
`is_chat_fn`	`isChatFn`	`boolean`	no	Whether this is a chat action function
`is_mcp_server`	`isMCPServer`	`boolean`	no	Whether this function connects to an MCP (Model Context Protocol) server
`is_code_template`	`isCodeTemplate`	`boolean`	no	Whether this is a code template function
`is_hand_off_fn`	`isHandOffFn`	`boolean`	no	Whether this function hands off to another agent or human
`is_agent_skill`	`isAgentSkill`	`boolean`	no	Whether this function is an agent skill
`agent_skill_script`	`agentSkillScript`	`string`	no	Script for the agent skill function
`hand_off_agent`	`handOffAgent`	`string`	no	Agent ID to hand off to
`hand_off_to_original_agent_on_completion`	`handOffToOriginalAgentOnCompletion`	`boolean`	no	Whether to return to the original agent on completion
`hand_off_to_original_agent_on_failure`	`handOffToOriginalAgentOnFailure`	`boolean`	no	Whether to return to the original agent on failure
`hand_off_agent_on_completion`	`handOffAgentOnCompletion`	`string`	no	Agent ID to hand off to on completion
`hand_off_agent_on_failure`	`handOffAgentOnFailure`	`string`	no	Agent ID to hand off to on failure
`handed_off_to_human_on_call`	`handedOffToHumanOnCall`	`boolean`	no	Whether the function hands off to a human operator
`users_to_hand_off_to`	`usersToHandOffTo`	`string`	no	List of user IDs who can receive hand-offs
`on_fn_call`	`onFnCall`	`string`	no	JSON-encoded configuration for actions on function call
`graphql_query`	`graphqlQuery`	`string`	no	GraphQL query string (for graphql_query request type)
`graphql_mutation`	`graphqlMutation`	`string`	no	GraphQL mutation string (for graphql_mutation request type)
`graphql_operation_name`	`graphqlOperationName`	`string`	no	Name of the GraphQL operation
`is_global`	`isGlobal`	`boolean`	no	Whether this function is available across all agents
`created_by`	`createdBy`	`string`	no	ID of the user who created this resource
`updated_by`	`updatedBy`	`string`	no	ID of the user who last updated this resource
`depends_on_before_execution`	`dependsOnBeforeExecution`	`string`	no	List of function IDs that must execute before this one
`depends_on_after_execution`	`dependsOnAfterExecution`	`string`	no	List of function IDs that execute after this one
`pre_execution_script`	`preExecutionScript`	`string`	no	Script executed before this function runs
`post_execution_script`	`postExecutionScript`	`string`	no	Script executed after this function runs
`pre_execution_fn_id`	`preExecutionFnID`	`string`	no	ID of a function to execute before this one
`pre_execution_mapping`	`preExecutionMapping`	`string`	no	JSON-encoded mapping for pre-execution data
`oauth_connection_id`	`OAuthConnectionID`	`string`	no	ID of the OAuth connection used by this function
`function_version`	`functionVersion`	`string`	no	Version identifier for the function
`function_type`	`functionType`	`string`	no	Type classification for the function
`request_type`	`requestType`	`string`	no	HTTP request type for API call functions: get, post, put, delete, patch, custom, graphql_query, or graphql_mutation

Always pass snake_case keyword arguments — the Python kwarg column shows the exact name to use for each wire field (as a named parameter where it appears in the method signature, otherwise via **kwargs). The SDK converts it deterministically to the camelCase wire key the API expects. Passing camelCase directly is deprecated: it emits a warning and converts to the same wire key.

Response fields

Field	Type	Description
`id`	`string`	Unique identifier for the agent function
`name`	`string`	Human-readable name of the function
`description`	`string`	Detailed description of function purpose
`parameters`	`object`	Function parameters schema (JSON Schema format)
`model`	`string`	AI model used for processing function calls
`url`	`string`	Endpoint URL for the function
`requestType`	`string`	HTTP method for the function call

Allowed: get, post, put, delete, patch, custom, graphql_query, graphql_mutation | | authorisationType | string | Authentication method required

Example

client.agentFunctions.create(name="…", description="…")

update

Update a agent_function.

def update(agent_function_id: str) -> AgentFunction

Endpoint: POST /function/update · API service

Request fields

Python kwarg	Wire field	Type	Required	Description
`id`	`id`	`string`	yes	Unique identifier
`workspace_id`	`workspaceid`	`string`	no	Unique workspace identifier (UUID v4)
`name`	`name`	`string`	no	Name of the resource
`description`	`description`	`string`	no	Detailed description of purpose and capabilities
`model`	`model`	`string`	no	Model identifier for the function's LLM
`is_callback_fn`	`isCallbackFn`	`boolean`	no	Whether this is a callback function
`is_database_script`	`isDatabaseScript`	`boolean`	no	Whether this function executes a database script
`is_html_fn`	`isHtmlFn`	`boolean`	no	Whether this function renders an HTML form/page
`is_chat_fn`	`isChatFn`	`boolean`	no	Whether this is a chat action function
`is_mcp_server`	`isMCPServer`	`boolean`	no	Whether this function connects to an MCP (Model Context Protocol) server
`is_code_template`	`isCodeTemplate`	`boolean`	no	Whether this is a code template function
`is_hand_off_fn`	`isHandOffFn`	`boolean`	no	Whether this function hands off to another agent or human
`is_agent_skill`	`isAgentSkill`	`boolean`	no	Whether this function is an agent skill
`agent_skill_script`	`agentSkillScript`	`string`	no	Script for the agent skill function
`hand_off_agent`	`handOffAgent`	`string`	no	Agent ID to hand off to
`hand_off_to_original_agent_on_completion`	`handOffToOriginalAgentOnCompletion`	`boolean`	no	Whether to return to the original agent on completion
`hand_off_to_original_agent_on_failure`	`handOffToOriginalAgentOnFailure`	`boolean`	no	Whether to return to the original agent on failure
`hand_off_agent_on_completion`	`handOffAgentOnCompletion`	`string`	no	Agent ID to hand off to on completion
`hand_off_agent_on_failure`	`handOffAgentOnFailure`	`string`	no	Agent ID to hand off to on failure
`handed_off_to_human_on_call`	`handedOffToHumanOnCall`	`boolean`	no	Whether the function hands off to a human operator
`users_to_hand_off_to`	`usersToHandOffTo`	`string`	no	List of user IDs who can receive hand-offs
`on_fn_call`	`onFnCall`	`string`	no	JSON-encoded configuration for actions on function call
`graphql_query`	`graphqlQuery`	`string`	no	GraphQL query string (for graphql_query request type)
`graphql_mutation`	`graphqlMutation`	`string`	no	GraphQL mutation string (for graphql_mutation request type)
`graphql_operation_name`	`graphqlOperationName`	`string`	no	Name of the GraphQL operation
`is_global`	`isGlobal`	`boolean`	no	Whether this function is available across all agents
`created_by`	`createdBy`	`string`	no	ID of the user who created this resource
`updated_by`	`updatedBy`	`string`	no	ID of the user who last updated this resource
`depends_on_before_execution`	`dependsOnBeforeExecution`	`string`	no	List of function IDs that must execute before this one
`depends_on_after_execution`	`dependsOnAfterExecution`	`string`	no	List of function IDs that execute after this one
`pre_execution_script`	`preExecutionScript`	`string`	no	Script executed before this function runs
`post_execution_script`	`postExecutionScript`	`string`	no	Script executed after this function runs
`pre_execution_fn_id`	`preExecutionFnID`	`string`	no	ID of a function to execute before this one
`pre_execution_mapping`	`preExecutionMapping`	`string`	no	JSON-encoded mapping for pre-execution data
`oauth_connection_id`	`OAuthConnectionID`	`string`	no	ID of the OAuth connection used by this function
`function_version`	`functionVersion`	`string`	no	Version identifier for the function
`function_type`	`functionType`	`string`	no	Type classification for the function
`request_type`	`requestType`	`string`	no	HTTP request type for API call functions: get, post, put, delete, patch, custom, graphql_query, or graphql_mutation

Always pass snake_case keyword arguments — the Python kwarg column shows the exact name to use for each wire field (as a named parameter where it appears in the method signature, otherwise via **kwargs). The SDK converts it deterministically to the camelCase wire key the API expects. Passing camelCase directly is deprecated: it emits a warning and converts to the same wire key.

Response

Returns the AgentFunction object — fields documented in the create section above.

Example

client.agentFunctions.update(agent_function_id="agent-id")

delete

Delete a agent_function.

def delete(agent_function_id: str) -> Dict[str, bool]

Endpoint: DELETE /function/delete/{agent_function_id} · API service

Response fields

Field	Type	Description
`success`	`boolean`	Operation success status
`data`	`object`	Response data
`message`	`string`	Optional success message

Example

client.agentFunctions.delete(agent_function_id="agent-id")

get

Get a agent_function by ID.

def get(agent_function_id: str) -> AgentFunction

Endpoint: GET /function/get/{agent_function_id} · API service

Response

Returns the AgentFunction object — fields documented in the create section above.

Example

client.agentFunctions.get(agent_function_id="agent-id")

list

List all agent functions.

def list(
    limit: Optional[int] = None,
    offset: Optional[int] = None
) -> ListResponse

Endpoint: GET /function/list · API service

Example

client.agentFunctions.list()

search

Search agent functions by name.

def search(search_term: str) -> List[AgentFunction]

Derived method — delegates to another SDK call and performs no direct HTTP request.

Example

client.agentFunctions.search(search_term="…")

Agent Functions​

Methods​

create​

Request fields​

Response fields​

Example​

update​

Request fields​

Response​

Example​

delete​

Response fields​

Example​

get​

Response​

Example​

list​

Example​

search​

Example​

Agent Functions

Methods

create

Request fields

Response fields

Example

update

Request fields

Response

Example

delete

Response fields

Example

get

Response

Example

list

Example

search

Example