Models

Workspaces

Organise training jobs and models.
View as Markdown

A workspace is the context for training jobs, models, and their metadata.

Create a workspace before starting a training job, or reuse an existing workspace when you want the new model to belong to the same modelling area.

Create a workspace

Create a workspace with a name that describes the modelling area, project, or use case.

POST
/workspaces
curl -X POST https://api.hi.umnai.com/workspaces \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Sample Workspace"
}'
Response
{
  "id": "1629dee48cc4e53161f9b2be8614e062",
  "account": {
    "id": "e268443e43d93dab7ebef303bbe9642f",
    "name": "Sample Account"
  },
  "name": "Sample Workspace",
  "created_at": "2026-03-24T13:12:54.215574Z",
  "created_by": {
    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
    "name": "Sample User"
  }
}

Save the returned workspace id. Training jobs use this value as the active workspace context.

Retrieve workspaces

Retrieve workspaces when you need to find an existing workspace for a training job or model.

GET
/workspaces
curl https://api.hi.umnai.com/workspaces \
     -H "Authorization: Bearer <token>"
Response
{
  "data": [
    {
      "id": "9773fc35d3e1a3b96d88bbfaae3b6c2a",
      "account": {
        "id": "729c654903c0aee752e82c44d02f5918",
        "name": "Sample Account"
      },
      "name": "Sample Workspace",
      "created_at": "2026-03-24T13:12:54.215574Z",
      "created_by": {
        "id": "eca422469dc3270625bf646df3472a45",
        "name": "Sample User"
      }
    }
  ],
  "pagination": {
    "total_items": 1,
    "items_per_page": 10,
    "current_page": 1,
    "total_pages": 1
  }
}

To inspect a specific workspace, retrieve it by id.

GET
/workspaces/:workspaceId
curl https://api.hi.umnai.com/workspaces/workspaceId \
     -H "Authorization: Bearer <token>"
Response
{
  "id": "1629dee48cc4e53161f9b2be8614e062",
  "account": {
    "id": "e268443e43d93dab7ebef303bbe9642f",
    "name": "Sample Account"
  },
  "name": "Sample Workspace",
  "created_at": "2026-03-24T13:12:54.215574Z",
  "created_by": {
    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
    "name": "Sample User"
  }
}

Update a workspace

Update a workspace when you need to rename it.

PATCH
/workspaces/:workspaceId
curl -X PATCH https://api.hi.umnai.com/workspaces/workspaceId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Sample Workspace"
}'
Response
{
  "id": "1629dee48cc4e53161f9b2be8614e062",
  "account": {
    "id": "e268443e43d93dab7ebef303bbe9642f",
    "name": "Sample Account"
  },
  "name": "Sample Workspace",
  "created_at": "2026-03-24T13:12:54.215574Z",
  "created_by": {
    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
    "name": "Sample User"
  },
  "updated_at": "2026-03-24T13:15:54.215574Z"
}

Delete a workspace

Delete a workspace when it should no longer be used.

DELETE
/workspaces/:workspaceId
curl -X DELETE https://api.hi.umnai.com/workspaces/workspaceId \
     -H "Authorization: Bearer <token>"