Developers
API documentation.
What you can talk to today, and what we are still building. Everything on this page is either live, or explicitly marked as not yet available.
What exists today.
Three things, all of them about getting Tidalock running on your machine.
Activation keys
Issued with your trial application. Used to activate the desktop app.
Download links
Personal, time-limited links to the current installer, issued from our delivery server.
Trial applications
The form behind "Get your free trial". Submitting it creates your key and your download link.
Not yet available: a public REST API, client SDKs, or a hosted API base URL. This page will not pretend otherwise.
Authentication.
Two different things get called "a key" around Tidalock. One of them exists today.
Format: TDK-XXXX-XXXX-… (blocked upper-case letters and digits). Paste it into the desktop app to activate your install. Shown masked by default after you apply; you can reveal and copy it. The full plaintext appears once more only when you regenerate it. Our database stores only a hash of it.
If and when a public API opens, its keys will be designed separately: scopes, expiry and rotation, all published before anything ships.
- This key is shown only once — save it now.
- Never commit it to a repository or share it in chat or email.
- Lost it? Generate a new one from API Management.
Endpoints.
Nothing below is a public API. The first table is what our own pages call today; the second is the shape of the API we intend to document — filled in when it exists, not before.
| Method & path | What it does | Identifies you by | Status |
|---|---|---|---|
POST /api/apply | Submits a trial application and issues your activation key and download link | None (public form) | Live |
POST /api/auth/otp/request / POST /api/auth/otp/verify | Email one-time code (for coming back) | None | Live |
GET /api/keys | Reads the display id of your key and your download link (never the plaintext key) | Session cookie | Live |
POST /api/keys/regenerate | Issues a new key (the old one stops working immediately) | Session cookie | Live |
POST /api/keys/revoke | Revokes your key | Session cookie | Live |
POST /api/download-link | Issues a personal, time-limited download link | Internal (delivery console) | Live |
POST /api/events | On-site analytics (page behaviour) | None | Live |
POST /api/chat / POST /api/demo-chat | On-site AI chat (support widget / demo page) | None | Live |
These are the interfaces our own pages use. They are not a public API and carry no compatibility promise for third parties.
| Item | Value |
|---|---|
| Base URL | To be defined |
| Versioning | To be defined |
| Authentication | To be defined |
| Read / query endpoint | To be defined |
| Task submission endpoint | To be defined |
| Rate limits & pagination | To be defined |
| Client SDKs | Not yet available |
We would rather leave these blank than fill them with guesses.
Error codes.
The site endpoints above already return machine-readable codes. A catalogue for a public API will be published together with the API itself.
| Code | HTTP | What it means |
|---|---|---|
missing_email | 400 | trial form submitted without an email |
invalid_email | 400 | the email is not a valid address |
missing_role | 400 | role was left out (required field) |
consent_required | 400 | DPDP consent not ticked (required) |
invalid_json / bad_json | 400 | request body is not valid JSON |
invalid_code / invalid_input | — | wrong one-time code / invalid input (returned in the "error" field) |
unauthenticated | 401 | session missing or expired |
lead_not_found | 404 | no trial application on record for that email |
issue_failed | 500 | issuing the key or link failed |
regenerate_failed / revoke_failed | 500 | regenerate or revoke failed |
- HTTP status taken from source; codes returned in an "error" field are marked "—".
- A public API error catalogue: not yet available.
Where to go next.
- API Management→
View, copy, regenerate or revoke your activation key.
- Status→
Service status for the hosted parts.
- Apply for the trial→
Get a key and the current installer.
Get your key, then read this page.
One month free · No credit card · Files stay on your machine.