Quickstart
Get up and running with ClinikAPI in three steps. The API lives athttps://api.clinikapi.com/v1 — the SDK targets it by default, so there is nothing to configure.
1. Get Your API Key
Sign up at dashboard.clinikapi.com and create an organization. You’ll get two keys:clk_test_*— routes to the shared test datastore (safe to experiment with)clk_live_*— routes to production (available on paid plans)
2. Install the SDK
3. Create a Patient
Search is eventually consistent. A freshly created resource can take a few
seconds (typically ~10s) to appear in
search results, while read(id) works
immediately. Always use the id returned by create for read-after-write —
never poll search to confirm a write. See
Data Consistency for the patterns.Response Format
Every SDK method returnsApiResponse<T>:
Using Test vs Live Keys
Test keys are available on all plans including Sandbox. Use them for development and testing — data is isolated from production.
Next Steps
- Authentication — how API keys and tenant isolation work
- Patients Guide — deep dive into patient operations
- Webhooks — get notified on resource changes
- Error Handling — handle errors gracefully