Skip to content

Commit 407ee76

Browse files
authored
docs(learnings): add /eval/simulation/* API endpoint reference (#13)
Appends a full API reference section to simulations.md covering all six controllers: simulation, scenario, personality, suite, run + run items, and AI scenario generation. Includes request/response shapes, query params, auth scopes, and validation rules grounded in the DTOs at libs/core/src/types/simulation.types/. Also fixes the stale POST /eval/simulation/suite/{suiteId}/run curl example — it's been replaced by the unified POST /eval/simulation/run with discriminated simulations[] entries.
1 parent 34bd9e9 commit 407ee76

2 files changed

Lines changed: 421 additions & 4 deletions

File tree

docs/learnings/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Gotchas and silent defaults for each resource type:
4141
| [assistants.md](assistants.md) | Model defaults, voice, transcriber, firstMessage, outbound modes, voicemailMessage, hooks, idle messages, endpointing, interruption, analysis, artifacts, background sound, server messages, HIPAA, tool resolution |
4242
| [squads.md](squads.md) | Name uniqueness, tools:append, assistantDestinations, handoff context, contextEngineeringPlan, VM detection relay pattern, override merge order |
4343
| [structured-outputs.md](structured-outputs.md) | Schema type gotchas, assistant_ids, default models, target modes, KPI patterns |
44-
| [simulations.md](simulations.md) | Personalities, evaluation comparators, chat-mode gotcha, missing references |
44+
| [simulations.md](simulations.md) | Personalities, evaluation comparators, chat-mode gotcha, missing references, full `/eval/simulation/*` API reference |
4545
| [webhooks.md](webhooks.md) | Default server messages, timeouts, unreachable servers, credential resolution, payload shape |
4646

4747
### Troubleshooting Runbooks

0 commit comments

Comments
 (0)