research note
orc research note searches note articles and discovers public content through creators, hashtags and topics. Follow article IDs to retrieve text or comments, and inspect creator profiles.
Authenticate the CLI and select an accessible Workspace. Use --workspace to set the scope for this call.
Usage
orc research note articles search --q "生成AI" --workspace <workspace-id> --jsonSearch public articles.
Subcommands
articles search
Search note articles with --q, then use discovered article IDs to read articles or comments.
orc research note articles search [options]Unique options
--q
Search text; 1–200 characters. URL-encode when building a request.; max 200 chars
Type: string. Required.
orc research note articles search --q <value>--sort
Native note ordering: popular, newest, or hot.; enum: popular|new|hot
Type: string. Optional.
orc research note articles search --sort <value>--start
Use pagination.next_start from the previous response; keep other search parameters unchanged.; (use "null" or "reset" to clear)
Type: number. Optional.
orc research note articles search --start <value>--paid
true selects the source sales collection; it does not unlock paid bodies.; enum: true|false
Type: string. Optional.
orc research note articles search --paid <value>articles get
Retrieve a note article using the article ID returned by a list or search.
orc research note articles get <id> [options]creators get
Retrieve a creator’s public profile by name, using creator information from article results.
orc research note creators get <name> [options]Retrieve public information about a named hashtag.
orc research note hashtags get <name> [options]Retrieve one page of articles associated with a hashtag.
orc research note hashtags articles list <name> [options]Unique options
--page
One-based native page number; use the returned continuation.
Type: number. Optional.
orc research note hashtags articles list <name> --page <value>interests get
Retrieve public information for a named interest.
orc research note interests get <name> [options]Unique options
--page
One-based native page number; use the returned continuation.
Type: number. Optional.
orc research note interests get <name> --page <value>map
Discover note topics and retrieval entry points. Use a returned topic path with topics get.
orc research note map [options]Retrieve public information about a named tag.
orc research note tags get <name> [options]Unique options
--mode
Native tag ordering. Keep the mode unchanged when following the returned cursor; switching it starts a different collection.; enum: popular|new
Type: string. Optional.
orc research note tags get <name> --mode <value>topics get
Retrieve a topic using --path discovered through map. Nested topic paths are supported.
orc research note topics get [options]Unique options
--page
One-based page within the selected topic and tab. Use the returned continuation; some curated layouts only expose their initial page.
Type: number. Optional.
orc research note topics get --page <value>--tab
Native topic tab identifier. Follow api_url in data.pages to select a tab. When omitted, the source top tab is selected.
Type: string. Optional.
orc research note topics get --tab <value>--path
Topic ID from map; nested paths are supported.; max 200 chars
Type: string. Required.
orc research note topics get --path <value>trends list
Retrieve note’s trending sections while retaining source coverage and ordering.
orc research note trends list [options]Unique options
--page
One-based native page number; use the returned continuation.
Type: number. Optional.
orc research note trends list --page <value>articles comments list
Retrieve one page of comments for an article. Keep the article and filters unchanged when following continuation.
orc research note articles comments list <id> [options]Unique options
--page
One-based native page number; use the returned continuation.
Type: number. Optional.
orc research note articles comments list <id> --page <value>creators articles list
List articles by creator name. Use the source identifier rather than a display name.
orc research note creators articles list <name> [options]Unique options
--page
One-based native page number; use the returned continuation.
Type: number. Optional.
orc research note creators articles list <name> --page <value>Examples
Retrieve a public topic.
orc research note topics get --path challenge --workspace <workspace-id> --jsonRetrieve a public topic.
Retrieve hashtag information.
orc research note hashtags get "生成AI" --workspace <workspace-id> --jsonRetrieve hashtag information.
Output and continuation
List calls retrieve one source page. Follow the query values in pagination.next_url using the corresponding flags, keeping filters unchanged. Unknown continuation does not establish completeness. Automatic traversal with --page-all is unavailable.
With --json, the full API response is retained inside the CLI data envelope. Records are in data.data, continuation in data.pagination, and provenance in data.source. --raw removes the CLI envelope; --field data selects API data. Missing and null values do not mean zero.
Permissions
API keys require read scope. Provider credentials are managed by the server.
Global Options
The following global options can be used with orc research note:
For details and examples, see global options.