Generate draft rounds
Generate draft rounds
Required scopes: interview_plans:write
Writes return data.audit with audit/event ids. Successful write events and audit rows include the resource type, public draft id, action key, request context, livemode partition, and a redacted payload summary. Use Idempotency-Key on retries; replayed requests return the cached response and do not duplicate draft checkpoints, audit rows, or events.
Example (curl):
curl -X POST https://api.yardstick.team/v1/interview_plan_drafts/actions/generate_rounds \
-H 'Authorization: Bearer ys_sk_live_…' \
-H 'Content-Type: application/json' \
-d '{"action":"interview_plan.generate_rounds","resource":{"type":"interview_plan_draft","id":"ipd_…"},"input":{}}'
Example (TypeScript):
await fetch("https://api.yardstick.team/v1/interview_plan_drafts/actions/generate_rounds", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.YS_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
action: "interview_plan.generate_rounds",
resource: { type: "interview_plan_draft", id: "ipd_…" },
input: {},
}),
});
Request
- Base URL: https://api.yardstick.team
- URL: https://api.yardstick.team/v1/interview_plan_drafts/actions/generate_rounds
- Auth: HTTP bearer
Headers
Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.
Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.
Request body
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.