Get agent

curl --request GET \
  --url https://api.elemente.ai/api/v1/agents/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.elemente.ai/api/v1/agents/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.elemente.ai/api/v1/agents/{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.elemente.ai/api/v1/agents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$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.elemente.ai/api/v1/agents/{id}"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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.elemente.ai/api/v1/agents/{id}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.elemente.ai/api/v1/agents/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "id": "1234567890",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "language": "en-US",
  "active": true,
  "voiceSpeed": 1.5,
  "voiceId": "1234567890",
  "capabilities": [
    "capability1",
    "capability2"
  ],
  "jobDescriptions": "Job description 1",
  "roleText": "Role text 1",
  "actions": [
    {
      "id": "1234567890",
      "name": "Action 1",
      "action": "action1",
      "parameters": {}
    }
  ],
  "skills": [
    {
      "id": "1234567890",
      "name": "Skill 1",
      "description": "Description of the skill 1",
      "language": "en-US",
      "active": true
    }
  ],
  "phone": "+1234567890",
  "updatedAt": "2022-01-01T00:00:00.000Z",
  "createdAt": "2022-01-01T00:00:00.000Z"
}

GET

api

agents

{id}

Get agent

curl --request GET \
  --url https://api.elemente.ai/api/v1/agents/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.elemente.ai/api/v1/agents/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.elemente.ai/api/v1/agents/{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.elemente.ai/api/v1/agents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$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.elemente.ai/api/v1/agents/{id}"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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.elemente.ai/api/v1/agents/{id}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.elemente.ai/api/v1/agents/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "id": "1234567890",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "language": "en-US",
  "active": true,
  "voiceSpeed": 1.5,
  "voiceId": "1234567890",
  "capabilities": [
    "capability1",
    "capability2"
  ],
  "jobDescriptions": "Job description 1",
  "roleText": "Role text 1",
  "actions": [
    {
      "id": "1234567890",
      "name": "Action 1",
      "action": "action1",
      "parameters": {}
    }
  ],
  "skills": [
    {
      "id": "1234567890",
      "name": "Skill 1",
      "description": "Description of the skill 1",
      "language": "en-US",
      "active": true
    }
  ],
  "phone": "+1234567890",
  "updatedAt": "2022-01-01T00:00:00.000Z",
  "createdAt": "2022-01-01T00:00:00.000Z"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

string

required

The id of the agent

Response

The requested AI agent

string

required

The id of the agent

Example:

"1234567890"

name

string | null

required

The name of the agent

Example:

"John Doe"

string | null

required

The email of the agent

Example:

"john.doe@example.com"

language

string | null

required

The language of the agent

Example:

"en-US"

active

boolean | null

required

The active status of the agent

Example:

true

voiceSpeed

number | null

required

The voice speed of the agent

Example:

1.5

voiceId

string | null

required

The voice id of the agent

Example:

"1234567890"

capabilities

string[] | null

required

The capabilities of the agent

Example:

["capability1", "capability2"]

jobDescriptions

string | null

required

The job descriptions of the agent

Example:

"Job description 1"

roleText

string | null

required

The role text of the agent

Example:

"Role text 1"

actions

string[] | null

required

The actions of the agent

Example:

[
  {
    "id": "1234567890",
    "name": "Action 1",
    "action": "action1",
    "parameters": {}
  }
]

skills

string[] | null

required

The skills of the agent

Example:

[
  {
    "id": "1234567890",
    "name": "Skill 1",
    "description": "Description of the skill 1",
    "language": "en-US",
    "active": true
  }
]

phone

string | null

required

The phone number of the agent

Example:

"+1234567890"

updatedAt

string<date-time> | null

required

The updatedAt date of the agent

Example:

"2022-01-01T00:00:00.000Z"

createdAt

string<date-time> | null

required

The createdAt date of the agent

Example:

"2022-01-01T00:00:00.000Z"

Create agent Update agent