Publish your Actor
By publishing your Actor, you make it available to the public on Apify Store. Publishing turns your Actor into a product with its own dedicated page, where users can read its documentation, run it, and review it.
Before you start
To publish an Actor on Apify Store, you must first:
- Accept the Store Publishing Terms and Conditions.
- Build and run your Actor at least once.
- Update your Actor README.
- Define the input and output schemas of your Actor.
If your Actor requires full permissions, or you want to publish more than 10 Actors, you must also verify your identity.
Make your Actor public
To make your Actor available on Apify Store:
- Log in to Apify Console.
- In the left-side panel, go to Development > My Actors.
- From the table, select the Actor you want to publish.
- Go to the Publishing tab.
Complete all required fields in the following sections:
- In the Display information section, add an Actor logo and description.
- In the Monetization section, set up monetization for your Actor.
- In the Sample output section, add a sample output for your Actor. If the input schema already includes the sample output, it's added automatically.
- In the Output schema section, define the output schema of your Actor. Optionally, define also the following schemas:
- In Actor permissions, define the permission level that your Actor requires.
Once all sections are marked as completed, select Publish on Store.
Verify the publication
To verify that your Actor has been published, use one of these methods:
- Open
https://apify.com/YOUR_USERNAME/YOUR_ACTOR_NAMEin a private browser window. If the Actor's page loads, your Actor is published. - Call the Get Actor API endpoint. If the
isPublicproperty in the response istrue, your Actor is published.
Publish Actor's source code
By default, the source code of your Actor is hidden from the public.
By making the source files and non-secret environment variables of your Actor publicly visible, you make your Actor open source and eligible for payouts through the Apify Open Source Fair Share program.
To publish your Actor's source code:
- Log in to Apify Console.
- In the left-side panel, go to Development > My Actors.
- From the table, select the Actor whose source code you want to publish.
- Go to the Publishing tab.
- In Display information, uncheck Hide source files from Actor detail.
You can't publish the source code of an Actor that you build from a private repository. Secret environment variables are never exposed.