--- title: research note description: Research note articles, creators and topics. canonical_url: https://orchestor.io/docs/en/cli/research/note markdown_url: https://orchestor.io/docs/en/cli/research/note.md contentType: reference --- # 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 ```bash title="terminal" orc research note articles search --q "生成AI" --workspace --json ``` *Search public articles.* ## Subcommands ### `articles search` Search note articles with `--q`, then use discovered article IDs to read articles or comments. ```bash title="terminal" 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. ```bash title="terminal" orc research note articles search --q ``` ##### `--sort` Native note ordering: popular, newest, or hot.; enum: popular|new|hot Type: `string`. Optional. ```bash title="terminal" orc research note articles search --sort ``` ##### `--start` Use pagination.next_start from the previous response; keep other search parameters unchanged.; (use "null" or "reset" to clear) Type: `number`. Optional. ```bash title="terminal" orc research note articles search --start ``` ##### `--paid` true selects the source sales collection; it does not unlock paid bodies.; enum: true|false Type: `string`. Optional. ```bash title="terminal" orc research note articles search --paid ``` ### `articles get` Retrieve a note article using the article ID returned by a list or search. ```bash title="terminal" orc research note articles get [options] ``` ### `creators get` Retrieve a creator’s public profile by name, using creator information from article results. ```bash title="terminal" orc research note creators get [options] ``` ### `hashtags get` Retrieve public information about a named hashtag. ```bash title="terminal" orc research note hashtags get [options] ``` ### `hashtags articles list` Retrieve one page of articles associated with a hashtag. ```bash title="terminal" orc research note hashtags articles list [options] ``` #### Unique options ##### `--page` One-based native page number; use the returned continuation. Type: `number`. Optional. ```bash title="terminal" orc research note hashtags articles list --page ``` ### `interests get` Retrieve public information for a named interest. ```bash title="terminal" orc research note interests get [options] ``` #### Unique options ##### `--page` One-based native page number; use the returned continuation. Type: `number`. Optional. ```bash title="terminal" orc research note interests get --page ``` ### `map` Discover note topics and retrieval entry points. Use a returned topic path with `topics get`. ```bash title="terminal" orc research note map [options] ``` ### `tags get` Retrieve public information about a named tag. ```bash title="terminal" orc research note tags get [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. ```bash title="terminal" orc research note tags get --mode ``` ### `topics get` Retrieve a topic using `--path` discovered through `map`. Nested topic paths are supported. ```bash title="terminal" 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. ```bash title="terminal" orc research note topics get --page ``` ##### `--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. ```bash title="terminal" orc research note topics get --tab ``` ##### `--path` Topic ID from map; nested paths are supported.; max 200 chars Type: `string`. Required. ```bash title="terminal" orc research note topics get --path ``` ### `trends list` Retrieve note’s trending sections while retaining source coverage and ordering. ```bash title="terminal" orc research note trends list [options] ``` #### Unique options ##### `--page` One-based native page number; use the returned continuation. Type: `number`. Optional. ```bash title="terminal" orc research note trends list --page ``` ### `articles comments list` Retrieve one page of comments for an article. Keep the article and filters unchanged when following continuation. ```bash title="terminal" orc research note articles comments list [options] ``` #### Unique options ##### `--page` One-based native page number; use the returned continuation. Type: `number`. Optional. ```bash title="terminal" orc research note articles comments list --page ``` ### `creators articles list` List articles by creator name. Use the source identifier rather than a display name. ```bash title="terminal" orc research note creators articles list [options] ``` #### Unique options ##### `--page` One-based native page number; use the returned continuation. Type: `number`. Optional. ```bash title="terminal" orc research note creators articles list --page ``` ## Examples ### Retrieve a public topic. ```bash title="terminal" orc research note topics get --path challenge --workspace --json ``` *Retrieve a public topic.* ### Retrieve hashtag information. ```bash title="terminal" orc research note hashtags get "生成AI" --workspace --json ``` *Retrieve 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](https://orchestor.io/docs/cli/global-flags.md) can be used with `orc research note`: - [`--help`](https://orchestor.io/docs/cli/global-flags.md#help) - [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#workspace) - [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-output) - [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-output) - [`--format`](https://orchestor.io/docs/cli/global-flags.md#output-format) - [`--field`](https://orchestor.io/docs/cli/global-flags.md#field-selection) - [`--fields`](https://orchestor.io/docs/cli/global-flags.md#field-selection) - [`--raw`](https://orchestor.io/docs/cli/global-flags.md#raw-output) - [`--output`](https://orchestor.io/docs/cli/global-flags.md#file-output) - [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#pager) - [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#dry-run) - [`--yes`](https://orchestor.io/docs/cli/global-flags.md#confirmation) - [`--limit`](https://orchestor.io/docs/cli/global-flags.md) - [`--cursor`](https://orchestor.io/docs/cli/global-flags.md) - [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#standard-input) - [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#standard-input) - [`--timing`](https://orchestor.io/docs/cli/global-flags.md#request-timing) For details and examples, see [global options](https://orchestor.io/docs/cli/global-flags.md). ## Related commands - Research overview - [Global options](https://orchestor.io/docs/en/cli/global-flags.md) --- [Documentation index](https://orchestor.io/docs/llms.txt)