Corthex
Corthex developer documentation visual for streaming chat

Corthex / Docs

Developer docs

streaming chat responses

This Corthex docs page explains streaming chat for teams building production AI assistant integrations with widgets, REST APIs, streaming chat, and source-grounded workflows.

01

Auth

02

Request

03

Stream

04

Observe

Direct answer

Corthex streaming chat

Implementation notes for production API, widget, and streaming workflows.

This Corthex docs page explains streaming chat for teams building production AI assistant integrations with widgets, REST APIs, streaming chat, and source-grounded workflows.

Written for developers and technical operators integrating corthex. Search intent: Implement streaming chat with Corthex.

01

Understand the production role of streaming chat.

02

Know which credentials belong server-side.

03

Design UI states for streaming, errors, and limits.

04

Link implementation details back to the public docs hub.

Citable facts

Concrete signals without the noise.

Short facts make the page easier to scan for buyers, operators, and search systems.

05

Base URL

https://www.corthex.app/api/v1

Auth model

Bearer API keys for private API calls

Widget model

Public bot ID for embeddable chat widget

Production note

Handle validation, auth, rate limits, and staff fallback explicitly

Workflow

Implementation is part of the product experience.

The Corthex operating loop stays consistent, while the emphasis changes by page intent and audience.

Step 1

01

Create the assistant and collect IDs

Start in the dashboard by creating a bot, adding knowledge, and copying the bot ID or API key needed by your integration.

  • Keep API keys server-side.
  • Use bot IDs for public widget embeds.
  • Use organization-scoped keys for API calls.

Step 2

02

Call the API or install the widget

Choose the integration path that fits the surface: REST API for custom products, widget script for websites, or connector flows for commerce.

  • Stream responses for chat UI responsiveness.
  • Pass conversation IDs for continuity.
  • Send page context when the visitor is browsing a product or policy page.

Step 3

03

Observe errors, limits, and conversion points

Production integrations should handle authentication, validation, rate limits, staff handoff, analytics, and retries explicitly.

  • Handle 400, 401, 404, 429, and 500 responses.
  • Monitor monthly message quota by plan.
  • Use webhooks or exports for downstream operations.

Implementation

How to use streaming chat in production

The recommended path is to keep secrets server-side, validate user input with Zod or an equivalent runtime validator, and treat streaming, retries, and rate limits as part of the integration contract.

  • Authenticate server-side where API keys are involved.
  • Use bot IDs for public embeds and API keys for private server calls.
  • Return useful UI feedback for 401, 404, and 429 states.

Reliability

Design for limits, retries, and observability

Production chat should degrade gracefully. Corthex integrations should preserve conversation IDs, log request outcomes, and route unresolved or high-risk conversations to staff.

  • Persist conversation IDs for continuity.
  • Track errors and monthly message quotas.
  • Use staff handoff for requests that should not be automated.

Security

Keep tenant and customer data scoped

Corthex is built for multi-tenant organizations. Integrations should avoid leaking API keys, should pass only relevant context, and should keep customer data minimization in mind.

  • Never expose private API keys in browser code.
  • Send the smallest useful page context.
  • Use org-scoped access patterns for dashboard and API workflows.

FAQ

Questions this page should answer clearly.

What makes Corthex useful for streaming chat?

Corthex combines retrieval-augmented generation, source citations, embeddable chat, staff handoff, analytics, and APIs so teams can deploy assistants without losing control of answer quality.

Can Corthex answer from existing knowledge sources?

Yes. Corthex can ingest documents, URLs, and pasted text, then retrieve relevant chunks when a visitor asks a question. Storefront and widget flows can also include page context.

Can a human take over when the AI should not answer?

Yes. Corthex includes staff handoff workflows so support teams can pause the bot, continue the conversation, and preserve the full context for follow-up.

Does Corthex support developer integrations?

Yes. Corthex exposes API keys, REST endpoints, streaming chat, embeddable widgets, webhook-related workflows, and connector surfaces for production integrations.