Functions

Functions let assistants call custom logic defined by your application.

Endpoints

Manage assistant functions with these REST endpoints.

List functionsRetrieve a list of functions

Create functionCreate a new function

Get functionRetrieve a specific function

Update functionUpdate an existing function

Delete functionDelete an existing function

`Function` type

Parameter	Type	Description
`id`	string	Unique identifier for the function
`openapiSpec`	string	OpenAPI specification in JSON format
`handler`	`Handler`	Function handler configuration
`createdAt`	string	Timestamp when the function was created
`updatedAt`	string	Timestamp when the function was last updated

Example function

const fn = { id: '00cfe680-fee5-49b9-b386-6a7097eb8497', openapiSpec: '{"openapi":"3.1.0"}', handler: { type: 'REQUEST', requestHandler: { url: 'https://example.com', method: 'GET', headers: '{}', body: '{}', }, }, createdAt: '2024-01-15T10:30:00Z', updatedAt: '2024-01-15T10:30:00Z', }

`Handler` type

Handlers determine how functions execute. The shape depends on type:

`type`	Object key	Fields
`REQUEST`	`requestHandler`	`{ url: string, method: string, headers: string, body: string }`
`FIRECRAWL`	`firecrawlHandler`	`{ type: string, apiKey: string, body: string }`
`REPLICATE`	`replicateHandler`	`{ type: string, apiKey: string, identifier: string, body: string }`
`CLIENT_TOOL`	`clientToolHandler`	`{ type: string, name: string, arguments: string }`
`ASSISTANT`	`assistantHandler`	`{ assistantId: string }`
`LIST_TASKS`	`listTasksHandler`	`{ keyTemplate: string }`
`CREATE_TASK`	`createTaskHandler`	`{ keyTemplate: string }`
`UPDATE_TASK`	`updateTaskHandler`	`{ keyTemplate: string }`
`DELETE_TASK`	`deleteTaskHandler`	`{ keyTemplate: string }`

Functions

Endpoints

Function type

Example function

Handler type

`Function` type

`Handler` type