Skip to main content

Parameters Reference Template

Parameter references document every input/output detail for one operation after the quickstart/onboarding journey. Keep them scannable: signature, tables, examples, exits.

❌ DO NOT COPY: Guidance & Constraints

  • Frontmatter requires title, description, icon. Titles should mirror the operation (“Add Memories Parameters”).
  • Place canonical Python and TypeScript signatures right under the heading using <CodeGroup>. Mention defaults or breaking changes in an <Info> or <Warning> immediately after.
  • Parameter table must include columns: Name, Type, Required, Description, Notes. Add a Managed/OSS distinction either as a column or in Notes.
  • When updating legacy parameter sheets, keep the authoritative field lists and notes. Reformat them into this structure rather than trimming details unless the schema changed.
  • Response table must include Field, Type, Description, Example. For nested objects, add subtables or <CodeGroup> JSON snippets beneath the row.
  • Examples section should show minimal Python and TypeScript calls with one-sentence explanations. If a language is missing, include a <Note> explaining why.
  • Finish with related operations, troubleshooting tied to parameter misuse, and a two-card CTA (operation guide on the left, cookbook/integration on the right).

✅ COPY THIS: Content Skeleton


✅ Publish Checklist

  • Python and TypeScript signatures match the current SDKs (or a <Note> explains missing parity).
  • Parameter and response tables cover every field with clear Managed vs OSS notes.
  • Examples execute the minimal happy path and include one-line explanations.
  • Troubleshooting entries correspond to parameter misuse or validation errors.
  • CTA pair links to the operation guide (left) and an applied example (right).

Browse Other Templates

Quickstart

Operation Guide

Feature Guide

Concept Guide

Integration Guide

Cookbook

API Reference

Parameters Reference

Migration Guide

Release Notes

Troubleshooting Playbook

Section Overview

Contribution Hub

Docs Home