Uruguay Guide / API docs

DEVELOPER REFERENCE

Uruguay Guide Chat API

Connect to the Uruguay assistant, inspect the knowledge index, and synchronize published content.

OpenAPI 3.1Uruguay · UYDownload specification

Base URL

This installation

Use the same origin as this page. All request and response bodies are JSON, except explicitly requested event streams.

Authentication

Browser chat and health checks need no key. Send X-API-Key for /v1/*.

Integration keys can chat. Administration keys can also inspect the index and synchronize knowledge. Keep keys on your server.

QUICK START

Ask a question

The browser route fixes the country to Uruguay. Do not send a country or excludeSourceIds field to /api/chat. For trusted server integrations, use /v1/chat and include country: "UY".

SAFE TO TRY

Check this installation

These checks do not send a chat request or call the AI provider.

Choose a check to see its live response.

REFERENCE

Endpoints

Loading the API specification…

STREAMING

Treat streamed text as a draft

Send Accept: text/event-stream to POST /api/chat. When streaming is enabled, the server sends SSE frames containing JSON data. If the installation disables streaming, the same request returns JSON.

EventDataClient behavior
status{"phase":"planning"}Show progress. Phases: planning, retrieving, generating, verifying.
delta{"text":"…"}Append provisional answer text. Verification is not finished.
reset{}Clear every draft fragment before a retry, refusal, or failure.
doneComplete ChatResponseReplace the draft with the final result and sources. Only this event may be saved to conversation history.
error{"code":"…","status":502,"message":"…"}Discard the draft and show a retry state. Headers may already have HTTP status 200.

Comments such as : keep-alive are heartbeats. A connection ending without done is an interrupted response. Cancel the fetch when the visitor starts another chat or leaves the page.

Errors and response headers

Errors contain a stable code, a safe message, and a request ID. Validation rejects unknown fields. Respect Retry-After after HTTP 429; retry evidence-change responses by asking the question again.

{
  "error": {
    "code": "unauthorized",
    "message": "A valid X-API-Key is required.",
    "requestId": "example-request-id"
  }
}

The server returns X-Request-ID. Chat and administration responses should be treated as private operational data. No credentials are included in this documentation.