Getting started
files
This page is the command reference for @orchestor-inc/cli.
Commands
orc files list— List uploaded filesorc files create— Upload a fileorc files get— Retrieve file metadataorc files content get— Download file binary contentorc files content update— Upload file binary content
orc files list
List uploaded files
Usage
orc files list [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--purpose | string | No | Filter by file purpose. Pass knowledge-base to list the workspace's evidence-corpus / knowledge-base documents.; enum: agent-context|brand-asset|document|screenshot|export|profile-image|docs-asset|domain-favicon|knowledge-base |
--owner-type | string | No | Owner type for an ownership filter. Must be paired with one or more repeated owner_id values. Issue attachments use issue.; enum: issue |
--owner-id | string | No | Owner ID values for an ownership filter. Repeat this parameter to return files owned by any of several issues in one read.; csv |
--order | string | No | Sort order by created_at, then id.; enum: asc|desc |
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque cursor for the next page |
See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc files list --helporc files create
Upload a file
Usage
orc files create [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--idempotency-key | string | No | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
--purpose | string | No | (required) What the file is used for. Use knowledge-base for evidence-corpus documents that ground brand context and reporting. See the File.purpose enum for the full set of canonical values. |
--filename | string | No | (required) Body field: filename |
--mime-type | string | No | (required) Body field: mime_type |
--byte-size | number | No | (required) Body field: byte_size |
--sha256 | string | No | Body field: sha256 |
--metadata | string | No | Body field: metadata; (JSON object, e.g. '{"custom_id":"x"}') |
--owner-ref | string | No | Structured ownership reference stored in File.owner_refs. For issue attachments the type is issue and the id is the issue ID.; (JSON object, e.g. '{"custom_id":"x"}') |
See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc files create --helporc files get
Retrieve file metadata
Usage
orc files get <file-id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
file-id | Yes | Path parameter: fileId |
See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc files get --helporc files content get
Download file binary content
Usage
orc files content get <file-id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
file-id | Yes | Path parameter: fileId |
See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc files content get --helporc files content update
Upload file binary content
Usage
orc files content update <file-id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
file-id | Yes | Path parameter: fileId |
See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc files content update --help