476 lines
13 KiB
Markdown
476 lines
13 KiB
Markdown
---
|
|
name: actor-runs-routes
|
|
description: Handle 40 OpenAPI operation(s) under /v2/actor-runs for the actor runs route group.
|
|
---
|
|
|
|
# actor runs API Routes
|
|
|
|
Handle 40 OpenAPI operation(s) under /v2/actor-runs for the actor runs 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_runs_get
|
|
|
|
- Operation ID: `actor_runs_get`
|
|
- Route: `GET /v2/actor-runs`
|
|
- Mode: READ
|
|
- Summary: Get user runs list
|
|
- Parameters:
|
|
- `offset` in `query`
|
|
- `limit` in `query`
|
|
- `desc` in `query`
|
|
- `status` in `query`
|
|
- `startedAfter` in `query`
|
|
- `startedBefore` in `query`
|
|
|
|
### actor_run_get
|
|
|
|
- Operation ID: `actor_run_get`
|
|
- Route: `GET /v2/actor-runs/{runId}`
|
|
- Mode: READ
|
|
- Summary: Get run
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `waitForFinish` in `query`
|
|
|
|
### actor_run_put
|
|
|
|
- Operation ID: `actor_run_put`
|
|
- Route: `PUT /v2/actor-runs/{runId}`
|
|
- Mode: WRITE
|
|
- Summary: Update run
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_delete
|
|
|
|
- Operation ID: `actor_run_delete`
|
|
- Route: `DELETE /v2/actor-runs/{runId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete run
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
|
|
### actor_run_abort_post
|
|
|
|
- Operation ID: `actor_run_abort_post`
|
|
- Route: `POST /v2/actor-runs/{runId}/abort`
|
|
- Mode: WRITE
|
|
- Summary: Abort run
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `gracefully` in `query`
|
|
|
|
### actor_run_metamorph_post
|
|
|
|
- Operation ID: `actor_run_metamorph_post`
|
|
- Route: `POST /v2/actor-runs/{runId}/metamorph`
|
|
- Mode: WRITE
|
|
- Summary: Metamorph run
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `targetActorId` in `query` required
|
|
- `build` in `query`
|
|
|
|
### actor_run_reboot_post
|
|
|
|
- Operation ID: `actor_run_reboot_post`
|
|
- Route: `POST /v2/actor-runs/{runId}/reboot`
|
|
- Mode: WRITE
|
|
- Summary: Reboot run
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
|
|
### post_resurrect_run
|
|
|
|
- Operation ID: `post_resurrect_run`
|
|
- Route: `POST /v2/actor-runs/{runId}/resurrect`
|
|
- Mode: WRITE
|
|
- Summary: Resurrect run
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `build` in `query`
|
|
- `timeout` in `query`
|
|
- `memory` in `query`
|
|
- `maxItems` in `query`
|
|
- `maxTotalChargeUsd` in `query`
|
|
- `restartOnError` in `query`
|
|
|
|
### post_charge_run
|
|
|
|
- Operation ID: `post_charge_run`
|
|
- Route: `POST /v2/actor-runs/{runId}/charge`
|
|
- Mode: WRITE
|
|
- Summary: Charge events in run
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `idempotency-key` in `header`
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_dataset_get
|
|
|
|
- Operation ID: `actor_run_dataset_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/dataset`
|
|
- Mode: READ
|
|
- Summary: Get default dataset
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
|
|
### actor_run_dataset_put
|
|
|
|
- Operation ID: `actor_run_dataset_put`
|
|
- Route: `PUT /v2/actor-runs/{runId}/dataset`
|
|
- Mode: WRITE
|
|
- Summary: Update default dataset
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_dataset_delete
|
|
|
|
- Operation ID: `actor_run_dataset_delete`
|
|
- Route: `DELETE /v2/actor-runs/{runId}/dataset`
|
|
- Mode: WRITE
|
|
- Summary: Delete default dataset
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
|
|
### actor_run_dataset_items_get
|
|
|
|
- Operation ID: `actor_run_dataset_items_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/dataset/items`
|
|
- Mode: READ
|
|
- Summary: Get default dataset items
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `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_run_dataset_items_post
|
|
|
|
- Operation ID: `actor_run_dataset_items_post`
|
|
- Route: `POST /v2/actor-runs/{runId}/dataset/items`
|
|
- Mode: WRITE
|
|
- Summary: Store items
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_dataset_statistics_get
|
|
|
|
- Operation ID: `actor_run_dataset_statistics_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/dataset/statistics`
|
|
- Mode: READ
|
|
- Summary: Get default dataset statistics
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
|
|
### actor_run_key_value_store_get
|
|
|
|
- Operation ID: `actor_run_key_value_store_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/key-value-store`
|
|
- Mode: READ
|
|
- Summary: Get default store
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
|
|
### actor_run_key_value_store_put
|
|
|
|
- Operation ID: `actor_run_key_value_store_put`
|
|
- Route: `PUT /v2/actor-runs/{runId}/key-value-store`
|
|
- Mode: WRITE
|
|
- Summary: Update default store
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_key_value_store_delete
|
|
|
|
- Operation ID: `actor_run_key_value_store_delete`
|
|
- Route: `DELETE /v2/actor-runs/{runId}/key-value-store`
|
|
- Mode: WRITE
|
|
- Summary: Delete default store
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
|
|
### actor_run_key_value_store_keys_get
|
|
|
|
- Operation ID: `actor_run_key_value_store_keys_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/key-value-store/keys`
|
|
- Mode: READ
|
|
- Summary: Get default store's list of keys
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `exclusiveStartKey` in `query`
|
|
- `limit` in `query`
|
|
- `collection` in `query`
|
|
- `prefix` in `query`
|
|
- `signature` in `query`
|
|
|
|
### actor_run_key_value_store_records_get
|
|
|
|
- Operation ID: `actor_run_key_value_store_records_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/key-value-store/records`
|
|
- Mode: READ
|
|
- Summary: Download default store's records
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `collection` in `query`
|
|
- `prefix` in `query`
|
|
- `signature` in `query`
|
|
|
|
### actor_run_key_value_store_record_get
|
|
|
|
- Operation ID: `actor_run_key_value_store_record_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/key-value-store/records/{recordKey}`
|
|
- Mode: READ
|
|
- Summary: Get default store's record
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `recordKey` in `path` required
|
|
- `signature` in `query`
|
|
- `attachment` in `query`
|
|
|
|
### actor_run_key_value_store_record_put
|
|
|
|
- Operation ID: `actor_run_key_value_store_record_put`
|
|
- Route: `PUT /v2/actor-runs/{runId}/key-value-store/records/{recordKey}`
|
|
- Mode: WRITE
|
|
- Summary: Store record in default store
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `recordKey` in `path` required
|
|
- `Content-Encoding` in `header`
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_key_value_store_record_post
|
|
|
|
- Operation ID: `actor_run_key_value_store_record_post`
|
|
- Route: `POST /v2/actor-runs/{runId}/key-value-store/records/{recordKey}`
|
|
- Mode: WRITE
|
|
- Summary: Store record in default store (POST)
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `recordKey` in `path` required
|
|
- `Content-Encoding` in `header`
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_key_value_store_record_delete
|
|
|
|
- Operation ID: `actor_run_key_value_store_record_delete`
|
|
- Route: `DELETE /v2/actor-runs/{runId}/key-value-store/records/{recordKey}`
|
|
- Mode: WRITE
|
|
- Summary: Delete default store's record
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `recordKey` in `path` required
|
|
|
|
### actor_run_request_queue_get
|
|
|
|
- Operation ID: `actor_run_request_queue_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/request-queue`
|
|
- Mode: READ
|
|
- Summary: Get default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
|
|
### actor_run_request_queue_put
|
|
|
|
- Operation ID: `actor_run_request_queue_put`
|
|
- Route: `PUT /v2/actor-runs/{runId}/request-queue`
|
|
- Mode: WRITE
|
|
- Summary: Update default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_request_queue_delete
|
|
|
|
- Operation ID: `actor_run_request_queue_delete`
|
|
- Route: `DELETE /v2/actor-runs/{runId}/request-queue`
|
|
- Mode: WRITE
|
|
- Summary: Delete default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
|
|
### actor_run_request_queue_requests_get
|
|
|
|
- Operation ID: `actor_run_request_queue_requests_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/request-queue/requests`
|
|
- Mode: READ
|
|
- Summary: List default request queue's requests
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `clientKey` in `query`
|
|
- `exclusiveStartId` in `query`
|
|
- `limit` in `query`
|
|
- `cursor` in `query`
|
|
- `filter` in `query`
|
|
|
|
### actor_run_request_queue_requests_post
|
|
|
|
- Operation ID: `actor_run_request_queue_requests_post`
|
|
- Route: `POST /v2/actor-runs/{runId}/request-queue/requests`
|
|
- Mode: WRITE
|
|
- Summary: Add request to default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `clientKey` in `query`
|
|
- `forefront` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_request_queue_requests_batch_post
|
|
|
|
- Operation ID: `actor_run_request_queue_requests_batch_post`
|
|
- Route: `POST /v2/actor-runs/{runId}/request-queue/requests/batch`
|
|
- Mode: WRITE
|
|
- Summary: Batch add requests to default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `clientKey` in `query`
|
|
- `forefront` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_request_queue_requests_batch_delete
|
|
|
|
- Operation ID: `actor_run_request_queue_requests_batch_delete`
|
|
- Route: `DELETE /v2/actor-runs/{runId}/request-queue/requests/batch`
|
|
- Mode: WRITE
|
|
- Summary: Batch delete requests from default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `Content-Type` in `header` required
|
|
- `clientKey` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_request_queue_requests_unlock_post
|
|
|
|
- Operation ID: `actor_run_request_queue_requests_unlock_post`
|
|
- Route: `POST /v2/actor-runs/{runId}/request-queue/requests/unlock`
|
|
- Mode: WRITE
|
|
- Summary: Unlock requests in default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `clientKey` in `query`
|
|
|
|
### actor_run_request_queue_request_get
|
|
|
|
- Operation ID: `actor_run_request_queue_request_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/request-queue/requests/{requestId}`
|
|
- Mode: READ
|
|
- Summary: Get request from default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `requestId` in `path` required
|
|
|
|
### actor_run_request_queue_request_put
|
|
|
|
- Operation ID: `actor_run_request_queue_request_put`
|
|
- Route: `PUT /v2/actor-runs/{runId}/request-queue/requests/{requestId}`
|
|
- Mode: WRITE
|
|
- Summary: Update request in default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `requestId` in `path` required
|
|
- `forefront` in `query`
|
|
- `clientKey` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### actor_run_request_queue_request_delete
|
|
|
|
- Operation ID: `actor_run_request_queue_request_delete`
|
|
- Route: `DELETE /v2/actor-runs/{runId}/request-queue/requests/{requestId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete request from default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `requestId` in `path` required
|
|
- `clientKey` in `query`
|
|
|
|
### actor_run_request_queue_request_lock_put
|
|
|
|
- Operation ID: `actor_run_request_queue_request_lock_put`
|
|
- Route: `PUT /v2/actor-runs/{runId}/request-queue/requests/{requestId}/lock`
|
|
- Mode: WRITE
|
|
- Summary: Prolong lock on request in default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `requestId` in `path` required
|
|
- `lockSecs` in `query` required
|
|
- `clientKey` in `query`
|
|
- `forefront` in `query`
|
|
|
|
### actor_run_request_queue_request_lock_delete
|
|
|
|
- Operation ID: `actor_run_request_queue_request_lock_delete`
|
|
- Route: `DELETE /v2/actor-runs/{runId}/request-queue/requests/{requestId}/lock`
|
|
- Mode: WRITE
|
|
- Summary: Delete lock on request in default request queue
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `requestId` in `path` required
|
|
- `clientKey` in `query`
|
|
- `forefront` in `query`
|
|
|
|
### actor_run_request_queue_head_get
|
|
|
|
- Operation ID: `actor_run_request_queue_head_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/request-queue/head`
|
|
- Mode: READ
|
|
- Summary: Get default request queue head
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `limit` in `query`
|
|
- `clientKey` in `query`
|
|
|
|
### actor_run_request_queue_head_lock_post
|
|
|
|
- Operation ID: `actor_run_request_queue_head_lock_post`
|
|
- Route: `POST /v2/actor-runs/{runId}/request-queue/head/lock`
|
|
- Mode: WRITE
|
|
- Summary: Get and lock default request queue head
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `lockSecs` in `query` required
|
|
- `limit` in `query`
|
|
- `clientKey` in `query`
|
|
|
|
### actor_run_log_get
|
|
|
|
- Operation ID: `actor_run_log_get`
|
|
- Route: `GET /v2/actor-runs/{runId}/log`
|
|
- Mode: READ
|
|
- Summary: Get run's log
|
|
- Parameters:
|
|
- `runId` in `path` required
|
|
- `stream` in `query`
|
|
- `download` in `query`
|
|
- `raw` in `query`
|