Get Actor

{
  "type": "object",
  "description": "Response containing Actor data.",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "createdAt",
        "defaultRunOptions",
        "id",
        "isPublic",
        "modifiedAt",
        "name",
        "stats",
        "userId",
        "username",
        "versions"
      ],
      "properties": {
        "actorPermissionLevel": {
          "type": "string",
          "description": "Determines the permission level that the Actor requires to run. For details, see [Actor permissions](https://docs.apify.com/platform/actors/development/permissions).\n",
          "enum": [
            "LIMITED_PERMISSIONS",
            "FULL_PERMISSIONS"
          ]
        },
        "actorStandby": {
          "type": "object"
        },
        "categories": {
          "type": "array",
          "description": "A list of categories that best define the Actor. Reflected in Apify Store's search and filtering options.",
          "items": {
            "type": "string"
          }
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time the Actor was created. Follows the ISO 8601 format."
        },
        "defaultRunOptions": {
          "type": "object",
          "description": "The default settings applied to an Actor run. Can be overridden elsewhere.",
          "properties": {
            "build": {
              "type": "string",
              "description": "Which build to run. Either a build tag or a version number."
            },
            "forcePermissionLevel": {
              "type": "object"
            },
            "maxItems": {
              "type": [
                "integer",
                "null"
              ],
              "description": "Maximum number of items the run might produce."
            },
            "memoryMbytes": {
              "type": "integer",
              "description": "In MB, the amount of memory allocated to the run."
            },
            "restartOnError": {
              "type": "boolean",
              "description": "Whether to automatically restart the run if it fails."
            },
            "timeoutSecs": {
              "type": "integer",
              "description": "Timeout in seconds. 0 if no timeout."
            }
          }
        },
        "deploymentKey": {
          "type": "string",
          "description": "The Actor's public SSH key, used as a deployment key for private Git repositories."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "Short description of the Actor, displayed in Apify Store and Console."
        },
        "exampleRunInput": {
          "type": "object"
        },
        "hasNoDataset": {
          "type": "boolean",
          "description": "Whether the Actor stores results in a dataset. Set by Apify."
        },
        "id": {
          "type": "string",
          "description": "The ID of the Actor."
        },
        "isCritical": {
          "type": "boolean",
          "description": "Whether the Actor is maintained by Apify."
        },
        "isDeprecated": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Whether the Actor is deprecated."
        },
        "isGeneric": {
          "type": "boolean",
          "description": "Whether the Actor is intended for developers. Set by Apify."
        },
        "isPublic": {
          "type": "boolean",
          "description": "Whether the Actor is available to users in Apify Store."
        },
        "isSourceCodeHidden": {
          "type": "boolean",
          "description": "Whether the Actor's source files are hidden on its detail page."
        },
        "modifiedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time the Actor was last modified. Follows the ISO 8601 format."
        },
        "name": {
          "type": "string",
          "description": "The name of the Actor."
        },
        "notice": {
          "type": [
            "string",
            "null"
          ],
          "description": "A warning displayed on the Actor's page in Apify Store and Console. Can be set by the Actor's developer or automatically by Apify's quality checks.",
          "enum": [
            "NONE",
            "RESIDENTIAL_PROXY_REQUIRED",
            "UNDER_MAINTENANCE"
          ]
        },
        "pictureUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "URL of the Actor's icon, displayed on the Actor's page in Apify Store and Console."
        },
        "pricingInfos": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "readmeSummary": {
          "type": "string",
          "description": "An AI-generated Markdown summary of the Actor's README, optimized for search and AI agents. Contains an overview and a list of use cases. Generated only for public Actors."
        },
        "restartOnError": {
          "type": "boolean"
        },
        "seoDescription": {
          "type": [
            "string",
            "null"
          ],
          "description": "Description of the Actor to display by search engines such as Google."
        },
        "seoTitle": {
          "type": [
            "string",
            "null"
          ],
          "description": "Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Apify Store and Console."
        },
        "standbyUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "URL for sending requests to the Actor in Standby mode.\n`null` if the Standby mode isn't enabled.\n"
        },
        "stats": {
          "type": "object",
          "description": "Usage statistics and Apify Store metrics for the Actor.",
          "properties": {
            "actorReviewCount": {
              "type": "integer",
              "description": "The number of reviews the Actor has received in Apify Store."
            },
            "actorReviewRating": {
              "type": "number",
              "description": "The average rating of the Actor in Apify Store."
            },
            "bookmarkCount": {
              "type": "integer",
              "description": "The number of users who bookmarked the Actor in Apify Store."
            },
            "lastRunStartedAt": {
              "type": "string",
              "format": "date-time",
              "description": "The date and time the most recent run of the Actor started."
            },
            "publicActorRunStats30Days": {
              "type": "object",
              "description": "Run status counts from the last 30 days. Only for public Actors.\nExcludes runs started by the Actor's owner.\n",
              "properties": {
                "ABORTED": {
                  "type": "integer",
                  "description": "The number of runs that were aborted."
                },
                "FAILED": {
                  "type": "integer",
                  "description": "The number of runs that failed."
                },
                "SUCCEEDED": {
                  "type": "integer",
                  "description": "The number of runs that succeeded."
                },
                "TIMED-OUT": {
                  "type": "integer",
                  "description": "The number of runs that timed out."
                },
                "TOTAL": {
                  "type": "integer",
                  "description": "The total number of runs."
                }
              }
            },
            "totalBuilds": {
              "type": "integer",
              "description": "The total number of builds of the Actor."
            },
            "totalMetamorphs": {
              "type": "integer",
              "description": "The total number of times a run of another Actor was [metamorphed](https://docs.apify.com/platform/actors/development/programming-interface/metamorph) into this Actor."
            },
            "totalRuns": {
              "type": "integer",
              "description": "The total number of runs of the Actor."
            },
            "totalUsers": {
              "type": "integer",
              "description": "The total number of Actor users, including its owner."
            },
            "totalUsers30Days": {
              "type": "integer",
              "description": "The number of active users of the Actor in the last 30 days."
            },
            "totalUsers7Days": {
              "type": "integer",
              "description": "The number of active users of the Actor in the last 7 days."
            },
            "totalUsers90Days": {
              "type": "integer",
              "description": "The number of active users of the Actor in the last 90 days."
            }
          }
        },
        "taggedBuilds": {
          "type": "object"
        },
        "title": {
          "type": [
            "string",
            "null"
          ],
          "description": "Human-readable name of the Actor, displayed in Apify Store and Console."
        },
        "userId": {
          "type": "string",
          "description": "The ID of the user who owns the Actor."
        },
        "username": {
          "type": "string",
          "description": "The username of the Actor owner."
        },
        "versions": {
          "type": "array",
          "description": "An array of `Version` objects. Each object represents a specific version of the Actor's source code: its location, builds, and environment configuration.",
          "items": {
            "type": "object",
            "required": [
              "versionNumber",
              "sourceType"
            ],
            "properties": {
              "applyEnvVarsToBuild": {
                "type": [
                  "boolean",
                  "null"
                ],
                "description": "Whether to inject the environment variables at build time."
              },
              "buildTag": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The tag name to apply to a successful build of this version. Can be `null` when the version has no build tag."
              },
              "envVars": {
                "description": "Environment variables for the version.",
                "type": "object"
              },
              "gitHubGistUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`."
              },
              "gitRepoUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`."
              },
              "sourceFiles": {
                "type": "array",
                "description": "Applies when the `sourceType` is `SOURCE_FILES`. Represents the Actor's file structure as an array of files and folders.",
                "items": {
                  "type": "object"
                }
              },
              "sourceType": {
                "description": "Where the source code of the version lives.",
                "type": "object"
              },
              "tarballUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "URL to download the source code from as a tarball or ZIP file. Applies when the `sourceType` is `TARBALL`."
              },
              "versionNumber": {
                "type": "string",
                "description": "The version number of the Actor. Two numbers separated by a dot, that represent the `MAJOR.MINOR` part of the semantic versioning."
              }
            }
          }
        }
      }
    }
  }
}