Skip to content
POST/api/v1/traces/rag-diagnostics

RAG-span diagnostics

Runs RAGDiagnosticEngine over a single RAG span. Body is the full RAGSpan: traceId, spanId, query, retrievedChunks[], contextSentToLLM, llmResponse, model, latencyMs, tokenCount (400 INVALID_PAYLOAD if any are missing/mistyped).

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Request body required

Example

{
  "traceId": "string",
  "spanId": "string",
  "query": "string",
  "retrievedChunks": [
    {
      "id": "string",
      "documentId": "string",
      "documentName": "string",
      "content": "string",
      "score": 0,
      "position": 0
    }
  ],
  "contextSentToLLM": "string",
  "llmResponse": "string",
  "model": "string",
  "latencyMs": 0,
  "tokenCount": 0
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "traceId",
        "spanId",
        "query",
        "retrievedChunks",
        "contextSentToLLM",
        "llmResponse",
        "model",
        "latencyMs",
        "tokenCount"
      ],
      "properties": {
        "traceId": {
          "type": "string"
        },
        "spanId": {
          "type": "string"
        },
        "query": {
          "type": "string"
        },
        "retrievedChunks": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "documentId",
              "documentName",
              "content",
              "score",
              "position"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "documentId": {
                "type": "string"
              },
              "documentName": {
                "type": "string"
              },
              "content": {
                "type": "string"
              },
              "score": {
                "type": "number"
              },
              "position": {
                "type": "number"
              }
            }
          }
        },
        "contextSentToLLM": {
          "type": "string"
        },
        "llmResponse": {
          "type": "string"
        },
        "model": {
          "type": "string"
        },
        "latencyMs": {
          "type": "number"
        },
        "tokenCount": {
          "type": "number"
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200RAG diagnostics result.
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/traces/rag-diagnostics \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "traceId": "string", "spanId": "string", "query": "string", "retrievedChunks": [ { "id": "string", "documentId": "string", "documentName": "string", "content": "string", "score": 0, "position": 0 } ], "contextSentToLLM": "string", "llmResponse": "string", "model": "string", "latencyMs": 0, "tokenCount": 0 }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/traces/rag-diagnostics", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "traceId": "string",
    "spanId": "string",
    "query": "string",
    "retrievedChunks": [
      {
        "id": "string",
        "documentId": "string",
        "documentName": "string",
        "content": "string",
        "score": 0,
        "position": 0
      }
    ],
    "contextSentToLLM": "string",
    "llmResponse": "string",
    "model": "string",
    "latencyMs": 0,
    "tokenCount": 0
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/traces/rag-diagnostics",
    headers=headers,
    json={
    "traceId": "string",
    "spanId": "string",
    "query": "string",
    "retrievedChunks": [
        {
            "id": "string",
            "documentId": "string",
            "documentName": "string",
            "content": "string",
            "score": 0,
            "position": 0
        }
    ],
    "contextSentToLLM": "string",
    "llmResponse": "string",
    "model": "string",
    "latencyMs": 0,
    "tokenCount": 0
},
)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"traceId":"string","spanId":"string","query":"string","retrievedChunks":[{"id":"string","documentId":"string","documentName":"string","content":"string","score":0,"position":0}],"contextSentToLLM":"string","llmResponse":"string","model":"string","latencyMs":0,"tokenCount":0}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/traces/rag-diagnostics", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429500

Other Traces endpoints