antigravity-skills-reference/web-app/public/skills/apify-actor-development/references/output-schema.md

Output Schema Reference

The Actor output schema builds upon the schemas for the dataset and key-value store. It specifies where an Actor stores its output and defines templates for accessing that output. Apify Console uses these output definitions to display run results.

Structure

{
    "actorOutputSchemaVersion": 1,
    "title": "<OUTPUT-SCHEMA-TITLE>",
    "properties": {
        /* define your outputs here */
    }
}

Example

{
    "actorOutputSchemaVersion": 1,
    "title": "Output schema of the files scraper",
    "properties": {
        "files": {
            "type": "string",
            "title": "Files",
            "template": "{{links.apiDefaultKeyValueStoreUrl}}/keys"
        },
        "dataset": {
            "type": "string",
            "title": "Dataset",
            "template": "{{links.apiDefaultDatasetUrl}}/items"
        }
    }
}

Output Schema Template Variables

• links (object) - Contains quick links to most commonly used URLs
• links.publicRunUrl (string) - Public run url in format https://console.apify.com/view/runs/:runId
• links.consoleRunUrl (string) - Console run url in format https://console.apify.com/actors/runs/:runId
• links.apiRunUrl (string) - API run url in format https://api.apify.com/v2/actor-runs/:runId
• links.apiDefaultDatasetUrl (string) - API url of default dataset in format https://api.apify.com/v2/datasets/:defaultDatasetId
• links.apiDefaultKeyValueStoreUrl (string) - API url of default key-value store in format https://api.apify.com/v2/key-value-stores/:defaultKeyValueStoreId
• links.containerRunUrl (string) - URL of a webserver running inside the run in format https://<containerId>.runs.apify.net/
• run (object) - Contains information about the run same as it is returned from the GET Run API endpoint
• run.defaultDatasetId (string) - ID of the default dataset
• run.defaultKeyValueStoreId (string) - ID of the default key-value store