Agent Functions

@toothfairyai/sdk@latest…

Agent Function Management Module Handles agent function CRUD operations for API integrations.

Accessed via client.agentFunctions.

Methods

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

create

Create a new agent function

async create(
    name: string,
    options: {
      description: string;
      url?: string;
      requestType?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
      authorisationType?: string;
      authorisationKey?: string;
      parameters?: FunctionParameter[];
      headers?: FunctionHeader[];
      staticArgs?: StaticArg[];
    }
)

Endpoint: POST /function/create · API service

Request fields

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

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

const result = await client.agentFunctions.create('…', '…');

update

Update an existing agent function

async update(
    agentFunctionId: string,
    options: {
      name?: string;
      description?: string;
      url?: string;
      requestType?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
      authorisationType?: string;
      authorisationKey?: string;
      parameters?: FunctionParameter[];
      headers?: FunctionHeader[];
      staticArgs?: StaticArg[];
    } = {}
)

Endpoint: POST /function/update · API service

Request fields

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

Response

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

Example

const result = await client.agentFunctions.update('agent-id');

delete

Delete an agent function

async delete(agentFunctionId: string): Promise<

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

Response fields

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

Example

const result = await client.agentFunctions.delete('agent-id');

get

Get an agent function by ID

async get(agentFunctionId: string)

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

Response

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

Example

const result = await client.agentFunctions.get('agent-id');

list

List all agent functions in the workspace

async list(limit?: number, offset?: number)

Endpoint: GET /function/list · API service

Example

const result = await client.agentFunctions.list();

search

Search agent functions by name

async search(searchTerm: string)

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

Example

const result = await client.agentFunctions.search('…');

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