Skip to main content
PUT
/
v0
/
agents
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "llmProvider": "<string>",
  "model": "<string>",
  "instruction": "<string>",
  "channelProvider": "<string>",
  "isConnectedToChannel": true,
  "isActive": true,
  "address": "<string>",
  "name": "<string>",
  "createdBy": "<string>",
  "orgId": "<string>",
  "webhookUrl": "<string>",
  "webhookSecret": "<string>",
  "eventConfigs": [
    {
      "id": "<string>",
      "agentId": "<string>",
      "displayName": "<string>",
      "key": "<string>",
      "description": "<string>",
      "schema": {
        "name": "apppointment_request",
        "schema": {
          "type": "object",
          "properties": {
            "email": {
              "type": "string",
              "description": "The email address of the user."
            },
            "age": {
              "type": "number",
              "description": "The age of the user."
            }
          },
          "required": [
            "email"
          ],
          "additionalProperties": false
        },
        "strict": true
      },
      "waitForResponse": true,
      "stopConversation": true,
      "isActive": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "isDeleted": true,
  "deletedAt": {}
}

Authorizations

​
Authorization
string
header
required

Example: Bearer <YOUR_API_KEY>

Body

application/json
​
id
string
required

The UUID of the agent to update.

Example:

"110c9c3f-9024-48ba-8b1e-968d7a5bf7dc"

​
channelProvider
enum<string>

The channel provider to connect to. Supported: OUTLOOK (Microsoft 365), GMAIL (Google Workspace).

Available options:
OUTLOOK,
GMAIL
Example:

"GMAIL"

​
address
string

The email address the agent will use to send and receive messages.

Example:

"[email protected]"

​
isActive
boolean

Whether the agent is active.

Example:

true

​
description
string

A description for the agent.

Example:

"Handles support emails for the team."

​
name
string

The display name for the agent.

Example:

"Support Bot"

​
webhookUrl
string

The webhook URL to receive events for this agent.

Example:

"https://api.example.com/webhook"

​
webhookSecret
string

The alphanumeric secret that will be sent along with each webhook request as X-Monsteria-Webhook-Secret header.

Example:

"supersecret"

​
eventConfigs
object[]

The event configurations associated with the agent.

​
llmProvider
enum<string>

The LLM provider for the agent. Supported: OPENAI. Coming soon: ANTHROPIC.

Available options:
OPENAI
Example:

"OPENAI"

​
model
enum<string>

The LLM model to use for the agent. E.g., gpt-4, gpt-3.5-turbo, claude-2, etc.

Available options:
gpt-4,
gpt-4.1,
gpt-4.1-mini,
gpt-4.1-nano,
gpt-4o,
gpt-4o-mini
Example:

"gpt-4.1"

​
instruction
string

Instructions and guidelines for the agent.

Example:

"You are a receptionist at a dental clinic. Your task is to assist patients in scheduling, rescheduling, or canceling appointments."

​
isDeleted
boolean

Whether the agent is deleted (soft delete).

Example:

false

Response

​
id
string
required
​
llmProvider
string
required
​
model
string
required
​
instruction
string
required
​
channelProvider
string
required
​
isConnectedToChannel
boolean
required
​
isActive
boolean
required
​
address
string
required
​
name
string
required
​
createdBy
string
required
​
orgId
string
required
​
webhookUrl
string
required
​
webhookSecret
string
required
​
eventConfigs
object[]
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
isDeleted
boolean
required
​
deletedAt
object
required