67 lines
2.3 KiB
Markdown
67 lines
2.3 KiB
Markdown
# Actor Configuration (actor.json)
|
|
|
|
The `.actor/actor.json` file contains the Actor's configuration including metadata, schema references, and platform settings.
|
|
|
|
## Structure
|
|
|
|
```json
|
|
{
|
|
"actorSpecification": 1,
|
|
"name": "project-name",
|
|
"title": "Project Title",
|
|
"description": "Actor description",
|
|
"version": "0.0",
|
|
"meta": {
|
|
"templateId": "template-id",
|
|
"generatedBy": "<FILL-IN-TOOL-AND-MODEL>"
|
|
},
|
|
"input": "./input_schema.json",
|
|
"output": "./output_schema.json",
|
|
"storages": {
|
|
"dataset": "./dataset_schema.json"
|
|
},
|
|
"dockerfile": "../Dockerfile"
|
|
}
|
|
```
|
|
|
|
## Example
|
|
|
|
```json
|
|
{
|
|
"actorSpecification": 1,
|
|
"name": "project-cheerio-crawler-javascript",
|
|
"title": "Project Cheerio Crawler Javascript",
|
|
"description": "Crawlee and Cheerio project in javascript.",
|
|
"version": "0.0",
|
|
"meta": {
|
|
"templateId": "js-crawlee-cheerio",
|
|
"generatedBy": "Claude Code with Claude Sonnet 4.5"
|
|
},
|
|
"input": "./input_schema.json",
|
|
"output": "./output_schema.json",
|
|
"storages": {
|
|
"dataset": "./dataset_schema.json"
|
|
},
|
|
"dockerfile": "../Dockerfile"
|
|
}
|
|
```
|
|
|
|
## Properties
|
|
|
|
- `actorSpecification` (integer, required) - Version of actor specification (currently 1)
|
|
- `name` (string, required) - Actor identifier (lowercase, hyphens allowed)
|
|
- `title` (string, required) - Human-readable title displayed in UI
|
|
- `description` (string, optional) - Actor description for marketplace
|
|
- `version` (string, required) - Semantic version number
|
|
- `meta` (object, optional) - Metadata about actor generation
|
|
- `templateId` (string) - ID of template used to create the actor
|
|
- `generatedBy` (string) - Tool and model name that generated/modified the actor (e.g., "Claude Code with Claude Sonnet 4.5")
|
|
- `input` (string, optional) - Path to input schema file
|
|
- `output` (string, optional) - Path to output schema file
|
|
- `storages` (object, optional) - Storage schema references
|
|
- `dataset` (string) - Path to dataset schema file
|
|
- `keyValueStore` (string) - Path to key-value store schema file
|
|
- `dockerfile` (string, optional) - Path to Dockerfile
|
|
|
|
**Important:** Always fill in the `generatedBy` property with the tool and model you're currently using (e.g., "Claude Code with Claude Sonnet 4.5") to help Apify improve documentation.
|