Skip to content

docs(agentic-payments): improve docs about x402 and Skyfire payment providers#2622

Open
stepskop wants to merge 3 commits into
masterfrom
docs/x402-agentic-payments-improvements
Open

docs(agentic-payments): improve docs about x402 and Skyfire payment providers#2622
stepskop wants to merge 3 commits into
masterfrom
docs/x402-agentic-payments-improvements

Conversation

@stepskop

@stepskop stepskop commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Improves docs around agentic payments (x402 and Skyfire), addressing several issues:

  • Document accessing the Actor run and its storages by reusing the existing header value for authentication
  • Mention authentication through agentic payment in API docs (reported in Slack)
  • Document allowsAgenticUsers=true eligibility criteria in the monetization docs (reported in Slack)
  • Unifies the "Supported Actors" section across both pages (that supported Actors can be retrieved from the /store endpoint using allowsAgenticUsers=true parameter)
  • Notes that the payment protocol is inferred from the provider-specific header (no X-APIFY-PAYMENT-PROTOCOL needed once a payment header is present).

- 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
@github-actions github-actions Bot added the t-core-services Issues with this label are in the ownership of the core services team. label Jun 8, 2026
@apify-service-account

apify-service-account commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

✅ Preview for this PR (commit 650734c) is ready at https://pr-2622.preview.docs.apify.com (see action run).

@stepskop stepskop changed the title docs: improve agentic payment (x402, Skyfire) docs docs(agentic-payments): improve docs about using x402 and Skyfire payment providers Jun 8, 2026

- 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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bummer. We don't want to bring Actor Standby down. Any better ideas? cc @raethlo

@stepskop stepskop requested a review from raethlo June 8, 2026 13:36
@stepskop stepskop changed the title docs(agentic-payments): improve docs about using x402 and Skyfire payment providers docs(agentic-payments): improve docs about x402 and Skyfire payment providers Jun 8, 2026

@raethlo raethlo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 🏇

"https://api.apify.com/v2/datasets/<datasetId>/items"
```

## Supported Actors

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is limited permissions required? Cause it's not mentioned anywhere on the pages for the specific methods.

Comment on lines 11 to 15
:::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.

:::

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

x402 uses run-sync-get-dataset-items, here's run-sync. Is that correct?

@marcel-rbro

Copy link
Copy Markdown
Contributor

Just keep in mind that #2618 will probably be merged before this PR and touches the same documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-core-services Issues with this label are in the ownership of the core services team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants