​

files

orc files は、Workspaceに保存したファイルの用途や所有者で一覧を絞り込み、メタデータを登録・取得し、ファイル内容をアップロードするコマンドです。Issueの添付やブランド資料、ナレッジベースなどのファイルをIDで管理します。

実行には認証とWorkspaceの選択が必要です。ファイルの登録情報を作る create と、実際のバイナリを送る content update は別の操作です。バイナリのアップロードにはJSONの --stdin ではなく --file を使用します。

Workspaceのナレッジベース資料を一覧にします。

用途や所有者で絞り込んで一覧にします。Issueの添付を取得する場合は --owner-type issue と --owner-id を組み合わせます。--order は作成日時とIDの asc または desc で、--limit と --cursor でページを指定します。

Include only files with this purpose. Omit for all purposes in the workspace.; enum: agent-context|brand-asset|chat-attachment|document|screenshot|export|profile-image|docs-asset|domain-favicon

型: string。任意。

Owner type for an ownership filter. Must be paired with one or
more repeated owner_id values. Issue attachments use issue.; enum: issue

型: string。任意。

Owner ID values for an ownership filter. Repeat this parameter
to return files owned by any of several issues in one read.; csv

型: string。任意。

Sort order by created_at, then id.; enum: asc|desc

型: string。任意。

purpose、filename、mime_type、byte_size を指定してファイルの登録情報を作成します。sha256、JSONの metadata、構造化した owner_ref も指定できます。Issue添付の owner_ref は種類 issue とIssue IDを使用します。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

(required) File usage category. Determines applicable upload policy. Use document for a general document or chat-attachment for an attachment.; enum: agent-context|brand-asset|chat-attachment|document|screenshot|export|profile-image|docs-asset|domain-favicon

型: string。任意。

(required) Display filename. Leading and trailing whitespace is removed; the result must not be empty.

型: string。任意。

(required) MIME type of the binary content, such as text/plain. Accepted types depend on purpose.

型: string。任意。

(required) Expected binary content size in bytes. Must be a non-negative integer; purpose-specific size limits also apply.

型: number。任意。

Optional 64-character hexadecimal hash for workspace-scoped deduplication. Normalized to lowercase. Omit to register a new storage key.

型: string。任意。

Optional caller-defined metadata object. Defaults to {}.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

Optional ownership reference. Issue attachments must use
{ "type": "issue", "id": "<issue id>" }.

型: string。任意。

ファイルIDを指定してメタデータを取得します。バイナリ内容の取得とは別の操作です。

ファイルIDを指定して内容取得APIを呼び出します。現在のCLIの応答処理はテキストを経由するため、画像などのバイナリを原本どおり保存する用途には使用しないでください。

ファイルIDと --file にローカルファイルのパスを指定してバイナリ内容を送信します。--file が必須で、--stdin との併用は拒否されます。

Path to the local file to upload as binary content

型: string。必須。

ファイルIDのメタデータを確認します。

登録済みファイルへローカルの内容をアップロードします。

orc files では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。