Get a workspace

GET

/v1/workspaces/:id

GET

/v1/workspaces/:id

1 import requests
2 
3 url = "https://api.bctrl.ai/v1/workspaces/3fa85f64-5717-4562-b3fc-2c963f66afa6"
4 
5 payload = {}
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.get(url, json=payload, headers=headers)
12 
13 print(response.json())

200Retrieved

1 {
2   "createdAt": "2024-05-20T09:15:30Z",
3   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4   "mounts": {
5     "ai": {
6       "allow": [
7         "text-generation",
8         "image-recognition"
9       ],
10       "defaults": {
11         "anthropic": "AnthropicModelV1",
12         "google": "GoogleVertexAI",
13         "openai": "OpenAI-GPT4",
14         "openai-compatible": "CustomOpenAIAdapter"
15       }
16     },
17     "storage": {
18       "workspace": "workspace-1234.storage"
19     },
20     "vault": {
21       "allow": [
22         "read-secrets",
23         "write-secrets"
24       ],
25       "allowRawReads": false,
26       "deny": [
27         "delete-secrets"
28       ]
29     }
30   },
31   "name": "Marketing Team Workspace",
32   "updatedAt": "2024-06-01T12:00:00Z"
33 }

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Response

Default Response

createdAtstring

idstringformat: "uuid"

mountsobject

namestring>=1 character

updatedAtstring