Skip to content

Direct API deployment

A Direct API deployment exposes your assistant over authenticated REST endpoints — for mobile apps, backend services, and custom UIs that do not use the web widget.

Direct APIWeb widget
Native apps, server-side chatEmbedded website chat
You control the entire UIChatevo provides chat UI + SSE streaming
Bearer/API key from your backendPublic embed with domain allowlist
  1. DeploymentsCreateDirect API.
  2. Name and Assistant selection.
  3. Environmentdevelopment, staging, production.
  4. Note deployment ID and create API keys for your server.
  5. Configure rate limits as needed.

Use the Messages API with your deployment context:

  1. Create or continue a conversation.
  2. POST a message — assistant runs RAG and tools same as widget.
  3. Optional: consume streaming responses if your client supports SSE.

Reference: API overview, OpenAPI spec.

Tool execution is identical to the widget. API responses may include structured rich content payloads when result_transform applies — your client renders them or maps to your UI.

  • Never expose API keys in mobile apps — proxy through your backend.
  • Rotate keys on compromise; per-environment keys recommended.
  • Same credential vault powers tools — not exposed via Direct API.