Version: Next

RequestResource

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

Hierarchy

RequestBase
- RequestResource

Index

Properties

error_messages

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

Error messages recorded from failed processing attempts.

handled_at

handled_at: Annotated[AwareDatetime | None, Field(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[str | None, Field(examples=['https://apify.com/jobs'])]

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

lock_by_client

lock_by_client: str | None

Key of the client that last locked the request. It is set when the request is locked and removed only by an explicit unlock or by an update of the request, so it can still be present after the lock has expired.

lock_expires_at

lock_expires_at: AwareDatetime | None

The timestamp when the lock on this request expires. Only present while the request is locked.

method

method: HttpMethod | None

model_config

model_config: Undefined

no_retry

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

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

payload

payload: Annotated[str | 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(examples=[0])]

The number of times this request has been retried.

unique_key

unique_key: Annotated[str, Field(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[str, Field(examples=['https://apify.com'])]

The URL of the request.

user_data

user_data: RequestUserData | None