bobseares-2/apify-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
b6830caa7190762fc02707179c0637bb36d22c6b
apify-api/skills/actors/SKILL.md
a2a-platform dfb65e705f deploy
2026-06-06 21:16:45 +00:00

24 KiB
Raw Blame History

name, description
name description
actors-routes Handle 70 OpenAPI operation(s) under /v2/actors for the actors route group.

actors API Routes

Handle 70 OpenAPI operation(s) under /v2/actors for the actors route group.

Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.

Operations

acts_get

  • Operation ID: acts_get
  • Route: GET /v2/actors
  • Mode: READ
  • Summary: Get list of Actors
  • Parameters:
    • my in query
    • offset in query
    • limit in query
    • desc in query
    • sortBy in query

acts_post

  • Operation ID: acts_post
  • Route: POST /v2/actors
  • Mode: WRITE
  • Summary: Create Actor
  • Body: JSON request body accepted.

act_get

  • Operation ID: act_get
  • Route: GET /v2/actors/{actorId}
  • Mode: READ
  • Summary: Get Actor
  • Parameters:
    • actorId in path required

act_put

  • Operation ID: act_put
  • Route: PUT /v2/actors/{actorId}
  • Mode: WRITE
  • Summary: Update Actor
  • Parameters:
    • actorId in path required
  • Body: JSON request body accepted.

act_delete

  • Operation ID: act_delete
  • Route: DELETE /v2/actors/{actorId}
  • Mode: WRITE
  • Summary: Delete Actor
  • Parameters:
    • actorId in path required

act_versions_get

  • Operation ID: act_versions_get
  • Route: GET /v2/actors/{actorId}/versions
  • Mode: READ
  • Summary: Get list of versions
  • Parameters:
    • actorId in path required

act_versions_post

  • Operation ID: act_versions_post
  • Route: POST /v2/actors/{actorId}/versions
  • Mode: WRITE
  • Summary: Create version
  • Parameters:
    • actorId in path required
  • Body: JSON request body accepted.

act_version_get

  • Operation ID: act_version_get
  • Route: GET /v2/actors/{actorId}/versions/{versionNumber}
  • Mode: READ
  • Summary: Get version
  • Parameters:
    • actorId in path required
    • versionNumber in path required

act_version_put

  • Operation ID: act_version_put
  • Route: PUT /v2/actors/{actorId}/versions/{versionNumber}
  • Mode: WRITE
  • Summary: Update version
  • Parameters:
    • actorId in path required
    • versionNumber in path required
  • Body: JSON request body accepted.

act_version_post

  • Operation ID: act_version_post
  • Route: POST /v2/actors/{actorId}/versions/{versionNumber}
  • Mode: WRITE
  • Summary: Update version (POST)
  • Parameters:
    • actorId in path required
    • versionNumber in path required
  • Body: JSON request body accepted.

act_version_delete

  • Operation ID: act_version_delete
  • Route: DELETE /v2/actors/{actorId}/versions/{versionNumber}
  • Mode: WRITE
  • Summary: Delete version
  • Parameters:
    • actorId in path required
    • versionNumber in path required

act_version_env_vars_get

  • Operation ID: act_version_env_vars_get
  • Route: GET /v2/actors/{actorId}/versions/{versionNumber}/env-vars
  • Mode: READ
  • Summary: Get list of environment variables
  • Parameters:
    • actorId in path required
    • versionNumber in path required

act_version_env_vars_post

  • Operation ID: act_version_env_vars_post
  • Route: POST /v2/actors/{actorId}/versions/{versionNumber}/env-vars
  • Mode: WRITE
  • Summary: Create environment variable
  • Parameters:
    • actorId in path required
    • versionNumber in path required
  • Body: JSON request body accepted.

act_version_env_var_get

  • Operation ID: act_version_env_var_get
  • Route: GET /v2/actors/{actorId}/versions/{versionNumber}/env-vars/{envVarName}
  • Mode: READ
  • Summary: Get environment variable
  • Parameters:
    • actorId in path required
    • versionNumber in path required
    • envVarName in path required

