FAQ Extractor to JSON-LD
Pricing
from $4.90 / 1,000 record processeds
Go to Apify Store
FAQ Extractor to JSON-LD
Extract FAQ questions/answers from pages or text and output clean rows plus JSON-LD-ready structured data.
FAQ Extractor to JSON-LD
Pricing
from $4.90 / 1,000 record processeds
Extract FAQ questions/answers from pages or text and output clean rows plus JSON-LD-ready structured data.
You can access the FAQ Extractor to JSON-LD programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "1.0", "x-build-id": "brLQd3CLvFEWIJRyI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~faq-extractor-to-jsonld/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-faq-extractor-to-jsonld", "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/junipr~faq-extractor-to-jsonld/runs": { "post": { "operationId": "runs-sync-junipr-faq-extractor-to-jsonld", "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/junipr~faq-extractor-to-jsonld/run-sync": { "post": { "operationId": "run-sync-junipr-faq-extractor-to-jsonld", "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": { "sourceId": { "title": "Source Id", "type": "string", "description": "Source Id input value.", "default": "github-copilot-ai-credits-faq" }, "sourceUrl": { "title": "Source Url", "type": "string", "description": "Source Url input value.", "default": "https://github.com/features/copilot/plans" }, "text": { "title": "Text", "type": "string", "description": "Text input value.", "default": "" }, "html": { "title": "Html", "type": "string", "description": "Html input value." }, "currentText": { "title": "Current Text", "type": "string", "description": "Current Text input value.", "default": "" }, "previousText": { "title": "Previous Text", "type": "string", "description": "Previous Text input value.", "default": "" }, "items": { "title": "Items", "type": "array", "description": "Items input value.", "items": { "type": "object", "additionalProperties": false, "properties": { "faqId": { "type": "string", "title": "Faq Id", "description": "Faq Id input value." }, "id": { "type": "string", "title": "Id", "description": "Id input value." }, "question": { "type": "string", "title": "Question", "description": "Question input value." }, "answer": { "type": "string", "title": "Answer", "description": "Answer input value." } } }, "default": [ { "faqId": "github-ai-credits-definition", "question": "What are GitHub AI Credits?", "answer": "GitHub AI Credits measure paid Copilot usage for chat, agent mode, code review, cloud agents, Copilot CLI, and related AI interactions." } ] }, "previousItems": { "title": "Previous Items", "type": "array", "description": "Previous Items input value.", "items": { "type": "object", "additionalProperties": false, "properties": { "faqId": { "type": "string", "title": "Faq Id", "description": "Faq Id input value." }, "id": { "type": "string", "title": "Id", "description": "Id input value." }, "question": { "type": "string", "title": "Question", "description": "Question input value." }, "answer": { "type": "string", "title": "Answer", "description": "Answer input value." } } } }, "topics": { "title": "Topics", "maxItems": 50, "type": "array", "description": "Topics input value.", "items": { "type": "string" } }, "expectedOptions": { "title": "Expected Options", "maxItems": 20, "type": "array", "description": "Expected Options input value.", "items": { "type": "string" } }, "targets": { "title": "Targets", "maxItems": 50, "type": "array", "description": "Targets input value.", "items": { "type": "object", "additionalProperties": false, "properties": { "sourceId": { "type": "string", "title": "Source Id", "description": "Source Id input value." }, "sourceUrl": { "type": "string", "title": "Source Url", "description": "Source Url input value." }, "text": { "type": "string", "title": "Text", "description": "Text input value." }, "html": { "type": "string", "title": "Html", "description": "Html input value." }, "currentText": { "type": "string", "title": "Current Text", "description": "Current Text input value." }, "previousText": { "type": "string", "title": "Previous Text", "description": "Previous Text input value." }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "faqId": { "type": "string", "title": "Faq Id", "description": "Faq Id input value." }, "id": { "type": "string", "title": "Id", "description": "Id input value." }, "question": { "type": "string", "title": "Question", "description": "Question input value." }, "answer": { "type": "string", "title": "Answer", "description": "Answer input value." } } }, "title": "Items", "description": "Items input value." }, "previousItems": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "faqId": { "type": "string", "title": "Faq Id", "description": "Faq Id input value." }, "id": { "type": "string", "title": "Id", "description": "Id input value." }, "question": { "type": "string", "title": "Question", "description": "Question input value." }, "answer": { "type": "string", "title": "Answer", "description": "Answer input value." } } }, "title": "Previous Items", "description": "Previous Items input value." }, "topics": { "type": "array", "items": { "type": "string" }, "maxItems": 50, "title": "Topics", "description": "Topics input value." }, "expectedOptions": { "type": "array", "items": { "type": "string" }, "maxItems": 20, "title": "Expected Options", "description": "Expected Options input value." } } } }, "urls": { "title": "Urls", "maxItems": 50, "type": "array", "description": "Urls input value.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 50, "type": "integer", "description": "Max Items input value.", "default": 1 }, "maxRecordsPerTarget": { "title": "Max Records Per Target", "minimum": 1, "maximum": 500, "type": "integer", "description": "Max Records Per Target input value.", "default": 5 }, "maxTextBytes": { "title": "Max Text Bytes", "minimum": 1000, "maximum": 1000000, "type": "integer", "description": "Max Text Bytes input value.", "default": 250000 }, "fetchTimeoutMs": { "title": "Fetch Timeout Ms", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "Fetch Timeout Ms input value.", "default": 15000 }, "allowUrlFetch": { "title": "Allow Url Fetch", "type": "boolean", "description": "Allow Url Fetch input value.", "default": false }, "includeDigest": { "title": "Include Digest", "type": "boolean", "description": "Include Digest input value.", "default": false }, "includeReport": { "title": "Include Report", "type": "boolean", "description": "Include Report input value.", "default": true }, "dryRun": { "title": "Dry Run", "type": "boolean", "description": "Dry Run input value.", "default": false }, "debug": { "title": "Debug", "type": "boolean", "description": "Debug input value.", "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for FAQ Extractor to JSON-LD from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: