Skip to content

Commit 07d0a2e

Browse files
Jkuzzclaude
andauthored
docs: add responseFormat and includeUnrunnableActors to store search endpoint (#2419)
## Summary - Add `responseFormat` query param (`full` | `agent`) for LLM-optimized responses - Add `includeUnrunnableActors` boolean param to bypass safety filtering Follows apify/apify-core#26566. 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Documentation-only change to the OpenAPI spec; no runtime logic is modified, so risk is low aside from potential client expectation changes. > > **Overview** > Documents two new query parameters on `GET /store`: `responseFormat` (`full`|`agent`) to request a reduced, LLM-oriented response shape, and `includeUnrunnableActors` to optionally bypass the default safety filtering that excludes automatically-unrunnable Actors. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 4dc776d. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent bfcad19 commit 07d0a2e

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

apify-api/openapi/paths/store/store.yaml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,36 @@ get:
7575
schema:
7676
type: boolean
7777
example: true
78+
- name: responseFormat
79+
in: query
80+
description: |
81+
Controls the shape of the response. Use `full` (default) for the
82+
complete response including image URLs and all fields. Use `agent`
83+
for a reduced field set optimized for LLM consumers, which only
84+
includes `id`, `title`, `name`, `username`, `description`, `notice`,
85+
`badge`, `categories`, and minimal `stats`.
86+
style: form
87+
explode: true
88+
schema:
89+
type: string
90+
enum:
91+
- full
92+
- agent
93+
default: full
94+
example: agent
95+
- name: includeUnrunnableActors
96+
in: query
97+
description: |
98+
By default, search results exclude Actors that are not safe to run
99+
automatically (e.g. Actors from developers who haven't passed KYC, or
100+
full-permission Actors without a large user base). Set to `true` to
101+
bypass this safety filtering and include all Actors in the results.
102+
style: form
103+
explode: true
104+
schema:
105+
type: boolean
106+
default: false
107+
example: true
78108
responses:
79109
"200":
80110
description: ""

0 commit comments

Comments
 (0)