dscout API

openapi: 3.1.0
info:
  title: dscout API
  version: '2026-10-24'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-24: 22 operation(s) read from 23 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; dscout has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 22
    pages-with-code: 0
    pages-read: 23
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-24'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://help.dscout.com/getting-started/dscout-quickstart-guide.md
  - https://help.dscout.com/private-panels/get-started/quickstart-guide.md
  - https://help.dscout.com/private-panels/panel-management/client-lists.md
  - https://help.dscout.com/private-panels/organization-settings/private-panels-api.md
  - https://help.dscout.com/private-panels/panel-management/restrict-availability-by-country.md
  - https://help.dscout.com/study-basics/testing-prototypes/analyze-heat-maps-and-click-data.md
  - https://help.dscout.com/recruit-participants/what-are-dscout-screeners/example-screener-teasers.md
  - https://help.dscout.com/usability-tests/create-a-usability-test/example-of-an-effective-usability-test.md
  - https://help.dscout.com/recruit-participants/what-are-dscout-screeners/example-of-an-effective-screener.md
  - https://help.dscout.com/diary-studies/what-are-diary-studies-in-dscout/example-of-an-effective-diary-study.md
  - https://help.dscout.com/interview-studies/view-interview-session-recordings/clips-and-playlists-in-interview-studies.md
  - https://help.dscout.com/getting-started/research-basics.md
  - https://help.dscout.com/getting-started/work-with-your-team.md
  - https://help.dscout.com/getting-started/workspaces-and-projects.md
  - https://help.dscout.com/getting-started/research-basics/accessibility.md
  - https://help.dscout.com/getting-started/work-with-your-team/builder-comments.md
  - https://help.dscout.com/getting-started/work-with-your-team/mentions-in-dscout.md
  - https://help.dscout.com/getting-started/research-basics/custom-informed-consent.md
  - https://help.dscout.com/getting-started/work-with-your-team/manage-project-members.md
  - https://help.dscout.com/getting-started/dscout-quickstart-guide/dscout-subscriptions.md
  - https://help.dscout.com/getting-started/research-basics/inclusive-research-guidelines.md
  - https://help.dscout.com/getting-started/dscout-quickstart-guide/using-the-dscout-sandbox.md
  - https://help.dscout.com/getting-started/workspaces-and-projects/project-review-checklist.md
