docs: Add more info about free users #2150
Open
+27
−11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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 |
metalwarrior665
requested changes
Dec 22, 2025
Member
metalwarrior665
left a comment
metalwarrior665
left a comment
There was a problem hiding this comment.
I added a few suggestions to be more perscriptive so devs do this correctly. Feel free to rephrase me.
|
|
||
| If your Actor has specific limitations for users on the Apify free plan (e.g., restricted features, limited results), it is crucial to communicate these clearly to avoid confusion. | ||
|
|
||
| - Status messages: Use `setStatusMessage` or the exit message to explain why a run finished early or failed (e.g., "Daily limit for free plan reached. Upgrade to continue."). |
Member
There was a problem hiding this comment.
Let's be more direct so they don't need to search the docs. Many devs don't know that Actor.exit has a status message
Suggested change
| - Status messages: Use `setStatusMessage` or the exit message to explain why a run finished early or failed (e.g., "Daily limit for free plan reached. Upgrade to continue."). | |
| - Status messages: Use `Actor.setStatusMessage` or `Actor.exit` message to explain why a run finished early or failed (e.g., "Daily limit for free plan reached. Upgrade to continue."). |
| If your Actor has specific limitations for users on the Apify free plan (e.g., restricted features, limited results), it is crucial to communicate these clearly to avoid confusion. | ||
|
|
||
| - Status messages: Use `setStatusMessage` or the exit message to explain why a run finished early or failed (e.g., "Daily limit for free plan reached. Upgrade to continue."). | ||
| - Avoid false errors: Do not return generic system errors or fail the run in a way that looks like a platform issue. This frustrates users and makes troubleshooting difficult. |
Member
There was a problem hiding this comment.
Again, let's be more perscriptive
Suggested change
| - Avoid false errors: Do not return generic system errors or fail the run in a way that looks like a platform issue. This frustrates users and makes troubleshooting difficult. | |
| - Avoid false errors: Do not return generic system errors or fail the run in a way that looks like a platform issue. This frustrates users and makes troubleshooting difficult. | |
| - Wrong: API usage is limited to 10 results | |
| - Right: This Actor only allows up to 10 results for free users. Upgrade to a paid plan to receive unlimited results. |
|
|
||
| - Status messages: Use `setStatusMessage` or the exit message to explain why a run finished early or failed (e.g., "Daily limit for free plan reached. Upgrade to continue."). | ||
| - Avoid false errors: Do not return generic system errors or fail the run in a way that looks like a platform issue. This frustrates users and makes troubleshooting difficult. | ||
| - Documentation: Clearly state any limitations in your Actor's `README` and input schema descriptions so users know what to expect before running the Actor. |
Member
There was a problem hiding this comment.
Suggested change
| - Documentation: Clearly state any limitations in your Actor's `README` and input schema descriptions so users know what to expect before running the Actor. | |
| - Documentation: Clearly state any limitations in your Actor's `README` and input schema descriptions so users know what to expect before running the Actor. | |
| - General restrictions (like limiting the number of results) must be explained in the top-level input schema description that renders above the input editor UI. | |
| - Feature-specific limitations must be included in the title of an input field. The title must include explanation in parenthesis such as `(paying users only)` or `(limited for free users`). E.g. `Max comments (paying users only)`. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note
Adds documentation on transparently handling free-plan limitations, including using status messages and graceful exits.
platform/actors/development/programming_interface/status_messages.mdwith guidance to:setStatusMessage/exit messages to explain early finishes or failures.READMEand input schema.platform/actors/publishing/monetize/index.mdxcovering:Written by Cursor Bugbot for commit 803f9d6. Configure here.