{ "openapi": "3.0.1", "info": { "title": "Docs to Pinecone Sync", "description": "Keep public HTML documentation in sync with Pinecone. Detect changed pages, embed updated content using your OpenAI key, and update a dedicated Pinecone namespace. Unchanged pages are skipped.", "version": "0.0", "x-build-id": "pRLrzhh31tgRQN1P0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/human_intelligence~docs-to-pinecone-sync/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-human_intelligence-docs-to-pinecone-sync", "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/human_intelligence~docs-to-pinecone-sync/runs": { "post": { "operationId": "runs-sync-human_intelligence-docs-to-pinecone-sync", "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/human_intelligence~docs-to-pinecone-sync/run-sync": { "post": { "operationId": "run-sync-human_intelligence-docs-to-pinecone-sync", "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", "properties": { "mode": { "title": "Mode", "enum": [ "preview", "sync", "demo" ], "type": "string", "description": "Preview checks sources without embedding or external writes. Sync uses your keys. Demo is offline.", "default": "preview" }, "monitorName": { "title": "Monitor name", "pattern": "^[a-z0-9][a-z0-9-]{0,39}$", "type": "string", "description": "Reuse this name and Actor for subsequent runs; source settings and target are bound to it.", "default": "my-docs" }, "urls": { "title": "Documentation URLs", "maxItems": 100, "type": "array", "description": "Exact URLs on one host without query parameters. Provide this OR sitemapUrl.", "items": { "type": "string" } }, "sitemapUrl": { "title": "Simple XML sitemap URL", "type": "string", "description": "A single urlset sitemap on the same host as the pages. Sitemap indexes are unsupported." }, "pathPrefix": { "title": "Path prefix", "type": "string", "description": "For example /docs/. At most 100 active sources after filtering.", "default": "/" }, "contentSelector": { "title": "Main content CSS selector", "type": "string", "description": "Optional. Otherwise main, role=main, article, then body. Missing selectors are errors." }, "pineconeIndex": { "title": "Pinecone index name", "type": "string", "description": "Sync: existing serverless dense-vector index, dimension 1536, no integrated embedding." }, "pineconeNamespace": { "title": "Dedicated Pinecone namespace", "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string", "description": "Sync: an empty namespace exclusively managed by this monitor. Do not use a shared or default namespace." }, "pineconeApiKey": { "title": "Pinecone API key", "type": "string", "description": "Your own key, sent only to Pinecone and the verified index host." }, "openaiApiKey": { "title": "OpenAI API key", "type": "string", "description": "Your own API key for text-embedding-3-small. External usage is billed by OpenAI." }, "maxPages": { "title": "Maximum checks per run", "minimum": 1, "maximum": 100, "type": "integer", "description": "Unchecked sources stay intact and are prioritized on later runs.", "default": 100 }, "maxEmbeddingTokens": { "title": "Embedding token budget", "minimum": 1000, "maximum": 250000, "type": "integer", "description": "Includes retries initiated by this Actor, not other use of your account.", "default": 100000 }, "maxRunSeconds": { "title": "Time budget (seconds)", "minimum": 30, "maximum": 600, "type": "integer", "description": "Stops new work and preserves unfinished operations.", "default": 600 }, "requestDelaySeconds": { "title": "Minimum source request interval", "minimum": 0.5, "maximum": 10, "type": "number", "description": "Longer robots.txt limits take precedence.", "default": 0.5 }, "approveDeletionPlan": { "title": "Approve a specific large deletion plan", "type": "string", "description": "Normally empty. Paste SUMMARY deletionPlan only after reviewing the listed URLs." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }