Skip to Content
Introduction

Developer API

This API lets you build on top of your own document sets. Upload and index documents, then ask natural-language questions and get answers grounded in those documents — with citations back to the source files and pages.

The most common use is a chatbot: you send a question (plus any prior turns of the conversation) and receive an answer with citations. The same API also powers document browsing, conversation titles, and indexing automation.

What you can build

A chatbot over your docsConversation titlesDocument browsing UIsAutomated indexing pipelines

Base URL

All endpoints are served from your deployment’s base URL. Replace https://api.example.com in these docs with your own host.

https://api.example.com

Requests are authenticated with a bearer token. See Authentication before making your first call.

Conventions

  • All request and response bodies are JSON (Content-Type: application/json), except the chat streaming response, which is Server-Sent Events.
  • A docset (docSetName) is a named collection of indexed documents. Most endpoints operate on one or more docsets.
  • Timestamps are ISO 8601 strings.

Next steps

  1. Get a token and make an authenticated request — Authentication.
  2. Run your first query — Quickstart.
  3. Build a full chat experience, including streaming — Chatbot.
  4. Explore every endpoint interactively — API Reference.
Authentication