{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://www.monocrawl.com/schemas/utility/quickstart.json","title":"utility/quickstart data fields","description":"Required core structure for successful data, with optional source fields. Additional fields are allowed. This is not a completeness guarantee.","type":"object","properties":{"platform":{"type":["string","null"]},"endpoint":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"id"},"platform":{"type":["string","null"],"description":"platform"},"endpoint":{"type":["string","null"],"description":"endpoint"},"name":{"type":["string","null"],"description":"name"},"description":{"type":["string","null"],"description":"description"},"credit_cost":{"type":["number","null"]},"params":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"name"},"doc":{"type":["string","null"],"description":"doc"},"required":{"type":["boolean","null"]},"example":{"description":"Operation-specific JSON value; inspect the status and requested operation before reading it."}},"additionalProperties":true}},"recommended_params":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"name"},"reason":{"type":["string","null"],"description":"reason"},"cost_note":{"type":["string","null"],"description":"cost note"},"description":{"type":["string","null"],"description":"description"},"example":{"description":"Operation-specific JSON value; inspect the status and requested operation before reading it."},"allowed_values":{"type":["array","null"],"items":{"description":"Operation-specific JSON value; inspect the status and requested operation before reading it."}}},"additionalProperties":true}},"related_endpoints":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"id"},"name":{"type":["string","null"],"description":"name"},"reason":{"type":["string","null"],"description":"reason"},"method":{"type":["string","null"],"description":"method"},"documentation":{"type":["string","null"],"description":"documentation"},"credit_cost":{"type":["number","null"]},"production_available":{"type":["boolean","null"]}},"additionalProperties":true}},"live_proven":{"type":["boolean","null"],"description":"live proven"},"production_available":{"type":["boolean","null"],"description":"production available"}},"additionalProperties":true},"curl":{"type":["string","null"]},"expected_envelope":{"type":["object","null"],"properties":{},"additionalProperties":true},"auth":{"type":["object","null"],"properties":{"header":{"type":["string","null"],"description":"header"},"doc":{"type":["string","null"],"description":"doc"}},"additionalProperties":true}},"additionalProperties":true,"allOf":[{"anyOf":[{"required":["endpoint"],"properties":{"endpoint":{"type":["object"],"properties":{"id":{"type":["string","null"],"description":"id"},"platform":{"type":["string","null"],"description":"platform"},"endpoint":{"type":["string","null"],"description":"endpoint"},"name":{"type":["string","null"],"description":"name"},"description":{"type":["string","null"],"description":"description"},"credit_cost":{"type":["number","null"]},"params":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"name"},"doc":{"type":["string","null"],"description":"doc"},"required":{"type":["boolean","null"]},"example":{"description":"Operation-specific JSON value; inspect the status and requested operation before reading it."}},"additionalProperties":true}},"recommended_params":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"name"},"reason":{"type":["string","null"],"description":"reason"},"cost_note":{"type":["string","null"],"description":"cost note"},"description":{"type":["string","null"],"description":"description"},"example":{"description":"Operation-specific JSON value; inspect the status and requested operation before reading it."},"allowed_values":{"type":["array","null"],"items":{"description":"Operation-specific JSON value; inspect the status and requested operation before reading it."}}},"additionalProperties":true}},"related_endpoints":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"id"},"name":{"type":["string","null"],"description":"name"},"reason":{"type":["string","null"],"description":"reason"},"method":{"type":["string","null"],"description":"method"},"documentation":{"type":["string","null"],"description":"documentation"},"credit_cost":{"type":["number","null"]},"production_available":{"type":["boolean","null"]}},"additionalProperties":true}},"live_proven":{"type":["boolean","null"],"description":"live proven"},"production_available":{"type":["boolean","null"],"description":"production available"}},"additionalProperties":true}}},{"required":["curl"],"properties":{"curl":{"type":["string"],"minLength":1}}},{"required":["expected_envelope"],"properties":{"expected_envelope":{"type":["object"],"properties":{},"additionalProperties":true}}},{"required":["auth"],"properties":{"auth":{"type":["object"],"properties":{"header":{"type":["string","null"],"description":"header"},"doc":{"type":["string","null"],"description":"doc"}},"additionalProperties":true}}}]}],"x-contract-version":"2026-09-22","x-validation-scope":"Required success payload structure; optional fields and source completeness remain separate.","examples":[{"platform":null,"endpoint":{"id":null,"platform":null,"endpoint":null,"name":null,"description":null,"credit_cost":0,"params":[],"recommended_params":[],"related_endpoints":[],"live_proven":false,"production_available":false},"curl":null,"expected_envelope":{},"auth":{"header":null,"doc":null}}]}