Skip to content
POST/api/v1/ask

Ask with conversation context

POST variant for multi-turn / context-window chat sessions on top of the platform's data.

Authentication

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

Request body required

Example

{
  "question": "string",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "conversationId": "string",
  "pageContext": {
    "pathname": "string"
  }
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "question": {
          "type": "string",
          "minLength": 1,
          "maxLength": 8000
        },
        "projectId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "conversationId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "pageContext": {
          "type": "object",
          "properties": {
            "pathname": {
              "type": "string",
              "maxLength": 512
            }
          },
          "additionalProperties": false
        }
      },
      "required": [
        "question",
        "projectId"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Response.
400(no description)
401(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/ask \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "question": "string", "projectId": "00000000-0000-0000-0000-000000000000", "conversationId": "string", "pageContext": { "pathname": "string" } }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/ask",
  body: {
    "question": "string",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "conversationId": "string",
    "pageContext": {
      "pathname": "string"
    }
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/ask",
    body={
    "question": "string",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "conversationId": "string",
    "pageContext": {
        "pathname": "string"
    }
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"question":"string","projectId":"00000000-0000-0000-0000-000000000000","conversationId":"string","pageContext":{"pathname":"string"}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/ask", 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

400401429

Other NL Pipeline endpoints