Skip to main content

Base URL

All API requests should be made to:
https://app.mycura.org/api/cura
Replace app.mycura.org with your Cura server domain.

Authentication

All API endpoints require authentication using an API key. Include your API key in the request headers:
X-API-Key: YOUR_API_KEY
Or as a query parameter:
?api_key=YOUR_API_KEY
Learn more about authentication.

Response Format

All API responses follow a consistent format:

Success Response

{
  "success": true,
  "response": "AI generated response text",
  "patient": { /* patient object when applicable */ }
}

Error Response

{
  "success": false,
  "error": "Error message describing what went wrong"
}

Available Endpoints

OpenAPI Specification

Access the complete OpenAPI specification at:
https://app.mycura.org/api/cura/openapi.json

Download OpenAPI Spec

Import into Postman, Insomnia, or generate client libraries

Error Codes

Status CodeDescription
200Success - Request completed successfully
201Created - Resource created successfully (patient creation)
400Bad Request - Invalid or missing required parameters
401Unauthorized - Invalid or missing API key
404Not Found - Resource doesn’t exist
409Conflict - Duplicate resource (e.g., patient with same phone)
500Internal Server Error - An unexpected error occurred