apify-client-python
Index
Async Resource Clients
Classes
- _BaseApifyClient
- _BaseBaseClient
- _BaseHTTPClient
- _ContextInjectingFilter
- _DebugLogFormatter
- ActorClient
- ActorClientAsync
- ActorCollectionClient
- ActorCollectionClientAsync
- ActorEnvVarClient
- ActorEnvVarClientAsync
- ActorEnvVarCollectionClient
- ActorEnvVarCollectionClientAsync
- ActorVersionClient
- ActorVersionClientAsync
- ActorVersionCollectionClient
- ActorVersionCollectionClientAsync
- ApifyClient
- ApifyClientAsync
- BatchAddRequestsResult
- BuildClient
- BuildClientAsync
- BuildCollectionClient
- BuildCollectionClientAsync
- DatasetClient
- DatasetClientAsync
- DatasetCollectionClient
- DatasetCollectionClientAsync
- HTTPClient
- HTTPClientAsync
- KeyValueStoreClient
- KeyValueStoreClientAsync
- KeyValueStoreCollectionClient
- KeyValueStoreCollectionClientAsync
- LogClient
- LogClientAsync
- LogContext
- RequestQueueClient
- RequestQueueClientAsync
- RequestQueueCollectionClient
- RequestQueueCollectionClientAsync
- RunClient
- RunClientAsync
- RunCollectionClient
- RunCollectionClientAsync
- ScheduleClient
- ScheduleClientAsync
- ScheduleCollectionClient
- ScheduleCollectionClientAsync
- StoreCollectionClient
- StoreCollectionClientAsync
- TaskClient
- TaskClientAsync
- TaskCollectionClient
- TaskCollectionClientAsync
- UserClient
- UserClientAsync
- WebhookClient
- WebhookClientAsync
- WebhookCollectionClient
- WebhookCollectionClientAsync
- WebhookDispatchClient
- WebhookDispatchClientAsync
- WebhookDispatchCollectionClient
- WebhookDispatchCollectionClientAsync
- WithLogDetailsClient
Data structures
Errors
Methods
Properties
- __version__
- API_VERSION
- DEFAULT_API_URL
- DEFAULT_BACKOFF_EXPONENTIAL_FACTOR
- DEFAULT_BACKOFF_RANDOM_FACTOR
- DEFAULT_WAIT_FOR_FINISH_SEC
- DEFAULT_WAIT_WHEN_JOB_NOT_EXIST_SEC
- DEPRECATED_NAMES
- http_client
- http_client
- log_context
- logger
- logger
- logger
- logger_name
- PARSE_DATE_FIELDS_KEY_SUFFIX
- PARSE_DATE_FIELDS_MAX_DEPTH
- RECORD_NOT_FOUND_EXCEPTION_TYPES
- root_client
- root_client
- StopRetryingType
- T
Async Resource Clients
retry_with_exp_backoff_async
Methods
__getattr__
Parameters
name: str
Returns Any
catch_not_found_or_throw
Parameters
exc: ApifyApiError
Returns None
encode_key_value_store_record_value
Parameters
value: Any
optionalcontent_type: str | None = None
Returns tuple[Any, str]
encode_webhook_list_to_base64
Parameters
webhooks: list[dict]
Returns str
get_actor_env_var_representation
Return an environment variable representation of the Actor in a dictionary.
Parameters
optionalkeyword-onlyis_secret: bool | None = None
optionalkeyword-onlyname: str | None = None
optionalkeyword-onlyvalue: str | None = None
Returns dict
get_actor_representation
Get dictionary representation of the Actor.
Parameters
keyword-onlyname: str | None
optionalkeyword-onlytitle: str | None = None
optionalkeyword-onlydescription: str | None = None
optionalkeyword-onlyseo_title: str | None = None
optionalkeyword-onlyseo_description: str | None = None
optionalkeyword-onlyversions: list[dict] | None = None
optionalkeyword-onlyrestart_on_error: bool | None = None
optionalkeyword-onlyis_public: bool | None = None
optionalkeyword-onlyis_deprecated: bool | None = None
optionalkeyword-onlyis_anonymously_runnable: bool | None = None
optionalkeyword-onlycategories: list[str] | None = None
optionalkeyword-onlydefault_run_build: str | None = None
optionalkeyword-onlydefault_run_max_items: int | None = None
optionalkeyword-onlydefault_run_memory_mbytes: int | None = None
optionalkeyword-onlydefault_run_timeout_secs: int | None = None
optionalkeyword-onlyexample_run_input_body: Any = None
optionalkeyword-onlyexample_run_input_content_type: str | None = None
optionalkeyword-onlyactor_standby_is_enabled: bool | None = None
optionalkeyword-onlyactor_standby_desired_requests_per_actor_run: int | None = None
optionalkeyword-onlyactor_standby_max_requests_per_actor_run: int | None = None
optionalkeyword-onlyactor_standby_idle_timeout_secs: int | None = None
optionalkeyword-onlyactor_standby_build: str | None = None
optionalkeyword-onlyactor_standby_memory_mbytes: int | None = None
optionalkeyword-onlypricing_infos: list[dict] | None = None
Returns dict
get_task_representation
Get the dictionary representation of a task.
Parameters
optionalactor_id: str | None = None
optionalname: str | None = None
optionaltask_input: dict | None = None
optionalbuild: str | None = None
optionalmax_items: int | None = None
optionalmemory_mbytes: int | None = None
optionaltimeout_secs: int | None = None
optionaltitle: str | None = None
optionalactor_standby_desired_requests_per_actor_run: int | None = None
optionalactor_standby_max_requests_per_actor_run: int | None = None
optionalactor_standby_idle_timeout_secs: int | None = None
optionalactor_standby_build: str | None = None
optionalactor_standby_memory_mbytes: int | None = None
Returns dict
get_webhook_representation
Prepare webhook dictionary representation for clients.
Parameters
optionalkeyword-onlyevent_types: list[WebhookEventType] | None = None
optionalkeyword-onlyrequest_url: str | None = None
optionalkeyword-onlypayload_template: str | None = None
optionalkeyword-onlyheaders_template: str | None = None
optionalkeyword-onlyactor_id: str | None = None
optionalkeyword-onlyactor_task_id: str | None = None
optionalkeyword-onlyactor_run_id: str | None = None
optionalkeyword-onlyignore_ssl_errors: bool | None = None
optionalkeyword-onlydo_not_retry: bool | None = None
optionalkeyword-onlyidempotency_key: str | None = None
optionalkeyword-onlyis_ad_hoc: bool | None = None
Returns dict
is_retryable_error
Check if the given error is retryable.
Parameters
exc: Exception
Returns bool
pluck_data
Parameters
parsed_response: Any
Returns dict
pluck_data_as_list
Parameters
parsed_response: Any
Returns list
retry_with_exp_backoff
to_safe_id
Parameters
id: str
Returns str
Encode a list of dictionaries representing webhooks to their base64-encoded representation for the API.