Ask the AI Assistant

Ask a question against a project's documentation. The answer is generated with RAG over the project's indexed content and streamed back as Server-Sent Events with citations.

This is the endpoint the embeddable chat widget uses — it's public (no API key required) but subject to visitor rate limits and the organization's monthly AI query quota.

Path Parameters

Request Body

Response

200 with Content-Type: text/event-stream. The X-Session-Id response header contains the session UUID to pass on follow-up questions.

The stream emits token deltas followed by a final message containing citations (source page paths) and a confidence score.

Example

curl -N https://api.syntext.dev/v1/projects/prj_abc123/chat \
-H "Content-Type: application/json" \
-d '{
"question": "How do I add a custom domain?",
"visitorId": "vis_9f8e7d"
}'

import { Syntext } from '@syntext/sdk'

const client = new Syntext('stx_abc12345_...')

const stream = await client.chat.ask('prj_abc123', {
question: 'How do I add a custom domain?',
})

for await (const chunk of stream) {
process.stdout.write(chunk.delta)
}

Error Responses

429 Rate Limited

The visitor asked too many questions in a short window. Configurable per project.

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests. Please wait before asking another question.",
    "retryAfterSeconds": 30
  }
}

403 Usage Limit Exceeded

The organization's monthly AI query quota is exhausted.

{
  "error": {
    "code": "USAGE_LIMIT_EXCEEDED",
    "message": "Monthly AI query limit reached (1000/1000). Upgrade your plan for more AI queries.",
    "current": 1000,
    "limit": 1000
  }
}

503 Service Unavailable

The AI assistant is not configured for this deployment.