ワークスペース取得

概要

このエンドポイントは、提供されたAPIキーが属するワークスペースの詳細情報を返します。ワークスペース名、作成日、設定などの基本的なメタデータが含まれます。

認証

すべてのAPIリクエストには、X-API-Key HTTPヘッダーにAPIキーを含める必要があります。

X-API-Key

string

必須

Caret APIキー。

レスポンス

workspace

object

ワークスペースオブジェクト。

表示 properties

string

ワークスペースの一意識別子。

name

string

ワークスペース名。

createdAt

string

ワークスペースが作成されたISO8601タイムスタンプ。

updatedAt

string

ワークスペースが最後に更新されたISO8601タイムスタンプ。

settings

object

ワークスペース設定。

表示 properties

rag_corpus_id

string

ワークスペースに関連付けられたRAGコーパスID。

company

object

会社情報。

表示 properties

name

string

会社名。

url

string

会社ウェブサイトURL。

info

string

会社の説明または情報。

headcount

string

会社の従業員数範囲。

keyterms

string[]

ワークスペースの主要用語リスト。

audio_location

string

音声ファイルの保存場所。none、local、aside-server、custom-serverのいずれか。

purge_period

string

データ保持期間（日数）。NONE、7、30、90、180、365のいずれか。

meeting_default_permission

string

新しいミーティングのデフォルト権限。public、workspace、only-meのいずれか。

member_meeting_visibility

string

メンバーミーティングの可視性。only-me、workspace-read、workspace-writeのいずれか。

mask_sensitive_info

boolean

文字起こしで機密情報をマスクするかどうか。

共有時にミーティングを自動的に公開するかどうか。

allowedEmailDomains

string[] | null

ワークスペースへのアクセスが許可されたメールドメインのリスト。

iconUrl

string | null

ワークスペースアイコンURL。

curl -X GET "https://api.caret.so/v1/workspace" \
     -H "X-API-Key: your_api_key_here"

{
  "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"
  }
}

APIリファレンス

​概要

​認証

​レスポンス

概要

認証

レスポンス