オブジェクト
Error
標準のエラーレスポンス。detailは文字列、codeを持つオブジェクト(たとえばchoose_org、org_suspended、招待のコード)、またはバリデーションエラーのリスト(422)です。errorは構造化された説明で、エラーカタログのコード、英語のメッセージ、構造化された詳細、リクエストIDを含みます。
フィールド
エラーメッセージ、コードを持つオブジェクト、またはバリデーションエラーのリスト。
errorErrorInfo
使用箇所
- GET
/v1/healthサービスの状態とバージョンを取得する - GET
/v1/users組織のユーザーを一覧表示する - POST
/v1/usersユーザーを作成する - PATCH
/v1/users/{user_id}ユーザーを更新する - GET
/v1/api-keys組織のAPIキーを一覧表示する - POST
/v1/api-keysAPIキーを作成する - DELETE
/v1/api-keys/{key_id}APIキーを取り消す - PATCH
/v1/api-keys/{key_id}APIキーを更新する - POST
/v1/api-keys/{key_id}/rollAPIキーを再発行する - POST
/v1/api-keys/{key_id}/revoke-previousAPIキーの以前の値を取り消す - GET
/v1/audit監査ログの項目を一覧表示する - GET
/v1/audit/actions監査ログのアクションを件数付きで一覧表示する - GET
/v1/audit/export.csv監査ログをCSVでエクスポートする - GET
/v1/org組織を取得する - GET
/v1/categoriesドキュメントのカテゴリを一覧表示する - POST
/v1/categoriesカテゴリを作成する - DELETE
/v1/categories/{key}カスタムカテゴリを削除する - PATCH
/v1/categories/{key}カテゴリを更新する - GET
/v1/collectionsユーザーがアクセスできるコレクションを一覧表示する - POST
/v1/collectionsコレクションを作成する - DELETE
/v1/collections/{name}コレクションを削除する - PATCH
/v1/collections/{name}コレクションを更新する - POST
/v1/collections/{name}/reindexコレクションを再インデックスする - GET
/v1/collections/{name}/statsコレクションの概要(統計、カテゴリ、最近のカード、権限)を取得する - GET
/v1/cardsカードを一覧表示する - POST
/v1/cardsファイルをカードとしてアップロードする - GET
/v1/jobsインデックス作成のジョブを一覧表示する - GET
/v1/jobs/summaryキューのサマリーを取得する - GET
/v1/jobs/streamジョブの変更をストリーミングする(SSE) - GET
/v1/jobs/{job_id}ジョブを取得する - DELETE
/v1/jobs/{job_id}キューにあるジョブをキャンセルする - GET
/v1/cards/countカードの数を数える - GET
/v1/cards/export.xlsxカードのリストをXLSXでエクスポートする - POST
/v1/cards/bulkカードに一括操作を実行する - GET
/v1/cards/{card_id}カードをバージョン、コメント、表、イベントとともに取得する - DELETE
/v1/cards/{card_id}カードを削除する - PATCH
/v1/cards/{card_id}カードを更新する - GET
/v1/cards-by-external-id/{external_id}外部IDでカードを取得する - PUT
/v1/cards-by-external-id/{external_id}外部IDでカードを作成または置換する - GET
/v1/cards/{card_id}/contentカードの本文をセクションごとに取得する - PUT
/v1/cards/{card_id}/contentカードの内容を置き換える - GET
/v1/cards/{card_id}/tables/{table_id}/rowsファクトテーブルの行を一覧表示する - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}カードの2つのバージョンを比較する - GET
/v1/cards/{card_id}/usage回答にカードが使われた質問を一覧表示する - POST
/v1/cards/{card_id}/usageカードの利用イベントを記録する - POST
/v1/cards/{card_id}/reindexカードを再インデックスする - DELETE
/v1/cards/{card_id}/comments/{comment_id}コメントを削除する - GET
/v1/cards/{card_id}/fileカードの元のファイルをダウンロードする - GET
/v1/cards/{card_id}/exportカードをドキュメントとしてエクスポートする - POST
/v1/cards/{card_id}/verifyカードが最新であることを確認する - POST
/v1/cards/{card_id}/commentsコメントを追加する - GET
/v1/conversations会話を一覧表示する - GET
/v1/conversations/{conv_id}会話をターンとともに取得する - POST
/v1/searchコレクションを検索する - POST
/v1/askストリーミングなしでアシスタントの回答を取得する - POST
/v1/chatアシスタントの回答をストリーミングする(SSE) - POST
/v1/questions/{question_id}/feedback回答を評価する - GET
/v1/questions/export.csv質問ログをCSVでエクスポートする - GET
/v1/questions/{question_id}保存済みの質問を回答とともに取得する - GET
/v1/questions/{question_id}/followups次の質問の候補を取得する - GET
/v1/questions質問ログを一覧表示する - GET
/v1/questions/{question_id}/export回答をドキュメントとしてエクスポートする - GET
/v1/questions/{question_id}/datasets/{dataset_id}/export回答のデータセットをエクスポートする - GET
/v1/questions/{question_id}/answer-tables/{index}/export回答の本文の表をエクスポートする - POST
/v1/questions/{question_id}/refresh回答のデータセットを更新する(ライブ回答) - POST
/v1/questions/{question_id}/save-card回答をカードとして保存する - POST
/v1/cards/textテキストのカードを作成する(Markdown) - GET
/v1/filesエクスポートファイルを一覧表示する - GET
/v1/files/authorsファイルの作成者を一覧表示する(管理者のフィルター用) - GET
/v1/files/{file_id}ファイルの詳細を取得する - DELETE
/v1/files/{file_id}ファイルを削除する - GET
/v1/files/{file_id}/downloadファイルをダウンロードする - GET
/v1/files/{file_id}/previewファイルをプレビューする - POST
/v1/files/{file_id}/extendファイルの保持期間を延長する - POST
/v1/files/{file_id}/regenerate保存済みのパラメーターからファイルを再生成する - GET
/v1/tasksユーザーまたはチームのタスクを一覧表示する - POST
/v1/sourcesソースを作成する - GET
/v1/sources/{source_id}ソースを取得する - DELETE
/v1/sources/{source_id}ソースを削除する - PATCH
/v1/sources/{source_id}ソースを更新する - PATCH
/v1/sources/{source_id}/settingsソースの設定を更新する - GET
/v1/cards/{card_id}/similar類似カードを一覧表示する - GET
/v1/insights/gapsナレッジギャップ(回答のない質問のまとまり)を一覧表示する - GET
/v1/permissions権限の一覧(レジストリ)を取得する - POST
/v1/uploadsマルチパートアップロードを開始する - GET
/v1/uploads/{upload_id}アップロードを取得する - DELETE
/v1/uploads/{upload_id}アップロードをキャンセルする - PUT
/v1/uploads/{upload_id}/parts/{n}アップロードのパートを送信する - POST
/v1/uploads/{upload_id}/completeアップロードを完了する - GET
/v1/meAPIの呼び出し元を取得する - GET
/v1/me/permissions組織に対する現在のユーザーの権限を取得する - GET
/v1/rolesロール(組み込みロールとカスタムロール)を一覧表示する - POST
/v1/rolesカスタムロールを作成する - DELETE
/v1/roles/{role_id}カスタムロールを削除する - PATCH
/v1/roles/{role_id}カスタムロールを更新する - GET
/v1/groups組織のグループを一覧表示する - POST
/v1/groupsグループを作成する - GET
/v1/groups/{group_id}グループをメンバーとともに取得する - DELETE
/v1/groups/{group_id}グループを削除する - PATCH
/v1/groups/{group_id}グループの名前を変更する - PUT
/v1/groups/{group_id}/members/{user_id}グループにメンバーを追加する - DELETE
/v1/groups/{group_id}/members/{user_id}グループからメンバーを削除する - GET
/v1/org/permissions組織に対する権限(誰が管理者か)を取得する - PUT
/v1/org/permissions組織に対するロールを付与する - DELETE
/v1/org/permissions組織に対するロールを取り消す - GET
/v1/collections/{name}/permissionsコレクションに対する権限(直接付与と継承)を取得する - PUT
/v1/collections/{name}/permissionsコレクションに対するロールを付与する - DELETE
/v1/collections/{name}/permissionsコレクションに対するロールを取り消す - GET
/v1/cards/{card_id}/permissionsカードに対する権限(直接付与と継承)を取得する - PUT
/v1/cards/{card_id}/permissionsカードに対するロールを付与する - DELETE
/v1/cards/{card_id}/permissionsカードに対するロールを取り消す - GET
/v1/sources/{source_id}/permissionsソースに対する権限(直接付与と継承)を取得する - PUT
/v1/sources/{source_id}/permissionsソースに対するロールを付与する - DELETE
/v1/sources/{source_id}/permissionsソースに対するロールを取り消す - POST
/v1/users/{user_id}/offboardユーザーをオフボーディングする - GET
/v1/collections/{name}/foldersコレクションのフォルダーツリーを取得する - POST
/v1/collections/{name}/foldersフォルダーを作成する - GET
/v1/foldersすべてのコレクションのフォルダーツリーを取得する - GET
/v1/folders/{folder_id}フォルダーを取得する - DELETE
/v1/folders/{folder_id}フォルダーを削除して中身を上の階層に移す - PATCH
/v1/folders/{folder_id}フォルダーの名前の変更、移動、並べ替えを行う - GET
/v1/folders/{folder_id}/cardsフォルダーのカードを一覧表示する - GET
/v1/folders/{folder_id}/permissionsフォルダーに対する権限(直接付与と継承)を取得する - PUT
/v1/folders/{folder_id}/permissionsフォルダーに対するロールを付与する - DELETE
/v1/folders/{folder_id}/permissionsフォルダーに対するロールを取り消す - GET
/v1/catalog/servicesカタログのサービスを一覧表示する - GET
/v1/catalog/services/{service_id}カタログのサービスを取得する - GET
/v1/catalog/services/{service_id}/iconサービスのアイコンを取得する - GET
/v1/catalog/categoriesカタログのカテゴリを一覧表示する - GET
/v1/catalog/spend-taxonomy支出・収益の分類体系を取得する - POST
/v1/catalog/resolve名前をカタログのサービスに照合する - GET
/v1/drafts下書きを一覧表示する - POST
/v1/drafts下書きを作成する - GET
/v1/drafts/{draft_id}下書きを取得する - PATCH
/v1/drafts/{draft_id}下書きを更新する - POST
/v1/drafts/{draft_id}/request-publish公開を申請する - POST
/v1/drafts/{draft_id}/approve公開を承認する - GET
/v1/tags組織のカードのタグを一覧表示する - POST
/v1/cards/archiveドキュメントのアーカイブファイルをアップロードする - GET
/v1/archives/{job_id}アーカイブファイルの展開のジョブを取得する - GET
/v1/cards/{card_id}/verificationカードの検証のブロックを取得する - POST
/v1/cards/{card_id}/verification/verifyカードを検証する - POST
/v1/cards/{card_id}/verification/unverify信頼を取り消すか、検証者にリマインドする - PUT
/v1/cards/{card_id}/verification/verifiersカードの検証者を設定する - PUT
/v1/cards/{card_id}/verification/interval検証の種類と期限を変更する - GET
/v1/verification/queue検証のキューを取得する - GET
/v1/collections/{name}/trustコレクションの信頼度スコア(Trust Score)を取得する - GET
/v1/org/trust組織の信頼度スコア(Trust Score)を取得する - GET
/v1/announcementsお知らせを一覧表示する - POST
/v1/announcements必読のお知らせを送信する - GET
/v1/announcements/{announcement_id}お知らせを取得する - GET
/v1/announcements/{announcement_id}/statsお知らせのレポートを取得する - POST
/v1/announcements/{announcement_id}/remind未読のユーザーにリマインドする - GET
/v1/cards/{card_id}/threadsカードのコメントスレッドを一覧表示する - POST
/v1/cards/{card_id}/threadsスレッドにコメントまたは返信を追加する - DELETE
/v1/cards/{card_id}/threads/{comment_id}コメントを返信とともに削除する - PATCH
/v1/cards/{card_id}/threads/{comment_id}スレッドの本文を編集する、解決済みにする、または再開する - GET
/v1/openapi-public.json公開OpenAPI仕様を取得する - GET
/v1/webhooks組織のWebhookを一覧表示する - POST
/v1/webhooksWebhookを作成する - GET
/v1/webhooks/catalogイベントタイプを一覧表示する - GET
/v1/webhooks/{webhook_id}Webhookを取得する - DELETE
/v1/webhooks/{webhook_id}Webhookを削除する - PATCH
/v1/webhooks/{webhook_id}Webhookを更新する - POST
/v1/webhooks/{webhook_id}/testテストイベントを送信する - POST
/v1/webhooks/{webhook_id}/rotate-secret署名シークレットをローテーションする - POST
/v1/webhooks/{webhook_id}/revoke-previous-secret以前のシークレットを取り消す - POST
/v1/webhooks/{webhook_id}/resumeWebhookを再開する - POST
/v1/webhooks/{webhook_id}/redeliver期間を指定して配信を再配信する - GET
/v1/webhooks/{webhook_id}/attempts配信試行を一覧表示する - GET
/v1/webhooks/{webhook_id}/deliveriesWebhookの配信を一覧表示する - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}配信をボディと配信試行とともに取得する - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverイベントを再配信する - GET
/v1/webhook-eventsイベントを一覧表示する - GET
/v1/webhook-events/{event_id}イベントを取得する - GET
/v1/api-usageAPIの利用状況を取得する - GET
/v1/api-logsAPIのリクエストを一覧表示する - GET
/v1/api-logs/{request_id}APIのリクエストを取得する - GET
/v1/appsOAuthアプリを一覧表示する - POST
/v1/appsOAuthアプリを作成する - GET
/v1/apps/{app_id}OAuthアプリを取得する - DELETE
/v1/apps/{app_id}OAuthアプリを削除する - PATCH
/v1/apps/{app_id}OAuthアプリを更新する - POST
/v1/apps/{app_id}/rotate-secretクライアントシークレットをローテーションする - GET
/v1/app-authorizationsアプリの認可を一覧表示する - DELETE
/v1/app-authorizations/{authorization_id}社員による認可を取り消す - GET
/v1/analytics/healthナレッジの健全性のダッシュボードを取得する - GET
/v1/analytics/usage利用状況のダッシュボードを取得する - GET
/v1/analytics/contribution貢献のダッシュボードを取得する - GET
/v1/analytics/cards/{card_id}カードの指標を取得する - GET
/v1/audit/verify組織の監査ログの整合性を検証する - POST
/v1/users/importCSVからユーザーをインポートする - GET
/v1/quality/gaps/followups対応中のナレッジギャップを一覧表示する - POST
/v1/quality/gaps/followupsナレッジギャップを対応中にする - PATCH
/v1/quality/gaps/followups/{followup_id}対応中のナレッジギャップを更新する - GET
/v1/access-requests自分のアクセス申請または受け取ったアクセス申請を一覧表示する - GET
/v1/access-requests/{request_id}承認者向けにアクセス申請を取得する - POST
/v1/access-requests/{request_id}/grant申請に対してアクセスを許可する - POST
/v1/access-requests/{request_id}/denyアクセスを拒否する - POST
/v1/finance/report財務サマリーレポートを取得する - POST
/v1/finance/report/export財務サマリーレポートをエクスポートする - POST
/v1/finance/invoices請求書を一覧表示する - POST
/v1/finance/invoices/export請求書のリストをエクスポートする - POST
/v1/finance/payments支払いを一覧表示する - POST
/v1/finance/payments/export支払いのリストをエクスポートする - GET
/v1/sources/{source_id}/push-keysカスタムソースのAPIキーを一覧表示する - POST
/v1/sources/{source_id}/push-keysカスタムソースのAPIキーを作成する - DELETE
/v1/sources/{source_id}/push-keys/{key_id}カスタムソースのAPIキーを取り消す - GET
/v1/sources/{source_id}/push-syncsカスタムソースの同期を一覧表示する - GET
/v1/push/sources/{source_id}キーを確認し、カスタムソースの状態を取得する - POST
/v1/push/sources/{source_id}/syncs同期を開始する - GET
/v1/push/sources/{source_id}/syncs/{sync_number}同期を取得する - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documents同期のドキュメントの結果を一覧表示する - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/close同期を終了する - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchドキュメントを再送せずに確認する - POST
/v1/push/sources/{source_id}/documentsドキュメントを送信する(作成または置換) - POST
/v1/push/sources/{source_id}/documents/batchドキュメントのバッチを送信する - GET
/v1/push/sources/{source_id}/documents/{external_id}ドキュメントの結果を取得する - DELETE
/v1/push/sources/{source_id}/documents/{external_id}ドキュメントを削除する