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

  • uniqueKey UniqueKey (string)

    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>

    The URL of the request.


    Example: https://apify.com
  • method HttpMethod (string)

    Possible values: [GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH]


    Example: GET
  • retryCount RetryCount (integer)

    The number of times this request has been retried.


    Example: 0
  • loadedUrl string,null<uri> nullable

    The final URL that was loaded, after redirects (if any).


    Example: https://apify.com/jobs
  • payload object | null nullable

    The request payload, typically used with POST or PUT requests.


    Example: null
  • headers object | null nullable

    HTTP headers sent with the request.


    Example: null
  • userData object

    Custom user data attached to the request. Can contain arbitrary fields.

    • label string | null nullable

      Optional label for categorizing the request.


      Example: DETAIL
    • image string,null<uri> nullable

      Optional image URL associated with the request.


      Example: https://picserver1.eu
    • property name* any

      Custom user data attached to the request. Can contain arbitrary fields.

  • noRetry boolean | null nullable

    Indicates whether the request should not be retried if processing fails.


    Example: false
  • errorMessages string[] nullable

    Error messages recorded from failed processing attempts.


    Example: null
  • handledAt string,null<date-time> nullable

    The timestamp when the request was marked as handled, if applicable.


    Example: 2019-06-16T10:23:31.607Z

Status 201

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