v1

latestOpenAPI 3.1.02026-07-135055368.9 KB
Agents

Get a Specific AI Agent by ID

Get a Specific AI Agent by ID

get/v1/ai-agents/{agent_id}

Path parameters

agent_idstring required

ID of the agent

ID of the agent

Response

AI Agent retrieved 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."
      }
    ]
  }
}