Assistants
Get Assistant
Retrieves detailed information about a specific assistant.
GET
/
api
/
v1
/
vendors
/
{vendorId}
/
organizations
/
{organizationId}
/
assistants
/
{assistantId}
Get Assistant Details
curl --request GET \
--url https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}import requests
url = "https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}', 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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}",
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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}"
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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}")
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{
"success": true,
"timestamp": "2025-04-17T14:23:30Z",
"message": "<string>",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Help Desk Assistant",
"systemPrompt": "You are a customer support assistant for ACME Gadgets. Be polite, helpful, and concise. Escalate complex issues to a human agent if necessary.",
"llmAudioContentGenerationStrategyId": "abcdef01-2345-6789-abcd-ef0123456789",
"extensions": [
{
"id": "deadbeef-cafe-babe-feed-faceabadb001",
"name": "Knowledge Base Search",
"type": "kb_search_v2",
"parameters": {
"kb_url": "https://kb.example.com/api",
"max_results": 3,
"auth_token": null
}
}
],
"callEventHooks": [
{
"id": "b00bface-1337-badd-cafe-d00df00dcafe",
"type": "webhook_transcript_ready_v1",
"parameters": {
"target_url": "https://my.internal.service/transcript",
"secret_key": "s3cr3t_tr4nscr1pt"
}
}
],
"systemPromptGreeting": "Hello! How can I help you with our products today?",
"telephoneNumberId": "11223344-5566-7788-9900-aabbccddeeff"
},
"traceId": "<string>"
}Path Parameters
ID of the Vendor (UUID)
ID of the Organization (UUID)
ID of the Assistant (UUID)
Response
Successfully retrieved assistant details
Standard API response wrapper
Indicates if the request was successful
Example:
true
Response timestamp in ISO-8601 format
Example:
"2025-04-17T14:23:30Z"
Human-readable message
Payload data object
Show child attributes
Show child attributes
Correlation or trace ID
Was this page helpful?
Previous
Update AssistantUpdates an existing assistant's configuration. Allows updating details, extensions, and call event hooks. Extensions and hooks can be modified or added (if ID is provided for update, null/missing for creation within the list).
Next
⌘I
Get Assistant Details
curl --request GET \
--url https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}import requests
url = "https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}', 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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}",
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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}"
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://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId}")
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{
"success": true,
"timestamp": "2025-04-17T14:23:30Z",
"message": "<string>",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Help Desk Assistant",
"systemPrompt": "You are a customer support assistant for ACME Gadgets. Be polite, helpful, and concise. Escalate complex issues to a human agent if necessary.",
"llmAudioContentGenerationStrategyId": "abcdef01-2345-6789-abcd-ef0123456789",
"extensions": [
{
"id": "deadbeef-cafe-babe-feed-faceabadb001",
"name": "Knowledge Base Search",
"type": "kb_search_v2",
"parameters": {
"kb_url": "https://kb.example.com/api",
"max_results": 3,
"auth_token": null
}
}
],
"callEventHooks": [
{
"id": "b00bface-1337-badd-cafe-d00df00dcafe",
"type": "webhook_transcript_ready_v1",
"parameters": {
"target_url": "https://my.internal.service/transcript",
"secret_key": "s3cr3t_tr4nscr1pt"
}
}
],
"systemPromptGreeting": "Hello! How can I help you with our products today?",
"telephoneNumberId": "11223344-5566-7788-9900-aabbccddeeff"
},
"traceId": "<string>"
}