Sign in

v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Storage/Request queues/Requests

Add request

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.

post/v2/request-queues/{queueId}/requests

Path parameters

queueIdstring required
Example:WkzbQMuFYuamGv3YF

Queue ID or username~queue-name.

Query parameters

clientKeystring
Example:client-abc

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.

forefrontstring
Example:false

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

Request body

uniqueKeystring

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

urlstring

The URL of the request.

method'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH'
retryCountinteger

The number of times this request has been retried.

loadedUrlstring nullable

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

headersobject nullable

HTTP headers sent with the request.

userDataRequestUserData

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

noRetryboolean nullable

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

errorMessagesstring[] nullable

Error messages recorded from failed processing attempts.

handledAtstring date-time nullable

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

Example request

{
  "uniqueKey": "GET|60d83e70|e3b0c442|https://apify.com",
  "url": "https://apify.com",
  "method": "GET",
  "loadedUrl": "https://apify.com/jobs",
  "userData": {
    "label": "DETAIL",
    "customField": "custom-value"
  },
  "handledAt": "2019-06-16T10:23:31.607Z"
}

Response

Example response

{
  "data": {
    "requestId": "sbJ7klsdf7ujN9l"
  }
}