Skip to main content

Add request

POST 
/v2/request-queues/:queueId/requests

Adds request to the queue. Response contains ID of the request and info if request was already present in the queue or handled.

If request with same uniqueKey was already present in the queue then returns an ID of existing request.

Request

Path Parameters

    queueId string required

    Queue ID or username~queue-name.


    Example: WkzbQMuFYuamGv3YF

Query Parameters

    clientKey string

    A unique identifier of the client accessing the request queue. It must be a string between 1 and 32 characters long. This identifier is used to determine whether the queue was accessed by multiple clients. If clientKey is not provided, the system considers this API call to come from a new client. For details, see the hadMultipleClients field returned by the Get head operation.


    Example: client-abc
    forefront string

    Determines if request should be added to the head of the queue or to the end. Default value is false (end of queue).


    Example: false

Bodyrequired

  • id string

    A unique identifier assigned to the request.


    Example: sbJ7klsdf7ujN9l
  • uniqueKey string required

    A unique key used for request de-duplication. Requests with the same unique key are considered identical.


    Example: GET|60d83e70|e3b0c442|https://apify.com
  • url string<uri> required

    The URL of the request.


    Example: https://apify.com
  • method string required

    The HTTP method of the request.


    Example: GET

Status 201

Response Headers
    {
      "data": {
        "requestId": "YiKoxjkaS9gjGTqhF",
        "wasAlreadyPresent": true,
        "wasAlreadyHandled": false
      }
    }