Get flow
GET
/
v1
/
agents
/
{agentId}
/
branches
/
{branchId}
/
flows
/
{flowId}
Get flow
curl --request GET \
--url https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}', 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.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
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.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"startStepId": "<string>",
"steps": [
{
"id": "<string>",
"type": "default_step",
"name": "<string>",
"prompt": "<string>",
"position": {
"x": 123,
"y": 123
},
"conditions": [
{
"id": "<string>",
"type": "exitFlowCondition",
"label": "<string>",
"description": "<string>",
"childStepId": "<string>",
"requiredEntities": [
"<string>"
]
}
],
"references": {
"entities": {},
"attributes": {},
"variables": {},
"extractedEntities": {},
"transitionFunctions": {},
"globalFunctions": {},
"sms": {},
"handoff": {}
},
"function": {
"id": "<string>",
"name": "<string>",
"code": "<string>",
"latencyControl": {
"enabled": true,
"randomize": true,
"initialDelay": 123,
"interval": 123
}
}
}
],
"transitionFunctions": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"description": "<string>",
"parameters": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"references": {
"flowSteps": {},
"variables": {}
}
}
]
}Authorizations
Last modified on November 4, 2026
Was this page helpful?
⌘I
Get flow
curl --request GET \
--url https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}', 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.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
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.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/flows/{flowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"startStepId": "<string>",
"steps": [
{
"id": "<string>",
"type": "default_step",
"name": "<string>",
"prompt": "<string>",
"position": {
"x": 123,
"y": 123
},
"conditions": [
{
"id": "<string>",
"type": "exitFlowCondition",
"label": "<string>",
"description": "<string>",
"childStepId": "<string>",
"requiredEntities": [
"<string>"
]
}
],
"references": {
"entities": {},
"attributes": {},
"variables": {},
"extractedEntities": {},
"transitionFunctions": {},
"globalFunctions": {},
"sms": {},
"handoff": {}
},
"function": {
"id": "<string>",
"name": "<string>",
"code": "<string>",
"latencyControl": {
"enabled": true,
"randomize": true,
"initialDelay": 123,
"interval": 123
}
}
}
],
"transitionFunctions": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"description": "<string>",
"parameters": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"references": {
"flowSteps": {},
"variables": {}
}
}
]
}
