Run Actor

v1.0.0

Runs an Actor and immediately returns without waiting for the run to finish.

The POST payload including its Content-Type header is passed as INPUT to the Actor (usually application/json).

The Actor is started with the default options; you can override them using various URL query parameters.

The response is the Run object as returned by the API endpoint.

If you want to wait for the run to finish and receive the actual output of the Actor as the response, please use one of the API endpoints instead.

To fetch the Actor run results that are typically stored in the default dataset, you'll need to pass the ID received in the defaultDatasetId field received in the response JSON to the API endpoint.

Input

{
  "type": "object",
  "properties": {
    "actorId": {
      "type": "string"
    },
    "build": {
      "type": "string"
    },
    "forcePermissionLevel": {
      "type": "string",
      "enum": [
        "LIMITED_PERMISSIONS",
        "FULL_PERMISSIONS"
      ]
    },
    "maxItems": {
      "type": "number",
      "format": "double"
    },
    "maxTotalChargeUsd": {
      "type": "number",
      "format": "double"
    },
    "memory": {
      "type": "number",
      "format": "double"
    },
    "restartOnError": {
      "type": "boolean"
    },
    "timeout": {
      "type": "number",
      "format": "double"
    },
    "waitForFinish": {
      "type": "number",
      "format": "double"
    },
    "webhooks": {
      "type": "string"
    }
  },
  "required": [
    "actorId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "description": "Represents an Actor run and its associated data.",
      "required": [
        "actId",
        "buildId",
        "defaultDatasetId",
        "defaultKeyValueStoreId",
        "defaultRequestQueueId",
        "generalAccess",
        "id",
        "meta",
        "options",
        "startedAt",
        "stats",
        "status",
        "userId"
      ],
      "properties": {
        "actId": {
          "type": "string",
          "description": "ID of the Actor that was run."
        },
        "actorTaskId": {
          "type": [
            "string",
            "null"
          ],
          "description": "ID of the Actor task, if the run was started from a task."
        },
        "buildId": {
          "type": "string",
          "description": "ID of the Actor build used for this run."
        },
        "buildNumber": {
          "type": [
            "string",
            "null"
          ],
          "description": "Build number of the Actor build used for this run."
        },
        "chargedEventCounts": {
          "type": "object",
          "description": "A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run."
        },
        "containerUrl": {
          "type": "string",
          "format": "uri",
          "description": "URL of the container running the Actor."
        },
        "defaultDatasetId": {
          "type": "string",
          "description": "ID of the default dataset for this run."
        },
        "defaultKeyValueStoreId": {
          "type": "string",
          "description": "ID of the default key-value store for this run."
        },
        "defaultRequestQueueId": {
          "type": "string",
          "description": "ID of the default request queue for this run."
        },
        "exitCode": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Exit code of the Actor run process."
        },
        "finishedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "Time when the Actor run finished."
        },
        "generalAccess": {
          "type": "string",
          "description": "General access level for the Actor run.",
          "enum": [
            "ANYONE_WITH_ID_CAN_READ",
            "ANYONE_WITH_NAME_CAN_READ",
            "FOLLOW_USER_SETTING",
            "RESTRICTED"
          ]
        },
        "gitBranchName": {
          "type": [
            "string",
            "null"
          ],
          "description": "Name of the git branch used for the Actor build."
        },
        "id": {
          "type": "string",
          "description": "Unique identifier of the Actor run."
        },
        "isContainerServerReady": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Whether the container's HTTP server is ready to accept requests."
        },
        "isStatusMessageTerminal": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Whether the status message is terminal (final)."
        },
        "meta": {
          "type": "object",
          "description": "Metadata about the Actor run.",
          "required": [
            "origin"
          ],
          "properties": {
            "clientIp": {
              "type": [
                "string",
                "null"
              ],
              "description": "IP address of the client that started the run."
            },
            "origin": {
              "type": "string",
              "enum": [
                "DEVELOPMENT",
                "WEB",
                "API",
                "SCHEDULER",
                "TEST",
                "WEBHOOK",
                "ACTOR",
                "CLI",
                "CI",
                "STANDBY",
                "MCP"
              ]
            },
            "scheduleId": {
              "type": [
                "string",
                "null"
              ],
              "description": "ID of the schedule that triggered the run."
            },
            "scheduledAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time",
              "description": "Time when the run was scheduled."
            },
            "userAgent": {
              "type": [
                "string",
                "null"
              ],
              "description": "User agent of the client that started the run."
            }
          }
        },
        "metamorphs": {
          "description": "List of metamorph events that occurred during the run.",
          "type": "object"
        },
        "options": {
          "type": "object",
          "description": "Configuration options for the Actor run.",
          "required": [
            "build",
            "diskMbytes",
            "memoryMbytes",
            "timeoutSecs"
          ],
          "properties": {
            "build": {
              "type": "string"
            },
            "diskMbytes": {
              "type": "integer"
            },
            "maxItems": {
              "type": [
                "integer",
                "null"
              ]
            },
            "maxTotalChargeUsd": {
              "type": [
                "number",
                "null"
              ]
            },
            "memoryMbytes": {
              "type": "integer"
            },
            "timeoutSecs": {
              "type": "integer"
            }
          }
        },
        "platformUsageBillingModel": {
          "type": "string",
          "description": "Indicates which party covers platform usage costs for this run."
        },
        "pricingInfo": {
          "description": "Pricing information for the Actor.",
          "type": "object"
        },
        "startedAt": {
          "type": "string",
          "format": "date-time",
          "description": "Time when the Actor run started."
        },
        "stats": {
          "type": "object",
          "description": "Statistics of the Actor run.",
          "properties": {
            "computeUnits": {
              "type": "number"
            },
            "cpuAvgUsage": {
              "type": "number"
            },
            "cpuCurrentUsage": {
              "type": "number"
            },
            "cpuMaxUsage": {
              "type": "number"
            },
            "durationMillis": {
              "type": "integer"
            },
            "inputBodyLen": {
              "type": [
                "integer",
                "null"
              ]
            },
            "memAvgBytes": {
              "type": "number"
            },
            "memCurrentBytes": {
              "type": "integer"
            },
            "memMaxBytes": {
              "type": "integer"
            },
            "metamorph": {
              "type": "integer"
            },
            "migrationCount": {
              "type": "integer"
            },
            "netRxBytes": {
              "type": "integer"
            },
            "netTxBytes": {
              "type": "integer"
            },
            "rebootCount": {
              "type": "integer"
            },
            "restartCount": {
              "type": "integer"
            },
            "resurrectCount": {
              "type": "integer"
            },
            "runTimeSecs": {
              "type": "number"
            }
          }
        },
        "status": {
          "type": "string",
          "description": "Status of an Actor job (run or build).",
          "enum": [
            "READY",
            "RUNNING",
            "SUCCEEDED",
            "FAILED",
            "TIMING-OUT",
            "TIMED-OUT",
            "ABORTING",
            "ABORTED"
          ]
        },
        "statusMessage": {
          "type": [
            "string",
            "null"
          ],
          "description": "Detailed message about the run status."
        },
        "storageIds": {
          "type": "object",
          "description": "A map of aliased storage IDs associated with this run, grouped by storage type.",
          "properties": {
            "datasets": {
              "type": "object",
              "description": "Aliased dataset IDs for this run.",
              "properties": {
                "default": {
                  "type": "string",
                  "description": "ID of the default dataset for this run."
                }
              }
            },
            "keyValueStores": {
              "type": "object",
              "description": "Aliased key-value store IDs for this run.",
              "properties": {
                "default": {
                  "type": "string",
                  "description": "ID of the default key-value store for this run."
                }
              }
            },
            "requestQueues": {
              "type": "object",
              "description": "Aliased request queue IDs for this run.",
              "properties": {
                "default": {
                  "type": "string",
                  "description": "ID of the default request queue for this run."
                }
              }
            }
          }
        },
        "usage": {
          "description": "Resource usage statistics for the run.",
          "type": "object"
        },
        "usageTotalUsd": {
          "type": [
            "number",
            "null"
          ],
          "description": "Total cost in USD for this run. Represents what you actually pay. For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model. For run non-owners: only available for Pay-Per-Event Actors (event costs only). Requires authentication token to access."
        },
        "usageUsd": {
          "description": "Platform usage costs breakdown in USD. Only present if you own the run AND are paying for platform usage (Pay-Per-Usage, Rental, or Pay-Per-Event with usage costs like standby Actors). Not available for standard Pay-Per-Event Actors. Requires authentication token to access.",
          "type": "object"
        },
        "userId": {
          "type": "string",
          "description": "ID of the user who started the run."
        }
      }
    }
  }
}