curl --request GET \
--url https://api.zapier.com/agentic-management/v0/{workflow_id}/intent \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.zapier.com/agentic-management/v0/{workflow_id}/intent"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.zapier.com/agentic-management/v0/{workflow_id}/intent', 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.zapier.com/agentic-management/v0/{workflow_id}/intent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zapier.com/agentic-management/v0/{workflow_id}/intent"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zapier.com/agentic-management/v0/{workflow_id}/intent")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zapier.com/agentic-management/v0/{workflow_id}/intent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intent": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}{
"errors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "bad-request",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {
"cap": "messages_per_day",
"used": 123,
"cap_value": 123,
"reset_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"errors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "bad-request",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {
"cap": "messages_per_day",
"used": 123,
"cap_value": 123,
"reset_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"errors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "bad-request",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {
"cap": "messages_per_day",
"used": 123,
"cap_value": 123,
"reset_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"errors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "bad-request",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {
"cap": "messages_per_day",
"used": 123,
"cap_value": 123,
"reset_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"errors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "bad-request",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {
"cap": "messages_per_day",
"used": 123,
"cap_value": 123,
"reset_at": "2023-11-07T05:31:56Z"
}
}
]
}Get the declared intent for a workflow version
Returns the natural-language intent that applies to one workflow version: what the owner said that version of the workflow is for. Intent belongs to the version it was recorded against, so a version with no intent of its own reads as intent: null. It never inherits the text of another version. A consumer can tell “never captured” apart from an error. Omit workflow_version_id to read the workflow’s current published version. A workflow with nothing published answers 200 with every field null rather than an error.
curl --request GET \
--url https://api.zapier.com/agentic-management/v0/{workflow_id}/intent \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.zapier.com/agentic-management/v0/{workflow_id}/intent"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.zapier.com/agentic-management/v0/{workflow_id}/intent', 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.zapier.com/agentic-management/v0/{workflow_id}/intent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zapier.com/agentic-management/v0/{workflow_id}/intent"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zapier.com/agentic-management/v0/{workflow_id}/intent")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zapier.com/agentic-management/v0/{workflow_id}/intent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intent": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}{
"errors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "bad-request",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {
"cap": "messages_per_day",
"used": 123,
"cap_value": 123,
"reset_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"errors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "bad-request",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {
"cap": "messages_per_day",
"used": 123,
"cap_value": 123,
"reset_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"errors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "bad-request",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {
"cap": "messages_per_day",
"used": 123,
"cap_value": 123,
"reset_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"errors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "bad-request",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {
"cap": "messages_per_day",
"used": 123,
"cap_value": 123,
"reset_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"errors": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"about": "<string>"
},
"status": "<string>",
"code": "bad-request",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {
"cap": "messages_per_day",
"used": 123,
"cap_value": 123,
"reset_at": "2023-11-07T05:31:56Z"
}
}
]
}Authorizations
OAuth 2.0 authentication.
- Authorization URL
- https://zapier.com/oauth/authorize
- Token URL
- https://zapier.com/oauth/token
- Token URL
- https://zapier.com/oauth/token
Path Parameters
Workflow ID to query.
Query Parameters
The workflow version to read the intent of. Intent belongs to one immutable version, not to the workflow as a whole. When omitted, the workflow's current published version is used, and the response reports which version answered. A version that belongs to a different workflow returns 404.
Response
OK
The workflow the intent belongs to.
The workflow version this read or write targeted, so a caller that omitted the parameter learns which version answered. null only on a read of a workflow that has nothing published yet.
The intent recorded against this version, or null when this version has none. Intent is never carried over from another version: text recorded against one version never answers a read of another.
When the intent was last written; null when never captured.
Was this page helpful?