Getting started

1. Get an API key

Create an API key from your API Keys page in the dashboard. Keys are scoped to your organization and optionally to specific collections.

There are two kinds. Start with a sandbox key (sk_test_): it returns canned results at no cost, so you can get the request shape right without spending credits. Swapping it for a live key (sk_live_) later changes nothing else about your integration.

Authorization: Bearer sk_test_YOUR_SANDBOX_KEY

2. Make your first request

Send a POST request to the search endpoint with your collection name and query text. That's all you need.

curl -X POST "https://api.redpine.ai/api/v1/search/query" \
  -H "Authorization: Bearer sk_test_YOUR_SANDBOX_KEY" \
  -H "Content-Type: application/json" \
  -d '{"collection": "my-collection", "query": "your search query"}'

3. Explore the response

Results are ranked by relevance. Each result includes the matched text and any metadata from the original document.

Because this used the sandbox key, the results are synthetic -- note synthetic and the sandbox- id. A live key returns the same shape with real content.

{
  "results": [
    {
      "id": "sandbox-0001-chunk-0",
      "text": "Lorem ipsum dolor sit amet...",
      "metadata": { "title": "Lorem ipsum dolor", "synthetic": true }
    }
  ],
  "queryId": "qry_a1b2c3d4e5f6",
  "latencyMs": 42
}

What's next?

• Sandbox -- what the sandbox key covers, and how to go live
• Authentication -- API key management and scoping
• Search API -- Full endpoint reference and examples
• Error Reference -- Status codes and troubleshooting