act_version_env_var_put

  • Operation ID: act_version_env_var_put
  • Route: PUT /v2/actors/{actorId}/versions/{versionNumber}/env-vars/{envVarName}
  • Mode: WRITE
  • Summary: Update environment variable
  • Parameters:
    • actorId in path required
    • versionNumber in path required
    • envVarName in path required
  • Body: JSON request body accepted.

act_version_env_var_post

  • Operation ID: act_version_env_var_post
  • Route: POST /v2/actors/{actorId}/versions/{versionNumber}/env-vars/{envVarName}
  • Mode: WRITE
  • Summary: Update environment variable (POST)
  • Parameters:
    • actorId in path required
    • versionNumber in path required
    • envVarName in path required
  • Body: JSON request body accepted.

act_version_env_var_delete

  • Operation ID: act_version_env_var_delete
  • Route: DELETE /v2/actors/{actorId}/versions/{versionNumber}/env-vars/{envVarName}
  • Mode: WRITE
  • Summary: Delete environment variable
  • Parameters:
    • actorId in path required
    • versionNumber in path required
    • envVarName in path required

act_webhooks_get

  • Operation ID: act_webhooks_get
  • Route: GET /v2/actors/{actorId}/webhooks
  • Mode: READ
  • Summary: Get list of webhooks
  • Parameters:
    • actorId in path required
    • offset in query
    • limit in query
    • desc in query

act_builds_get

  • Operation ID: act_builds_get
  • Route: GET /v2/actors/{actorId}/builds
  • Mode: READ
  • Summary: Get list of builds
  • Parameters:
    • actorId in path required
    • offset in query
    • limit in query
    • desc in query

act_builds_post

  • Operation ID: act_builds_post
  • Route: POST /v2/actors/{actorId}/builds
  • Mode: WRITE
  • Summary: Build Actor
  • Parameters:
    • actorId in path required
    • version in query required
    • useCache in query
    • betaPackages in query
    • tag in query
    • waitForFinish in query

act_build_default_get

  • Operation ID: act_build_default_get
  • Route: GET /v2/actors/{actorId}/builds/default
  • Mode: READ
  • Summary: Get default build
  • Parameters:
    • actorId in path required
    • waitForFinish in query

act_openapi_json_get

  • Operation ID: act_openapi_json_get
  • Route: GET /v2/actors/{actorId}/builds/{buildId}/openapi.json
  • Mode: READ
  • Summary: Get OpenAPI definition
  • Parameters:
    • actorId in path required
    • buildId in path required

act_build_get

  • Operation ID: act_build_get
  • Route: GET /v2/actors/{actorId}/builds/{buildId}
  • Mode: READ
  • Summary: Get build
  • Parameters:
    • actorId in path required
    • buildId in path required
    • waitForFinish in query

act_build_abort_post

  • Operation ID: act_build_abort_post
  • Route: POST /v2/actors/{actorId}/builds/{buildId}/abort
  • Mode: WRITE
  • Summary: Abort build
  • Parameters:
    • actorId in path required
    • buildId in path required

act_runs_get

  • Operation ID: act_runs_get
  • Route: GET /v2/actors/{actorId}/runs
  • Mode: READ
  • Summary: Get list of runs
  • Parameters:
    • actorId in path required
    • offset in query
    • limit in query
    • desc in query
    • status in query
    • startedAfter in query
    • startedBefore in query

act_runs_post

  • Operation ID: act_runs_post
  • Route: POST /v2/actors/{actorId}/runs
  • Mode: WRITE
  • Summary: Run Actor
  • Parameters:
    • actorId in path required
    • timeout in query
    • memory in query
    • maxItems in query
    • maxTotalChargeUsd in query
    • restartOnError in query
    • build in query
    • waitForFinish in query
    • webhooks in query
    • forcePermissionLevel in query
  • Body: JSON request body accepted.

act_run_sync_post

  • Operation ID: act_run_sync_post
  • Route: POST /v2/actors/{actorId}/run-sync
  • Mode: WRITE
  • Summary: Run Actor synchronously and return output
  • Parameters:
    • actorId in path required
    • outputRecordKey in query
    • timeout in query
    • memory in query
    • maxItems in query
    • maxTotalChargeUsd in query
    • restartOnError in query
    • build in query
    • webhooks in query
  • Body: JSON request body accepted.

