# Actor Input Schema Preflight — Store Test Readiness (`vivid_astronaut/actor-input-schema-preflight`) Actor

Detect missing or invalid prefills that can break Apify automated Store tests before publishing.

- **URL**: https://apify.com/vivid\_astronaut/actor-input-schema-preflight.md
- **Developed by:** [BRAINIALL Team](https://apify.com/vivid_astronaut) (community)
- **Categories:** Developer tools, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $5.00 / 1,000 preflight reports

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Actor Input Schema Preflight — Store Test Readiness

Check an Apify Actor input schema before publishing. The report focuses on a
specific failure mode that can put an otherwise working Actor under maintenance:
required fields that Apify's automated Store test cannot populate from
`prefill` values.

### What it checks

- the input-schema root and property map;
- required fields that are missing from `properties`;
- missing required-field `prefill` values;
- prefill type and enum mismatches;
- optional `actor.json` `exampleRunInput.body` coverage;
- deterministic test input generated from valid prefills.

The Actor returns one bounded report. It does **not** read your Actor source,
token, environment variables, datasets, logs, or private Store configuration.
Do not paste credentials or real customer data into either JSON field.

### Quick start

```json
{
  "inputSchemaText": "{\"title\":\"Example input\",\"type\":\"object\",\"schemaVersion\":1,\"required\":[\"url\"],\"properties\":{\"url\":{\"type\":\"string\",\"prefill\":\"https://example.com\"}}}"
}
```

### Interpreting the report

- `FAIL` means a static schema defect can prevent deterministic automated-test input.
- `REVIEW` means static checks passed but runtime success still needs proof.
- `automatedTestReady` covers only the statically testable input contract.

Apify's runtime test remains the authority: run `recommendedTestInput`, require
status `SUCCEEDED`, a non-empty default dataset, and completion within five
minutes. This Actor cannot prove runtime output, proxy behavior, upstream
availability, permissions, pricing, or final Store quality score.

### Pricing

The configured Store price is **US$0.005 per report**. Apify may also show a
platform start charge. Always check the live Pricing tab before running.

### Privacy and security

- Input is parsed in memory and is not logged.
- Unknown top-level fields and oversized JSON are rejected.
- Findings contain field names, not pasted schema values.
- No network request is made by the preflight logic.
- The dataset contains only the report, generated test input, attribution label,
  and evaluation timestamp.

### Support

Open an Actor issue with the run ID and finding codes. Do not include an Apify
token, secret schema values, private datasets, or customer records.

# Actor input Schema

## `inputSchemaText` (type: `string`):

Paste the complete .actor/input\_schema.json content. It is parsed in this run and is not logged.

## `actorJsonText` (type: `string`):

Optionally paste .actor/actor.json to check exampleRunInput consistency. Leave blank to validate only the input schema.

## `integrationSource` (type: `string`):

Optional attribution label; it does not identify a buyer or prove payment.

## Actor input object example

```json
{
  "inputSchemaText": "{\"title\":\"Example input\",\"type\":\"object\",\"schemaVersion\":1,\"required\":[\"url\"],\"properties\":{\"url\":{\"type\":\"string\",\"prefill\":\"https://example.com\"}}}",
  "actorJsonText": "",
  "integrationSource": "apify-store"
}
```

# Actor output Schema

## `report` (type: `string`):

Dataset item containing static Store-test readiness checks, generated test input, and bounded findings.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "inputSchemaText": "{\"title\":\"Example input\",\"type\":\"object\",\"schemaVersion\":1,\"required\":[\"url\"],\"properties\":{\"url\":{\"type\":\"string\",\"prefill\":\"https://example.com\"}}}"
};

// Run the Actor and wait for it to finish
const run = await client.actor("vivid_astronaut/actor-input-schema-preflight").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "inputSchemaText": "{\"title\":\"Example input\",\"type\":\"object\",\"schemaVersion\":1,\"required\":[\"url\"],\"properties\":{\"url\":{\"type\":\"string\",\"prefill\":\"https://example.com\"}}}" }

# Run the Actor and wait for it to finish
run = client.actor("vivid_astronaut/actor-input-schema-preflight").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "inputSchemaText": "{\\"title\\":\\"Example input\\",\\"type\\":\\"object\\",\\"schemaVersion\\":1,\\"required\\":[\\"url\\"],\\"properties\\":{\\"url\\":{\\"type\\":\\"string\\",\\"prefill\\":\\"https://example.com\\"}}}"
}' |
apify call vivid_astronaut/actor-input-schema-preflight --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=vivid_astronaut/actor-input-schema-preflight",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/X5eaw05q0x7F6R5vU/builds/yr3qzPZHfjaFuE22E/openapi.json