RegLayer Instant Decision Briefs

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['order_id', 'access_token'], 'properties': {'order_id': {'type': 'string', 'pattern': '^agentcheck_[a-f0-9]{32}$'}, 'access_token': {'type': 'string', 'minLength': 32}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['pdf_url', 'authentication'], 'properties': {'ok': {'type': 'boolean', 'description': 'Whether the private status request succeeded.'}, 'error': {'type': 'string', 'description': 'A machine-readable error label when the request cannot be completed.'}, 'notice': {'type': 'string', 'description': 'The notice that must travel with RegLayer research outputs.'}, 'status': {'type': 'string', 'description': 'The current order state, such as researching, ready, or failed.'}, 'message': {'type': 'string', 'description': 'A human-readable status, authentication, or not-ready message.'}, 'pdf_url': {'type': 'string', 'format': 'uri', 'description': 'The authenticated endpoint for downloading the finished PDF.'}, 'product': {'type': 'string', 'description': 'The purchased Instant Brief product code.'}, 'brief_id': {'type': 'string', 'description': 'The Decision Brief identifier used in the finished artifact.'}, 'order_id': {'type': 'string', 'description': 'The private RegLayer order identifier.'}, 'reference': {'type': 'string', 'description': 'The customer-facing brief reference.'}, 'api_version': {'type': 'string', 'description': 'The version of the RegLayer agent delivery contract.'}, 'delivery_mode': {'type': 'string', 'description': 'The asynchronous delivery pattern used for this order.'}, 'authentication': {'type': 'string', 'description': 'The authorization header required to download the PDF.'}, 'poll_after_seconds': {'anyOf': [{'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, {'type': 'null'}], 'description': 'Seconds to wait before the next status check, or null when no further polling is needed.'}, 'connection_required': {'type': 'boolean', 'description': 'Whether the original connection must remain open.'}, 'delivery_instructions': {'type': 'string', 'description': 'Instructions for retrieving the result without relying on email.'}}, 'additionalProperties': {}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['order_id', 'access_token'], 'properties': {'order_id': {'type': 'string', 'pattern': '^agentcheck_[a-f0-9]{32}$'}, 'access_token': {'type': 'string', 'minLength': 32}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'ok': {'type': 'boolean', 'description': 'Whether the private status request succeeded.'}, 'error': {'type': 'string', 'description': 'A machine-readable error label when the request cannot be completed.'}, 'notice': {'type': 'string', 'description': 'The notice that must travel with RegLayer research outputs.'}, 'result': {'type': 'object', 'description': 'The complete structured Decision Brief when research is ready.', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}, 'status': {'type': 'string', 'description': 'The current order state, such as researching, ready, or failed.'}, 'message': {'type': 'string', 'description': 'A human-readable status, authentication, or not-ready message.'}, 'product': {'type': 'string', 'description': 'The purchased Instant Brief product code.'}, 'brief_id': {'type': 'string', 'description': 'The Decision Brief identifier used in the finished artifact.'}, 'order_id': {'type': 'string', 'description': 'The private RegLayer order identifier.'}, 'reference': {'type': 'string', 'description': 'The customer-facing brief reference.'}, 'api_version': {'type': 'string', 'description': 'The version of the RegLayer agent delivery contract.'}, 'result_kind': {'type': 'string', 'description': 'The type of structured artifact returned.'}, 'published_at': {'type': 'string', 'description': 'The timestamp when the result became available.'}, 'delivery_mode': {'type': 'string', 'description': 'The asynchronous delivery pattern used for this order.'}, 'result_version': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'The version of the stored structured result.'}, 'poll_after_seconds': {'anyOf': [{'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, {'type': 'null'}], 'description': 'Seconds to wait before the next status check, or null when no further polling is needed.'}, 'connection_required': {'type': 'boolean', 'description': 'Whether the original connection must remain open.'}, 'delivery_instructions': {'type': 'string', 'description': 'Instructions for retrieving the result without relying on email.'}}, 'additionalProperties': {}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['order_id', 'access_token'], 'properties': {'order_id': {'type': 'string', 'pattern': '^agentcheck_[a-f0-9]{32}$'}, 'access_token': {'type': 'string', 'minLength': 32}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'ok': {'type': 'boolean', 'description': 'Whether the private status request succeeded.'}, 'error': {'type': 'string', 'description': 'A machine-readable error label when the request cannot be completed.'}, 'notice': {'type': 'string', 'description': 'The notice that must travel with RegLayer research outputs.'}, 'status': {'type': 'string', 'description': 'The current order state, such as researching, ready, or failed.'}, 'message': {'type': 'string', 'description': 'A human-readable status, authentication, or not-ready message.'}, 'product': {'type': 'string', 'description': 'The purchased Instant Brief product code.'}, 'brief_id': {'type': 'string', 'description': 'The Decision Brief identifier used in the finished artifact.'}, 'order_id': {'type': 'string', 'description': 'The private RegLayer order identifier.'}, 'reference': {'type': 'string', 'description': 'The customer-facing brief reference.'}, 'api_version': {'type': 'string', 'description': 'The version of the RegLayer agent delivery contract.'}, 'delivery_mode': {'type': 'string', 'description': 'The asynchronous delivery pattern used for this order.'}, 'poll_after_seconds': {'anyOf': [{'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, {'type': 'null'}], 'description': 'Seconds to wait before the next status check, or null when no further polling is needed.'}, 'connection_required': {'type': 'boolean', 'description': 'Whether the original connection must remain open.'}, 'delivery_instructions': {'type': 'string', 'description': 'Instructions for retrieving the result without relying on email.'}}, 'additionalProperties': {}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['order_id', 'access_token'], 'properties': {'order_id': {'type': 'string', 'minLength': 8, 'description': 'The order_id returned by the paid Instant Brief purchase request.'}, 'access_token': {'type': 'string', 'minLength': 32, 'description': 'The private RegLayer access token returned with the order. Send it only to RegLayer and never expose it to the end user.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['pdf_url', 'authentication'], 'properties': {'ok': {'type': 'boolean', 'description': 'Whether the private status request succeeded.'}, 'error': {'type': 'string', 'description': 'A machine-readable error label when the request cannot be completed.'}, 'notice': {'type': 'string', 'description': 'The notice that must travel with RegLayer research outputs.'}, 'status': {'type': 'string', 'description': 'The current order state, such as researching, ready, or failed.'}, 'message': {'type': 'string', 'description': 'A human-readable status, authentication, or not-ready message.'}, 'pdf_url': {'type': 'string', 'format': 'uri', 'description': 'The authenticated endpoint for downloading the finished PDF.'}, 'product': {'type': 'string', 'description': 'The purchased Instant Brief product code.'}, 'brief_id': {'type': 'string', 'description': 'The Decision Brief identifier used in the finished artifact.'}, 'order_id': {'type': 'string', 'description': 'The private RegLayer order identifier.'}, 'reference': {'type': 'string', 'description': 'The customer-facing brief reference.'}, 'api_version': {'type': 'string', 'description': 'The version of the RegLayer agent delivery contract.'}, 'delivery_mode': {'type': 'string', 'description': 'The asynchronous delivery pattern used for this order.'}, 'authentication': {'type': 'string', 'description': 'The authorization header required to download the PDF.'}, 'poll_after_seconds': {'anyOf': [{'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, {'type': 'null'}], 'description': 'Seconds to wait before the next status check, or null when no further polling is needed.'}, 'connection_required': {'type': 'boolean', 'description': 'Whether the original connection must remain open.'}, 'delivery_instructions': {'type': 'string', 'description': 'Instructions for retrieving the result without relying on email.'}}, 'additionalProperties': {}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['order_id', 'access_token'], 'properties': {'order_id': {'type': 'string', 'minLength': 8, 'description': 'The order_id returned by the paid Instant Brief purchase request.'}, 'access_token': {'type': 'string', 'minLength': 32, 'description': 'The private RegLayer access token returned with the order. Send it only to RegLayer and never expose it to the end user.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'ok': {'type': 'boolean', 'description': 'Whether the private status request succeeded.'}, 'error': {'type': 'string', 'description': 'A machine-readable error label when the request cannot be completed.'}, 'notice': {'type': 'string', 'description': 'The notice that must travel with RegLayer research outputs.'}, 'result': {'type': 'object', 'description': 'The complete structured Decision Brief when research is ready.', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}, 'status': {'type': 'string', 'description': 'The current order state, such as researching, ready, or failed.'}, 'message': {'type': 'string', 'description': 'A human-readable status, authentication, or not-ready message.'}, 'product': {'type': 'string', 'description': 'The purchased Instant Brief product code.'}, 'brief_id': {'type': 'string', 'description': 'The Decision Brief identifier used in the finished artifact.'}, 'order_id': {'type': 'string', 'description': 'The private RegLayer order identifier.'}, 'reference': {'type': 'string', 'description': 'The customer-facing brief reference.'}, 'api_version': {'type': 'string', 'description': 'The version of the RegLayer agent delivery contract.'}, 'result_kind': {'type': 'string', 'description': 'The type of structured artifact returned.'}, 'published_at': {'type': 'string', 'description': 'The timestamp when the result became available.'}, 'delivery_mode': {'type': 'string', 'description': 'The asynchronous delivery pattern used for this order.'}, 'result_version': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'The version of the stored structured result.'}, 'poll_after_seconds': {'anyOf': [{'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, {'type': 'null'}], 'description': 'Seconds to wait before the next status check, or null when no further polling is needed.'}, 'connection_required': {'type': 'boolean', 'description': 'Whether the original connection must remain open.'}, 'delivery_instructions': {'type': 'string', 'description': 'Instructions for retrieving the result without relying on email.'}}, 'additionalProperties': {}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['order_id', 'access_token'], 'properties': {'order_id': {'type': 'string', 'minLength': 8, 'description': 'The order_id returned by the paid Instant Brief purchase request.'}, 'access_token': {'type': 'string', 'minLength': 32, 'description': 'The private RegLayer access token returned with the order. Send it only to RegLayer and never expose it to the end user.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'ok': {'type': 'boolean', 'description': 'Whether the private status request succeeded.'}, 'error': {'type': 'string', 'description': 'A machine-readable error label when the request cannot be completed.'}, 'notice': {'type': 'string', 'description': 'The notice that must travel with RegLayer research outputs.'}, 'status': {'type': 'string', 'description': 'The current order state, such as researching, ready, or failed.'}, 'message': {'type': 'string', 'description': 'A human-readable status, authentication, or not-ready message.'}, 'product': {'type': 'string', 'description': 'The purchased Instant Brief product code.'}, 'brief_id': {'type': 'string', 'description': 'The Decision Brief identifier used in the finished artifact.'}, 'order_id': {'type': 'string', 'description': 'The private RegLayer order identifier.'}, 'reference': {'type': 'string', 'description': 'The customer-facing brief reference.'}, 'api_version': {'type': 'string', 'description': 'The version of the RegLayer agent delivery contract.'}, 'delivery_mode': {'type': 'string', 'description': 'The asynchronous delivery pattern used for this order.'}, 'poll_after_seconds': {'anyOf': [{'type': 'integer', 'maximum': 9007199254740991, 'minimum': -9007199254740991}, {'type': 'null'}], 'description': 'Seconds to wait before the next status check, or null when no further polling is needed.'}, 'connection_required': {'type': 'boolean', 'description': 'Whether the original connection must remain open.'}, 'delivery_instructions': {'type': 'string', 'description': 'Instructions for retrieving the result without relying on email.'}}, 'additionalProperties': {}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['products', 'purchase_endpoint', 'payment_protocol', 'delivery_mode', 'connection_required', 'poll_after_seconds', 'delivery_instructions', 'notice'], 'properties': {'notice': {'type': 'string', 'description': 'The notice that must travel with RegLayer research outputs.'}, 'products': {'type': 'array', 'items': {'type': 'object', 'required': ['code', 'name', 'amount_cents', 'currency', 'min_jurisdictions', 'max_jurisdictions', 'delivery'], 'properties': {'code': {'type': 'string', 'const': 'instant_brief', 'description': 'The RegLayer Instant Brief product code.'}, 'name': {'type': 'string', 'description': 'The customer-facing name of the brief product.'}, 'currency': {'type': 'string', 'description': 'The lowercase ISO 4217 currency code used for payment.'}, 'delivery': {'type': 'string', 'description': 'How the finished brief is delivered and its normal completion window.'}, 'amount_cents': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0, 'description': 'The purchase price in the smallest currency unit, currently US cents.'}, 'max_jurisdictions': {'type': 'integer', 'maximum': 9007199254740991, 'description': 'The maximum number of distinct jurisdictions accepted for this product.', 'exclusiveMinimum': 0}, 'min_jurisdictions': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0, 'description': 'The minimum number of distinct jurisdictions accepted for this product.'}}, 'additionalProperties': False}, 'description': 'The Instant Brief products currently available to agents.'}, 'delivery_mode': {'type': 'string', 'const': 'asynchronous_polling', 'description': 'The delivery pattern used after payment.'}, 'payment_protocol': {'type': 'string', 'description': 'The machine-payment protocol used at the purchase endpoint.'}, 'purchase_endpoint': {'type': 'string', 'format': 'uri', 'description': 'The REST endpoint that accepts the paid brief request.'}, 'poll_after_seconds': {'type': 'integer', 'maximum': 9007199254740991, 'description': 'The recommended interval between private status checks.', 'exclusiveMinimum': 0}, 'connection_required': {'type': 'boolean', 'description': 'Whether the purchase connection must remain open while research runs.'}, 'delivery_instructions': {'type': 'string', 'description': 'Instructions for storing credentials, polling, and retrieving the finished brief.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['ok'], 'properties': {'ok': {'type': 'boolean'}}, 'additionalProperties': {}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['material_count', 'total_characters'], 'properties': {'material_count': {'type': 'integer', 'maximum': 2, 'minimum': 1}, 'total_characters': {'type': 'integer', 'maximum': 240000, 'minimum': 1, 'description': 'Combined readable-text character count after extracting the supplied materials.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['ok'], 'properties': {'ok': {'type': 'boolean'}}, 'additionalProperties': {}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['product', 'jurisdictions'], 'properties': {'product': {'type': 'string', 'const': 'instant_brief', 'description': 'The RegLayer Instant Brief product code.'}, 'jurisdictions': {'type': 'array', 'items': {'type': 'string', 'minLength': 1, 'description': 'A country, US state, or other regulatory geography to cover, written as a clear human-readable name.'}, 'maxItems': 3, 'minItems': 1, 'description': 'The distinct regulatory geographies the Decision Brief should cover.'}}}

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['valid', 'product', 'jurisdictions', 'price', 'error', 'endpoint', 'required_headers', 'required_body_fields', 'after_payment', 'notice'], 'properties': {'error': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'A scope correction message, or null when the request is valid.'}, 'price': {'type': 'object', 'required': ['code', 'name', 'amount_cents', 'currency', 'min_jurisdictions', 'max_jurisdictions', 'delivery'], 'properties': {'code': {'type': 'string', 'const': 'instant_brief', 'description': 'The RegLayer Instant Brief product code.'}, 'name': {'type': 'string', 'description': 'The customer-facing name of the brief product.'}, 'currency': {'type': 'string', 'description': 'The lowercase ISO 4217 currency code used for payment.'}, 'delivery': {'type': 'string', 'description': 'How the finished brief is delivered and its normal completion window.'}, 'amount_cents': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0, 'description': 'The purchase price in the smallest currency unit, currently US cents.'}, 'max_jurisdictions': {'type': 'integer', 'maximum': 9007199254740991, 'description': 'The maximum number of distinct jurisdictions accepted for this product.', 'exclusiveMinimum': 0}, 'min_jurisdictions': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0, 'description': 'The minimum number of distinct jurisdictions accepted for this product.'}}, 'description': 'The selected product, price, and geographic limits.', 'additionalProperties': False}, 'valid': {'type': 'boolean', 'description': 'Whether the selected product and jurisdictions form a valid purchasable scope.'}, 'notice': {'type': 'string', 'description': 'The notice that must travel with RegLayer research outputs.'}, 'product': {'type': 'string', 'const': 'instant_brief', 'description': 'The RegLayer Instant Brief product code.'}, 'endpoint': {'type': 'string', 'format': 'uri', 'description': 'The REST endpoint to call to create and pay for the brief.'}, 'after_payment': {'type': 'object', 'required': ['connection_required', 'poll_after_seconds', 'instruction'], 'properties': {'instruction': {'type': 'string', 'description': 'The complete asynchronous retrieval instructions for the agent.'}, 'poll_after_seconds': {'type': 'integer', 'maximum': 9007199254740991, 'description': 'How long the agent should wait between private status checks.', 'exclusiveMinimum': 0}, 'connection_required': {'type': 'boolean', 'description': 'Whether the agent must keep the original request connection open while research runs.'}}, 'description': 'What the agent must do after payment succeeds.', 'additionalProperties': False}, 'jurisdictions': {'type': 'array', 'items': {'type': 'string', 'minLength': 1, 'description': 'A country, US state, or other regulatory geography to cover, written as a clear human-readable name.'}, 'description': 'The normalized scope supplied for validation.'}, 'required_headers': {'type': 'object', 'required': ['Content-Type', 'Idempotency-Key'], 'properties': {'Content-Type': {'type': 'string', 'description': 'The required request content type.'}, 'Idempotency-Key': {'type': 'string', 'description': 'A unique stable value that makes purchase retries safe.'}}, 'description': 'HTTP headers required by the purchase endpoint.', 'additionalProperties': False}, 'required_body_fields': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Fields that must be present in the purchase request body.'}}, 'additionalProperties': False}