act_run_sync_get

  • Operation ID: act_run_sync_get
  • Route: GET /v2/actors/{actorId}/run-sync
  • Mode: READ
  • Summary: Run Actor synchronously without input
  • Parameters:
    • actorId in path required
    • outputRecordKey in query
    • timeout in query
    • memory in query
    • maxItems in query
    • maxTotalChargeUsd in query
    • restartOnError in query
    • build in query
    • webhooks in query

act_run_sync_get_dataset_items_post

  • Operation ID: act_run_sync_get_dataset_items_post
  • Route: POST /v2/actors/{actorId}/run-sync-get-dataset-items
  • Mode: WRITE
  • Summary: Run Actor synchronously and get dataset items
  • Parameters:
    • actorId in path required
    • timeout in query
    • memory in query
    • maxItems in query
    • maxTotalChargeUsd in query
    • restartOnError in query
    • build in query
    • webhooks in query
    • format in query
    • clean in query
    • offset in query
    • limit in query
    • fields in query
    • outputFields in query
    • omit in query
    • unwind in query
    • flatten in query
    • desc in query
    • attachment in query
    • delimiter in query
    • bom in query
    • xmlRoot in query
    • xmlRow in query
    • skipHeaderRow in query
    • skipHidden in query
    • skipEmpty in query
    • simplified in query
    • view in query
    • skipFailedPages in query
    • feedTitle in query
    • feedDescription in query
  • Body: JSON request body accepted.

act_run_sync_get_dataset_items_get

  • Operation ID: act_run_sync_get_dataset_items_get
  • Route: GET /v2/actors/{actorId}/run-sync-get-dataset-items
  • Mode: READ
  • Summary: Run Actor synchronously without input and get dataset items
  • Parameters:
    • actorId in path required
    • timeout in query
    • memory in query
    • maxItems in query
    • maxTotalChargeUsd in query
    • restartOnError in query
    • build in query
    • webhooks in query
    • format in query
    • clean in query
    • offset in query
    • limit in query
    • fields in query
    • outputFields in query
    • omit in query
    • unwind in query
    • flatten in query
    • desc in query
    • attachment in query
    • delimiter in query
    • bom in query
    • xmlRoot in query
    • xmlRow in query
    • skipHeaderRow in query
    • skipHidden in query
    • skipEmpty in query
    • simplified in query
    • view in query
    • skipFailedPages in query
    • feedTitle in query
    • feedDescription in query

act_validate_input_post

  • Operation ID: act_validate_input_post
  • Route: POST /v2/actors/{actorId}/validate-input
  • Mode: WRITE
  • Summary: Validate Actor input
  • Parameters:
    • actorId in path required
    • build in query
  • Body: JSON request body accepted.

act_run_resurrect_post

  • Operation ID: act_run_resurrect_post
  • Route: POST /v2/actors/{actorId}/runs/{runId}/resurrect
  • Mode: WRITE
  • Summary: Resurrect run
  • Parameters:
    • actorId in path required
    • runId in path required
    • build in query
    • timeout in query
    • memory in query
    • restartOnError in query

act_runs_last_get

  • Operation ID: act_runs_last_get
  • Route: GET /v2/actors/{actorId}/runs/last
  • Mode: READ
  • Summary: Get last run
  • Parameters:
    • actorId in path required
    • status in query
    • waitForFinish in query

act_runs_last_dataset_get

  • Operation ID: act_runs_last_dataset_get
  • Route: GET /v2/actors/{actorId}/runs/last/dataset
  • Mode: READ
  • Summary: Get last run's default dataset
  • Parameters:
    • actorId in path required
    • status in query

act_runs_last_dataset_put

  • Operation ID: act_runs_last_dataset_put
  • Route: PUT /v2/actors/{actorId}/runs/last/dataset
  • Mode: WRITE
  • Summary: Update last run's default dataset
  • Parameters:
    • actorId in path required
    • status in query
  • Body: JSON request body accepted.

