Reference
Versioning
The API is at version 1 and Oxumi is an early build. This page says plainly what that means for anything you build on it.
How the API is versioned
The version is part of the path. There is no version header and there are no dated versions.
- It is not frozen. While the product is in early build, endpoints and fields may still change, including in ways that break existing code. There is no notice period yet.
- Write tolerant clients. Ignore fields you do not recognise, do not depend on the order of keys, and branch on HTTP status instead of message text.
- Webhook signatures carry their own version. The
v1=inOxumi-Signaturenames the signing scheme, independently of the API version.
- Current
- v1, the only version
- Where
- In the path: every endpoint starts with /v1
- Version header
- None
- Stability
- Early build; may still change
- Deprecation policy
- None yet
- Signature scheme
- v1, named in Oxumi-Signature
Version
What v1 contains
Agents List and retrieve. Read-only.Phone calls Place, list, retrieve and hang up.Text conversations Start, send a message and end.One webhook event call.completed, signed and retried.
What it does not contain:
Managing resourcesAgents, API keys and webhook endpoints are created and edited in the app.
PaginationGET /v1/calls reaches the 200 most recent calls and no further.
Idempotency keysSending POST /v1/calls twice places two calls.
SDKsSamples use each language's standard HTTP client.
Behaviour that is known to be wrong today is listed under Known issues.