---
title: "Get Agent"
method: GET
path: "/v1/agents"
tags: ["agents"]
---

# Get Agent

`GET /v1/agents`

## Query parameters

- `id` string, uuid, required

## Response `200`

Successful Response

- Agent
  - `id` string, uuid, required
  - `user_id` string, uuid, required
  - `prompt` Prompt, required
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `content` string
    - `collect_fields` CollectField[]
      - `field_type` 'field_type_email', required
      - `label` string, required
      - `name` string, required
      - `description` string
    - `context_endpoint` string
    - `prompt_template` PromptTemplate
      - `id` string, uuid, required
      - `user_id` string, uuid, required
      - `label` string
      - `required_context_keys` string[], required
  - `language` 'en' | 'es' | 'de' — An enumeration.
  - `actions` union[], required
    - union
      - TransferCallAction
        - `id` string, uuid, required
        - `user_id` string, uuid, required
        - `type` 'action_transfer_call', required
        - `config` TransferCallConfig, required
          - `phone_number` string, required
      - EndConversationAction
        - `id` string, uuid, required
        - `user_id` string, uuid, required
        - `type` 'action_end_conversation', required
        - `config` EmptyActionConfig
      - DTMFAction
        - `id` string, uuid, required
        - `user_id` string, uuid, required
        - `type` 'action_dtmf', required
        - `config` EmptyActionConfig
  - `voice` union, required
    - AzureVoice
      - `id` string, uuid, required
      - `user_id` string, uuid, required
      - `type` 'voice_azure', required
      - `voice_name` string, required
      - `pitch` integer
      - `rate` integer
    - RimeVoice
      - `id` string, uuid, required
      - `user_id` string, uuid, required
      - `type` 'voice_rime', required
      - `speaker` string, required
      - `speed_alpha` number
    - ElevenLabsVoice
      - `id` string, uuid, required
      - `user_id` string, uuid, required
      - `type` 'voice_eleven_labs', required
      - `voice_id` string, required
      - `stability` number
      - `similarity_boost` number
      - `api_key` string
    - PlayHtVoice
      - `id` string, uuid, required
      - `user_id` string, uuid, required
      - `type` 'voice_play_ht', required
      - `voice_id` string, required
      - `api_user_id` string
      - `api_key` string
      - `version` '1' | '2'
  - `initial_message` string
  - `webhook` Webhook
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `subscriptions` EventType[], required
    - `url` string, required
    - `method` 'GET' | 'POST' — An enumeration.
  - `vector_database` PineconeVectorDatabase
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `type` 'vector_database_pinecone', required
    - `index` string, required
    - `api_key` string, required
    - `api_environment` string, required
  - `interrupt_sensitivity` 'low' | 'high' — An enumeration.
  - `context_endpoint` string
  - `noise_suppression` boolean
  - `endpointing_sensitivity` 'auto' | 'relaxed'
  - `ivr_navigation_mode` 'default' | 'off'
  - `conversation_speed` number

## Other responses

- `422` — Validation Error

## Changes

- **2023-10-13** `9feade6bcba8` — 2 breaking, 1 info
  - the response property `voice/oneOf[subschema #4: PlayHtVoice]/api_key` became optional for the status `200`
  - the response property `voice/oneOf[subschema #4: PlayHtVoice]/api_user_id` became optional for the status `200`
  - added the optional property `voice/oneOf[subschema #4: PlayHtVoice]/version` to the response with the `200` status
- **2023-10-05** `f4d951d6fa94` — 1 warning, 1 info
  - added the new `event_human_detection` enum value to the `webhook/subscriptions/items/` response property for the response status `200`
  - removed the `event_machine_detection` enum value from the `webhook/subscriptions/items/` response property for the response status `200`
- **2023-09-26** `eb14a21c478e` — 1 breaking, 2 info
  - the response property `prompt/content` became optional for the status `200`
  - added the optional property `prompt/prompt_template` to the response with the `200` status
  - the `content` response's property default value `` was added for the status `200`
- **2023-09-19** `bcd75d816789` — 1 info
  - added the optional property `conversation_speed` to the response with the `200` status
- **2023-09-07** `c9ae97ec337f` — 2 info
  - added the optional property `ivr_navigation_mode` to the response with the `200` status
  - added the optional property `voice/oneOf[subschema #2: RimeVoice]/speed_alpha` to the response with the `200` status

[Full history](https://skmtc.dev/vocodedev/apis/vocode-hosted-api/changes/v1/agents/get.md)

---

[API](https://skmtc.dev/vocodedev/apis/vocode-hosted-api.md) · [All operations](https://skmtc.dev/vocodedev/apis/vocode-hosted-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vocodedev/apis/vocode-hosted-api/revisions/9feade6bcba8?raw)