Contract snapshot 0.101.0 · Deployment and client release availability follow the integration note for your environment.
Choose the connected environment
Use the API base URL supplied for your environment. Production API address is https://api.rewalto.com; staging is https://api-dev.rewalto.com. The branded API cutover is complete; use the address for your environment. Check GET /v1/version against the integration note before relying on a capability.
Start with a read
Provide a Clerk session token or an organisation API key in the Authorization header. Keep the token in your server environment. This example reads identity and does not start a data run.
curl --fail-with-body "$REWALTO_CORE_API_URL/v1/whoami" \
-H "Authorization: Bearer $REWALTO_API_TOKEN"Then discover your data
Check the data reference for fields, pagination, freshness and charge behaviour. Review any published rate or quote before requesting chargeable data.
Check the first response
After the identity read, confirm that the returned organisation is the one you intended to use. Record the request identifier if the call fails. Correct the environment or credentials before moving on; a successful identity request does not establish that every data route is deployed or that your key has the scopes needed for it.
Make the next request small
Choose a documented read operation and a narrowly scoped input. Inspect the returned fields, missing values, pagination and receipt before adding a loop or scheduling repeated work. Keep the original response shape while you establish which fields the application actually needs.
GET
/v1/version
The API release that answered
No credentials needed. Use it to confirm which release a base URL runs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 429 | Error. The `error.code` is one of: - `rate_limited`: retry advice `after_reset` |
| 500 | Error. The `error.code` is one of: - `internal`: retry advice `bounded` |
| 503 | Error. The `error.code` is one of: - `unavailable`: retry advice `bounded` |
Full response fields and reusable schemas are in the downloadable OpenAPI contract.
GET
/v1/whoami
Who is calling, their organisation, role and plan
Accepts a Clerk session token or an API key. For a signed-in user without an organisation it creates one personal organisation on the first call (idempotent). A session token that carries `org_name` keeps the stored organisation name in step with Clerk. Costs nothing; the credits balance is GET /v1/credits/balance.
| Status | Meaning |
|---|---|
| 200 | Success |
| 401 | Error. The `error.code` is one of: - `key_expired`: retry advice `refresh_credentials` - `key_revoked`: retry advice `refresh_credentials` - `session_expired`: retry advice `refresh_credentials` - `unauthenticated`: retry advice `refresh_credentials` |
| 403 | Error. The `error.code` is one of: - `org_missing`: retry advice `never` |
| 429 | Error. The `error.code` is one of: - `rate_limited`: retry advice `after_reset` |
| 500 | Error. The `error.code` is one of: - `internal`: retry advice `bounded` |
| 503 | Error. The `error.code` is one of: - `unavailable`: retry advice `bounded` |
Full response fields and reusable schemas are in the downloadable OpenAPI contract.