Files
a2a-platform dfb65e705f deploy
2026-06-06 21:16:45 +00:00

670 lines
20 KiB
Markdown

---
name: actor-tasks-routes
description: 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:
- `offset` in `query`
- `limit` in `query`
- `desc` in `query`
### 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:
- `actorTaskId` in `path` required
### actor_task_put
- Operation ID: `actor_task_put`
- Route: `PUT /v2/actor-tasks/{actorTaskId}`
- Mode: WRITE
- Summary: Update task
- Parameters:
- `actorTaskId` in `path` required
- 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:
- `actorTaskId` in `path` required
### actor_task_input_get
- Operation ID: `actor_task_input_get`
- Route: `GET /v2/actor-tasks/{actorTaskId}/input`
- Mode: READ
- Summary: Get task input
- Parameters:
- `actorTaskId` in `path` required
### actor_task_input_put
- Operation ID: `actor_task_input_put`
- Route: `PUT /v2/actor-tasks/{actorTaskId}/input`
- Mode: WRITE
- Summary: Update task input
- Parameters:
- `actorTaskId` in `path` required
- 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:
- `actorTaskId` in `path` required
- `offset` in `query`
- `limit` in `query`
- `desc` in `query`
### 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:
- `actorTaskId` in `path` required
- `offset` in `query`
- `limit` in `query`
- `desc` in `query`
- `status` in `query`
### actor_task_runs_post
- Operation ID: `actor_task_runs_post`
- Route: `POST /v2/actor-tasks/{actorTaskId}/runs`
- Mode: WRITE
- Summary: Run task
- Parameters:
- `actorTaskId` 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`
- 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:
- `actorTaskId` in `path` required
- `timeout` in `query`
- `memory` in `query`
- `maxItems` in `query`
- `build` in `query`
- `outputRecordKey` in `query`
- `webhooks` in `query`
### 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:
- `actorTaskId` in `path` required
- `timeout` in `query`
- `memory` in `query`
- `maxItems` in `query`
- `maxTotalChargeUsd` in `query`
- `restartOnError` in `query`
- `build` in `query`
- `outputRecordKey` in `query`
- `webhooks` in `query`
- 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:
- `actorTaskId` in `path` required
- `timeout` in `query`
- `memory` in `query`
- `maxItems` 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`
### 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:
- `actorTaskId` 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.
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `waitForFinish` in `query`
### 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:
- `actorTaskId` in `path` required
- `stream` in `query`
- `download` in `query`
- `raw` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `gracefully` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `targetActorId` in `query` required
- `build` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- 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:
- `actorTaskId` in `path` required
- `status` in `query`
### 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:
- `actorTaskId` 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`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- 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:
- `actorTaskId` in `path` required
- `status` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- 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:
- `actorTaskId` in `path` required
- `status` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `exclusiveStartKey` in `query`
- `limit` in `query`
- `collection` in `query`
- `prefix` in `query`
- `signature` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `collection` in `query`
- `prefix` in `query`
- `signature` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `recordKey` in `path` required
- `signature` in `query`
- `attachment` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `recordKey` in `path` required
- `Content-Encoding` in `header`
- 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `recordKey` in `path` required
- `Content-Encoding` in `header`
- 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `recordKey` in `path` required
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- 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:
- `actorTaskId` in `path` required
- `status` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `limit` in `query`
- `clientKey` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `lockSecs` in `query` required
- `limit` in `query`
- `clientKey` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `clientKey` in `query`
- `exclusiveStartId` in `query`
- `limit` in `query`
- `cursor` in `query`
- `filter` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `clientKey` in `query`
- `forefront` in `query`
- 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `clientKey` in `query`
- `forefront` in `query`
- 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `Content-Type` in `header` required
- `clientKey` in `query`
- 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `clientKey` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `requestId` in `path` required
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `requestId` in `path` required
- `forefront` in `query`
- `clientKey` in `query`
- 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `requestId` in `path` required
- `clientKey` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `requestId` in `path` required
- `lockSecs` in `query` required
- `clientKey` in `query`
- `forefront` in `query`
### 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:
- `actorTaskId` in `path` required
- `status` in `query`
- `requestId` in `path` required
- `clientKey` in `query`
- `forefront` in `query`