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"
}
}
ワークスペース
ワークスペース取得
APIキーに関連付けられたワークスペースの詳細を取得します
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"
}
}
概要
このエンドポイントは、提供されたAPIキーが属するワークスペースの詳細情報を返します。ワークスペース名、作成日、設定などの基本的なメタデータが含まれます。認証
すべてのAPIリクエストはAuthorization: Bearer <API_KEY> で認証します。
string
必須
Bearerトークン。形式:
Bearer <API_KEY>。レスポンス
object
ワークスペースオブジェクト。
表示 properties
表示 properties
string
ワークスペースの一意識別子。
string
ワークスペース名。
string
ワークスペースが作成されたISO8601タイムスタンプ。
string
ワークスペースが最後に更新されたISO8601タイムスタンプ。
object
ワークスペース設定。
表示 properties
表示 properties
string
ワークスペースに関連付けられたRAGコーパスID。
string[]
ワークスペースの主要用語リスト。
string
音声ファイルの保存場所。
none、local、aside-server、custom-serverのいずれか。string
データ保持期間（日数）。
NONE、7、30、90、180、365のいずれか。string
新しいミーティングのデフォルト権限。
public、workspace、only-meのいずれか。string
メンバーミーティングの可視性。
only-me、workspace-read、workspace-writeのいずれか。boolean
文字起こしで機密情報をマスクするかどうか。
boolean
共有時にミーティングを自動的に公開するかどうか。
string[] | null
ワークスペースへのアクセスが許可されたメールドメインのリスト。
string | null
ワークスペースアイコンURL。
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