Invoke an active Frames v2 function
curl --request POST \
--url https://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"input": "<unknown>",
"context": {
"timezone": "<string>"
}
}
'import requests
url = "https://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations"
payload = {
"input": "<unknown>",
"context": { "timezone": "<string>" }
}
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({input: '<unknown>', context: {timezone: '<string>'}})
};
fetch('https://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations', 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://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations",
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([
'input' => '<unknown>',
'context' => [
'timezone' => '<string>'
]
]),
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://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations"
payload := strings.NewReader("{\n \"input\": \"<unknown>\",\n \"context\": {\n \"timezone\": \"<string>\"\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://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"input\": \"<unknown>\",\n \"context\": {\n \"timezone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations")
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 \"input\": \"<unknown>\",\n \"context\": {\n \"timezone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"invocation": {
"sId": "<string>",
"functionId": "<string>",
"status": "created",
"createdAt": "2023-11-07T05:31:56Z"
},
"outcome": {
"status": "succeeded",
"result": "<unknown>"
}
}Private Frames
Invoke an active Frames v2 function
Resolves a bare function name from the Frame’s active immutable publication, checks Frame use rights, and starts an invocation pinned to that publication.
POST
/
api
/
w
/
{wId}
/
frames
/
{frameId}
/
functions
/
{name}
/
invocations
Invoke an active Frames v2 function
curl --request POST \
--url https://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"input": "<unknown>",
"context": {
"timezone": "<string>"
}
}
'import requests
url = "https://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations"
payload = {
"input": "<unknown>",
"context": { "timezone": "<string>" }
}
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({input: '<unknown>', context: {timezone: '<string>'}})
};
fetch('https://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations', 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://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations",
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([
'input' => '<unknown>',
'context' => [
'timezone' => '<string>'
]
]),
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://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations"
payload := strings.NewReader("{\n \"input\": \"<unknown>\",\n \"context\": {\n \"timezone\": \"<string>\"\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://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"input\": \"<unknown>\",\n \"context\": {\n \"timezone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dust.tt/api/w/{wId}/frames/{frameId}/functions/{name}/invocations")
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 \"input\": \"<unknown>\",\n \"context\": {\n \"timezone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"invocation": {
"sId": "<string>",
"functionId": "<string>",
"status": "created",
"createdAt": "2023-11-07T05:31:56Z"
},
"outcome": {
"status": "succeeded",
"result": "<unknown>"
}
}Authorizations
Your DUST API key is a Bearer token.
Path Parameters
Bare function name declared by the active Frame publication.
Body
application/json