{ "openapi": "3.0.1", "info": { "title": "Instagram Dm Automation", "description": "Instagram Dm Automation sends personalized direct messages at scale to targeted Instagram users. Manage outreach, replies, and message sequences with precision. Ideal for marketing, lead generation, influencer outreach, and workflows needing automated Instagram DM actions.", "version": "0.1", "x-build-id": "8EwWPhtcbAubrEOa6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-empire~instagram-dm-automation/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-empire-instagram-dm-automation", "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/api-empire~instagram-dm-automation/runs": { "post": { "operationId": "runs-sync-api-empire-instagram-dm-automation", "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/api-empire~instagram-dm-automation/run-sync": { "post": { "operationId": "run-sync-api-empire-instagram-dm-automation", "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": [ "startUrls", "message", "sessionId" ], "properties": { "startUrls": { "title": "🎯πŸ‘₯ Target Users & Sources", "type": "array", "description": "πŸ“‹ Add one or more Instagram targets to message:\n\nβœ… πŸ”— Profile URLs: https://www.instagram.com/username\nβœ… πŸ‘€ Usernames: username or @username\nβœ… πŸ” Keywords: fitness, travel, photography\nβœ… #️⃣ Hashtags: #fitness, #travel, #photography\n\nπŸ€– Keywords and hashtags are auto-searched on Instagram to discover relevant profiles.\nπŸ“¦ Bulk input is supported for outreach campaigns.\n✨ Mix and match target types in one run.", "items": { "type": "string" } }, "message": { "title": "πŸ’¬πŸ“ DM Message Template", "type": "string", "description": "πŸ“ Write the message to send to each target user.\n\nπŸ’‘ Best practices:\n✨ Keep it short and friendly\n🎯 Make it relevant to the profile\nπŸ™Œ Avoid spammy wording\n\nπŸ“¨ This template is reused for all discovered users in this run.", "default": "Hey! Just wanted to reach out." }, "sessionId": { "title": "πŸ”πŸ”‘ Instagram Session ID Cookie", "type": "string", "description": "πŸ” Your Instagram `sessionid` cookie value is required for authentication.\n\nπŸ“– How to find it:\n1️⃣ Log in to Instagram in your browser\n2️⃣ Open Developer Tools (F12)\n3️⃣ Go to Application/Storage β†’ Cookies β†’ instagram.com\n4️⃣ Copy the value of `sessionid`\n\n⚠️ Keep this private and secure.\nπŸ›‘οΈ This value grants account access like a password." }, "maxUsers": { "title": "πŸ“ŠπŸŽ›οΈ Maximum Users to Process", "minimum": 0, "maximum": 10000, "type": "integer", "description": "🎯 Set how many users should be processed in this run (0-10,000).\n\nπŸ“¨ This controls how many users can receive your DM.\n♾️ Use `0` to remove the limit and process all discovered users.", "default": 10 }, "proxyConfiguration": { "title": "πŸŒπŸ›‘οΈ Proxy Configuration", "type": "object", "description": "πŸ”’ Configure proxy preferences to reduce rate limits and IP blocks.\n\nπŸ’‘ Recommendations:\nβœ… Use Apify Proxy for easy rotation\nβœ… Residential proxies for stronger deliverability\nβœ… Datacenter proxies for speed and lower cost\n\n⚠️ The actor uses exactly the proxy setup you provide.\nπŸ§ͺ Make sure credentials, groups, and connectivity are valid." } } }, "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 } } } } } } } } } }