Get Workspace - MemoryLake AI

curl -X GET 'https://app.memorylake.ai/openapi/memorylake/api/v3/workspaces/ws_abc123def456' \
  -H 'Authorization: Bearer sk_xxxxxx'

{
  "success": true,
  "data": {
    "id": "ws_abc123def456",
    "name": "My Research Workspace",
    "description": "Central workspace for research documents and notes",
    "metadata": {
      "team": "research",
      "priority": "high"
    },
    "custom_id": "research-ws-001",
    "created_at": "2025-03-10T08:30:00Z",
    "updated_at": "2025-03-15T12:00:00Z"
  }
}

GET /openapi/memorylake/api/v3/workspaces/{id}

Retrieves a workspace by its internal ID or by its custom_id. To look up a workspace using your caller-defined custom_id, set the by_custom_id query parameter to true and pass the custom ID as the path parameter.

Permission required: workspace:read

Path Parameters

string

required

Workspace identifier. Pass the internal workspace ID, or the custom_id value when by_custom_id is set to true.

Query Parameters

by_custom_id

boolean

default:"false"

Set to true to look up the workspace by custom_id instead of the internal ID

curl -X GET 'https://app.memorylake.ai/openapi/memorylake/api/v3/workspaces/ws_abc123def456' \
  -H 'Authorization: Bearer sk_xxxxxx'

Response

data

object

Show Workspace object

string

Unique workspace identifier

name

string

Workspace name

description

string

Workspace description

metadata

object

Arbitrary key-value metadata attached to the workspace

custom_id

string

Caller-defined unique identifier for external reference

created_at

string

Creation timestamp

updated_at

string

Last update timestamp

{
  "success": true,
  "data": {
    "id": "ws_abc123def456",
    "name": "My Research Workspace",
    "description": "Central workspace for research documents and notes",
    "metadata": {
      "team": "research",
      "priority": "high"
    },
    "custom_id": "research-ws-001",
    "created_at": "2025-03-10T08:30:00Z",
    "updated_at": "2025-03-15T12:00:00Z"
  }
}

Create Workspace Update Workspace

​Path Parameters

​Query Parameters

​Response

Path Parameters

Query Parameters

Response