Skip to main content
GET
/
api
/
user
/
assistant
/
{id}
Get a single assistant by ID
curl --request GET \
  --url https://pria.praxislxp.com/api/user/assistant/{id} \
  --header 'x-access-token: <api-key>'
import requests

url = "https://pria.praxislxp.com/api/user/assistant/{id}"

headers = {"x-access-token": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};

fetch('https://pria.praxislxp.com/api/user/assistant/{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://pria.praxislxp.com/api/user/assistant/{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 => [
"x-access-token: <api-key>"
],
]);

$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://pria.praxislxp.com/api/user/assistant/{id}"

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

req.Header.Add("x-access-token", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://pria.praxislxp.com/api/user/assistant/{id}")
.header("x-access-token", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://pria.praxislxp.com/api/user/assistant/{id}")

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

request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "instructions": "<string>",
    "picture_url": "<string>",
    "liked_count": 123,
    "admin_only": true,
    "institution_shared": true,
    "account_shared": true,
    "editable_others": true,
    "remember_history": 123,
    "ragEnabled": true,
    "bypassSystemContext": true,
    "conversationModel": "<string>",
    "stsConversationModel": "<string>",
    "argument_5": "<string>",
    "user": "<string>",
    "institution": "<string>",
    "user_data": {
      "email": "<string>",
      "fname": "<string>",
      "lname": "<string>",
      "institution": "<string>",
      "accountType": "<string>"
    },
    "institution_data": {
      "name": "<string>",
      "ainame": "<string>",
      "status": "<string>",
      "picture": "<string>"
    },
    "account_data": {
      "_id": "<string>",
      "name": "<string>",
      "status": "<string>"
    },
    "created": "2023-11-07T05:31:56Z"
  }
}
{
"success": false,
"error": {},
"message": "Invalid Assistant Id"
}
{
"success": false,
"message": "Authentication Required"
}
{
"success": false,
"message": "Not authorized to view this assistant"
}
{
"success": false,
"message": "Assistant not found"
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

id
string
required

The ObjectId of the assistant to retrieve

Response

Successfully retrieved assistant

success
boolean
Example:

true

data
object | null

Most recently used assistant in this course. Mobile/web use this to restore conversation context on the next turn. Null if the assistant was deleted or not found.