{ "openapi": "3.0.1", "info": { "title": "NOAA Essential Fish Habitat Consultation Screener", "description": "Screen U.S. project points, bounding boxes, and GeoJSON areas against NOAA EFH and HAPC layers; export species, life stages, councils, caveats, and official references for permitting triage.", "version": "0.1", "x-build-id": "6jG11p9f9wm4e8QI8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~noaa-essential-fish-habitat-consultation-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-noaa-essential-fish-habitat-consultation-screener", "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/automation-lab~noaa-essential-fish-habitat-consultation-screener/runs": { "post": { "operationId": "runs-sync-automation-lab-noaa-essential-fish-habitat-consultation-screener", "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/automation-lab~noaa-essential-fish-habitat-consultation-screener/run-sync": { "post": { "operationId": "run-sync-automation-lab-noaa-essential-fish-habitat-consultation-screener", "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": [ "projectAreas" ], "properties": { "projectAreas": { "title": "Project areas", "minItems": 1, "maxItems": 100, "type": "array", "description": "One to 100 project locations. Each item must contain exactly one geometry: point, bbox, or geoJson.", "items": { "type": "object", "properties": { "id": { "type": "string", "title": "Project ID", "description": "Optional stable ID copied to the result." }, "name": { "type": "string", "title": "Project name", "description": "Optional human-readable project name." }, "point": { "type": "object", "title": "Point", "description": "WGS84 point with longitude and latitude.", "properties": { "longitude": { "type": "number", "title": "Longitude", "description": "WGS84 longitude from -180 to 180.", "minimum": -180, "maximum": 180 }, "latitude": { "type": "number", "title": "Latitude", "description": "WGS84 latitude from -90 to 90.", "minimum": -90, "maximum": 90 } }, "required": [ "longitude", "latitude" ] }, "bbox": { "type": "array", "title": "Bounding box", "description": "WGS84 [west, south, east, north] bounds.", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, "geoJson": { "type": "object", "title": "GeoJSON area", "description": "WGS84 GeoJSON Polygon or MultiPolygon geometry (not a Feature wrapper).", "editor": "json" } } }, "default": [ { "id": "boston-harbor", "name": "Boston Harbor project point", "point": { "longitude": -71.05, "latitude": 42.35 } } ] }, "includeHapc": { "title": "Include Habitat Areas of Particular Concern", "type": "boolean", "description": "Also query NOAA's HAPC layer and include any intersecting priority habitat areas.", "default": true }, "maxMatchesPerLayer": { "title": "Maximum matches per layer", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Safety limit for EFH and HAPC features returned for each project area. Results report when this limit truncates a layer.", "default": 2000 } } }, "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 } } } } } } } } } }