Update Omni Flow Agent

PUThttps://api.trillet.ai/v1/api/omni-flow-agents/{agentId}

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Path Parameters

agentIdstringrequired

The unique identifier of the agent to update

Request Body

namestring

New name for the agent

llmModelstring

New language model to use

ttsModelobject

Response Fields

_idstring

The unique identifier for the OmniFlowAgent.

workspaceIdstring

The identifier of the workspace where the OmniFlowAgent is configured.

userIdstring

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

namestring

The name of the OmniFlowAgent.

llmModelstring

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

phoneNumberIdstring

The identifier of the phone number associated with the OmniFlowAgent.

settingsobject

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

statusstring

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

createdAtstring

Timestamp when the conversation was created.

updatedAtstring

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"
}