docs: add agentic payments docs#1981
Conversation
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
The OpenAPI part (for which I'm a code owner) is fine, but not the important part of the PR - that's why I removed my review request |
tobice
left a comment
There was a problem hiding this comment.
Read through the documentation page and honestly, I don't have much to add there. Looks good, ship it 🚀 👍
| - name: allowsAgenticUsers | ||
| in: query | ||
| description: | | ||
| If true, only return Actors that allow agentic users. If false, only |
|
I added a diagram of the whole flow to the "How It Works" section. |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
mhamas
left a comment
There was a problem hiding this comment.
LGTM, couple of small comments to consider.
|
|
||
| Agentic payments enable AI agents to autonomously run Apify Actors using third-party payment providers, without requiring traditional Apify user accounts. This allows agents to discover, execute, and pay for web scraping and automation tasks independently. | ||
|
|
||
| Currently, Apify supports agentic payments through **Skyfire**, a payment network specifically designed for AI agents. |
There was a problem hiding this comment.
Nit: I'd smuggle somewhere that more integrations are planned for foreseeable future.
|
|
||
| ### Configuration | ||
|
|
||
| Configure your MCP client to connect to both the Skyfire and Apify MCP servers. When connecting to the Apify MCP server for agentic payments, you must include the `?payment=skyfire` query parameter in the server URL. This enables the agentic payment flow and informs the agent about payment requirements. |
There was a problem hiding this comment.
Q: do we want to also include this info on mcp.apify.com? So agentic-payment-supported URL can be easily copied from there?
| https://mcp.apify.com?payment=skyfire&tools=actor1,actor2,actor3 | ||
| ``` | ||
|
|
||
| Replace `actor1,actor2,actor3` with the actual Actor IDs you want to make available, such as `junglee/free-amazon-product-scraper,streamers/youtube-scraper`. |
There was a problem hiding this comment.
Suggestion: I'd also refer to the section below on discussion, which Actors are available.
|
|
||
| ## Using Skyfire with Apify API | ||
|
|
||
| For direct API integration, you can use Skyfire PAY tokens to authenticate and pay for Actor runs. |
There was a problem hiding this comment.
Suggestion: here, I'd stress that the MCP client should do all of this seamlessly behind the scenes. That's the primary and recommended mode of operation. The information here is just for completness if somebody decides they want to try it out directly.
|
|
||
| Not all Actors in the Apify Store can be run using agentic payments. | ||
|
|
||
| Apify maintains a curated list of Actors approved for agentic payments. To check if an Actor supports agentic payments, use the `allowsAgenticUsers=true` query parameter when [searching the store via API](https://docs.apify.com/api/v2#/reference/store/store-actors-collection/get-list-of-actors-in-store). |
There was a problem hiding this comment.
Nit: you you maybe directly link the correct URL user can just copy paste?
mhamas
left a comment
There was a problem hiding this comment.
LGTM, couple of small comments to consider.
|
Preview for this PR was built for commit |
TC-MO
left a comment
There was a problem hiding this comment.
Few changes made to formatting, some changes for clarity & conciness.
Removed time-anchor in docs
Fixed description
Some questions as well
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
TC-MO
left a comment
There was a problem hiding this comment.
Few more things, after that we are good to go
|
Preview for this PR was built for commit |
Adds a page at `/platform/integrations/skyfire`. Dedicated to the documentation of agentic payments with Skyfire. Also mentions the `allowsAgenticUsers` parameter on API's `GET /store`. Based on [this Notion document](https://www.notion.so/apify/Agentic-Payments-User-documentation-284f39950a22808381d6f5a03c36e024). <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Adds Skyfire agentic payments documentation and updates Store Actors API with `allowsAgenticUsers` filter and `isWhiteListedForAgenticPayment` field. > > - **API (OpenAPI)** > - Add query parameter `allowsAgenticUsers` (boolean) to `GET /store` actors listing in `apify-api/openapi/paths/store/store.yaml`. > - Extend response examples with `isWhiteListedForAgenticPayment` on actor items. > - **Docs** > - New page `sources/platform/integrations/ai/skyfire.md` documenting agentic payments via Skyfire: > - MCP setup and configuration (including `?payment=skyfire` and optional `actors` preload). > - API usage with `skyfire-pay-id` header for Actor runs and data retrieval. > - Limitations and supported-actors filtering using `allowsAgenticUsers=true`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 906522f. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
Adds a page at
/platform/integrations/skyfire. Dedicated to the documentation of agentic payments with Skyfire.Also mentions the
allowsAgenticUsersparameter on API'sGET /store.Based on this Notion document.
Note
Adds Skyfire agentic payments documentation and updates Store Actors API with
allowsAgenticUsersfilter andisWhiteListedForAgenticPaymentfield.allowsAgenticUsers(boolean) toGET /storeactors listing inapify-api/openapi/paths/store/store.yaml.isWhiteListedForAgenticPaymenton actor items.sources/platform/integrations/ai/skyfire.mddocumenting agentic payments via Skyfire:?payment=skyfireand optionalactorspreload).skyfire-pay-idheader for Actor runs and data retrieval.allowsAgenticUsers=true.Written by Cursor Bugbot for commit 906522f. Configure here.