Skip to main content

​
API Overview

The Gradiant API is built on modern REST principles, providing secure and efficient access to our healthcare platform’s features. Our API supports both REST and GraphQL interfaces, with built-in security measures and HIPAA compliance.

​
API Architecture

Authentication

Secure your API requests

Rate Limiting

Understand usage limits

Versioning

API version compatibility

Error Handling

Handle API responses

​
Base URL

https://api.gradiant.dev/v1
All API requests must use HTTPS. HTTP requests will be rejected.

​
Authentication

curl -X GET "https://api.gradiant.dev/v1/user" \
  -H "Authorization: Bearer <YOUR-API-TOKEN>"

​
Rate Limiting

Our rate limits are based on the type of API token and endpoint being accessed.
PlanRate LimitBurst Limit
Developer100/min200/min
Professional1000/min2000/min
EnterpriseCustomCustom

​
Response Format

{
  "data": {
    // Response data
  },
  "meta": {
    "requestId": "req_123",
    "timestamp": "2024-03-21T10:30:00Z"
  }
}

​
Error Handling

{
  "error": {
    "code": "validation_error",
    "message": "Invalid input parameters",
    "details": {
      "field": "email",
      "issue": "Invalid email format"
    }
  },
  "meta": {
    "requestId": "req_123",
    "timestamp": "2024-03-21T10:30:00Z"
  }
}

​
Available Endpoints

​
User Management

​
POST /users
endpoint
Create a new user account
​
GET /users/{id}
endpoint
Retrieve user information
​
PUT /users/{id}
endpoint
Update user details

​
Session Management

​
POST /sessions
endpoint
Create a new therapy session
​
GET /sessions/{id}
endpoint
Retrieve session details
​
PUT /sessions/{id}
endpoint
Update session information

​
Analytics

​
GET /analytics/sessions
endpoint
Retrieve session analytics
​
GET /analytics/users
endpoint
Retrieve user analytics

​
SDKs and Libraries

Python SDK

Official Python client

TypeScript SDK

Official TypeScript client

Go SDK

Official Go client

​
Webhooks

Webhooks require HTTPS endpoints with valid SSL certificates.
{
  "event": "session.completed",
  "data": {
    "sessionId": "sess_123",
    "completedAt": "2024-03-21T10:30:00Z"
  }
}

​
Best Practices

1
Use Appropriate Authentication Always use secure authentication methods
2
Handle Rate Limits Implement proper rate limit handling and backoff
3
strategies ### Monitor Usage Track your API usage and set up alerts

​
Support

Need help with the API? Contact our developer support:

Developer Discord

Join our developer community

API Support

Contact API support team