API Documentation
MyRSD Assessment API
Integrate RSD assessments directly into your Electronic Patient Record system. Create assessments, retrieve results, and receive real-time notifications.
Quick Start
Get up and running in minutes
1
Contact Us
Request API access for your clinic account
2
Generate API Key
Create an API key from your dashboard settings
3
Create Assessment
POST to /api/v1/assessments with patient details
4
Get Results
Retrieve results via API or webhook notification
Authentication
All API requests require authentication using a Bearer token. Include your API key in the Authorization header:
curl -X POST https://rsdrs.com/api/v1/assessments \
-H "Authorization: Bearer myrsd_sk_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{"assessment_for": "self", "age_band": "adult", "sex": "female"}'Security: API keys are shown only once at creation. Store them securely and never expose them in client-side code.
Base URL
https://rsdrs.com/api/v1API Endpoints
POST
/assessmentsCreate a new assessment for a patient. Returns an assessment URL to send to the patient.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| patient_reference | string | Optional | Your internal patient ID (returned in results and webhooks) |
| string | Optional | Patient email for sending the assessment link | |
| assessment_for | string | Required | "self" or "child" |
| age_band | string | Required | "adult", "adolescent", or "child" |
| sex | string | Required | "male", "female", or "other" |
| callback_url | string | Optional | Override webhook URL for this assessment only |
Example Request
POST /api/v1/assessments
Content-Type: application/json
Authorization: Bearer myrsd_sk_xxxxx
{
"patient_reference": "PAT-12345",
"email": "patient@example.com",
"assessment_for": "self",
"age_band": "adult",
"sex": "female"
}Response (201 Created)
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"assessment_url": "https://myrsd.com/assessment/take?token=xxx",
"status": "pending",
"patient_reference": "PAT-12345",
"created_at": "2024-01-15T10:00:00Z",
"expires_at": "2024-01-22T10:00:00Z"
}Rate Limits
| Tier | Requests/Minute | Monthly Assessments |
|---|---|---|
| Standard | 30 | 100 |
| Professional | 60 | 500 |
| Unlimited | 120 | Unlimited |
When rate limited, the API returns HTTP 429 with a Retry-After header indicating when to retry.
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request - Invalid or missing parameters |
| 401 | Unauthorized - Invalid or missing API key |
| 403 | Forbidden - API access not enabled or insufficient permissions |
| 404 | Not Found - Assessment does not exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error - Contact support |
Error Response Format
{
"error": "Invalid API key",
"code": "UNAUTHORIZED"
}