curl -X GET "https://api.caret.so/v1/workspace" \
-H "Authorization: Bearer your_api_key_here"
const response = await fetch('https://api.caret.so/v1/workspace', {
headers: {
Authorization: 'Bearer your_api_key_here',
},
});
const data = await response.json();
console.log(data);
import requests
url = "https://api.caret.so/v1/workspace"
headers = {
"Authorization": "Bearer your_api_key_here"
}
response = requests.get(url, headers=headers)
print(response.json())
{
"workspace": {
"id": "ws_123456789",
"name": "Acme Corp",
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-01T00:00:00Z",
"settings": {
"keyterms": ["technical", "documentation"],
"audio_location": "aside-server",
"meeting_default_permission": "workspace"
},
"allowedEmailDomains": ["acme.com"],
"iconUrl": "https://example.com/icon.png"
}
}
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}
{
"error": {
"code": "internal_server_error",
"message": "An unexpected error occurred"
}
}
Workspace
Get Workspace
Get details about the workspace associated with the API key
GET
/
v1
/
workspace
curl -X GET "https://api.caret.so/v1/workspace" \
-H "Authorization: Bearer your_api_key_here"
const response = await fetch('https://api.caret.so/v1/workspace', {
headers: {
Authorization: 'Bearer your_api_key_here',
},
});
const data = await response.json();
console.log(data);
import requests
url = "https://api.caret.so/v1/workspace"
headers = {
"Authorization": "Bearer your_api_key_here"
}
response = requests.get(url, headers=headers)
print(response.json())
{
"workspace": {
"id": "ws_123456789",
"name": "Acme Corp",
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-01T00:00:00Z",
"settings": {
"keyterms": ["technical", "documentation"],
"audio_location": "aside-server",
"meeting_default_permission": "workspace"
},
"allowedEmailDomains": ["acme.com"],
"iconUrl": "https://example.com/icon.png"
}
}
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}
{
"error": {
"code": "internal_server_error",
"message": "An unexpected error occurred"
}
}
Overview
This endpoint returns detailed information about the workspace that the provided API key belongs to. It includes basic metadata like the workspace name, creation date, and settings.Authentication
All API requests must authenticate withAuthorization: Bearer <API_KEY>.
string
required
Bearer token. Format:
Bearer <API_KEY>.Response
object
The workspace object.
Show properties
Show properties
string
Unique identifier for the workspace.
string
Name of the workspace.
string
ISO8601 timestamp when the workspace was created.
string
ISO8601 timestamp when the workspace was last updated.
object
Workspace settings.
Show properties
Show properties
string
The ID of the RAG corpus associated with the workspace.
object
string[]
List of key terms for the workspace.
string
Where audio files are stored. One of:
none, local, aside-server,
custom-server.string
Data retention period in days. One of:
NONE, 7, 30, 90, 180,
365.string
Default permission for new meetings. One of:
public, workspace,
only-me.string
Visibility of member meetings. One of:
only-me, workspace-read,
workspace-write.boolean
Whether to mask sensitive information in transcripts.
boolean
Whether to automatically make meetings public when shared.
string[] | null
List of allowed email domains for workspace access.
string | null
URL of the workspace icon.
curl -X GET "https://api.caret.so/v1/workspace" \
-H "Authorization: Bearer your_api_key_here"
const response = await fetch('https://api.caret.so/v1/workspace', {
headers: {
Authorization: 'Bearer your_api_key_here',
},
});
const data = await response.json();
console.log(data);
import requests
url = "https://api.caret.so/v1/workspace"
headers = {
"Authorization": "Bearer your_api_key_here"
}
response = requests.get(url, headers=headers)
print(response.json())
{
"workspace": {
"id": "ws_123456789",
"name": "Acme Corp",
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-01T00:00:00Z",
"settings": {
"keyterms": ["technical", "documentation"],
"audio_location": "aside-server",
"meeting_default_permission": "workspace"
},
"allowedEmailDomains": ["acme.com"],
"iconUrl": "https://example.com/icon.png"
}
}
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}
{
"error": {
"code": "internal_server_error",
"message": "An unexpected error occurred"
}
}
⌘I