{ "openapi": "3.0.1", "info": { "title": "LLM Output Guard | JSON Schema Validation for Agent Output", "description": "Check that your model's JSON matches the schema you asked for. Every failure comes back with its path, the keyword it broke, and the repair that would fix it. Shape repairs are opt-in and never invent content, so a repair can never hide a real failure.", "version": "0.1", "x-build-id": "t2ob6cbbBvuvg8N5I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/broomwagon~llm-output-guard/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-broomwagon-llm-output-guard", "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/broomwagon~llm-output-guard/runs": { "post": { "operationId": "runs-sync-broomwagon-llm-output-guard", "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/broomwagon~llm-output-guard/run-sync": { "post": { "operationId": "run-sync-broomwagon-llm-output-guard", "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": [ "schema" ], "properties": { "schema": { "title": "JSON Schema", "type": "object", "description": "The shape the output is supposed to have. Standard JSON Schema: types, required, enums, patterns, formats, bounds, arrays, $ref, anyOf/oneOf/allOf. Keywords this actor cannot check are listed in the run report rather than silently ignored." }, "datasetId": { "title": "Output to check", "type": "string", "description": "A dataset of records produced by your model or agent. Pipe it straight in; a picked dataset always wins over the sample records below." }, "items": { "title": "Inline records", "type": "array", "description": "Records provided inline as a JSON array. Ignored when a dataset is picked above." }, "fileUrl": { "title": "File URL", "type": "string", "description": "URL of a JSON or NDJSON file of records to check." }, "payloadField": { "title": "Field holding the payload", "type": "string", "description": "If each record wraps the model's answer in a field, e.g. \"output\" or \"response\", name it here. Leave empty to validate the whole record." }, "repairShape": { "title": "Apply shape repairs", "type": "boolean", "description": "Off by default: the actor reports the repairs it would make but changes nothing. On, it fixes shape mistakes (a quoted number, a stringified object, a single value where a list belongs, a key in the wrong case) and re-validates. Repairs never invent content, and every one is listed in the row's coercions.", "default": false }, "maxErrorsPerRecord": { "title": "Errors kept per record", "minimum": 1, "type": "integer", "description": "A record that is entirely wrong can produce hundreds of errors. The row keeps this many and reports how many were left out; the totals are always complete.", "default": 20 } } }, "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 } } } } } } } } } }