Functions
Create function
Create a new Zavu Function. The function starts in draft status. A dedicated API key is auto-provisioned and injected as the ZAVU_API_KEY secret so the function can call back into the Zavu API without manual setup.
Provide sourceCode to seed the draft. Call POST /v1/functions/{functionId}/deploy afterwards to publish.
POST
/
v1
/
functions
Create function
curl --request POST \
--url https://api.zavu.dev/v1/functions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"slug": "order-bot",
"name": "Order Bot",
"description": "Replies to order status questions on WhatsApp.",
"sourceCode": "import { defineFunction } from '@zavudev/functions';\n\nexport default defineFunction(async (event, ctx) => {\n ctx.log('received', event.type);\n});\n",
"dependencies": {
"openai": "^4.20.0"
}
}
EOFimport requests
url = "https://api.zavu.dev/v1/functions"
payload = {
"slug": "order-bot",
"name": "Order Bot",
"description": "Replies to order status questions on WhatsApp.",
"sourceCode": "import { defineFunction } from '@zavudev/functions';
export default defineFunction(async (event, ctx) => {
ctx.log('received', event.type);
});
",
"dependencies": { "openai": "^4.20.0" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: 'order-bot',
name: 'Order Bot',
description: 'Replies to order status questions on WhatsApp.',
sourceCode: 'import { defineFunction } from \'@zavudev/functions\';\n\nexport default defineFunction(async (event, ctx) => {\n ctx.log(\'received\', event.type);\n});\n',
dependencies: {openai: '^4.20.0'}
})
};
fetch('https://api.zavu.dev/v1/functions', 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.zavu.dev/v1/functions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'slug' => 'order-bot',
'name' => 'Order Bot',
'description' => 'Replies to order status questions on WhatsApp.',
'sourceCode' => 'import { defineFunction } from \'@zavudev/functions\';
export default defineFunction(async (event, ctx) => {
ctx.log(\'received\', event.type);
});
',
'dependencies' => [
'openai' => '^4.20.0'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.zavu.dev/v1/functions"
payload := strings.NewReader("{\n \"slug\": \"order-bot\",\n \"name\": \"Order Bot\",\n \"description\": \"Replies to order status questions on WhatsApp.\",\n \"sourceCode\": \"import { defineFunction } from '@zavudev/functions';\\n\\nexport default defineFunction(async (event, ctx) => {\\n ctx.log('received', event.type);\\n});\\n\",\n \"dependencies\": {\n \"openai\": \"^4.20.0\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.zavu.dev/v1/functions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"order-bot\",\n \"name\": \"Order Bot\",\n \"description\": \"Replies to order status questions on WhatsApp.\",\n \"sourceCode\": \"import { defineFunction } from '@zavudev/functions';\\n\\nexport default defineFunction(async (event, ctx) => {\\n ctx.log('received', event.type);\\n});\\n\",\n \"dependencies\": {\n \"openai\": \"^4.20.0\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zavu.dev/v1/functions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"order-bot\",\n \"name\": \"Order Bot\",\n \"description\": \"Replies to order status questions on WhatsApp.\",\n \"sourceCode\": \"import { defineFunction } from '@zavudev/functions';\\n\\nexport default defineFunction(async (event, ctx) => {\\n ctx.log('received', event.type);\\n});\\n\",\n \"dependencies\": {\n \"openai\": \"^4.20.0\"\n }\n}"
response = http.request(request)
puts response.read_body{
"function": {
"id": "fn_abc123",
"slug": "order-bot",
"name": "Order Bot",
"runtime": "nodejs24",
"status": "draft",
"timeoutSec": 10,
"memoryMb": 256,
"httpEnabled": true,
"dependencies": {
"openai": "^4.20.0"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"publicUrl": "<string>",
"activeDeploymentId": "<string>"
}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "conflict",
"message": "A function with slug \"order-bot\" already exists"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
URL-safe identifier (lowercase, digits, hyphens). Must be unique per project.
Required string length:
1 - 50Example:
"order-bot"
Maximum string length:
80Example:
"Order Bot"
Maximum string length:
280Runtime the function is deployed on.
Available options:
nodejs24 Per-invocation timeout in seconds. Event and cron invocations are asynchronous, so a long timeout only bounds cost; a tool called during a live conversation holds up the reply, and a function exposed over HTTP is additionally bounded by the platform's HTTP response limit.
Required range:
1 <= x <= 180Available options:
128, 256, 512, 1024 Whether to expose a public HTTPS URL for this function.
The project's source files, keyed by path relative to the project root (e.g. index.ts, lib/orders.ts). Imports between them are resolved when the function is built, so a function can be split across as many files as it needs.
Paths must be relative and use forward slashes; .., node_modules/ and package.json are rejected. npm packages are not uploaded here — declare them under dependencies and Zavu installs them. Limits: 200 files and 900,000 bytes for the whole tree.
Show child attributes
Show child attributes
Example:
{
"index.ts": "import { formatOrder } from './lib/orders';\n\nexport default async function handler(event) {\n return { statusCode: 200, body: formatOrder(event) };\n}\n",
"lib/orders.ts": "export function formatOrder(event) {\n return JSON.stringify(event);\n}\n"
}
Which file in files is the entry point. Defaults to index.ts.
Example:
"index.ts"
Shortcut for a single-file function: exactly equivalent to sending files with one entry named after entrypoint (index.ts by default). Fully supported — use whichever fits. If both are sent, files wins.
Maximum string length:
900000npm dependencies. Keys are package names, values are semver ranges.
Show child attributes
Show child attributes
Example:
{ "openai": "^4.20.0" }
Response
Function created.
A Zavu Function — user-supplied TypeScript that runs in Zavu Cloud and reacts to messaging events or HTTP requests.
Show child attributes
Show child attributes
⌘I
Create function
curl --request POST \
--url https://api.zavu.dev/v1/functions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"slug": "order-bot",
"name": "Order Bot",
"description": "Replies to order status questions on WhatsApp.",
"sourceCode": "import { defineFunction } from '@zavudev/functions';\n\nexport default defineFunction(async (event, ctx) => {\n ctx.log('received', event.type);\n});\n",
"dependencies": {
"openai": "^4.20.0"
}
}
EOFimport requests
url = "https://api.zavu.dev/v1/functions"
payload = {
"slug": "order-bot",
"name": "Order Bot",
"description": "Replies to order status questions on WhatsApp.",
"sourceCode": "import { defineFunction } from '@zavudev/functions';
export default defineFunction(async (event, ctx) => {
ctx.log('received', event.type);
});
",
"dependencies": { "openai": "^4.20.0" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: 'order-bot',
name: 'Order Bot',
description: 'Replies to order status questions on WhatsApp.',
sourceCode: 'import { defineFunction } from \'@zavudev/functions\';\n\nexport default defineFunction(async (event, ctx) => {\n ctx.log(\'received\', event.type);\n});\n',
dependencies: {openai: '^4.20.0'}
})
};
fetch('https://api.zavu.dev/v1/functions', 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.zavu.dev/v1/functions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'slug' => 'order-bot',
'name' => 'Order Bot',
'description' => 'Replies to order status questions on WhatsApp.',
'sourceCode' => 'import { defineFunction } from \'@zavudev/functions\';
export default defineFunction(async (event, ctx) => {
ctx.log(\'received\', event.type);
});
',
'dependencies' => [
'openai' => '^4.20.0'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.zavu.dev/v1/functions"
payload := strings.NewReader("{\n \"slug\": \"order-bot\",\n \"name\": \"Order Bot\",\n \"description\": \"Replies to order status questions on WhatsApp.\",\n \"sourceCode\": \"import { defineFunction } from '@zavudev/functions';\\n\\nexport default defineFunction(async (event, ctx) => {\\n ctx.log('received', event.type);\\n});\\n\",\n \"dependencies\": {\n \"openai\": \"^4.20.0\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.zavu.dev/v1/functions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"order-bot\",\n \"name\": \"Order Bot\",\n \"description\": \"Replies to order status questions on WhatsApp.\",\n \"sourceCode\": \"import { defineFunction } from '@zavudev/functions';\\n\\nexport default defineFunction(async (event, ctx) => {\\n ctx.log('received', event.type);\\n});\\n\",\n \"dependencies\": {\n \"openai\": \"^4.20.0\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zavu.dev/v1/functions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"order-bot\",\n \"name\": \"Order Bot\",\n \"description\": \"Replies to order status questions on WhatsApp.\",\n \"sourceCode\": \"import { defineFunction } from '@zavudev/functions';\\n\\nexport default defineFunction(async (event, ctx) => {\\n ctx.log('received', event.type);\\n});\\n\",\n \"dependencies\": {\n \"openai\": \"^4.20.0\"\n }\n}"
response = http.request(request)
puts response.read_body{
"function": {
"id": "fn_abc123",
"slug": "order-bot",
"name": "Order Bot",
"runtime": "nodejs24",
"status": "draft",
"timeoutSec": 10,
"memoryMb": 256,
"httpEnabled": true,
"dependencies": {
"openai": "^4.20.0"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"publicUrl": "<string>",
"activeDeploymentId": "<string>"
}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "conflict",
"message": "A function with slug \"order-bot\" already exists"
}