Administration

Accounts

Retrieve the accounts available to your credentials.
View as Markdown

Accounts are where teams create and manage platform resources, including data, models, configurations, and workspaces.

Accounts are currently created by Umnai during onboarding. During account creation, storage is configured as either:

  • PROVISIONED, where Umnai provisions and manages the account storage bucket; or
  • PROVIDED, where the customer supplies and manages the account storage bucket.

Account storage holds resources created by the platform. See Account storage for configuration options and setup requirements.

Use the API to retrieve the accounts your credentials can access and to inspect a specific account when you already have its id.

Retrieve accounts

Retrieve the accounts available to the current credentials.

GET
/accounts
curl https://api.hi.umnai.com/accounts \
     -H "Authorization: Bearer <token>"
Response
{
  "data": [
    {
      "id": "729c654903c0aee752e82c44d02f5918",
      "name": "Provisioned Storage Account",
      "organisation": {
        "id": "ea8b745ead39ec442fc3b4fba359bf98",
        "name": "Sample Organisation"
      },
      "region": "eu-west-1",
      "storage_configuration": {
        "storage_configuration_type": "PROVISIONED",
        "bucket_name": "cf5b193e7f65480e98107feb78649222"
      },
      "created_at": "2026-03-01T17:04:20.800625Z",
      "status": "ACTIVE"
    },
    {
      "id": "bc2cad66fa5c422ba7b59887d684c073",
      "name": "Provided Storage Account",
      "organisation": {
        "id": "ea8b745ead39ec442fc3b4fba359bf98",
        "name": "Sample Organisation"
      },
      "region": "eu-west-1",
      "storage_configuration": {
        "storage_configuration_type": "PROVIDED",
        "bucket_name": "customer-account-storage"
      },
      "created_at": "2026-07-10T15:04:37.637000Z",
      "status": "ACTIVE"
    }
  ],
  "pagination": {
    "total_items": 2,
    "items_per_page": 10,
    "current_page": 1,
    "total_pages": 1
  }
}

Use the returned account id when creating or retrieving account-scoped resources.

Retrieve an account

Retrieve a specific account by its id.

GET
/accounts/:accountId
curl https://api.hi.umnai.com/accounts/accountId \
     -H "Authorization: Bearer <token>"
Response
{
  "id": "bc2cad66fa5c422ba7b59887d684c073",
  "name": "Provided Storage Account",
  "organisation": {
    "id": "ea8b745ead39ec442fc3b4fba359bf98",
    "name": "Sample Organisation"
  },
  "region": "eu-west-1",
  "storage_configuration": {
    "storage_configuration_type": "PROVIDED",
    "bucket_name": "customer-account-storage"
  },
  "created_at": "2026-07-10T15:04:37.637000Z",
  "status": "ACTIVE"
}

Inspect account storage

The account response includes storage_configuration:

{
  "storage_configuration": {
    "storage_configuration_type": "PROVIDED",
    "bucket_name": "customer-account-storage"
  }
}

For provided storage, verify that bucket_name matches the bucket supplied to Umnai during onboarding. For provisioned storage, the field identifies the bucket managed by Umnai.