{ "openapi": "3.0.1", "info": { "title": "Brazil ESG Supply-Chain Monitor — Slave Labor + IBAMA by CNPJ", "description": "ESG supply-chain risk monitor by Brazilian CNPJ with change detection between runs.", "version": "1.0", "x-build-id": "Ob11DsQx7qynW87Wx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/paulovitor18~brazil-esg-supply-chain-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-paulovitor18-brazil-esg-supply-chain-monitor", "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/paulovitor18~brazil-esg-supply-chain-monitor/runs": { "post": { "operationId": "runs-sync-paulovitor18-brazil-esg-supply-chain-monitor", "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/paulovitor18~brazil-esg-supply-chain-monitor/run-sync": { "post": { "operationId": "run-sync-paulovitor18-brazil-esg-supply-chain-monitor", "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": [ "watchCnpjs" ], "properties": { "watchCnpjs": { "title": "CNPJs/CPFs to watch", "type": "array", "description": "List of Brazilian company tax ids (CNPJ) or individual ids (CPF) of the suppliers/companies to monitor. Accepts formatted or digits-only. Matching is ALWAYS by document, never by name — never attaches a homonymous company.", "default": [ "03.246.366/0001-33", "10.199.645/0001-59" ], "items": { "type": "string" } }, "mode": { "title": "Run mode", "enum": [ "auto", "baseline" ], "type": "string", "description": "auto = first run is the baseline, following runs report only the delta. baseline = force re-emit the full state and rewrite the baseline.", "default": "auto" }, "includeDirtyList": { "title": "Include Dirty List (slave labor / MTE)", "type": "boolean", "description": "Check the Employers Registry (Dirty List) of the Brazilian Ministry of Labor and Employment.", "default": true }, "includeIbama": { "title": "Include IBAMA (environmental infractions + embargoes)", "type": "boolean", "description": "Scan IBAMA environmental infraction records (open data) and flag linked embargo terms. Downloads ~120 MB per run.", "default": true }, "matchByRoot": { "title": "Also match by CNPJ root (8 digits)", "type": "boolean", "description": "Besides the full CNPJ, match IBAMA infractions by the 8-digit root (economic group / other branches of the same parent). Risk is often a group-level phenomenon.", "default": false }, "stateStoreName": { "title": "State store name (delta)", "type": "string", "description": "Named key-value store where the baseline is kept between runs. Use a distinct name per watchlist/schedule to isolate each monitor's delta history. Keep the same name across the recurring runs of the same monitor.", "default": "brazil-esg-state" }, "debugForceListaFail": { "title": "(internal) force Dirty List source failure", "type": "boolean", "description": "Internal testing only: simulates gov.br + Wayback outage to exercise the cache fallback. Do not use in production.", "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 } } } } } } } } } }