Public API

FishDog External API

Production-ready endpoints for recruiting research groups, creating studies, asking questions, completing workflows, and sharing results.

OpenAPI spec Quickstart guide All guides Changelog notes Workflow guides Jump to docs
Status: Public
Version: v1
Guide Index All runtime-served guide files grouped by workflow and use case. Quickstart Canonical 6-step implementation sequence with extraction and polling notes. Async Polling Status model and wait strategy for `GET /v1/jobs/{job_id}`. Common Mistakes Frequent integration mistakes and exact corrections. Recruitment Filters Health, occupation synonym, industry, and MCP filter usage guide. Workflow Diagram Branching map for study, direct question, curation, and media workflows. Postman Collection Runnable request collection for the primary flow and branch scenarios. What Changed Dated release notes labeled by breaking vs non-breaking impact.

API Guides

Every public guide served under `/docs/api/guides/<filename>`, grouped by the workflow it supports.

Core API Workflow

Quickstart Canonical implementation sequence for the v1 API. Examples Concrete request examples for common endpoint families. Async Polling Job status model and polling strategy. Common Mistakes Frequent integration errors and corrections. Workflow Diagram Branching map for study and direct-question flows. Postman Collection Runnable request collection for API testing. Changelog Dated external documentation and contract updates.

Recruitment and Filters

Recruitment Filter Expansion Health, occupation, industry, value discovery, and MCP usage. Filters Reference Syntax, aliases, exact-match behavior, and value sets. Research Group Requests Natural-language group recruitment workflow. Research Study Requests Natural-language recruitment plus study creation workflow.

MCP and Thesis Lab

MCP Adapter Quickstart MCP setup, tenant headers, and tool map. Thesis Lab Wave 1 Thesis Lab API/MCP usage guide. Agent Industry Digests Agent industry digest workflow guidance.

Access, Billing, and Operations

Auth API-key authentication guidance. Claude Code OAuth Free-tier OAuth notes for Claude Code usage. Pricing and Billable Events Plan and usage-event behavior. Stripe Billing Operations Operational billing guidance. Slack Request URL Migration Marketplace Request URL migration guidance. Slack Cutover Checklist Step-by-step Slack Request URL cutover commands. Slack Worker Observability Slack worker runtime observability notes.

Workflow Branching Overview

Use this branch map to choose the correct flow before making your first API call.

Diagram showing core 6-step study flow, direct agent question flow, direct group question flow, over-recruit and curate flow, and media upload attachment branch.
  1. Core study flow: recruit group -> create study -> ask question -> poll job -> complete study -> enable share link.
  2. Direct agent question: ask one recruitable agent directly without creating a study.
  3. Direct group question: ask an existing group directly without creating a study.
  4. Over-recruit and curate: recruit larger initial group, ask a screening question, remove mismatched agents, continue study questions.
  5. Media branch: upload assets once and reference `media_asset_id` from direct or study question endpoints.

Claude Code Guides

Workflow-first tutorials for AI agents and developers. Use these when you want complete end-to-end examples by use case, not just endpoint reference details.

Get Started

Claude Code Hub Entry point with capability overview, quick links, and endpoint tables. Install FishDog Skill Skill installation, API key setup, filters, troubleshooting, and FAQ. Install PMM Skill Product-marketing focused setup and study-type decision support. Why FishDog AI-agent decision brief and capability gap rationale.

Use-Case Workflows

API Workflow Hub Index of all workflow guides with endpoint references. Customer Segmentation Multi-group segment comparison and prioritization workflow. Competitive Intelligence Perception gaps, switching triggers, and battlecard-ready outputs. Pricing Research Willingness-to-pay and pricing framework workflows. Positioning Validation Positioning clarity and differentiation validation workflows. Product Messaging A/B/C messaging test loops and decision templates. Sales Enablement Objection handling, quote banks, and sales collateral workflows. Voice of Customer Always-on VoC loops and monthly pulse-check workflow. GTM Strategy Go-to-market motion and channel strategy validation flow. Product Launch Pre-launch concept validation and post-launch sentiment checks. Content Marketing One-study to multi-format content production workflow. Question Design Playbook Question frameworks, patterns, and anti-patterns by study type. Recruitment Strategies Audience selection, over-recruit-and-curate, and balancing guidance.