v2.4Sign In
Integration
API Overview
Connect to GuidedMind via REST API - architecture, authentication, and rate limits.
The GuidedMind REST API provides direct HTTP access to your RAG projects. Every request is authenticated via API key and follows standard REST conventions.
Architecture
Base URL
https://api.guidedmind.ai
Authentication
All requests require an API key passed via the X-API-Key header:
curl -H "X-API-Key: rk_your_key_here" \
https://api.guidedmind.ai/rag/searchGetting Your API Key
- Complete the RAG Wizard (Step 5: API Endpoints)
- Copy your key (starts with
rk_) - Store it in environment variables
Do
- Store in environment variables or secrets manager
- Use separate keys for dev/staging/production
- Rotate keys regularly
Don't
- Hardcode in source code
- Commit to version control
- Expose in client-side JavaScript
Available Endpoints
| Method | Endpoint | Purpose |
|---|---|---|
| POST | /rag/search | Search your document index |
| POST | /rag/upload | Upload a document |
| POST | /rag/upload-and-process | Upload and process immediately |
Rate Limits
| Plan | Requests/min | Requests/day |
|---|---|---|
| Free | 30 | 1,000 |
| Pro | 100 | 10,000 |
| Enterprise | Custom | Custom |
When rate limited, you'll receive a 429 response:
{
"error": "rate_limit_exceeded",
"message": "Too many requests. Retry after 30 seconds.",
"retry_after": 30
}Error Responses
All errors follow a consistent format:
{
"error": "error_code",
"message": "Human-readable description"
}| Status | Error Code | Description |
|---|---|---|
| 400 | bad_request | Invalid request format |
| 401 | authentication_failed | Invalid or missing API key |
| 403 | access_denied | API access disabled for project |
| 429 | rate_limit_exceeded | Rate limit reached |
| 500 | internal_error | Server error |
Integration Options
Choose your integration approach:
- Simple Python - Quick start with
requestslibrary - Per-Route Docs - Full payload documentation for each endpoint
- Python SDK - Type-safe client with async support
- MCP - Model Context Protocol for AI agents