---
title: "List All AI Agents"
method: GET
path: "/v1/ai-agents"
tags: ["Agents"]
---

# List All AI Agents

`GET /v1/ai-agents`

List All AI Agents

## Query parameters

- `search_by` string, nullable — Field name to search by
- `search_value` string, nullable — Value to search for in the specified field
- `status` string, nullable — Filter by status
- `sort_by` string, nullable — Field to sort by
- `sort_order` 'asc' | 'desc'
- `skip` integer — Number of records to skip
- `limit` integer — Maximum number of records to return

## Response `200`

List of AI Agents retrieved successfully

- AIAgentOutput[]
  - `id` string
  - `orgId` string
  - `name` string
  - `imageUrl` string
  - `mission` Mission
    - `prompt` string, nullable — Full prompt instructions for LLM model
    - `objective` string, nullable — Objective of the mission
    - `greeting` string, nullable, required — Greeting message to be read by the AI agent
    - `sequence` Sequence[], nullable — Sequence of actions to be performed by the AI agent during the conversation.
      - `stageName` string, required — Name of the stage
      - `description` string, required — Description of the stage
      - `otherNotes` string, nullable — Other notes that AI agent should know in this stage of conversation
    - `farewell` string, nullable — Conclusion message to be read by the AI agent
  - `role` string
  - `roleDescription` string
  - `transcriber` Transcriber
    - `providerName` string
    - `transcriberModel` string, nullable
    - `providerProps` object, nullable
  - `intelligenceProvider` IntelligenceProvider
    - `providerName` string, nullable
    - `model` string, nullable
    - `providerProps` object, nullable
  - `voice` VoiceOutput
    - `gender` 'Male' | 'Female' | 'Neutral', required
    - `languageAccent` LanguageAccentCombo, required
      - `language` 'English' | 'Spanish' | 'Hindi', required
      - `accent` 'American' | 'Indian' | 'Australian' | 'British' | 'Hindi', required
    - `modelId` string, required
  - `status` string
  - `timezone` string
  - `createdBy` string
  - `createdAt` string, date-time
  - `updatedBy` string
  - `updatedAt` string, date-time

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/tratahq/apis/trata-ai-api.md) · [All operations](https://skmtc.net/tratahq/apis/trata-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tratahq/trata-ai-api/revisions/8f7b69ee5a90/schema)
