Skip to main content
GET
/
api
/
user
/
files
/
{uploadId}
/
kag-summary
Get KAG (knowledge graph) summary for a file
curl --request GET \
  --url https://pria.praxislxp.com/api/user/files/{uploadId}/kag-summary \
  --header 'x-access-token: <api-key>'
import requests

url = "https://pria.praxislxp.com/api/user/files/{uploadId}/kag-summary"

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/files/{uploadId}/kag-summary', 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/files/{uploadId}/kag-summary",
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/files/{uploadId}/kag-summary"

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/files/{uploadId}/kag-summary")
.header("x-access-token", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://pria.praxislxp.com/api/user/files/{uploadId}/kag-summary")

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,
  "exists": true,
  "notReady": true,
  "job": {
    "progress": {
      "percent": 123,
      "message": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "chunksProcessed": 1,
    "entitiesExtracted": 5,
    "relationshipsExtracted": 4,
    "recordsSeen": 123,
    "recordsValid": 123,
    "recordsInvalid": 123,
    "attempts": 123,
    "error": "<string>",
    "nextAttemptAt": "2023-11-07T05:31:56Z",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "llmProvider": "openrouter",
    "tokensIn": 1433,
    "tokensOut": 571
  }
}
{
"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

Path Parameters

uploadId
string
required

The upload ID

Response

KAG summary (may be {exists:false} or {notReady:true})

success
boolean
Example:

true

exists
boolean

false when no knowledge_graph_job has been enqueued yet

notReady
boolean

true when the embeddings DB connection is still opening; client should re-poll

job
object

Only present when exists=true