Skip to main content
POST
/
api
/
user
/
embeddings
Get embedding chunks for an upload
curl --request POST \
  --url https://pria.praxislxp.com/api/user/embeddings \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "upload": "665a1b2c3d4e5f6789012300"
}
'
import requests

url = "https://pria.praxislxp.com/api/user/embeddings"

payload = { "upload": "665a1b2c3d4e5f6789012300" }
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({upload: '665a1b2c3d4e5f6789012300'})
};

fetch('https://pria.praxislxp.com/api/user/embeddings', 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/embeddings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'upload' => '665a1b2c3d4e5f6789012300'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://pria.praxislxp.com/api/user/embeddings"

payload := strings.NewReader("{\n \"upload\": \"665a1b2c3d4e5f6789012300\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/user/embeddings")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"upload\": \"665a1b2c3d4e5f6789012300\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://pria.praxislxp.com/api/user/embeddings")

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

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"upload\": \"665a1b2c3d4e5f6789012300\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": [
    {
      "_id": "665a1b2c3d4e5f6789012345",
      "chunkText": "This is a paragraph from the uploaded document...",
      "chunkLen": 512,
      "chunkIndex": 0,
      "upload": "665a1b2c3d4e5f6789012300",
      "chunkUrl": "#page=2",
      "created": "2023-11-07T05:31:56Z",
      "usage": 128
    }
  ],
  "embeddingModel": {
    "name": "text-embedding-3-small",
    "provider": "openai_cli",
    "maxInputTokens": 8191
  },
  "currentEmbeddingModel": {
    "name": "text-embedding-3-small",
    "provider": "openai_cli"
  },
  "chunkMaxChars": 8000
}
{
"success": false,
"message": "<string>",
"error": "<string>"
}
{
"success": false,
"message": "<string>",
"error": "<string>"
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
upload
string
required

The ID of the upload whose embedding chunks to retrieve

Example:

"665a1b2c3d4e5f6789012300"

Response

Embedding chunks retrieved successfully

success
boolean
Example:

true

data
object[]

Embedding chunks sorted by chunkIndex (max 1000)

embeddingModel
object | null

Model actually used to generate these chunks' vectors. Null when the upload has no recorded embedding model.

currentEmbeddingModel
object | null

The institution's currently-configured embedding model (what a re-ingestion would use). Compare against embeddingModel to detect drift.

chunkMaxChars
integer

Soft cap (characters) for segment edit/create UI. Matches the server-side RAG chunk-size constant so admin edits stay in lockstep with new ingestion output.

Example:

8000