Beta

権限

リクエストで実行できる操作は、APIキーまたはアプリ連携のスコープと、ワークスペースおよびプロジェクトでのあなたのロールの2つで決まります。

スコープ

各エンドポイントのリファレンスページに、必要なスコープが記載されています。 キーや連携は、そのスコープで許可されたエンドポイントのみ呼び出せます。スコープがない場合は、Pingのみ呼び出せます。

スコープ許可される操作
projects:readプロジェクトの検索と取得、アーカイブ済みプロジェクトと削除予定プロジェクトの一覧取得
projects:writeプロジェクトの作成、更新、アーカイブ、アーカイブ解除、削除の予約とキャンセル
folders:readフォルダーの一覧取得と個別取得
folders:writeフォルダーの作成、更新、削除
files:readファイルの一覧取得と個別取得、AIで生成したファイルのAIジョブの取得
files:writeファイルのアップロード、更新、タグ付け、削除
files:downloadファイルのダウンロードURLの取得
ai:generateAIモデルの一覧取得、AIによるファイル生成と予約クレジットの見積もり、AI生成添付ファイルのアップロード
comments:readコメント、返信、リアクションの一覧取得と個別取得
comments:writeコメント、リアクション、コメント添付ファイルの作成、更新、削除
comments:downloadコメント添付ファイルのダウンロードURLの取得
workspace-members:readワークスペースメンバーの一覧取得
project-members:readプロジェクトメンバーの一覧取得
project-members:writeプロジェクトメンバーの追加、更新、削除
access-links:readアクセスリンクの一覧取得と個別取得
access-links:writeアクセスリンクの作成、更新、削除
access-links:read.keyアクセスリンクの accessKey の参照。このスコープがない場合、accessKey は null
skills:readスキルの一覧取得と個別取得、スキルバージョンのダウンロード
skills:writeスキルの作成、更新、削除、スキルバージョンの作成と削除
schedules:readプロジェクトスケジュールの一覧取得と個別取得
schedules:writeプロジェクトスケジュールの作成、更新、削除
usage:readワークスペース使用量の取得。credits:read もある場合はクレジットの状況も返却
credits:readプランクレジット、購入クレジット、メンバー別クレジットの一覧取得。usage:read もある場合はワークスペース使用量にクレジットの状況も返却

ロール

リクエストはあなたの権限で動作するため、YouViCoアプリで開けるプロジェクトと同じプロジェクトにアクセスできます。

  • 参加しているプロジェクト
  • ワークスペース全体に公開されているプロジェクト
  • ワークスペースの所有者または管理者の場合、ワークスペース内のすべてのプロジェクト
  • 他のワークスペースからあなたのワークスペースに連携されたプロジェクト

プロジェクトロールまたはワークスペースロールが必要なエンドポイントは、許可されるロールをリファレンスページに記載しています。

一部の操作は、その項目を作成した人のみが行えます。

  • コメントの編集と削除: コメントの作成者
  • ファイルアップロードの完了: アップロードを開始した人
  • AI生成添付ファイルのアップロード完了: アップロードを開始した人
  • コメント添付ファイルのアップロード完了、キャンセル、削除: アップロードした人

制限付きファイル

制限付きレビュアーには、共有されたファイル(allowRestricted が true)のみ表示されます。 プロジェクトに参加せず、ワークスペースロールでプロジェクトを開く場合も同様です。

プランの機能

AIファイル生成とスキルは、それらを含むプランでのみ利用できます。

アーカイブ済みプロジェクト

アーカイブ済みプロジェクトは、アーカイブを解除するまで読み取り専用です。 ダウンロードURLの取得、プロジェクトメンバーの削除、アクセスリンクの削除は引き続き行えます。