{ "openapi": "3.0.1", "info": { "title": "Jsonplaceholder Api", "description": "The JSONPlaceholder API data extraction actor automates the retrieval and structuring of sample data from the popular JSONPlaceholder REST API service, widely used for testing and development purposes.", "version": "0.1", "x-build-id": "nLVIgx8JTcgWmcFag" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aluminum_jam~jsonplaceholder-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aluminum_jam-jsonplaceholder-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/aluminum_jam~jsonplaceholder-api/runs": { "post": { "operationId": "runs-sync-aluminum_jam-jsonplaceholder-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/aluminum_jam~jsonplaceholder-api/run-sync": { "post": { "operationId": "run-sync-aluminum_jam-jsonplaceholder-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "endpoints" ], "properties": { "endpoints": { "title": "Endpoints to Extract", "uniqueItems": true, "type": "array", "description": "Select which JSONPlaceholder endpoints to extract data from. Each endpoint provides different types of sample data:\n- **Posts** - Blog posts with titles and body content (100 items)\n- **Comments** - User comments on posts (500 items)\n- **Albums** - Photo albums (100 items)\n- **Photos** - Individual photos with URLs (5000 items)\n- **Todos** - Task items with completion status (200 items)\n- **Users** - Complete user profiles (10 items)", "items": { "type": "string", "enum": [ "posts", "comments", "albums", "photos", "todos", "users" ] }, "default": [ "posts", "comments", "albums", "photos", "todos", "users" ] }, "filterByUserId": { "title": "Filter by User ID", "minimum": 1, "maximum": 10, "type": "integer", "description": "Filter data for a specific user ID (1-10). When set, only data belonging to this user will be extracted. Leave empty to get all users' data.\n\n**Example**: Set to `1` to get all posts, comments, and todos created by user 1." }, "maxItemsPerEndpoint": { "title": "Max Items Per Endpoint", "minimum": 0, "type": "integer", "description": "Maximum number of items to retrieve per endpoint. Set to `0` for unlimited items.\n\n**Recommended values**:\n- **Testing**: 5-10 items\n- **Development**: 20-50 items\n- **Full dataset**: 0 (unlimited)", "default": 0 }, "includeDataValidation": { "title": "Enable Data Validation", "type": "boolean", "description": "Validate and clean extracted data for consistency. This includes:\n- Trimming whitespace from strings\n- Validating email formats in comments\n- Normalizing data types (numbers, booleans)\n- Ensuring required fields exist\n\n**Recommended**: Keep enabled for production use.", "default": true }, "includeMetadata": { "title": "Add Metadata Fields", "type": "boolean", "description": "Add metadata to each extracted item including:\n- `extractedAt` - ISO timestamp of extraction\n- `dataType` - Type of endpoint (posts, comments, etc.)\n- `source` - Source API domain\n\n**Use case**: Useful for tracking when data was extracted and from which endpoint.", "default": false }, "combineResults": { "title": "Combine All Results", "type": "boolean", "description": "Combine all endpoint results into a single dataset with a `type` field indicating the data source.\n\n- **Enabled**: All data in one dataset with `type` field (posts, comments, etc.)\n- **Disabled**: Separate datasets/records per endpoint\n\n**Use case**: Enable for unified data analysis, disable for organized separate files.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }