Get Actor

GET 
/v2/acts/:actorId

Gets an object that contains all the details about a specific Actor.

Request

Path Parameters

actorId string required
Actor ID or a tilde-separated owner's username and Actor name.

Example: janedoe~my-actor

Status 200

Response Headers

{
  "data": {
    "id": "zdc3Pyhyz3m8vjDeM",
    "userId": "wRsJZtadYvn4mBZmm",
    "name": "MyActor",
    "username": "jane35",
    "description": "My favourite Actor!",
    "isPublic": false,
    "createdAt": "2019-07-08T11:27:57.401Z",
    "modifiedAt": "2019-07-08T14:01:05.546Z",
    "stats": {
      "totalBuilds": 9,
      "totalRuns": 16,
      "totalUsers": 6,
      "totalUsers7Days": 2,
      "totalUsers30Days": 6,
      "totalUsers90Days": 6,
      "totalMetamorphs": 2,
      "lastRunStartedAt": "2019-07-08T14:01:05.546Z"
    },
    "versions": [
      {
        "versionNumber": "0.1",
        "envVars": null,
        "sourceType": "SOURCE_FILES",
        "applyEnvVarsToBuild": false,
        "buildTag": "latest",
        "sourceFiles": []
      },
      {
        "versionNumber": "0.2",
        "sourceType": "GIT_REPO",
        "envVars": null,
        "applyEnvVarsToBuild": false,
        "buildTag": "latest",
        "gitRepoUrl": "https://github.com/jane35/my-actor"
      },
      {
        "versionNumber": "0.3",
        "sourceType": "TARBALL",
        "envVars": null,
        "applyEnvVarsToBuild": false,
        "buildTag": "latest",
        "tarballUrl": "https://github.com/jane35/my-actor/archive/master.zip"
      },
      {
        "versionNumber": "0.4",
        "sourceType": "GITHUB_GIST",
        "envVars": null,
        "applyEnvVarsToBuild": false,
        "buildTag": "latest",
        "gitHubGistUrl": "https://gist.github.com/jane35/e51feb784yu89"
      }
    ],
    "defaultRunOptions": {
      "build": "latest",
      "timeoutSecs": 3600,
      "memoryMbytes": 2048,
      "restartOnError": false
    },
    "exampleRunInput": {
      "body": "{ \"helloWorld\": 123 }",
      "contentType": "application/json; charset=utf-8"
    },
    "isDeprecated": false,
    "deploymentKey": "ssh-rsa AAAA ...",
    "title": "My Actor",
    "taggedBuilds": {
      "latest": {
        "buildId": "z2EryhbfhgSyqj6Hn",
        "buildNumber": "0.0.2",
        "finishedAt": "2019-06-10T11:15:49.286Z"
      }
    }
  }
}

Schema

• data object required

  • id string required
    Example: zdc3Pyhyz3m8vjDeM
  • userId string required
    Example: wRsJZtadYvn4mBZmm
  • name string required
    Example: MyActor
  • username string required
    Example: jane35
  • description string | null nullable
    Example: My favourite actor!
  • restartOnError boolean deprecated
    Example: false
  • isPublic boolean required
    Example: false
  • actorPermissionLevel ActorPermissionLevel (string)

    Determines permissions that the Actor requires to run. For more information, see the Actor permissions documentation.

    Possible values: [LIMITED_PERMISSIONS, FULL_PERMISSIONS]

    
    Example: LIMITED_PERMISSIONS
  • createdAt string<date-time> required
    Example: 2019-07-08T11:27:57.401Z
  • modifiedAt string<date-time> required
    Example: 2019-07-08T14:01:05.546Z
  • stats object required

    • totalBuilds integer
      Example: 9
    • totalRuns integer
      Example: 16
    • totalUsers integer
      Example: 6
    • totalUsers7Days integer
      Example: 2
    • totalUsers30Days integer
      Example: 6
    • totalUsers90Days integer
      Example: 6
    • totalMetamorphs integer
      Example: 2
    • lastRunStartedAt string<date-time>
      Example: 2019-07-08T14:01:05.546Z
  • versions object[] required

    • versionNumber string required
      Example: 0.0
    • sourceType object required

      anyOf
      • VersionSourceType
      • null

      VersionSourceType (string)

      Possible values: [SOURCE_FILES, GIT_REPO, TARBALL, GITHUB_GIST]

    • envVars object[]

      • name string required
        Example: MY_ENV_VAR
      • value string required
        Example: my-value
      • isSecret boolean | null nullable
        Example: false
    • applyEnvVarsToBuild boolean | null nullable
      Example: false
    • buildTag string
      Example: latest
    • sourceFiles object[]

      anyOf
      • SourceCodeFile
      • SourceCodeFolder
      format SourceCodeFileFormat (string) required
      Possible values: [BASE64, TEXT]
      
      Example: TEXT
      content string required
      Example: console.log('This is the main.js file');
      name string required
      Example: src/main.js
    • gitRepoUrl string | null nullable

      URL of the Git repository when sourceType is GIT_REPO.

    • tarballUrl string | null nullable

      URL of the tarball when sourceType is TARBALL.

    • gitHubGistUrl string | null nullable

      URL of the GitHub Gist when sourceType is GITHUB_GIST.
  • pricingInfos object[]

    oneOf
    • PayPerEventActorPricingInfo
    • PricePerDatasetItemActorPricingInfo
    • FlatPricePerMonthActorPricingInfo
    • FreeActorPricingInfo
    apifyMarginPercentage number required
    In [0, 1], fraction of pricePerUnitUsd that goes to Apify
    createdAt string<date-time> required
    When this pricing info record has been created
    startedAt string<date-time> required
    Since when is this pricing info record effective for a given Actor
    notifiedAboutFutureChangeAt string,null<date-time> nullable
    notifiedAboutChangeAt string,null<date-time> nullable
    reasonForChange string | null nullable
    pricingModel PricingModel (string) required
    Possible values: [PAY_PER_EVENT, PRICE_PER_DATASET_ITEM, FLAT_PRICE_PER_MONTH, FREE]
    pricingPerEvent object required
    • actorChargeEvents object

      • property name* ActorChargeEvent

        • eventPriceUsd number required
        • eventTitle string required
        • eventDescription string required
    minimalMaxTotalChargeUsd number | null nullable
  • defaultRunOptions object required

    • build string required
      Example: latest
    • timeoutSecs integer
      Example: 3600
    • memoryMbytes integer required
      Example: 2048
    • restartOnError boolean
      Example: false
  • exampleRunInput object

    anyOf
    • exampleRunInput
    • null
    body string required
    Example: { "helloWorld": 123 }
    contentType string required
    Example: application/json; charset=utf-8
  • isDeprecated boolean | null nullable
    Example: false
  • deploymentKey string
    Example: ssh-rsa AAAA ...
  • title string | null nullable
    Example: My Actor
  • taggedBuilds object

    anyOf
    • TaggedBuilds
    • null
    object
    A dictionary mapping build tag names (e.g., "latest", "beta") to their build information.
    
    Example: {"latest":{"buildId":"z2EryhbfhgSyqj6Hn","buildNumber":"0.0.2","finishedAt":"2019-06-10T11:15:49.286Z"},"beta":{"buildId":"abc123def456","buildNumber":"1.0.0-beta","finishedAt":"2019-07-15T14:30:00.000Z"}}
  • readmeSummary string

    A brief, LLM-generated readme summary

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)