workspaces

Get a workspace

One workspace in the caller’s account, with its settings. A workspace in another account is a 404.

get/v1/workspaces/{id}

Request

  • Base URL: https://api.hyperresearch.ai
  • URL: https://api.hyperresearch.ai/v1/workspaces/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie hr_session

Path parameters

idstring required

Response

Workspace

idstring required
namestring required
display_namestring required

What to show a customer where the workspace is named. The workspace name, or "Untitled workspace" when it has none — never the id.

display_idstring required

The id as a screen shows it: the prefix, an ellipsis and the last characters, the same treatment #/keys gives a key id. Support quotes an id by copying id, never by reading it off the page.

vault_bytesinteger required
status'active' | 'deleting' | 'deleted' required
created_atstring required
updated_atstring required

Example response

{
  "id": "ws_01J9ZQ7V6H0000000000000000",
  "display_id": "ws…GSB5GJ7"
}

Changes

No recorded changes to this operation across all 1 revision of this API.