Agents

List All AI Agents

List All AI Agents

get/v1/ai-agents

Request

  • Base URL
    https://api.trata.ai
  • URL
    https://api.trata.ai/v1/ai-agents
  • Auth
    HTTP bearer

Query parameters

search_bystring nullable

Field name to search by

search_valuestring nullable

Value to search for in the specified field

statusstring nullable

Filter by status

sort_bystring nullable

Field to sort by

sort_order'asc' | 'desc'

Sort order (asc or desc)

skipinteger

Number of records to skip

limitinteger

Maximum number of records to return

Response

List of AI Agents 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."
        }
      ]
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.