Update Custom Function

curl --request PATCH \
  --url https://api.xpander.ai/v1/custom_functions/{function_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "description": "Adds documents to a managed knowledge base."
}
'

import requests

url = "https://api.xpander.ai/v1/custom_functions/{function_id}"

payload = { "description": "Adds documents to a managed knowledge base." }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: 'Adds documents to a managed knowledge base.'})
};

fetch('https://api.xpander.ai/v1/custom_functions/{function_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.xpander.ai/v1/custom_functions/{function_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Adds documents to a managed knowledge base.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.xpander.ai/v1/custom_functions/{function_id}"

	payload := strings.NewReader("{\n  \"description\": \"Adds documents to a managed knowledge base.\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.xpander.ai/v1/custom_functions/{function_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Adds documents to a managed knowledge base.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.xpander.ai/v1/custom_functions/{function_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Adds documents to a managed knowledge base.\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "updating"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PATCH

custom_functions

{function_id}

Update Custom Function

curl --request PATCH \
  --url https://api.xpander.ai/v1/custom_functions/{function_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "description": "Adds documents to a managed knowledge base."
}
'

import requests

url = "https://api.xpander.ai/v1/custom_functions/{function_id}"

payload = { "description": "Adds documents to a managed knowledge base." }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: 'Adds documents to a managed knowledge base.'})
};

fetch('https://api.xpander.ai/v1/custom_functions/{function_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.xpander.ai/v1/custom_functions/{function_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Adds documents to a managed knowledge base.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.xpander.ai/v1/custom_functions/{function_id}"

	payload := strings.NewReader("{\n  \"description\": \"Adds documents to a managed knowledge base.\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.xpander.ai/v1/custom_functions/{function_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Adds documents to a managed knowledge base.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.xpander.ai/v1/custom_functions/{function_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Adds documents to a managed knowledge base.\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "updating"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Update an existing custom function. You can update the name, description, source code, and limits. If source code changes, the function is re-analyzed automatically.

Path Parameters

string

required

Unique identifier of the custom function

Request Body

All fields are optional. Only provided fields will be updated.

string

Updated display name

string

Updated description

string

Updated Python source code (triggers re-analysis)

object

Updated execution limits, for example {"max_run_time": 30} (seconds)

Response

Returns {"status": "updating"}. The change is applied in the background. Runs that start in the next few seconds can still use the previous code. Read the function with Get Custom Function to see the saved version.

Example Request

curl -X PATCH -H "x-api-key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"description": "Updated description", "source_code": "def xpander_run_action(city: str) -> str:\n    return f\"Weather in {city}: Sunny\""}' \
  "https://api.xpander.ai/v1/custom_functions/<function-id>"

Notes

Changing source_code triggers a new analysis of the code and its input schema
Non-code fields (name, description, limits) can be updated without triggering re-analysis

Authorizations

x-api-key

string

header

required

API Key for authentication

Path Parameters

function_id

string

required

Body

application/json

Request model for updating an existing custom function.

All fields are optional. If source_code changes, the function will be re-analyzed automatically (status transitions to 'analysing' then 'ready').

name

string | null

Updated function name.

description

string | null

Updated function description.

source_code

string | null

Updated Python source code. If changed, triggers re-analysis.

limits

CustomFunctionLimitsModel · object | null

Updated resource limits.

Show child attributes

Response

Successful Response

Overview

REST API - Conversations

REST API - Agents

REST API - Tasks

Agent Workspace

REST API - Knowledge

REST API - Skills

REST API - Workflows

REST API - Custom Functions

REST API - Scheduled Tasks

REST API - Self-Schedules

REST API - Misc

Channels and webhooks

Update Custom Function

Path Parameters

Request Body

Response

Example Request

Notes

Authorizations

Path Parameters

Body

Response