{
  "repository": "https://github.com/user-intuition/examples",
  "runtime": "Node.js >=22.18.0",
  "compatibility": "Report and search adapters checked against 2026-10-05 OpenAPI and staging reads; production live calls not checked",
  "examples": [
    {
      "name": "conduct-a-study",
      "command": "study",
      "title": "Conduct a study",
      "inputs": "Fixture mode needs no inputs. Live actions use --action, a study ID after creation, and the action-specific name, message, or request file described in the walkthrough.",
      "output": "Fictional plan/fieldwork walkthrough labeled with fixture mode. Live mode prints the selected operation response.",
      "effects": "Fixture mode has no side effects. Live create/customize/launch/report-generation actions write data; launch starts paid recruitment and requires a separate approval flag.",
      "errors": "Missing study/action inputs, malformed request JSON, a missing launch approval, and HTTP failures stop the operation. An interrupted write may have succeeded; inspect saved state before retrying.",
      "path": "examples/conduct-a-study/index.ts",
      "sha256": "f8cd9f0bfeb836b06c65f54595edd330775f835fbe825a50afb07a27e927f990",
      "source_url": "https://raw.githubusercontent.com/user-intuition/examples/main/examples/conduct-a-study/index.ts",
      "documentation": "https://docs.userintuition.ai/api-reference/examples/conduct-a-study"
    },
    {
      "name": "retrieve-study-results",
      "command": "results",
      "title": "Retrieve study results",
      "inputs": "Live mode requires --study YOUR_STUDY_ID. Add --fetch-source to fetch the first supporting interview.",
      "output": "JSON containing mode, report, and source_references. With --fetch-source, a second JSON object contains the reference and source_interview, or a source_status explaining why none was fetched.",
      "effects": "Read-only in live mode; it does not generate a report or start research.",
      "errors": "Missing credentials or study ID, HTTP failures, invalid JSON, and unresolved source interviews are failures, not empty evidence. Stale or unknown freshness is reported separately.",
      "path": "examples/retrieve-study-results/index.ts",
      "sha256": "1dca3ac1a43df59b393f2d163e86128c731b146ce505d177a633e4e6bbc69672",
      "source_url": "https://raw.githubusercontent.com/user-intuition/examples/main/examples/retrieve-study-results/index.ts",
      "documentation": "https://docs.userintuition.ai/api-reference/examples/retrieve-study-results"
    },
    {
      "name": "search-research",
      "docsSlug": "search-research-example",
      "command": "search",
      "title": "Search research",
      "inputs": "Use --query with the research question and --study for a live scoped search. Optional --cursor, --limit, and --fetch-source constrain or extend retrieval. Fixture mode returns a fixed match and does not execute the query.",
      "output": "JSON containing mode, request, and response. The response groups canonical results under studies and includes next_cursor. With --fetch-source, a second object contains source_kind and source or explains that there are no matches.",
      "effects": "Retrieves existing evidence; does not create studies, regenerate reports, invite people, or launch recruitment.",
      "errors": "Invalid limits, missing live credentials or study ID, HTTP errors, invalid response shapes, and unresolved sources are failures. A successful empty nested results array is distinct from these errors.",
      "path": "examples/search-research/index.ts",
      "sha256": "f9d5d4e9d49b518feb7e22fbce170bbc661184ccc16c039cb94e282bbcabbfe5",
      "source_url": "https://raw.githubusercontent.com/user-intuition/examples/main/examples/search-research/index.ts",
      "documentation": "https://docs.userintuition.ai/api-reference/examples/search-research-example"
    }
  ]
}