Get Agent

GET /agents/{agent_id}

Get Agent

cURL

curl --request GET \
  --url https://api-west.millis.ai/agents/{agent_id}

import requests

url = "https://api-west.millis.ai/agents/{agent_id}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api-west.millis.ai/agents/{agent_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-west.millis.ai/agents/{agent_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-west.millis.ai/agents/{agent_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-west.millis.ai/agents/{agent_id}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-west.millis.ai/agents/{agent_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "name": "<string>",
  "config": {
    "prompt": "<string>",
    "voice": {
      "voice_id": "<string>",
      "model": "<string>",
      "settings": {}
    },
    "flow": {
      "user_start_first": true,
      "interruption": {
        "allowed": true,
        "keep_interruption_message": true,
        "first_messsage": true
      },
      "response_delay": 123,
      "auto_fill_responses": {
        "response_gap_threshold": 123,
        "messages": [
          "<string>"
        ]
      },
      "agent_terminate_call": {
        "enabled": true,
        "instruction": "<string>",
        "messages": [
          "<string>"
        ]
      },
      "voicemail": {
        "message": "<string>",
        "continue_on_voice_activity": true
      },
      "call_transfer": {
        "phone": "<string>",
        "phones": [
          {
            "phone": "<string>",
            "description": "<string>"
          }
        ],
        "instruction": "<string>",
        "messages": [
          "<string>"
        ]
      },
      "inactivity_handling": {
        "idle_time": 123,
        "message": "<string>"
      },
      "dtmf_dial": {
        "enabled": false,
        "instruction": "<string>"
      }
    },
    "first_message": "<string>",
    "tools": [
      {
        "name": "<string>",
        "description": "<string>",
        "params": [
          {
            "name": "<string>",
            "required": true,
            "type": "<string>",
            "description": "<string>"
          }
        ],
        "webhook": "<string>",
        "header": {},
        "method": "<string>",
        "timeout": 123,
        "run_after_call": true,
        "messages": [
          "<string>"
        ],
        "execute_after_message": true,
        "exclude_session_id": true
      }
    ],
    "millis_functions": [
      {
        "name": "<string>",
        "description": "<string>",
        "data": {
          "param": {
            "description": "<string>",
            "name": "<string>",
            "required": true,
            "type": "<string>"
          }
        },
        "type": "<string>",
        "messages": [
          "<string>"
        ]
      }
    ],
    "app_functions": [
      {
        "name": "<string>",
        "credentials": {}
      }
    ],
    "custom_llm_websocket": "<string>",
    "language": "en-US",
    "vad_threshold": 123,
    "llm": {
      "temperature": 0,
      "history_settings": {
        "history_message_limit": 123,
        "history_tool_result_limit": 123
      }
    },
    "session_timeout": {
      "max_duration": 123,
      "max_idle": 123,
      "message": "<string>"
    },
    "session_data_webhook": "<string>",
    "privacy_settings": {
      "opt_out_data_collection": true,
      "do_not_call_detection": false
    },
    "custom_vocabulary": {
      "keywords": {}
    },
    "extra_prompt_webhook": "<string>",
    "switch_language": {
      "languages": [
        "<string>"
      ]
    },
    "knowledge_base": {
      "files": [
        "<string>"
      ],
      "messages": [
        "<string>"
      ]
    },
    "speech_to_text": {
      "multilingual": true,
      "model": "<string>"
    },
    "call_settings": {
      "enable_recording": false,
      "background": {
        "url": "<string>",
        "volume": 123
      }
    },
    "memory": {
      "user_identifier_key": ""
    },
    "timezone": "<string>"
  },
  "created_at": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

authorization · string | null

Private Key

Path Parameters

agent_id · string · required

Response

200

application/json

Successful Response

id · string · required

name · string · required

config · AgentConfig · object · required

Show child attributes

created_at · integer · required