act_runs_last_dataset_delete

  • Operation ID: act_runs_last_dataset_delete
  • Route: DELETE /v2/actors/{actorId}/runs/last/dataset
  • Mode: WRITE
  • Summary: Delete last run's default dataset
  • Parameters:
    • actorId in path required
    • status in query

act_runs_last_dataset_items_get

  • Operation ID: act_runs_last_dataset_items_get
  • Route: GET /v2/actors/{actorId}/runs/last/dataset/items
  • Mode: READ
  • Summary: Get last run's dataset items
  • Parameters:
    • actorId in path required
    • status in query
    • format in query
    • clean in query
    • offset in query
    • limit in query
    • fields in query
    • outputFields in query
    • omit in query
    • unwind in query
    • flatten in query
    • desc in query
    • attachment in query
    • delimiter in query
    • bom in query
    • xmlRoot in query
    • xmlRow in query
    • skipHeaderRow in query
    • skipHidden in query
    • skipEmpty in query
    • simplified in query
    • view in query
    • skipFailedPages in query
    • feedTitle in query
    • feedDescription in query
    • signature in query

act_runs_last_dataset_items_post

  • Operation ID: act_runs_last_dataset_items_post
  • Route: POST /v2/actors/{actorId}/runs/last/dataset/items
  • Mode: WRITE
  • Summary: Store items in last run's dataset
  • Parameters:
    • actorId in path required
    • status in query
  • Body: JSON request body accepted.

act_runs_last_dataset_statistics_get

  • Operation ID: act_runs_last_dataset_statistics_get
  • Route: GET /v2/actors/{actorId}/runs/last/dataset/statistics
  • Mode: READ
  • Summary: Get last run's dataset statistics
  • Parameters:
    • actorId in path required
    • status in query

act_runs_last_key_value_store_get

  • Operation ID: act_runs_last_key_value_store_get
  • Route: GET /v2/actors/{actorId}/runs/last/key-value-store
  • Mode: READ
  • Summary: Get last run's default store
  • Parameters:
    • actorId in path required
    • status in query

act_runs_last_key_value_store_put

  • Operation ID: act_runs_last_key_value_store_put
  • Route: PUT /v2/actors/{actorId}/runs/last/key-value-store
  • Mode: WRITE
  • Summary: Update last run's default store
  • Parameters:
    • actorId in path required
    • status in query
  • Body: JSON request body accepted.

act_runs_last_key_value_store_delete

  • Operation ID: act_runs_last_key_value_store_delete
  • Route: DELETE /v2/actors/{actorId}/runs/last/key-value-store
  • Mode: WRITE
  • Summary: Delete last run's default store
  • Parameters:
    • actorId in path required
    • status in query

act_runs_last_key_value_store_keys_get

  • Operation ID: act_runs_last_key_value_store_keys_get
  • Route: GET /v2/actors/{actorId}/runs/last/key-value-store/keys
  • Mode: READ
  • Summary: Get last run's default store's list of keys
  • Parameters:
    • actorId in path required
    • status in query
    • exclusiveStartKey in query
    • limit in query
    • collection in query
    • prefix in query
    • signature in query

act_runs_last_key_value_store_records_get

  • Operation ID: act_runs_last_key_value_store_records_get
  • Route: GET /v2/actors/{actorId}/runs/last/key-value-store/records
  • Mode: READ
  • Summary: Download last run's default store's records
  • Parameters:
    • actorId in path required
    • status in query
    • collection in query
    • prefix in query
    • signature in query

act_runs_last_key_value_store_record_get

  • Operation ID: act_runs_last_key_value_store_record_get
  • Route: GET /v2/actors/{actorId}/runs/last/key-value-store/records/{recordKey}
  • Mode: READ
  • Summary: Get last run's default store's record
  • Parameters:
    • actorId in path required
    • status in query
    • recordKey in path required
    • signature in query
    • attachment in query

act_runs_last_key_value_store_record_put

  • Operation ID: act_runs_last_key_value_store_record_put
  • Route: PUT /v2/actors/{actorId}/runs/last/key-value-store/records/{recordKey}
  • Mode: WRITE
  • Summary: Store record in last run's default store
  • Parameters:
    • actorId in path required
    • status in query
    • recordKey in path required
    • Content-Encoding in header
  • Body: JSON request body accepted.

