Getting started
Your first search result in under a minute.
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.
Authorization: Bearer sk_live_YOUR_API_KEY2. 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_live_YOUR_API_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.
{
"results": [
{
"id": "abc123",
"text": "Matching document text...",
"metadata": { "title": "Document Title" }
}
],
"queryId": "qry_a1b2c3d4e5f6",
"latencyMs": 42
}What's next?
- Authentication -- API key management and scoping
- Search API -- Full endpoint reference and examples
- Error Reference -- Status codes and troubleshooting
Was this page helpful?