# Typeform

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://typeform.ferndocs.com/_mcp/server

## Docs

- [Welcome to Typeform's APIs!](https://typeform.ferndocs.com/welcome.md): Typeform's developer documentation for APIs and tools to create, embed, and retrieve form data.
- [Create API](https://typeform.ferndocs.com/create.md): A RESTful API that gives you direct control over your typeforms, images, and themes with extensive customization options.
- [Create API Walkthroughs](https://typeform.ferndocs.com/walkthroughs.md): Learn how to create, update, and customize typeforms using the Create API with practical walkthroughs for common scenarios.
- [Translations](https://typeform.ferndocs.com/create-api/translations.md)
- [URL Parameters](https://typeform.ferndocs.com/create-api/url-parameters.md)
- [Logic Jumps](https://typeform.ferndocs.com/create-api/logic-jumps.md)
- [Image sizes](https://typeform.ferndocs.com/create-api/image-sizes.md): Learn about image size options and scaling methods when retrieving images via the Create API.
- [Score and Price](https://typeform.ferndocs.com/create-api/score-and-price.md)
- [Recall Information](https://typeform.ferndocs.com/create-api/recall-information.md): Learn how to use Recall Information to personalize your typeforms by referencing previous answers, Hidden Fields, and calculated values.
- [Workspaces](https://typeform.ferndocs.com/create-api/workspaces.md)
- [Responses API](https://typeform.ferndocs.com/responses.md): Access your typeform response data on demand in JSON format without setting up webhooks or third-party integrations.
- [Responses API Walkthroughs](https://typeform.ferndocs.com/responses-api/walkthroughs.md): Learn how to retrieve, filter, and manage typeform responses using practical walkthroughs for common scenarios.
- [JSON Response Explanation](https://typeform.ferndocs.com/responses-api/json-response-explanation.md): Detailed guide to the JSON structure of Typeform responses, including all field types and metadata.
- [Right To Be Forgotten (RTBF)](https://typeform.ferndocs.com/responses-api/right-to-be-forgotten.md): Learn how to implement the Right to Be Forgotten to comply with GDPR and other privacy regulations.
- [RTBF Custom Script](https://typeform.ferndocs.com/responses-api/rtbf-custom-script.md): Build custom scripts and automation to handle Right to Be Forgotten requests at scale across multiple forms and systems.
- [Webhooks API](https://typeform.ferndocs.com/webhooks.md): Send every typeform submission straight to any URL or compatible web application as soon as it's submitted.
- [Webhooks API Walkthroughs](https://typeform.ferndocs.com/webhooks-api/walkthroughs.md): Learn how to set up and manage webhooks to receive instant notifications when someone submits your typeform.
- [Secure Your Webhooks](https://typeform.ferndocs.com/webhooks-api/secure-webhooks.md): Learn how to implement webhook signature verification to ensure requests are genuinely from Typeform.
- [Example Webhook Payload](https://typeform.ferndocs.com/webhooks-api/example-payload.md): Detailed examples of webhook payloads for every Typeform field type to help you parse and process response data.
- [Embed SDK](https://typeform.ferndocs.com/embed.md): Client-side library to embed typeforms directly in your website or web application with full customization options.
- [Vanilla Embed Library](https://typeform.ferndocs.com/embed/vanilla-embed-library.md): Learn how to embed typeforms in any website using the vanilla JavaScript embed library with full customization options.
- [Inline Embed](https://typeform.ferndocs.com/inline.md): Embed your typeform inline within a DOM element on your website or web application.
- [Modal Embeds](https://typeform.ferndocs.com/modal.md): Open typeforms in modal windows including popup, slider, sidetab, and popover options.
- [Configuration](https://typeform.ferndocs.com/configuration.md): Complete configuration options for the Typeform Embed SDK.
- [URL Parameters](https://typeform.ferndocs.com/url-parameters.md): Use URL parameters (hidden fields) to pass information to embedded typeforms for personalization and tracking.
- [Callbacks](https://typeform.ferndocs.com/callbacks.md): Listen to various events as respondents fill out your embedded typeform.
- [React Embed Library](https://typeform.ferndocs.com/react.md): Official Typeform embed library for React to embed typeforms in your React application.
- [Mobile Apps](https://typeform.ferndocs.com/mobile-apps.md): Embed typeforms in progressive web apps and native mobile applications.
- [Custom Embeds](https://typeform.ferndocs.com/custom-embed.md): Why you should use the Embed SDK instead of custom iframe embeds.
- [Contributing](https://typeform.ferndocs.com/contributing.md): Contribute to the open-source Embed SDK on GitHub.
- [What is Typeform AI?](https://typeform.ferndocs.com/typeform-ai/what-is-typeform-ai.md)
- [AI Platform Overview](https://typeform.ferndocs.com/typeform-ai/platform-overview.md)
- [Getting Started with AI](https://typeform.ferndocs.com/typeform-ai/getting-started.md)
- [AI Form Builder](https://typeform.ferndocs.com/typeform-ai/ai-form-builder.md)
- [AI Form Importer](https://typeform.ferndocs.com/typeform-ai/ai-form-importer.md)
- [AI Brand Kit](https://typeform.ferndocs.com/typeform-ai/ai-brand-kit.md)
- [AI Form Translator](https://typeform.ferndocs.com/typeform-ai/ai-form-translator.md)
- [AI Content Optimizer](https://typeform.ferndocs.com/typeform-ai/ai-content-optimizer.md)
- [Clarify with AI](https://typeform.ferndocs.com/typeform-ai/clarify-with-ai.md)
- [FAQ with AI](https://typeform.ferndocs.com/typeform-ai/faq-with-ai.md)
- [Dynamic Follow-up Questions](https://typeform.ferndocs.com/typeform-ai/dynamic-followup.md)
- [Ask AI](https://typeform.ferndocs.com/typeform-ai/ask-ai.md)
- [Qualitative Analysis](https://typeform.ferndocs.com/typeform-ai/qualitative-analysis.md)
- [Quantitative Analysis](https://typeform.ferndocs.com/typeform-ai/quantitative-analysis.md)
- [Smart Insights](https://typeform.ferndocs.com/typeform-ai/smart-insights.md)
- [Marketing Forms](https://typeform.ferndocs.com/typeform-ai/marketing-forms.md)
- [Customer Feedback](https://typeform.ferndocs.com/typeform-ai/customer-feedback.md)
- [Lead Generation](https://typeform.ferndocs.com/typeform-ai/lead-generation.md)
- [Employee Surveys](https://typeform.ferndocs.com/typeform-ai/employee-surveys.md)
- [How AI Uses Your Data](https://typeform.ferndocs.com/typeform-ai/data-usage.md)
- [Security & Compliance](https://typeform.ferndocs.com/typeform-ai/security-compliance.md)
- [FAQs](https://typeform.ferndocs.com/typeform-ai/faqs.md)
- [Community projects](https://typeform.ferndocs.com/community/projects.md)
- [Troubleshooting and Errors](https://typeform.ferndocs.com/troubleshooting.md)
- [API Changelog](https://typeform.ferndocs.com/changelog.md)
- [Changelog (all entries)](https://typeform.ferndocs.com/changelog/llms.txt)

## API Docs

- API Reference > Workspaces [Retrieve account workspaces](https://typeform.ferndocs.com/documentation/create-api/api-reference/workspaces/list-by-account.md)
- API Reference > Workspaces [Retrieve workspaces](https://typeform.ferndocs.com/documentation/create-api/api-reference/workspaces/list.md)
- API Reference > Workspaces [Create workspace](https://typeform.ferndocs.com/documentation/create-api/api-reference/workspaces/create.md)
- API Reference > Workspaces [Delete workspace](https://typeform.ferndocs.com/documentation/create-api/api-reference/workspaces/delete.md)
- API Reference > Workspaces [Retrieve workspace](https://typeform.ferndocs.com/documentation/create-api/api-reference/workspaces/get.md)
- API Reference > Workspaces [Update workspace](https://typeform.ferndocs.com/documentation/create-api/api-reference/workspaces/update.md)
- API Reference > Forms [Retrieve forms](https://typeform.ferndocs.com/documentation/create-api/api-reference/forms/list.md)
- API Reference > Forms [Create form](https://typeform.ferndocs.com/documentation/create-api/api-reference/forms/create.md)
- API Reference > Forms [Delete form](https://typeform.ferndocs.com/documentation/create-api/api-reference/forms/delete.md)
- API Reference > Forms [Retrieve form](https://typeform.ferndocs.com/documentation/create-api/api-reference/forms/get.md)
- API Reference > Forms [Update form (patch)](https://typeform.ferndocs.com/documentation/create-api/api-reference/forms/update.md)
- API Reference > Forms [Update form](https://typeform.ferndocs.com/documentation/create-api/api-reference/forms/replace.md)
- API Reference > Forms [Retrieve custom form messages](https://typeform.ferndocs.com/documentation/create-api/api-reference/forms/messages.md)
- API Reference > Forms [Update custom messages](https://typeform.ferndocs.com/documentation/create-api/api-reference/forms/set-messages.md)
- API Reference > Images [Retrieve images collection](https://typeform.ferndocs.com/documentation/create-api/api-reference/images/list.md)
- API Reference > Images [Create image](https://typeform.ferndocs.com/documentation/create-api/api-reference/images/create.md)
- API Reference > Images [Delete image](https://typeform.ferndocs.com/documentation/create-api/api-reference/images/delete.md)
- API Reference > Images [Retrieve image](https://typeform.ferndocs.com/documentation/create-api/api-reference/images/get.md)
- API Reference > Images [Retrieve background by size](https://typeform.ferndocs.com/documentation/create-api/api-reference/images/background.md)
- API Reference > Images [Retrieve choice image by size](https://typeform.ferndocs.com/documentation/create-api/api-reference/images/choice.md)
- API Reference > Images [Retrieve image by size](https://typeform.ferndocs.com/documentation/create-api/api-reference/images/image.md)
- API Reference > Themes [Retrieve themes](https://typeform.ferndocs.com/documentation/create-api/api-reference/themes/list.md)
- API Reference > Themes [Create theme](https://typeform.ferndocs.com/documentation/create-api/api-reference/themes/create.md)
- API Reference > Themes [Delete theme](https://typeform.ferndocs.com/documentation/create-api/api-reference/themes/delete.md)
- API Reference > Themes [Retrieve theme](https://typeform.ferndocs.com/documentation/create-api/api-reference/themes/get.md)
- API Reference > Themes [Update theme (partial update)](https://typeform.ferndocs.com/documentation/create-api/api-reference/themes/update.md)
- API Reference > Themes [Update theme (whole definition)](https://typeform.ferndocs.com/documentation/create-api/api-reference/themes/replace.md)
- API Reference > Workspaces [Get workspace member role](https://typeform.ferndocs.com/documentation/create-api/api-reference/workspaces/role.md)
- API Reference > Forms [Retrieve the form features](https://typeform.ferndocs.com/documentation/create-api/api-reference/forms/features.md)
- API Reference [Delete responses](https://typeform.ferndocs.com/documentation/responses-api/api-reference/delete.md)
- API Reference [Retrieve responses](https://typeform.ferndocs.com/documentation/responses-api/api-reference/list.md)
- API Reference > Webhooks [Retrieve webhooks](https://typeform.ferndocs.com/documentation/webhooks-api/api-reference/webhooks/list.md)
- API Reference > Webhooks [Retrieve single webhook](https://typeform.ferndocs.com/documentation/webhooks-api/api-reference/webhooks/get.md)
- API Reference > Webhooks [Create or update webhook](https://typeform.ferndocs.com/documentation/webhooks-api/api-reference/webhooks/upsert.md)
- API Reference > Webhooks [Delete webhook](https://typeform.ferndocs.com/documentation/webhooks-api/api-reference/webhooks/delete.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://typeform.ferndocs.com/openapi.json)
- [OpenAPI YAML](https://typeform.ferndocs.com/openapi.yaml)