Base URL and responses

Foundation for every HTTP call: hosts, path versioning, required headers, and the common error and pagination envelopes.

Hosts

All REST paths in this documentation are relative to /v1 on the host you choose. Example:

GET https://sandbox-api.udai.live/v1/assets

See Environments and the Sandbox for access policy.

Path versioning

Public routes are served under the /v1 path prefix. Breaking changes to request or response contracts increment the path version. Clients continue to call /v1 until they deliberately move to a later prefix.

Required headers

Most operational routes require:

Authentication routes and exceptions are defined in Access control. Session issuance is documented in Authentication.

Error response format

Errors use a single JSON shape:

{
  "error": "Bad Request",
  "message": "Missing required field 'email'",
  "status_code": 400,
  "timestamp": "2025-07-17T11:45:00Z",
  "path": "/v1/auth/register"
}

Common status codes

Endpoint pages document which of these codes that route returns.

Pagination

List endpoints that page results accept:

Successful list responses use:

{
  "message": "Resources retrieved successfully",
  "data": [],
  "pagination": {
    "total_records": 142,
    "total_pages": 3,
    "current_page": 1,
    "per_page": 50,
    "has_next": true,
    "has_previous": false
  }
}