act_runs_last_key_value_store_record_post

  • Operation ID: act_runs_last_key_value_store_record_post
  • Route: POST /v2/actors/{actorId}/runs/last/key-value-store/records/{recordKey}
  • Mode: WRITE
  • Summary: Store record in last run's default store (POST)
  • Parameters:
    • actorId in path required
    • status in query
    • recordKey in path required
    • Content-Encoding in header
  • Body: JSON request body accepted.

act_runs_last_key_value_store_record_delete

  • Operation ID: act_runs_last_key_value_store_record_delete
  • Route: DELETE /v2/actors/{actorId}/runs/last/key-value-store/records/{recordKey}
  • Mode: WRITE
  • Summary: Delete last run's default store's record
  • Parameters:
    • actorId in path required
    • status in query
    • recordKey in path required

act_runs_last_request_queue_get

  • Operation ID: act_runs_last_request_queue_get
  • Route: GET /v2/actors/{actorId}/runs/last/request-queue
  • Mode: READ
  • Summary: Get last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query

act_runs_last_request_queue_put

  • Operation ID: act_runs_last_request_queue_put
  • Route: PUT /v2/actors/{actorId}/runs/last/request-queue
  • Mode: WRITE
  • Summary: Update last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query
  • Body: JSON request body accepted.

act_runs_last_request_queue_delete

  • Operation ID: act_runs_last_request_queue_delete
  • Route: DELETE /v2/actors/{actorId}/runs/last/request-queue
  • Mode: WRITE
  • Summary: Delete last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query

act_runs_last_request_queue_requests_get

  • Operation ID: act_runs_last_request_queue_requests_get
  • Route: GET /v2/actors/{actorId}/runs/last/request-queue/requests
  • Mode: READ
  • Summary: List last run's default request queue's requests
  • Parameters:
    • actorId in path required
    • status in query
    • clientKey in query
    • exclusiveStartId in query
    • limit in query
    • cursor in query
    • filter in query

act_runs_last_request_queue_requests_post

  • Operation ID: act_runs_last_request_queue_requests_post
  • Route: POST /v2/actors/{actorId}/runs/last/request-queue/requests
  • Mode: WRITE
  • Summary: Add request to last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query
    • clientKey in query
    • forefront in query
  • Body: JSON request body accepted.

act_runs_last_request_queue_requests_batch_post

  • Operation ID: act_runs_last_request_queue_requests_batch_post
  • Route: POST /v2/actors/{actorId}/runs/last/request-queue/requests/batch
  • Mode: WRITE
  • Summary: Batch add requests to last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query
    • clientKey in query
    • forefront in query
  • Body: JSON request body accepted.

act_runs_last_request_queue_requests_batch_delete

  • Operation ID: act_runs_last_request_queue_requests_batch_delete
  • Route: DELETE /v2/actors/{actorId}/runs/last/request-queue/requests/batch
  • Mode: WRITE
  • Summary: Batch delete requests from last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query
    • Content-Type in header required
    • clientKey in query
  • Body: JSON request body accepted.

act_runs_last_request_queue_requests_unlock_post

  • Operation ID: act_runs_last_request_queue_requests_unlock_post
  • Route: POST /v2/actors/{actorId}/runs/last/request-queue/requests/unlock
  • Mode: WRITE
  • Summary: Unlock requests in last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query
    • clientKey in query

act_runs_last_request_queue_request_get

  • Operation ID: act_runs_last_request_queue_request_get
  • Route: GET /v2/actors/{actorId}/runs/last/request-queue/requests/{requestId}
  • Mode: READ
  • Summary: Get request from last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query
    • requestId in path required

act_runs_last_request_queue_request_put

  • Operation ID: act_runs_last_request_queue_request_put
  • Route: PUT /v2/actors/{actorId}/runs/last/request-queue/requests/{requestId}
  • Mode: WRITE
  • Summary: Update request in last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query
    • requestId in path required
    • forefront in query
    • clientKey in query
  • Body: JSON request body accepted.

