API reference

Last updated: July 14, 2026

Use these endpoints to query indexed website content from your agents and backend services. All site-scoped routes use the site UUID from your dashboard.

Search endpoint · Requirements · Errors

Base URL

https://chatwithyoursite.com

Authentication

All API routes require an API key with the search ability.

Authorization: Bearer cwy_your_api_key_here

Default rate limit is 60 requests per minute per key. You can set a lower limit when you create a key.

Requirements

The site must be Ready (crawl finished and content indexed).
The API key must belong to the site owner and include the search ability.
Use the site UUID from the dashboard, not the numeric database id.

Search indexed content

Semantic search over chunks from a ready site. Use this before generating a reply in your own agent or chat UI.

POST /api/sites/{site}/search

Request body

{
  "query": "refund policy",
  "limit": 10
}

query — required, max 500 characters
limit — optional, 1–50, defaults to 20

Response

{
  "data": [
    {
      "content": "Our refund policy allows returns within 30 days...",
      "page_title": "Returns & refunds",
      "page_url": "https://example.com/refunds",
      "similarity": 0.82
    }
  ]
}

Example

curl -X POST https://chatwithyoursite.com/api/sites/550e8400-e29b-41d4-a716-446655440000/search \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer cwy_your_api_key_here" \
  -d '{"query":"refund policy","limit":5}'

Errors

401 — Missing or invalid API key
403 — Key lacks the search ability, or the site is not yours
422 — Validation failed (for example an empty query)
429 — Rate limit exceeded