Skip to main content

Module models

Module models 

Source
Expand description

Data models for Apify API resources.

Each resource is modelled with the fields most commonly used by clients, mirroring the reference JavaScript client. To remain forward-compatible with additive changes to the API, every model captures any unknown fields in an extra map via #[serde(flatten)], so new API fields never break deserialization.

Structs§

Actor
An Actor on the Apify platform.
ActorEnvVar
An environment variable attached to an Actor version.
ActorRun
A single execution of an Actor (an Actor run).
ActorStoreListItem
A single Actor entry as returned by the Apify Store listing.
ActorVersion
An Actor version.
Build
A build of an Actor.
Dataset
A dataset storage.
KeyValueStore
A key-value store storage.
KeyValueStoreKey
Metadata about a single key in a key-value store.
KeyValueStoreKeysPage
Result of listing keys in a key-value store (key-based pagination).
KeyValueStoreRecord
A record (key + value + content type) in a key-value store.
RequestQueue
A request queue storage.
RequestQueueHead
The head of a request queue (requests waiting to be processed).
RequestQueueOperationInfo
Result of adding (or updating) a request in a queue.
RequestQueueRequest
A single request stored in a request queue.
Schedule
A schedule that triggers Actor or task runs on a cron expression.
Task
An Actor task (a saved, reusable Actor configuration).
User
Account information about a user.
Webhook
A webhook that notifies an external URL on Actor events.
WebhookDispatch
A single dispatch (invocation) of a webhook.

Type Aliases§

Extra
Convenience alias for the catch-all map of unmodelled JSON fields.