Example using GitHub Gist avatar
Example using GitHub Gist
Try for free

No credit card required

View all Actors
Example using GitHub Gist

Example using GitHub Gist

apify/example-github-gist
Try for free

No credit card required

Example of an Apify actor with source code hosted in a GitHub Gist. For example, this is useful if you want to have public code examples accompanied by a working API that anyone can try straight away.

Below you can find a list of relevant HTTP API endpoints for calling the Actor. To use them, you need to have an Apify account. Replace <YOUR_API_TOKEN> in the URLs with your API token, which you can find under Settings > Integrations in Apify Console. For details, see the API reference .

Run Actor synchronously and get dataset items

Runs this Actor and waits for it to finish. The POST payload including its Content-Type header is passed as INPUT to the Actor (usually application/json). The HTTP response contains the Actor's dataset items, while the format of items depends on specifying dataset items' format parameter.

POST
https://api.apify.com/v2/acts/apify~example-github-gist/run-sync-get-dataset-items?token=<YOUR_API_TOKEN>

Hint: This endpoint can be used with both POST and GET request methods, but only the POST method allows you to pass input.

Run Actor synchronously

Runs this Actor and waits for it to finish. The POST payload including its Content-Type is passed as INPUT to the Actor (usually application/json) and the OUTPUT is returned in the HTTP response. The Actor is started with the default options; you can override them using various URL query parameters. Note that long HTTP connections might break.

POST
https://api.apify.com/v2/acts/apify~example-github-gist/run-sync?token=<YOUR_API_TOKEN>

Hint: This endpoint can be used with both POST and GET request methods, but only the POST method allows you to pass input.

Run Actor

Runs this Actor. The POST payload including its Content-Type header is passed as INPUT to the Actor (typically application/json). The Actor is started with the default options; you can override them using various URL query parameters.

POST
https://api.apify.com/v2/acts/apify~example-github-gist/runs?token=<YOUR_API_TOKEN>

Hint: By adding the method=POST query parameter, this API endpoint can be called using a GET request and thus used in third-party webhooks.

Get Actor

Returns settings of this Actor in JSON format.

GET
https://api.apify.com/v2/acts/apify~example-github-gist?token=<YOUR_API_TOKEN>

Get list of Actor versions

Returns a list of versions of this Actor in JSON format.

GET
https://api.apify.com/v2/acts/apify~example-github-gist/versions?token=<YOUR_API_TOKEN>

Get list of Actor webhooks

Returns a list of webhooks of this Actor in JSON format.

GET
https://api.apify.com/v2/acts/apify~example-github-gist/webhooks?token=<YOUR_API_TOKEN>
Developer
Maintained by Apify
Actor metrics
  • 1 monthly user
  • 0 stars
  • 100.0% runs succeeded
  • Created in Jan 2018
  • Modified 5 days ago