Copy
Ask AI
curl -X GET "https://api.caret.so/v1/workspace" \
-H "X-API-Key: your_api_key_here"
Copy
Ask AI
{
"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"
}
}
Workspace
Get Workspace
Get details about the workspace associated with the API key
GET
/
v1
/
workspace
Copy
Ask AI
curl -X GET "https://api.caret.so/v1/workspace" \
-H "X-API-Key: your_api_key_here"
Copy
Ask AI
{
"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"
}
}
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 include your API key in theX-API-Key HTTP header.
Your Caret API key.
Response
The workspace object.
Show properties
Show properties
Unique identifier for the workspace.
Name of the workspace.
ISO8601 timestamp when the workspace was created.
ISO8601 timestamp when the workspace was last updated.
Workspace settings.
Show properties
Show properties
The ID of the RAG corpus associated with the workspace.
List of key terms for the workspace.
Where audio files are stored. One of:
none, local, aside-server,
custom-server.Data retention period in days. One of:
NONE, 7, 30, 90, 180,
365.Default permission for new meetings. One of:
public, workspace,
only-me.Visibility of member meetings. One of:
only-me, workspace-read,
workspace-write.Whether to mask sensitive information in transcripts.
Whether to automatically make meetings public when shared.
List of allowed email domains for workspace access.
URL of the workspace icon.
Copy
Ask AI
curl -X GET "https://api.caret.so/v1/workspace" \
-H "X-API-Key: your_api_key_here"
Copy
Ask AI
{
"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"
}
}
⌘I