Get Omni Flow Agent

curl --request GET \
  --url https://api.trillet.ai/v1/api/omni-flow-agents/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'

import requests

url = "https://api.trillet.ai/v1/api/omni-flow-agents/{id}"

headers = {
    "x-api-key": "<api-key>",
    "x-workspace-id": "<x-workspace-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<api-key>', 'x-workspace-id': '<x-workspace-id>'}
};

fetch('https://api.trillet.ai/v1/api/omni-flow-agents/{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.trillet.ai/v1/api/omni-flow-agents/{id}",
  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>",
    "x-workspace-id: <x-workspace-id>"
  ],
]);

$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.trillet.ai/v1/api/omni-flow-agents/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-workspace-id", "<x-workspace-id>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.trillet.ai/v1/api/omni-flow-agents/{id}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-workspace-id"] = '<x-workspace-id>'

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

{
  "workspaceId": "674b9687d56a35c024db9cce",
  "userId": "674b9687d56a35c024db9ccc",
  "name": "test",
  "llmModel": "gpt-4o-mini",
  "phoneNumberId": null,
  "status": "ready",
  "createdAt": "2025-01-19T03:18:22.604Z",
  "updatedAt": "2025-01-19T03:18:22.604Z",
  "messageChannel": "SMS"
}

GET

api

omni-flow-agents

{id}

Get Omni Flow Agent

curl --request GET \
  --url https://api.trillet.ai/v1/api/omni-flow-agents/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'

import requests

url = "https://api.trillet.ai/v1/api/omni-flow-agents/{id}"

headers = {
    "x-api-key": "<api-key>",
    "x-workspace-id": "<x-workspace-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<api-key>', 'x-workspace-id': '<x-workspace-id>'}
};

fetch('https://api.trillet.ai/v1/api/omni-flow-agents/{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.trillet.ai/v1/api/omni-flow-agents/{id}",
  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>",
    "x-workspace-id: <x-workspace-id>"
  ],
]);

$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.trillet.ai/v1/api/omni-flow-agents/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-workspace-id", "<x-workspace-id>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.trillet.ai/v1/api/omni-flow-agents/{id}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-workspace-id"] = '<x-workspace-id>'

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

{
  "workspaceId": "674b9687d56a35c024db9cce",
  "userId": "674b9687d56a35c024db9ccc",
  "name": "test",
  "llmModel": "gpt-4o-mini",
  "phoneNumberId": null,
  "status": "ready",
  "createdAt": "2025-01-19T03:18:22.604Z",
  "updatedAt": "2025-01-19T03:18:22.604Z",
  "messageChannel": "SMS"
}

Headers

string

required

API key used for authenticating requests to the API.

string

required

Workspace identifier for the API.

Path Parameters

string

required

The unique identifier of the agent.

{
  "workspaceId": "674b9687d56a35c024db9cce",
  "userId": "674b9687d56a35c024db9ccc",
  "name": "test",
  "llmModel": "gpt-4o-mini",
  "phoneNumberId": null,
  "status": "ready",
  "createdAt": "2025-01-19T03:18:22.604Z",
  "updatedAt": "2025-01-19T03:18:22.604Z",
  "messageChannel": "SMS"
}

Response Fields

string

Workspace ID associated with the agent.

string

User ID of the agent creator.

string

Name of the agent.

string

Language model used by the agent (e.g., gpt-4o-mini).

object

The phone number ID associated with the agent, if available.

string

Current status of the agent (e.g., ready).

string

Timestamp when the agent was created.

string

Timestamp when the agent was last updated.

string

The channel used by the agent for communication (e.g., SMS).

API Reference V1

Workspaces

Calls

Batch Calls

Telephony

Conversations

Folder Management

Call Flows

Message Flows

Call Agents

Omni Flow Agents (Message)

Knowledge Base

Active Calls

Recordings

Get Omni Flow Agent

Headers

Path Parameters

Response Fields