act_runs_last_request_queue_request_delete

  • Operation ID: act_runs_last_request_queue_request_delete
  • Route: DELETE /v2/actors/{actorId}/runs/last/request-queue/requests/{requestId}
  • Mode: WRITE
  • Summary: Delete request from last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query
    • requestId in path required
    • clientKey in query

act_runs_last_request_queue_request_lock_put

  • Operation ID: act_runs_last_request_queue_request_lock_put
  • Route: PUT /v2/actors/{actorId}/runs/last/request-queue/requests/{requestId}/lock
  • Mode: WRITE
  • Summary: Prolong lock on request in last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query
    • requestId in path required
    • lockSecs in query required
    • clientKey in query
    • forefront in query

act_runs_last_request_queue_request_lock_delete

  • Operation ID: act_runs_last_request_queue_request_lock_delete
  • Route: DELETE /v2/actors/{actorId}/runs/last/request-queue/requests/{requestId}/lock
  • Mode: WRITE
  • Summary: Delete lock on request in last run's default request queue
  • Parameters:
    • actorId in path required
    • status in query
    • requestId in path required
    • clientKey in query
    • forefront in query

act_runs_last_request_queue_head_get

  • Operation ID: act_runs_last_request_queue_head_get
  • Route: GET /v2/actors/{actorId}/runs/last/request-queue/head
  • Mode: READ
  • Summary: Get last run's default request queue head
  • Parameters:
    • actorId in path required
    • status in query
    • limit in query
    • clientKey in query

act_runs_last_request_queue_head_lock_post

  • Operation ID: act_runs_last_request_queue_head_lock_post
  • Route: POST /v2/actors/{actorId}/runs/last/request-queue/head/lock
  • Mode: WRITE
  • Summary: Get and lock last run's default request queue head
  • Parameters:
    • actorId in path required
    • status in query
    • lockSecs in query required
    • limit in query
    • clientKey in query

act_runs_last_log_get

  • Operation ID: act_runs_last_log_get
  • Route: GET /v2/actors/{actorId}/runs/last/log
  • Mode: READ
  • Summary: Get last Actor run's log
  • Parameters:
    • actorId in path required
    • stream in query
    • download in query
    • raw in query

act_runs_last_abort_post

  • Operation ID: act_runs_last_abort_post
  • Route: POST /v2/actors/{actorId}/runs/last/abort
  • Mode: WRITE
  • Summary: Abort Actor's last run
  • Parameters:
    • actorId in path required
    • status in query
    • gracefully in query

act_runs_last_metamorph_post

  • Operation ID: act_runs_last_metamorph_post
  • Route: POST /v2/actors/{actorId}/runs/last/metamorph
  • Mode: WRITE
  • Summary: Metamorph Actor's last run
  • Parameters:
    • actorId in path required
    • status in query
    • targetActorId in query required
    • build in query

act_runs_last_reboot_post

  • Operation ID: act_runs_last_reboot_post
  • Route: POST /v2/actors/{actorId}/runs/last/reboot
  • Mode: WRITE
  • Summary: Reboot Actor's last run
  • Parameters:
    • actorId in path required
    • status in query

act_run_get

  • Operation ID: act_run_get
  • Route: GET /v2/actors/{actorId}/runs/{runId}
  • Mode: READ
  • Summary: Get run
  • Parameters:
    • actorId in path required
    • runId in path required
    • waitForFinish in query

act_run_abort_post

  • Operation ID: act_run_abort_post
  • Route: POST /v2/actors/{actorId}/runs/{runId}/abort
  • Mode: WRITE
  • Summary: Abort run
  • Parameters:
    • actorId in path required
    • runId in path required
    • gracefully in query

act_run_metamorph_post

  • Operation ID: act_run_metamorph_post
  • Route: POST /v2/actors/{actorId}/runs/{runId}/metamorph
  • Mode: WRITE
  • Summary: Metamorph run
  • Parameters:
    • actorId in path required
    • runId in path required
    • targetActorId in query required
    • build in query
Reference in New Issue View Git Blame Copy Permalink