Before you begin
The public OpenAPI document describes a preview contract. It is not an invitation to send requests to a public production API, and its reserved .invalid hostnames must never receive credentials.
An authorized tenant engagement supplies the real base URL, identity configuration, scopes, resource access, and limits.
Evaluation sequence
- Read the OpenAPI 3.1 document and authentication guidance.
- Confirm that the required resource and operation are enabled for your tenant.
- Obtain a tenant-approved identity and least-privilege scopes.
- Use a tenant-assigned API hostname; never substitute an unverified host.
- Begin with read-only operations and preserve request IDs for support.
- For mutations, use an idempotency key and honor human-review and policy gates.
Illustrative request
This example is a template only and cannot run until Aevah supplies the tenant-specific values.
curl --request GET \
--url "$AEVAH_API_BASE/entities?limit=25" \
--header "Authorization: Bearer $AEVAH_ACCESS_TOKEN" \
--header "Accept: application/json"
