LogoLogo
  • 🔬Activeloop
  • 🏠Setup
    • Quickstart
  • Models & Pricing
  • 📖User Guide
    • Ingesting with Metadata
      • Modalities
    • Filtering Query
      • Query Syntax
    • Streaming Output
  • 🏗️API Reference
    • Chat Completions
    • Files
    • Workspaces
Powered by GitBook
On this page
Export as PDF
  1. API Reference

Workspaces

PreviousFiles

Last updated 1 day ago

🏗️

Get Workspace

get
Authorizations
Path parameters
workspace_idstringRequired

The ID of the workspace to get.

Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /workspaces/{workspace_id} HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Accept: */*
{
  "id": "text",
  "name": "text",
  "creator_user_id": "text",
  "org_id": "text",
  "created_at": "2025-06-13T01:43:57.933Z"
}

Delete Workspace

delete
Authorizations
Path parameters
workspace_idstringRequired

The ID of the workspace to delete.

Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
delete
DELETE /workspaces/{workspace_id} HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Accept: */*

No content

Remove User From Workspace

delete
Authorizations
Path parameters
workspace_idstringRequired

The ID of the workspace to remove user from.

user_idstringRequired

The ID of the user.

Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
delete
DELETE /workspaces/{workspace_id}/user/{user_id} HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Accept: */*

No content

List Workspace Users

get
Authorizations
Path parameters
workspace_idstringRequired

The ID of the workspace to list users from.

Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /workspaces/{workspace_id}/users HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Accept: */*
{
  "data": [
    {
      "user_id": "text",
      "access": "writer",
      "created_at": "2025-06-13T01:43:57.933Z"
    }
  ]
}
  • POSTCreate Workspace
  • GETList Workspaces
  • GETGet Workspace
  • DELETEDelete Workspace
  • POSTAdd User To Workspace
  • PUTUpdate User In Workspace
  • DELETERemove User From Workspace
  • GETList Workspace Users

List Workspaces

get
Authorizations
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /workspaces HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Accept: */*
{
  "data": [
    {
      "id": "text",
      "name": "text",
      "creator_user_id": "text",
      "org_id": "text",
      "created_at": "2025-06-13T01:43:57.933Z"
    }
  ]
}

Create Workspace

post
Authorizations
Body
idstring · min: 1 · max: 34RequiredPattern: ^[a-z0-9]+(?:[-_][a-z0-9]+)*$
namestringRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
post
POST /workspaces HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "id": "text",
  "name": "text"
}

No content

Add User To Workspace

post
Authorizations
Path parameters
workspace_idstringRequired

The ID of the workspace to add user to.

Body
userstringRequired
accessstring · enumRequiredPossible values:
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
post
POST /workspaces/{workspace_id}/user HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "user": "text",
  "access": "writer"
}

No content

Update User In Workspace

put
Authorizations
Path parameters
workspace_idstringRequired

The ID of the workspace to update user info.

Body
userstringRequired
accessstring · enumRequiredPossible values:
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
put
PUT /workspaces/{workspace_id}/user HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "user": "text",
  "access": "writer"
}

No content