20 KiB
20 KiB
name, description
| name | description |
|---|---|
| actor-tasks-routes | Handle 49 OpenAPI operation(s) under /v2/actor-tasks for the actor tasks route group. |
actor tasks API Routes
Handle 49 OpenAPI operation(s) under /v2/actor-tasks for the actor tasks 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
actor_tasks_get
- Operation ID:
actor_tasks_get - Route:
GET /v2/actor-tasks - Mode: READ
- Summary: Get list of tasks
- Parameters:
offsetinquerylimitinquerydescinquery
actor_tasks_post
- Operation ID:
actor_tasks_post - Route:
POST /v2/actor-tasks - Mode: WRITE
- Summary: Create task
- Body: JSON request body accepted.
actor_task_get
- Operation ID:
actor_task_get - Route:
GET /v2/actor-tasks/{actorTaskId} - Mode: READ
- Summary: Get task
- Parameters:
actorTaskIdinpathrequired
actor_task_put
- Operation ID:
actor_task_put - Route:
PUT /v2/actor-tasks/{actorTaskId} - Mode: WRITE
- Summary: Update task
- Parameters:
actorTaskIdinpathrequired
- Body: JSON request body accepted.
actor_task_delete
- Operation ID:
actor_task_delete - Route:
DELETE /v2/actor-tasks/{actorTaskId} - Mode: WRITE
- Summary: Delete task
- Parameters:
actorTaskIdinpathrequired
actor_task_input_get
- Operation ID:
actor_task_input_get - Route:
GET /v2/actor-tasks/{actorTaskId}/input - Mode: READ
- Summary: Get task input
- Parameters:
actorTaskIdinpathrequired
actor_task_input_put
- Operation ID:
actor_task_input_put - Route:
PUT /v2/actor-tasks/{actorTaskId}/input - Mode: WRITE
- Summary: Update task input
- Parameters:
actorTaskIdinpathrequired
- Body: JSON request body accepted.
actor_task_webhooks_get
- Operation ID:
actor_task_webhooks_get - Route:
GET /v2/actor-tasks/{actorTaskId}/webhooks - Mode: READ
- Summary: Get list of webhooks
- Parameters:
actorTaskIdinpathrequiredoffsetinquerylimitinquerydescinquery
actor_task_runs_get
- Operation ID:
actor_task_runs_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs - Mode: READ
- Summary: Get list of task runs
- Parameters:
actorTaskIdinpathrequiredoffsetinquerylimitinquerydescinquerystatusinquery
actor_task_runs_post
- Operation ID:
actor_task_runs_post - Route:
POST /v2/actor-tasks/{actorTaskId}/runs - Mode: WRITE
- Summary: Run task
- Parameters:
actorTaskIdinpathrequiredtimeoutinquerymemoryinquerymaxItemsinquerymaxTotalChargeUsdinqueryrestartOnErrorinquerybuildinquerywaitForFinishinquerywebhooksinquery
- Body: JSON request body accepted.
actor_task_run_sync_get
- Operation ID:
actor_task_run_sync_get - Route:
GET /v2/actor-tasks/{actorTaskId}/run-sync - Mode: READ
- Summary: Run task synchronously
- Parameters:
actorTaskIdinpathrequiredtimeoutinquerymemoryinquerymaxItemsinquerybuildinqueryoutputRecordKeyinquerywebhooksinquery
actor_task_run_sync_post
- Operation ID:
actor_task_run_sync_post - Route:
POST /v2/actor-tasks/{actorTaskId}/run-sync - Mode: WRITE
- Summary: Run task synchronously
- Parameters:
actorTaskIdinpathrequiredtimeoutinquerymemoryinquerymaxItemsinquerymaxTotalChargeUsdinqueryrestartOnErrorinquerybuildinqueryoutputRecordKeyinquerywebhooksinquery
- Body: JSON request body accepted.
actor_task_run_sync_get_dataset_items_get
- Operation ID:
actor_task_run_sync_get_dataset_items_get - Route:
GET /v2/actor-tasks/{actorTaskId}/run-sync-get-dataset-items - Mode: READ
- Summary: Run task synchronously and get dataset items
- Parameters:
actorTaskIdinpathrequiredtimeoutinquerymemoryinquerymaxItemsinquerybuildinquerywebhooksinqueryformatinquerycleaninqueryoffsetinquerylimitinqueryfieldsinqueryoutputFieldsinqueryomitinqueryunwindinqueryflatteninquerydescinqueryattachmentinquerydelimiterinquerybominqueryxmlRootinqueryxmlRowinqueryskipHeaderRowinqueryskipHiddeninqueryskipEmptyinquerysimplifiedinqueryviewinqueryskipFailedPagesinqueryfeedTitleinqueryfeedDescriptioninquery
actor_task_run_sync_get_dataset_items_post
- Operation ID:
actor_task_run_sync_get_dataset_items_post - Route:
POST /v2/actor-tasks/{actorTaskId}/run-sync-get-dataset-items - Mode: WRITE
- Summary: Run task synchronously and get dataset items
- Parameters:
actorTaskIdinpathrequiredtimeoutinquerymemoryinquerymaxItemsinquerymaxTotalChargeUsdinqueryrestartOnErrorinquerybuildinquerywebhooksinqueryformatinquerycleaninqueryoffsetinquerylimitinqueryfieldsinqueryoutputFieldsinqueryomitinqueryunwindinqueryflatteninquerydescinqueryattachmentinquerydelimiterinquerybominqueryxmlRootinqueryxmlRowinqueryskipHeaderRowinqueryskipHiddeninqueryskipEmptyinquerysimplifiedinqueryviewinqueryskipFailedPagesinqueryfeedTitleinqueryfeedDescriptioninquery
- Body: JSON request body accepted.
actor_task_runs_last_get
- Operation ID:
actor_task_runs_last_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last - Mode: READ
- Summary: Get last run
- Parameters:
actorTaskIdinpathrequiredstatusinquerywaitForFinishinquery
actor_task_last_log_get
- Operation ID:
actor_task_last_log_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/log - Mode: READ
- Summary: Get last Actor task run's log
- Parameters:
actorTaskIdinpathrequiredstreaminquerydownloadinqueryrawinquery
actor_task_runs_last_abort_post
- Operation ID:
actor_task_runs_last_abort_post - Route:
POST /v2/actor-tasks/{actorTaskId}/runs/last/abort - Mode: WRITE
- Summary: Abort Actor task's last run
- Parameters:
actorTaskIdinpathrequiredstatusinquerygracefullyinquery
actor_task_runs_last_metamorph_post
- Operation ID:
actor_task_runs_last_metamorph_post - Route:
POST /v2/actor-tasks/{actorTaskId}/runs/last/metamorph - Mode: WRITE
- Summary: Metamorph Actor task's last run
- Parameters:
actorTaskIdinpathrequiredstatusinquerytargetActorIdinqueryrequiredbuildinquery
actor_task_runs_last_reboot_post
- Operation ID:
actor_task_runs_last_reboot_post - Route:
POST /v2/actor-tasks/{actorTaskId}/runs/last/reboot - Mode: WRITE
- Summary: Reboot Actor task's last run
- Parameters:
actorTaskIdinpathrequiredstatusinquery
actor_task_runs_last_dataset_get
- Operation ID:
actor_task_runs_last_dataset_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/dataset - Mode: READ
- Summary: Get last task run's default dataset
- Parameters:
actorTaskIdinpathrequiredstatusinquery
actor_task_runs_last_dataset_put
- Operation ID:
actor_task_runs_last_dataset_put - Route:
PUT /v2/actor-tasks/{actorTaskId}/runs/last/dataset - Mode: WRITE
- Summary: Update last task run's default dataset
- Parameters:
actorTaskIdinpathrequiredstatusinquery
- Body: JSON request body accepted.
actor_task_runs_last_dataset_delete
- Operation ID:
actor_task_runs_last_dataset_delete - Route:
DELETE /v2/actor-tasks/{actorTaskId}/runs/last/dataset - Mode: WRITE
- Summary: Delete last task run's default dataset
- Parameters:
actorTaskIdinpathrequiredstatusinquery
actor_task_runs_last_dataset_items_get
- Operation ID:
actor_task_runs_last_dataset_items_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/dataset/items - Mode: READ
- Summary: Get last task run's dataset items
- Parameters:
actorTaskIdinpathrequiredstatusinqueryformatinquerycleaninqueryoffsetinquerylimitinqueryfieldsinqueryoutputFieldsinqueryomitinqueryunwindinqueryflatteninquerydescinqueryattachmentinquerydelimiterinquerybominqueryxmlRootinqueryxmlRowinqueryskipHeaderRowinqueryskipHiddeninqueryskipEmptyinquerysimplifiedinqueryviewinqueryskipFailedPagesinqueryfeedTitleinqueryfeedDescriptioninquerysignatureinquery
actor_task_runs_last_dataset_items_post
- Operation ID:
actor_task_runs_last_dataset_items_post - Route:
POST /v2/actor-tasks/{actorTaskId}/runs/last/dataset/items - Mode: WRITE
- Summary: Store items in last task run's dataset
- Parameters:
actorTaskIdinpathrequiredstatusinquery
- Body: JSON request body accepted.
actor_task_runs_last_dataset_statistics_get
- Operation ID:
actor_task_runs_last_dataset_statistics_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/dataset/statistics - Mode: READ
- Summary: Get last task run's dataset statistics
- Parameters:
actorTaskIdinpathrequiredstatusinquery
actor_task_runs_last_key_value_store_get
- Operation ID:
actor_task_runs_last_key_value_store_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/key-value-store - Mode: READ
- Summary: Get last task run's default store
- Parameters:
actorTaskIdinpathrequiredstatusinquery
actor_task_runs_last_key_value_store_put
- Operation ID:
actor_task_runs_last_key_value_store_put - Route:
PUT /v2/actor-tasks/{actorTaskId}/runs/last/key-value-store - Mode: WRITE
- Summary: Update last task run's default store
- Parameters:
actorTaskIdinpathrequiredstatusinquery
- Body: JSON request body accepted.
actor_task_runs_last_key_value_store_delete
- Operation ID:
actor_task_runs_last_key_value_store_delete - Route:
DELETE /v2/actor-tasks/{actorTaskId}/runs/last/key-value-store - Mode: WRITE
- Summary: Delete last task run's default store
- Parameters:
actorTaskIdinpathrequiredstatusinquery
actor_task_runs_last_key_value_store_keys_get
- Operation ID:
actor_task_runs_last_key_value_store_keys_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/keys - Mode: READ
- Summary: Get last task run's default store's list of keys
- Parameters:
actorTaskIdinpathrequiredstatusinqueryexclusiveStartKeyinquerylimitinquerycollectioninqueryprefixinquerysignatureinquery
actor_task_runs_last_key_value_store_records_get
- Operation ID:
actor_task_runs_last_key_value_store_records_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records - Mode: READ
- Summary: Download last task run's default store's records
- Parameters:
actorTaskIdinpathrequiredstatusinquerycollectioninqueryprefixinquerysignatureinquery
actor_task_runs_last_key_value_store_record_get
- Operation ID:
actor_task_runs_last_key_value_store_record_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records/{recordKey} - Mode: READ
- Summary: Get last task run's default store's record
- Parameters:
actorTaskIdinpathrequiredstatusinqueryrecordKeyinpathrequiredsignatureinqueryattachmentinquery
actor_task_runs_last_key_value_store_record_put
- Operation ID:
actor_task_runs_last_key_value_store_record_put - Route:
PUT /v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records/{recordKey} - Mode: WRITE
- Summary: Store record in last task run's default store
- Parameters:
actorTaskIdinpathrequiredstatusinqueryrecordKeyinpathrequiredContent-Encodinginheader
- Body: JSON request body accepted.
actor_task_runs_last_key_value_store_record_post
- Operation ID:
actor_task_runs_last_key_value_store_record_post - Route:
POST /v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records/{recordKey} - Mode: WRITE
- Summary: Store record in last task run's default store (POST)
- Parameters:
actorTaskIdinpathrequiredstatusinqueryrecordKeyinpathrequiredContent-Encodinginheader
- Body: JSON request body accepted.
actor_task_runs_last_key_value_store_record_delete
- Operation ID:
actor_task_runs_last_key_value_store_record_delete - Route:
DELETE /v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records/{recordKey} - Mode: WRITE
- Summary: Delete last task run's default store's record
- Parameters:
actorTaskIdinpathrequiredstatusinqueryrecordKeyinpathrequired
actor_task_runs_last_request_queue_get
- Operation ID:
actor_task_runs_last_request_queue_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/request-queue - Mode: READ
- Summary: Get last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinquery
actor_task_runs_last_request_queue_put
- Operation ID:
actor_task_runs_last_request_queue_put - Route:
PUT /v2/actor-tasks/{actorTaskId}/runs/last/request-queue - Mode: WRITE
- Summary: Update last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinquery
- Body: JSON request body accepted.
actor_task_runs_last_request_queue_delete
- Operation ID:
actor_task_runs_last_request_queue_delete - Route:
DELETE /v2/actor-tasks/{actorTaskId}/runs/last/request-queue - Mode: WRITE
- Summary: Delete last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinquery
actor_task_runs_last_request_queue_head_get
- Operation ID:
actor_task_runs_last_request_queue_head_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/head - Mode: READ
- Summary: Get last task run's default request queue head
- Parameters:
actorTaskIdinpathrequiredstatusinquerylimitinqueryclientKeyinquery
actor_task_runs_last_request_queue_head_lock_post
- Operation ID:
actor_task_runs_last_request_queue_head_lock_post - Route:
POST /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/head/lock - Mode: WRITE
- Summary: Get and lock last task run's default request queue head
- Parameters:
actorTaskIdinpathrequiredstatusinquerylockSecsinqueryrequiredlimitinqueryclientKeyinquery
actor_task_runs_last_request_queue_requests_get
- Operation ID:
actor_task_runs_last_request_queue_requests_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests - Mode: READ
- Summary: List last task run's default request queue's requests
- Parameters:
actorTaskIdinpathrequiredstatusinqueryclientKeyinqueryexclusiveStartIdinquerylimitinquerycursorinqueryfilterinquery
actor_task_runs_last_request_queue_requests_post
- Operation ID:
actor_task_runs_last_request_queue_requests_post - Route:
POST /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests - Mode: WRITE
- Summary: Add request to last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinqueryclientKeyinqueryforefrontinquery
- Body: JSON request body accepted.
actor_task_runs_last_request_queue_requests_batch_post
- Operation ID:
actor_task_runs_last_request_queue_requests_batch_post - Route:
POST /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/batch - Mode: WRITE
- Summary: Batch add requests to last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinqueryclientKeyinqueryforefrontinquery
- Body: JSON request body accepted.
actor_task_runs_last_request_queue_requests_batch_delete
- Operation ID:
actor_task_runs_last_request_queue_requests_batch_delete - Route:
DELETE /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/batch - Mode: WRITE
- Summary: Batch delete requests from last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinqueryContent-TypeinheaderrequiredclientKeyinquery
- Body: JSON request body accepted.
actor_task_runs_last_request_queue_requests_unlock_post
- Operation ID:
actor_task_runs_last_request_queue_requests_unlock_post - Route:
POST /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/unlock - Mode: WRITE
- Summary: Unlock requests in last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinqueryclientKeyinquery
actor_task_runs_last_request_queue_request_get
- Operation ID:
actor_task_runs_last_request_queue_request_get - Route:
GET /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId} - Mode: READ
- Summary: Get request from last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinqueryrequestIdinpathrequired
actor_task_runs_last_request_queue_request_put
- Operation ID:
actor_task_runs_last_request_queue_request_put - Route:
PUT /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId} - Mode: WRITE
- Summary: Update request in last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinqueryrequestIdinpathrequiredforefrontinqueryclientKeyinquery
- Body: JSON request body accepted.
actor_task_runs_last_request_queue_request_delete
- Operation ID:
actor_task_runs_last_request_queue_request_delete - Route:
DELETE /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId} - Mode: WRITE
- Summary: Delete request from last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinqueryrequestIdinpathrequiredclientKeyinquery
actor_task_runs_last_request_queue_request_lock_put
- Operation ID:
actor_task_runs_last_request_queue_request_lock_put - Route:
PUT /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId}/lock - Mode: WRITE
- Summary: Prolong lock on request in last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinqueryrequestIdinpathrequiredlockSecsinqueryrequiredclientKeyinqueryforefrontinquery
actor_task_runs_last_request_queue_request_lock_delete
- Operation ID:
actor_task_runs_last_request_queue_request_lock_delete - Route:
DELETE /v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId}/lock - Mode: WRITE
- Summary: Delete lock on request in last task run's default request queue
- Parameters:
actorTaskIdinpathrequiredstatusinqueryrequestIdinpathrequiredclientKeyinqueryforefrontinquery