# Actor<!-- -->

Represents an Actor in the Apify platform.

Actors are serverless computing units that can perform arbitrary tasks such as web scraping, data processing, automation, and more. Each Actor has versions, builds, and can be executed with different configurations.

## Index[**](#Index)

### Properties

* [**actorPermissionLevel](#actorPermissionLevel)
* [**actorStandby](#actorStandby)
* [**categories](#categories)
* [**createdAt](#createdAt)
* [**defaultRunOptions](#defaultRunOptions)
* [**deploymentKey](#deploymentKey)
* [**description](#description)
* [**exampleRunInput](#exampleRunInput)
* [**id](#id)
* [**isAnonymouslyRunnable](#isAnonymouslyRunnable)
* [**isDeprecated](#isDeprecated)
* [**isPublic](#isPublic)
* [**modifiedAt](#modifiedAt)
* [**name](#name)
* [**pricingInfos](#pricingInfos)
* [**readmeSummary](#readmeSummary)
* [**restartOnError](#restartOnError)
* [**seoDescription](#seoDescription)
* [**seoTitle](#seoTitle)
* [**stats](#stats)
* [**taggedBuilds](#taggedBuilds)
* [**title](#title)
* [**userId](#userId)
* [**username](#username)
* [**versions](#versions)

## Properties<!-- -->[**](#Properties)

### [**](#actorPermissionLevel)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L510)actorPermissionLevel

**actorPermissionLevel: ACTOR\_PERMISSION\_LEVEL

Permission level of the Actor on Apify platform

### [**](#actorStandby)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L506)optionalactorStandby

**actorStandby?

<!-- -->

: [ActorStandby](https://docs.apify.com/api/client/js/api/client/js/reference/interface/ActorStandby.md) & { isEnabled: boolean }

Standby mode configuration for keeping Actor warm and responsive

### [**](#categories)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L504)optionalcategories

**categories?

<!-- -->

: string\[]

Categories the Actor belongs to (e.g., 'ECOMMERCE', 'SCRAPING')

### [**](#createdAt)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L478)createdAt

**createdAt: Date

Timestamp when the Actor was created

### [**](#defaultRunOptions)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L488)defaultRunOptions

**defaultRunOptions: [ActorDefaultRunOptions](https://docs.apify.com/api/client/js/api/client/js/reference/interface/ActorDefaultRunOptions.md)

Default configuration options for Actor runs

### [**](#deploymentKey)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L494)deploymentKey

**deploymentKey: string

Deployment key used for automated deployments

### [**](#description)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L470)optionaldescription

**description?

<!-- -->

: string

Detailed description of what the Actor does

### [**](#exampleRunInput)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L490)optionalexampleRunInput

**exampleRunInput?

<!-- -->

: [ActorExampleRunInput](https://docs.apify.com/api/client/js/api/client/js/reference/interface/ActorExampleRunInput.md)

Example input to help users understand how to use the Actor

### [**](#id)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L462)id

**id: string

Unique Actor ID

### [**](#isAnonymouslyRunnable)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L476)optionalisAnonymouslyRunnable

**isAnonymouslyRunnable?

<!-- -->

: boolean

Whether the Actor can be run by anonymous users without authentication

### [**](#isDeprecated)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L492)optionalisDeprecated

**isDeprecated?

<!-- -->

: boolean

Whether the Actor is deprecated and should not be used

### [**](#isPublic)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L474)isPublic

**isPublic: boolean

Whether the Actor is publicly available in Apify Store

### [**](#modifiedAt)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L480)modifiedAt

**modifiedAt: Date

Timestamp when the Actor was last modified

### [**](#name)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L466)name

**name: string

Unique name of the Actor (used in API paths, e.g., 'my-actor')

### [**](#pricingInfos)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L486)optionalpricingInfos

**pricingInfos?

<!-- -->

: [ActorRunPricingInfo](https://docs.apify.com/api/client/js/api/client/js/reference.md#ActorRunPricingInfo)\[]

Pricing information for pay-per-result or pay-per-event Actors

### [**](#readmeSummary)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L512)optionalreadmeSummary

**readmeSummary?

<!-- -->

: string

A brief, LLM-generated readme summary

### [**](#restartOnError)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L472)optionalrestartOnError

**restartOnError?

<!-- -->

: boolean

* **@deprecated**

  Use defaultRunOptions.restartOnError instead

### [**](#seoDescription)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L502)optionalseoDescription

**seoDescription?

<!-- -->

: string

SEO-optimized description for the Actor's public page

### [**](#seoTitle)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L500)optionalseoTitle

**seoTitle?

<!-- -->

: string

SEO-optimized title for the Actor's public page

### [**](#stats)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L482)stats

**stats: [ActorStats](https://docs.apify.com/api/client/js/api/client/js/reference/interface/ActorStats.md)

Usage and run statistics for the Actor

### [**](#taggedBuilds)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L498)optionaltaggedBuilds

**taggedBuilds?

<!-- -->

: [ActorTaggedBuilds](https://docs.apify.com/api/client/js/api/client/js/reference.md#ActorTaggedBuilds)

Mapping of tags to specific builds (e.g., 'latest', 'beta')

### [**](#title)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L496)optionaltitle

**title?

<!-- -->

: string

Human-readable title of the Actor (displayed in UI)

### [**](#userId)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L464)userId

**userId: string

ID of the user who owns the Actor

### [**](#username)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L468)username

**username: string

Username of the Actor's owner

### [**](#versions)[**](https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L484)versions

**versions: [ActorVersion](https://docs.apify.com/api/client/js/api/client/js/reference.md#ActorVersion)\[]

All versions of this Actor