docs(agentic-payments): improve docs about x402 and Skyfire payment providers#2622
docs(agentic-payments): improve docs about x402 and Skyfire payment providers#2622stepskop wants to merge 3 commits into
Conversation
- x402: document accessing run/storage with the existing PAYMENT-SIGNATURE - API auth reference: mention agentic payments (x402, Skyfire) - Skyfire: discover payment requirements via X-APIFY-PAYMENT-PROTOCOL header - Drop redundant protocol header once a payment header is present (inferred) - Unify Supported Actors section across x402 and Skyfire - Document allowsAgenticUsers eligibility criteria in monetization docs
|
✅ Preview for this PR (commit |
|
|
||
| - Use the [pay per event](/platform/actors/publishing/monetize/pay-per-event) pricing model. Rental and pay-per-usage Actors are not supported. | ||
| - Run with [limited permissions](/platform/actors/development/permissions). Actors that request full permissions are excluded. | ||
| - Not rely on [Standby](/platform/actors/running/standby) mode for now. Standby support is coming soon. |
There was a problem hiding this comment.
This is a bummer. We don't want to bring Actor Standby down. Any better ideas? cc @raethlo
| "https://api.apify.com/v2/datasets/<datasetId>/items" | ||
| ``` | ||
|
|
||
| ## Supported Actors |
There was a problem hiding this comment.
| ## Supported Actors | |
| ### Supported Actors |
This can be an H3, same as in Skyfire docs.
| To be eligible for agentic payments, your Actor must: | ||
|
|
||
| - Use the [pay per event](/platform/actors/publishing/monetize/pay-per-event) pricing model. Rental and pay-per-usage Actors are not supported. | ||
| - Run with [limited permissions](/platform/actors/development/permissions). Actors that request full permissions are excluded. |
There was a problem hiding this comment.
Is limited permissions required? Cause it's not mentioned anywhere on the pages for the specific methods.
| :::caution Experimental feature | ||
|
|
||
| Agentic payments are experimental and may change as payment protocols evolve. Only Actors with the [Pay Per Event](/platform/actors/publishing/monetize/pay-per-event) pricing model are supported. [Standby](/platform/actors/running/standby) Actors are not supported. | ||
|
|
||
| ::: |
There was a problem hiding this comment.
Do we still want to keep this note? We're already mentioning x402 elsewhere in the docs. The info could be moved to the section about supported Actors.
|
|
||
| ## Make your Actor eligible for agentic payments | ||
|
|
||
| [Agentic payments](/platform/integrations/x402) let AI agents discover, run, and pay for your Actor without an Apify account, using protocols such as [x402](/platform/integrations/x402) and [Skyfire](/platform/integrations/skyfire). Eligible Actors are flagged with `allowsAgenticUsers=true` and surface in agentic discovery, for example when [searching the store via API](https://docs.apify.com/api/v2#/reference/store/store-actors-collection/get-list-of-actors-in-store) with `allowsAgenticUsers=true`. |
There was a problem hiding this comment.
The first link is generic for Agentic payments, but only links to x402. I'd just not use a link here as the links to x402 and skyfire are there later in the text.
|
|
||
| - Use the [pay per event](/platform/actors/publishing/monetize/pay-per-event) pricing model. Rental and pay-per-usage Actors are not supported. | ||
| - Run with [limited permissions](/platform/actors/development/permissions). Actors that request full permissions are excluded. | ||
| - Not use [Standby](/platform/actors/running/standby) mode for now. Standby support is coming soon. |
There was a problem hiding this comment.
| - Not use [Standby](/platform/actors/running/standby) mode for now. Standby support is coming soon. | |
| - Not use [Standby](/platform/actors/running/standby) mode for now. Standby support is coming later. |
Just to be sure
| ```bash | ||
| curl -si \ | ||
| -H 'X-APIFY-PAYMENT-PROTOCOL: SKYFIRE' \ | ||
| 'https://api.apify.com/v2/actors/ACTOR_ID/run-sync' |
There was a problem hiding this comment.
x402 uses run-sync-get-dataset-items, here's run-sync. Is that correct?
|
Just keep in mind that #2618 will probably be merged before this PR and touches the same documentation. |
Improves docs around agentic payments (x402 and Skyfire), addressing several issues:
allowsAgenticUsers=trueeligibility criteria in the monetization docs (reported in Slack)/storeendpoint usingallowsAgenticUsers=trueparameter)X-APIFY-PAYMENT-PROTOCOLneeded once a payment header is present).