# TRADING4AI Quant Lab Public Examples

This directory contains public Quant Lab examples for request creation, request status polling, and budget confirmation.

These files are examples only. They do not create real jobs, approve real budgets, or unlock private delivery.

## Primary Entry Points

- Category HTML landing: https://trading4ai.com/samples/quant-lab
- Category raw landing: https://trading4ai.com/examples/quant-lab
- Category JSON catalog: https://trading4ai.com/examples/quant-lab/index.json
- Category Markdown guide: https://trading4ai.com/examples/quant-lab/README.md
- Top-level JSON catalog: https://trading4ai.com/examples/index.json
- Top-level Markdown guide: https://trading4ai.com/examples/README.md
- Machine bridge: https://trading4ai.com/llms

## Files

- `/samples`
- `/examples`
- `/examples/README.md`
- `/samples/quant-lab`
- `/examples/quant-lab`
- `/examples/quant-lab/index.json`
- `/examples/quant-lab/README.md`
- `/examples/quant-lab/request-create.json`
- `/examples/quant-lab/request-status.json`
- `/examples/quant-lab/budget-confirm.json`
- `/examples/index.json`
- `/llms.txt`
- `/llms`
- `/.well-known/agent.json`
- `/for-agents`
- `/openapi.json`

## Recommended Flow

1. Start with `/samples` when you want the top-level HTML public sample hub.
2. Read `/examples` when you want the top-level raw example hub and shared machine entry points.
3. Read the HTML overview at `/samples/quant-lab`.
4. Read `/examples/quant-lab` when you want the raw category landing page with discovery guidance.
5. Inspect `/samples/quant-lab/request-create` to understand intake shape.
6. Inspect `/samples/quant-lab/request-status` to understand `request_urls`, `next_actions`, and `execution_outcome`.
7. Inspect `/samples/quant-lab/budget-confirm` to understand budget approval.
8. Fetch `/examples/quant-lab/index.json` if you need the category-level machine-readable catalog.
9. Fetch `/examples/index.json` if you need the full public sample catalog.

## Which Entry Should You Start With?

- Crawler or search engine: start with `/samples/quant-lab` because it provides crawlable HTML, internal links, and structured data.
- LLM or agent needing compact discovery: start with `/examples/quant-lab/index.json` because it gives the category-level machine catalog without parsing HTML.
- LLM needing plain text context: start with `/examples/quant-lab/README.md` because it is the compact Markdown guide for this category.
- Agent runtime or tool caller: start with `/.well-known/agent.json`, then use `/for-agents` and `/openapi.json` before choosing the specific request or status sample.

## Important Fields

- `template_id`: selects the constrained Quant Lab workflow.
- `template_parameters`: schema-bound parameters for the selected workflow.
- `request_token`: follow-up token for status or budget actions.
- `request_urls`: direct follow-up links that a machine can use.
- `next_actions`: machine hint for whether clarification, budget confirmation, or payment is required.
- `execution_outcome`: normalized result once execution produces a conclusion.

## Boundary

These examples show public payload shape and state transitions. Real requests may require live API calls, budget approval, payment, and entitlement checks before private delivery is available.

Use `/llms` for bridge-page orientation, `/llms.txt` for compact plain-text discovery, `/.well-known/agent.json` for agent entry-point discovery, `/for-agents` for integration guidance, `/examples/quant-lab/index.json` for compact category discovery, and `/openapi.json` as the canonical contract.