Update function

Update an existing function for an assistant.

Request

PATCH https://superinterface.ai/api/cloud/assistants/{assistantId}/functions/{functionId}

Authentication

Include your private API key in the request headers:

Authorization: Bearer YOUR_PRIVATE_API_KEY

Path Parameters

Parameter	Type	Description
`assistantId`	string	The ID of the assistant
`functionId`	string	The ID of the function

Request Body

Parameter	Type	Required	Description
`openapiSpec`	string	Yes	OpenAPI specification in JSON format
`handler`	object	Yes	Function handler configuration

handler shape depends on type. See the Handler type for all options. For a REQUEST handler:

Parameter	Type	Required	Description
`type`	`HandlerType`	Yes	Must be `REQUEST`
`requestHandler`	object	Yes	`{ url: string, method: string, headers: string, body: string }`

Example request

curl -X PATCH "https://superinterface.ai/api/cloud/assistants/00cfe680-fee5-49b9-b386-6a7097eb8497/functions/10cfe680-fee5-49b9-b386-6a7097eb8497" \ -H "Authorization: Bearer YOUR_PRIVATE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "openapiSpec": "{\"openapi\":\"3.1.0\"}", "handler": { "type": "REQUEST", "requestHandler": { "url": "https://example.com", "method": "POST", "headers": "{}", "body": "{}" } } }'

Response

Parameter	Type	Description
`function`	`Function`	Updated function

Example response

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

Errors

The endpoint may return the following errors:

401 Unauthorized

This error occurs if the API key is invalid or missing.

{ "error": "Unauthorized", "message": "Invalid or missing API key" }