API Reference
Complete REST API documentation for CoderSwap AI's hybrid search platform
Base URL
https://api.coderswap.aiAuthentication
All API requests require authentication via the X-API-Key header.
X-API-Key: YOUR_API_KEYNote: Get your API key from Dashboard → API Keys. Keep your key secure and never expose it in public code.
Endpoints
/v1/searchSearch your indexed documents using hybrid semantic + keyword search.
Request Body
{
"query": "your search query",
"project_id": "5e4ab3b7",
"snippet_length": 200
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | Yes | Search query text |
| project_id | string | Yes | Project identifier (8-character code) |
| snippet_length | integer | No | Maximum snippet length in characters (default: 150) |
Response
{
"success": true,
"results": [
{
"id": "abc123",
"snippet": "How to reset your password...",
"score": 0.92,
"uri": null,
"metadata": {
"page": "5",
"section": "account"
}
}
],
"total_results": 1,
"settings_version": "v1"
}Dashboard OnlyDocument uploads are currently available through the web dashboard only. Navigate to your project and use the upload interface.
Supported Formats
- • PDF (.pdf)
- • Microsoft Word (.docx)
- • Markdown (.md)
- • Plain Text (.txt)
Storage Limits: Free: 100 MB • Pro ($19/mo): 1 GB • Business ($49/mo): 5 GB
📝 Coming Soon: Programmatic document upload API endpoint will be available in a future release.
Error Codes
| Code | Description |
|---|---|
| 200 | Request successful |
| 401 | Invalid or missing API key |
| 403 | Quota exceeded or unauthorized operation |
| 429 | Rate limit exceeded |
| 500 | Internal server error |
Rate Limits
Rate limits are enforced per API key and vary by tier:
Free
60 requests/min
10K calls/month
Pro ($19/mo)
600 requests/min
100K calls/month
Business ($49/mo)
1,200 requests/min
500K calls/month
When rate limited, you'll receive a 429 response withx-ratelimit-* headers indicating your limit, remaining requests, and reset time.
Ready to get started?
Try our interactive quickstart guide with working code examples.