POST
/
v1
/
api
/
omni-flow-agents
Create Omni Flow Agent
curl --request POST \
  --url https://api.trillet.ai/v1/api/omni-flow-agents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '{
  "name": "<string>",
  "llmModel": "<string>",
  "settings": {}
}'
{  
  "workspaceId": "01a0sda156scx5f8",  
  "userId": "01a0sda156scx5f8",  
  "name": "ExampleOmniFlowAgent",  
  "llmModel": "gpt-4o-mini",  
  "phoneNumberId": null,  
  "status": "ready",  
  "createdAt": "2025-01-19T03:18:22.604Z",  
  "updatedAt": "2025-01-19T03:18:22.604Z"  
}  

Headers

x-api-key
string
required
API key used for authenticating requests to the API.
x-workspace-id
string
required
Workspace identifier for the API.

Request Body

name
string
required
Name of the agent being created.
llmModel
string
default:"gpt-4o-mini"
required
Language Model to be used by the agent to generate responses. (e.g. gpt-4o-mini, gpt-4o, gpt-4o-enterprise)
settings
object
Settings related to the agent.

Response Fields

workspaceId
string
Workspace ID associated with the agent.
userId
string
User ID of the agent creator.
name
string
Name of the agent.
llmModel
string
Language model used by the agent (e.g., gpt-4o-mini).
phoneNumberId
string
Phone number ID, if assigned to the agent.
status
string
Current status of the agent (e.g., ready).
createdAt
string
Timestamp when the agent was created.
updatedAt
string
Timestamp when the agent was last updated.
{  
  "workspaceId": "01a0sda156scx5f8",  
  "userId": "01a0sda156scx5f8",  
  "name": "ExampleOmniFlowAgent",  
  "llmModel": "gpt-4o-mini",  
  "phoneNumberId": null,  
  "status": "ready",  
  "createdAt": "2025-01-19T03:18:22.604Z",  
  "updatedAt": "2025-01-19T03:18:22.604Z"  
}