> For the complete documentation index, see [llms.txt](https://docs.scraperapi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scraperapi.com/data-pipeline/datapipeline-endpoints/endpoints-and-parameters.md). # Endpoints and Parameters The following section provides a list of the current API endpoints and parameters. Explore these options to tailor your experience and optimize your integration with our DataPipeline. ## List of Endpoints ```java Create a project POST Get a single project GET Update a project PATCH Archive a project DELETE List projects GET List the jobs of a project GET Cancel a job DELETE ``` ## Fields / Parameters


`name`	The project name is purely for representation purposes.
`schedulingEnabled`	true / false This specifies the automatic rescheduling of a project. If it's set to `false`, the project won't be rescheduled after the next run (if applicable)
`scrapingInterval`	- just scrape once (default) - hourly - daily - weekly - monthly - cron expression like "10 * * * *"
`scheduledAt`	Next project runtime. Should be specified in ISO 8601 format. Simply use "now" as your reference point to initiate at the earliest possible time.
`createdAt`	The ISO 8601 representation of the date when the project was created.
`projectType`	This can be `URLs` for simple URL scraping, or a number of other values if you need to get structured data (JSON,CSV) Valid `projectType` parameters: - urls - amazon_product - amazon_offer - amazon_review - amazon_search - ebay_product - ebay_search - google_jobs - google_news - google_search - google_shopping - redfin_search - redfin_agent - redfin_forsale - refin_forrent - walmart_category - walmart_product - walmart_search - walmart_review
`projectInput`	The source of the list of URLs, search terms etc. for the project. There are 2 valid variants - A simple list (this is the default): `{"type": "list", "list": ["<https://example.com>", "<https://wikipedia.org>"] }` - Webhook input. The result of the address of the webhook has to be a new line delimited list of search terms, asins, etc. `{"type": "webhook_input", "url": "<https://the.url.where.your.list.is>" }`
`webhookOutput`	The results are always saved and you can download them through the results link or through the UI. If you want to get a webhook callback from your jobs you can add an optional parameter: `...` `"webhookOutput": { "url": "<url>"}` `...` If you want to encode the results as multipart/form-data (because for example you use webhook.site) you can use the extra webhookEncoding parameter like that: `"webhookOutput": {` `"url": "<url>",` `"webhookEncoding": "multipart_form_data_encoding"}` To unset a webhookOutput set it's value ot null `"webhookOutput": null`
`notificationConfig`	Conifugre when to send email notifications about the finished jobs •`notifyOnSuccess` - valid values `never`, `with_every_run`, `daily`, `weekly` •`notifyOnFailure` - valid values `with_every_run`, `daily`, `weekly`
`apiParams`	Please refer to the Async API params.
`output_format`	Set the output format of the response: •CSV •JSON

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.scraperapi.com/data-pipeline/datapipeline-endpoints/endpoints-and-parameters.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.