Quickstart

This guide creates an index, adds one document, and searches it with curl.

Run these commands from a trusted machine or backend. Never expose your API key in browser code.

Set your credentials

Use the production API URL and the API key supplied during onboarding.

export BREADBOWL_API_URL="https://embed.breadbowl.ai"
export BREADBOWL_API_KEY="qkv_live_..."

Create an index

curl --fail-with-body --silent --show-error \
  "$BREADBOWL_API_URL/v1/indexes" \
  -H "Authorization: Bearer $BREADBOWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"quickstart","text_retention":"none"}'

Copy the id from the response, then set it for the next requests:

export BREADBOWL_INDEX_ID="paste-index-id-here"

Add a document

curl --fail-with-body --silent --show-error \
  "$BREADBOWL_API_URL/v1/indexes/$BREADBOWL_INDEX_ID/documents" \
  -H "Authorization: Bearer $BREADBOWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "documents": [{
      "doc_id": "refund-policy",
      "text": "Refund requests are accepted within 30 days of purchase.",
      "metadata": {"status": "published"}
    }]
  }'

A successful response has "upserted_documents": 1 and "failed": [].

curl --fail-with-body --silent --show-error \
  "$BREADBOWL_API_URL/v1/indexes/$BREADBOWL_INDEX_ID/search" \
  -H "Authorization: Bearer $BREADBOWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"How long do I have to request a refund?"}'

The first result should reference refund-policy. In your application, use its doc_id to load the original text from your own datastore.

Next, learn how to ingest documents, use search results, or browse the complete API reference.

BreadBowl Embed (Alpha)Add documents

⌘I

Get started

Guides

Help