API Overview
The DreamSolve API is a REST API that uses standard HTTP methods and returns JSON responses.
Base URL
https://dreamsolve.ai/api/v1
Authentication
All API endpoints require authentication using an API key. Include your API key in the x-api-key header with every request.
x-api-key: YOUR_API_KEY
Getting an API Key
To use the DreamSolve API, you first need to generate an API key. See the Generating API Keys guide for step-by-step instructions.
Example Request
curl -X GET \
-H "x-api-key: YOUR_API_KEY" \
https://dreamsolve.ai/api/v1/nodes
Response Format
All responses are returned in JSON format.
Success Response
{
"id": "123",
"name": "Example",
"created_at": "2024-01-15T10:00:00Z"
}
Error Response
{
"error": "Error description"
}
HTTP Status Codes
| Status Code | Description |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request - Missing or invalid parameters |
| 401 | Unauthorized - Invalid or missing API key |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Resource not found |
| 405 | Method Not Allowed |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |
Available Endpoints
Core Resources
| Endpoint | Description |
|---|---|
| /api/v1/nodes | Manage nodes (projects, tasks, etc.) |
| /api/v1/api-keys | Manage API keys |
AI & Agents
| Endpoint | Description |
|---|---|
| /api/v1/agents | Execute and manage AI agents |
| /api/v1/completions | Generate AI completions |
Organizations
| Endpoint | Description |
|---|---|
| /api/v1/organizations | Manage organization invitations |
Rate Limiting
API requests may be subject to rate limiting. If you exceed the rate limit, you will receive a 429 status code. Implement exponential backoff in your client to handle rate limiting gracefully.
Pagination
List endpoints may return paginated results for large datasets. Check the response for pagination metadata when working with collections.
Need Help?
If you encounter issues with the API, please check:
- Your API key is valid and included in the request headers
- The request body is properly formatted JSON
- All required parameters are provided
- You have the necessary permissions for the operation
For additional support, visit the DreamSolve documentation or contact support.