Skip to content

Commit 0c0ac56

Browse files
committed
deep search: update documentation of supported query parameters
1 parent 69abe75 commit 0c0ac56

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

docs/deep-search/api.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,9 +191,11 @@ Available query parameters:
191191

192192
- `filter_id` - Filter by conversation ID
193193
- `filter_user_id` - Filter by user ID
194+
- `filter_read_token` - Access conversations via read token (requires sharing to be enabled)
195+
- `filter_is_starred` - Filter by starred conversations (`true` or `false`)
194196
- `page_first` - Number of results per page
195197
- `page_after` - Pagination cursor
196-
- `sort` - Sort order: `created_at`, `-created_at`, `updated_at`, `-updated_at`
198+
- `sort` - Sort order: `id`, `-id`, `created_at`, `-created_at`, `updated_at`, `-updated_at` (default: `-updated_at`)
197199

198200
## Managing conversations
199201

@@ -225,6 +227,21 @@ curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1/140/questions/163
225227
-H 'X-Requested-With: my-client 1.0.0'
226228
```
227229

230+
## Accessing conversations via read tokens
231+
232+
You can retrieve a conversation using its read token with the `filter_read_token` query parameter.
233+
234+
Each conversation includes a `read_token` field that allows accessing the conversation.
235+
The read token is also visible in the web client URL and in the `share_url` field.
236+
Note that you can only access other users' conversations via read tokens if sharing is enabled on your Sourcegraph instance.
237+
238+
```bash
239+
curl 'https://your-sourcegraph-instance.com/.api/deepsearch/v1?filter_read_token=5d9aa113-c511-4687-8b71-dbc2dd733c03' \
240+
-H 'Accept: application/json' \
241+
-H "Authorization: token $SRC_ACCESS_TOKEN" \
242+
-H 'X-Requested-With: my-client 1.0.0'
243+
```
244+
228245
## Response structure
229246

230247
**Conversation object:**

0 commit comments

Comments
 (0)