paths:
  /diary-studies/what-are-diary-studies-in-dscout/example-of-an-effective-diary-study.md:
    get:
      operationId: get_diary_studies_what_are_diary_studies_in_dscout_example_of_an_effective_diary
      tags:
      - Diary Studies
      summary: Example of an effective diary study
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/diary-studies/what-are-diary-studies-in-dscout/example-of-an-effective-diary-study.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question; specific, self‑contained, natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal; describes the outcome they want.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/dscout-quickstart-guide.md:
    get:
      operationId: get_getting_started_dscout_quickstart_guide_md
      tags:
      - Getting Started
      summary: Dscout quickstart guide
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/getting-started/dscout-quickstart-guide.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question; specific, self‑contained, natural language query.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal; describes the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/dscout-quickstart-guide/dscout-subscriptions.md:
    get:
      operationId: get_getting_started_dscout_quickstart_guide_dscout_subscriptions_md
      tags:
      - Getting Started
      summary: Dscout subscriptions
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/getting-started/dscout-quickstart-guide/dscout-subscriptions.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: 'The immediate question: it should be specific, self-contained, and written in natural language.'
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want rather than restating the question.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/dscout-quickstart-guide/using-the-dscout-sandbox.md:
    get:
      operationId: get_getting_started_dscout_quickstart_guide_using_the_dscout_sandbox_md
      tags:
      - Getting Started
      summary: Using the Dscout sandbox
      x-source: https://help.dscout.com/getting-started/dscout-quickstart-guide/using-the-dscout-sandbox.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGettingStartedDscoutQuickstartGuideUsingTheDscoutSandboxM'
      x-evidence:
        kind: documentation
  /getting-started/research-basics.md:
    get:
      operationId: get_getting_started_research_basics_md
      tags:
      - Getting Started
      summary: Research basics
      x-source: https://help.dscout.com/getting-started/research-basics.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: 'The immediate question: it should be specific, self-contained, and written in natural language.'
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want rather than restating the question.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/research-basics/accessibility.md:
    get:
      operationId: get_getting_started_research_basics_accessibility_md
      tags:
      - Getting Started
      summary: Accessibility
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters. The response will contain a direct answer
        to the question and relevant excerpts and sources from the documentation.
      x-source: https://help.dscout.com/getting-started/research-basics/accessibility.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/research-basics/custom-informed-consent.md:
    get:
      operationId: get_getting_started_research_basics_custom_informed_consent_md
      tags:
      - Getting Started
      summary: Custom informed consent
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/getting-started/research-basics/custom-informed-consent.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: true
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/research-basics/inclusive-research-guidelines.md:
    get:
      operationId: get_getting_started_research_basics_inclusive_research_guidelines_md
      tags:
      - Getting Started
      summary: Inclusive research guidelines
      description: Retrieves the inclusive research guidelines markdown page.
      x-source: https://help.dscout.com/getting-started/research-basics/inclusive-research-guidelines.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/work-with-your-team.md:
    get:
      operationId: get_getting_started_work_with_your_team_md
      tags:
      - Getting Started
      summary: Work with your team
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/getting-started/work-with-your-team.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want rather than restating the question.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/work-with-your-team/builder-comments.md:
    get:
      operationId: get_getting_started_work_with_your_team_builder_comments_md
      tags:
      - Getting Started
      summary: Builder comments
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer from the documentation.
      x-source: https://help.dscout.com/getting-started/work-with-your-team/builder-comments.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question to ask the documentation.
      - name: goal
        in: query
        required: true
        schema:
          type: string
        description: The broader goal the user is trying to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/work-with-your-team/manage-project-members.md:
    get:
      operationId: get_getting_started_work_with_your_team_manage_project_members_md
      tags:
      - Getting Started
      summary: Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters
      description: The GET request returns a direct answer to the question along with relevant excerpts and sources from the documentation.
      x-source: https://help.dscout.com/getting-started/work-with-your-team/manage-project-members.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: true
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/work-with-your-team/mentions-in-dscout.md:
    get:
      operationId: get_getting_started_work_with_your_team_mentions_in_dscout_md
      tags:
      - Getting Started
      summary: Mentions in Dscout
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer from the documentation.
      x-source: https://help.dscout.com/getting-started/work-with-your-team/mentions-in-dscout.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question to ask the documentation.
      - name: goal
        in: query
        required: true
        schema:
          type: string
        description: The broader goal the user is trying to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/workspaces-and-projects.md:
    get:
      operationId: get_getting_started_workspaces_and_projects_md
      tags:
      - Getting Started
      summary: Workspaces and projects
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/getting-started/workspaces-and-projects.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /getting-started/workspaces-and-projects/project-review-checklist.md:
    get:
      operationId: get_getting_started_workspaces_and_projects_project_review_checklist_md
      tags:
      - Getting Started
      summary: Project review checklist
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/getting-started/workspaces-and-projects/project-review-checklist.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /interview-studies/view-interview-session-recordings/clips-and-playlists-in-interview-studies.md:
    get:
      operationId: get_interview_studies_view_interview_session_recordings_clips_and_playlists_in_i
      tags:
      - Interview Studies
      summary: Clips and playlists in interview studies
      description: Retrieves the Markdown page for Clips & Playlists in interview studies, optionally with `ask` and `goal` query parameters to
        get a contextual answer from the documentation engine.
      x-source: https://help.dscout.com/interview-studies/view-interview-session-recordings/clips-and-playlists-in-interview-studies.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question to ask the documentation engine, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The broader goal the user is trying to achieve, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /private-panels/get-started/quickstart-guide.md:
    get:
      operationId: get_private_panels_get_started_quickstart_guide_md
      tags:
      - Private Panels
      summary: Quickstart guide
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/private-panels/get-started/quickstart-guide.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: true
        schema:
          type: string
        description: The user’s overall goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /private-panels/panel-management/client-lists.md:
    get:
      operationId: get_private_panels_panel_management_client_lists_md
      tags:
      - Private Panels
      summary: Client lists
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/private-panels/panel-management/client-lists.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /private-panels/panel-management/restrict-availability-by-country.md:
    get:
      operationId: get_private_panels_panel_management_restrict_availability_by_country_md
      tags:
      - Private Panels
      summary: Restrict availability by country
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/private-panels/panel-management/restrict-availability-by-country.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /recruit-participants/what-are-dscout-screeners/example-of-an-effective-screener.md:
    get:
      operationId: get_recruit_participants_what_are_dscout_screeners_example_of_an_effective_scree
      tags:
      - Recruit Participants
      summary: 'Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:'
      description: The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
      x-source: https://help.dscout.com/recruit-participants/what-are-dscout-screeners/example-of-an-effective-screener.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question; should be specific, self‑contained, and written in natural language.
      - name: goal
        in: query
        required: true
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /recruit-participants/what-are-dscout-screeners/example-screener-teasers.md:
    get:
      operationId: get_recruit_participants_what_are_dscout_screeners_example_screener_teasers_md
      tags:
      - Recruit Participants
      summary: Example screener teasers
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/recruit-participants/what-are-dscout-screeners/example-screener-teasers.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /study-basics/testing-prototypes/analyze-heat-maps-and-click-data.md:
    get:
      operationId: get_study_basics_testing_prototypes_analyze_heat_maps_and_click_data_md
      tags:
      - Study Basics
      summary: Analyze heat maps and click data
      description: Performs an HTTP GET request on the documentation page with optional `ask` and `goal` query parameters to retrieve a direct
        answer and relevant excerpts from the page.
      x-source: https://help.dscout.com/study-basics/testing-prototypes/analyze-heat-maps-and-click-data.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question to ask the documentation, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The broader goal the user is trying to achieve, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /usability-tests/create-a-usability-test/example-of-an-effective-usability-test.md:
    get:
      operationId: get_usability_tests_create_a_usability_test_example_of_an_effective_usability_te
      tags:
      - Usability Tests
      summary: Example of an effective usability test
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://help.dscout.com/usability-tests/create-a-usability-test/example-of-an-effective-usability-test.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question to ask the documentation.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The broader goal the user is trying to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetGettingStartedDscoutQuickstartGuideUsingTheDscoutSandboxM:
      type: object
      properties:
        answer:
          type: string
          description: Direct answer to the question.
        excerpts:
          type: array
          description: Relevant excerpts from the documentation.
        sources:
          type: array
          description: Sources indicating where the information was retrieved.
tags:
- name: Diary Studies
- name: Getting Started
- name: Interview Studies
- name: Private Panels
- name: Recruit Participants
- name: Study Basics
- name: Usability Tests