API reference · Auth
Request OTP
Emails a six-digit code.
- Authentication
- None
- Retries
- Idempotency-Key
- Body
- application/json
- Version
- 2026-09-03
Passwordless sign-in and step-up authentication in one endpoint. The code is short because people retype it from a phone; its security comes from the ten-minute expiry and the five-attempt cap, not from its length.
Headers
Idempotency-KeystringA unique key of your choosing, so this request can be retried safely. The first request with a given key executes; every replay returns that first response unchanged, with
Idempotent-Replay: trueset.Generate one key per action, not per session - reusing a key with a different body is refused with 422 rather than silently replaying the wrong answer. Keys are remembered for 24 hours. A request that failed releases its key, so a retry after fixing the payload runs normally.
Up to 255 characters
Request body
application/json · required
EmailOnlyRequest
emailstring (email)required
Responses
- 200OKapplication/json
Message
messagestringrequiredokbooleanDefault: true
5 response headers
- RateLimit-Limit
Requests permitted in the current window.
- RateLimit-Remaining
Requests left in the current window. Back off before it reaches 0.
- RateLimit-Reset
Seconds until the current window resets.
- X-API-Version
The dated version of the API contract that served this response, e.g.
2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.- X-Request-ID
Quote this in a support request to identify the call.
- 422Validation error
The shared error envelope, served as
application/problem+jsonwitherror.codeset to validation_error. Its details name each field that failed and why.
Example request
curl -X POST "https://api.integrable.cloud/api/auth/otp/request" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"email": "sam@example.com"
}'Set INTEGRABLE_API_KEY first. The same call from the TypeScript or Python SDK takes the same fields.
Example response
{
"message": "string",
"ok": true
}Generated from the schema above — the shape is exact, the values are placeholders.
Errors
Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:
validation_error· 422 — The payload was well-formed JSON but failed schema validation.idempotency_key_reused· 422 — This `Idempotency-Key` was used before, for a request with a different body.rate_limited· 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-bot limit on top.
More Auth endpoints
- post/api/auth/accept-invitationAccept invitation
- post/api/auth/change-passwordChange password
- post/api/auth/forgot-passwordForgot password
- post/api/auth/googleComplete Google sign-in
- get/api/auth/google/startStart Google sign-in
- get/api/auth/identitiesList identities
- delete/api/auth/identities/{provider}Unlink identity
- get/api/auth/invitationPreview invitation
- post/api/auth/loginLog in
- post/api/auth/logoutLog out
- post/api/auth/logout-allLog out everywhere
- get/api/auth/meGet the current user
- get/api/auth/mfaMFA status
- post/api/auth/mfa/activateActivate MFA
- post/api/auth/mfa/disableDisable MFA
- post/api/auth/mfa/recovery-codesRegenerate recovery codes
- post/api/auth/mfa/setupSetup MFA
- post/api/auth/mfa/verifyVerify MFA
- get/api/auth/organizationsList my organizations
- post/api/auth/otp/verifyVerify OTP
- post/api/auth/refreshRefresh a session
- post/api/auth/registerRegister an account
- post/api/auth/resend-verificationResend verification
- post/api/auth/reset-passwordReset password
- get/api/auth/verification-statusVerification status
- post/api/auth/verify-emailVerify email
Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.