Skip to main content
Version: Next

Request

A request stored in the request queue, including its metadata and processing state.

Hierarchy

Index

Properties

error_messages

error_messages: Annotated[list[str] | None, Field(alias='errorMessages', examples=[None])]

Error messages recorded from failed processing attempts.

handled_at

handled_at: Annotated[AwareDatetime | None, Field(alias='handledAt', examples=['2019-06-16T10:23:31.607Z'])]

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

headers

headers: Annotated[dict[str, Any] | None, Field(examples=[None])]

HTTP headers sent with the request.

id

id: str | None

A unique identifier assigned to the request.

loaded_url

loaded_url: Annotated[AnyUrl | None, Field(alias='loadedUrl', examples=['https://apify.com/jobs'])]

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

method

method: HttpMethod | None

model_config

model_config: Undefined

no_retry

no_retry: Annotated[bool | None, Field(alias='noRetry', examples=[False])]

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

payload

payload: Annotated[dict[str, Any] | None, Field(examples=[None])]

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

retry_count

retry_count: Annotated[int | None, Field(alias='retryCount', examples=[0])]

The number of times this request has been retried.

unique_key

unique_key: Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]

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

url

url: Annotated[AnyUrl | None, Field(examples=['https://apify.com'])]

The URL of the request.

user_data

user_data: RequestUserData | None