API reference

Use the API reference when you need exact endpoint paths, request bodies, response schemas, parameters, and examples.

For guided workflows, start with the guides. For conceptual background, use the concepts section.

Authentication

Most API requests require an access token.

Your integration gets an access token by exchanging API credentials at the authentication endpoint. Use the returned token as a bearer token on subsequent requests.

$
Authorization: Bearer ACCESS_TOKEN

Get an access token

1
curl -X POST https://api.hi.umnai.com/oauth/token \
2
     -H "Content-Type: application/x-www-form-urlencoded" \
3
     -d "grant_type=client_credentials" \
4
     -d "client_id=62608e08adc29a8d6dbc9754e659f125" \
5
     -d "client_secret=37b599fa-8a7f-495e-a3d4-1e5f824a522f"

1
{
2
  "access_token": "eyJhbGaiOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCx6Ijg5YzlmMzdhIn0.eyJzdWIiOiI4ZjQxOWE2Zi1lNDUxLTRiYjItYmQ0Ny1kZGIxZjVmYjM1N2MiLCJuYW1lIjoiSm9zZXBoIE1hc2luaSIsImVtYWlsIjoiam9zZXBoLm1hc2luaUB1bW5haS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibWV0YWRhdGEiOnsibGFzdFRlcm1zQ2hlY2siOiIyMDI1LTAyLTI4VDE3OjA3OjU2LjU3M1oifSwicm9sZXMiOlsiQWRtaW4iXSwicGVybWlzc2lvbnMiOlsiZmUuYWNjb3VudC1zZXR0aW5ncy5yZWFkLmFwcCIsImZlLmNvbm5lY3Rpdml0eS4qIiwiZmUuc2VjdXJlLioiLCJ1bW5haS5tb2RlbHMuZGVsZXRlLnBlcm1hbnRlbnRseURlbGV0ZSJdLCJ0ZW5hbnRJZCI6ImNmNWIwOTNlLTdmNjUtNDgwZS05ODEwLTdmZWI3ODY0OTIyMiIsInRlbmFudElkcyI6WyJjMDU1MmUzZC00ZWI0LTQyODktOTg2Yi1mMGVkMWU0YWM3OWMiLCJjZjViMDkzZS03ZjY1LTQ4MGUtOTgxMC03ZmViNzg2NDkyMjIiXSwicHJvZmlsZVBpY3R1cmVVcmwiOiJodHRwczovL3d3dy5ncmF2YXRhci5jb20vYXZhdGFyLzA3ZDQ1YmE5Nzk2MDExZGQ5ZmRiZDJiMzkyZmM5NDdkP2Q9aHR0cHM6Ly91aS1hdmF0YXJzLmNvbS9hcGkvSm9zZXBoK01hc2luaS8xMjgvcmFuZG9tIiwiZXh0ZXJuYWxJZCI6bnVsbCwicGhvbmVOdW1iZXIiOm51bGwsInNpZCI6ImJmZmZjZjNmLTE3ODkt4GRhNi1hN2JkLThkZTRkMGUwODYwYiIsInR5cGUiOiJ1c2VyVG9rZW4iLCJhcHBsaWNhdGlvbklkIjoiZmJhMzE3YjQtNmIyMS00NjZhLTlkMjktZDZjZTNlZWEzZWVhIiwiYXVkIjoiODljOWYzN2EtMmQyNC00ZmE2LWJlMTItYjkxOGM4ZmIzZDEzIiwiaXNzIjoiaHR0cHM6Ly9hcHAtaXIwZXhsajh0a3ZnLmZyb250ZWdnLmNvbSIsImlhdCI6MTc3NDU0MDA1MSwiZXhwIjoxNzc3MTMyMDUxfQ.WTbu-NBi9NSxn9y4tusGJIentDWkDWF2uwcGwp3Ms_2e7yxyqJLSjYXgLjj3oZUs-oVbTJaRmFDPK7B5x8eiyUoD7WxhkcOBTwzFMkcQMkVEVCxCO_zeI_xVPz1auxiKmfNEMcToYMpxkiX401b5Oq_59vESpZPvWhsrV-eLxnADsEV8B2hGEmemAcb_64JJIHipyDfpclpznMzirE6KEJ6AEMlE3BedKV2g0Zb_jsBsQNxY-ZH-EgcGYSc8ft8JlhQZCvva32YD8Z2eJV3BIycGsEs9vnMd1RXiEL3ZrJm7T9S_fzKkIQ5d2Qarg9PAdNBOIPYFsb2Y2klkvs-GsQ",
3
  "token_type": "Bearer",
4
  "expires_in": 2592000
5
}

Account credentials use grant_type: "client_credentials" with a client_id and client_secret.

Make your first request

After you have an access token, call any authenticated endpoint with the Authorization header.

1
curl https://api.hi.umnai.com/accounts \
2
     -H "Authorization: Bearer <token>"

Use this request to confirm that authentication works and that your credentials can access the expected accounts.

Response formats

Most API responses are JSON.

View endpoints often return tabular data using a split-orientation dataframe structure:

1
{
2
  "columns": ["column_name"],
3
  "index": [0],
4
  "data": [["value"]]
5
}

See the View response structure guide for how to read view outputs.

Long-running requests

Some operations may return 202 Accepted instead of the final result immediately.

When this happens, the response includes a Location header. Poll the URL in the Location header to retrieve the completed result.

Errors and troubleshooting

When a request fails, check the status code and response body first.

For troubleshooting, keep the request ID from the response headers when available. Include it when contacting support so the request can be traced more easily.

Compatibility

The API may add new optional fields, enum values, endpoints, examples, or response columns over time.

When building clients, prefer parsers that tolerate additional fields and columns. Avoid depending on object property order unless the schema explicitly defines a positional structure, such as split-orientation dataframe rows that align with columns.