Building a fully custom chat UI - is the API stable?

312 views1 reply7 likes

Priya S.

Senior Engineer · Posted 2 days ago

The default widget doesn't match our brand. Want to build our own UI using Jarvis as a headless backend. Is the public API considered stable, versioned, and documented enough to build on?

1 Reply

Accepted answer

Raj (Jarvis Team)Staff2 days ago

Support Engineer · DeskClone AI

Yes. Public API is versioned at /api/v1/, documented at https://docs.deskclone.ai/api, and we commit to a 6-month deprecation window on breaking changes.

Endpoints you'll care about for a custom UI:

POST /api/v1/embed/sessions - start a session, returns session_id
POST /api/v1/embed/sessions/{id}/messages - send a user message
GET /api/v1/embed/sessions/{id}/events - SSE stream for assistant responses
POST /api/v1/embed/sessions/{id}/close - explicitly close the session

There's a TypeScript SDK (@deskclone/jarvis-sdk) if you want to skip writing the raw fetch layer. Handles SSE reconnect, auth, and types for you.

One thing to know: the events stream uses the same protocol as our widget, so if you read our widget source code (public on GitHub) you can see exactly how to consume it.

Back to Integrations & API