v1

latestOpenAPI 3.1.02026-07-135055368.9 KB

Agents

Update a Specific AI Agent by ID

put/v1/ai-agents/{agent_id}

Path parameters

agent_idstring required

ID of the agent

Request body

namestring required

Name of the AI agent

imageUrlstring required

Image URL for the AI agent

status'active' | 'inactive' required

rolestring required

Role of the AI agent in the company

roleDescriptionstring required

Description of the role of the AI agent

timezonestring required

Timezone of the AI agent used for scheduling meetings

Example request

{
  "name": "HelperBot",
  "imageUrl": "http://example.com/agent.png",
  "mission": {
    "prompt": "Check Trata AI docs on the specifics of prompting.",
    "objective": "This is a more easier version where the user dont have to given the entire prompt but just share the objective of the call and rest will be handled by Trata.",
    "greeting": "Hello! Thank you for taking the time to speak with me today.",
    "sequence": [
      {
        "stageName": "Introduction",
        "description": "This stage involves introducing the AI agent to the user and explaining the purpose of the call.",
        "otherNotes": "Ensure the user understands the privacy policy."
      }
    ]
  },
  "role": "Customer Support",
  "roleDescription": "Handles customer inquiries and support tasks",
  "timezone": "America/New_York"
}

Response

AI Agent updated successfully

idstring

orgIdstring

namestring

imageUrlstring

rolestring

roleDescriptionstring

statusstring

timezonestring

createdBystring

createdAtstring date-time

updatedBystring

updatedAtstring date-time

Example response

{
  "mission": {
    "prompt": "Check Trata AI docs on the specifics of prompting.",
    "objective": "This is a more easier version where the user dont have to given the entire prompt but just share the objective of the call and rest will be handled by Trata.",
    "greeting": "Hello! Thank you for taking the time to speak with me today.",
    "sequence": [
      {
        "stageName": "Introduction",
        "description": "This stage involves introducing the AI agent to the user and explaining the purpose of the call.",
        "otherNotes": "Ensure the user understands the privacy policy."
      }
    ]
  }
}