PUT
/
v1
/
api
/
omni-flow-agents
/
{agentId}
curl --request PUT \
  --url https://api.trillet.ai/v1/api/omni-flow-agents/{agentId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '{
  "name": "<string>",
  "llmModel": "<string>",
  "ttsModel": {
    "provider": "<string>",
    "voiceId": "<string>"
  }
}'
{
  "_id": "agentIdExample",
  "workspaceId": "workspaceIdExample",
  "userId": "userIdExample",
  "name": "Updated Agent Name",
  "llmModel": "gpt-4o-mini",
  "phoneNumberId": "phoneNumberIdExample",
  "settings": {
    "customSetting": "value"
  },
  "status": "ready",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-02T12:00:00Z"
}

​
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.

​
Path Parameters

​
agentId
string
required

The unique identifier of the agent to update

​
Request Body

​
name
string

New name for the agent

​
llmModel
string

New language model to use

​
ttsModel
object

​
Response Fields

​
_id
string

The unique identifier for the OmniFlowAgent.

​
workspaceId
string

The identifier of the workspace where the OmniFlowAgent is configured.

​
userId
string

The identifier of the user associated with the OmniFlowAgent, if any.

​
name
string

The name of the OmniFlowAgent.

​
llmModel
string

The language model used by the OmniFlowAgent, such as ‘gpt-4o-mini’.

​
phoneNumberId
string

The identifier of the phone number associated with the OmniFlowAgent.

​
settings
object

A flexible schema for storing custom settings related to the OmniFlowAgent.

​
status
string

The operational status of the OmniFlowAgent, such as ‘pending’, ‘ready’, or ‘error’.

​
createdAt
string

Timestamp when the conversation was created.

​
updatedAt
string

Timestamp when the conversation was last updated.

{
  "_id": "agentIdExample",
  "workspaceId": "workspaceIdExample",
  "userId": "userIdExample",
  "name": "Updated Agent Name",
  "llmModel": "gpt-4o-mini",
  "phoneNumberId": "phoneNumberIdExample",
  "settings": {
    "customSetting": "value"
  },
  "status": "ready",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-02T12:00:00Z"
}