> ## Documentation Index > Fetch the complete documentation index at: https://formbricks.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Find similar feedback records > Returns the records in the same dataset whose embedded text is closest to the given record's, with cosine similarity scores. The anchor record itself is excluded. The gateway looks the record up to learn its dataset and authorizes against that. Requires an API key with **read** permission (or higher) on a workspace the record's dataset is assigned to. Answers **403** for an unknown or inaccessible id. Answers **404** when the record exists but has no embedding — it has no text, or was created moments ago and is not embedded yet. Answers **503** on instances without an embedding model configured. ## OpenAPI ````yaml /api-v3-reference/openapi.yml get /api/v3/feedbackRecords/{id}/similar openapi: 3.1.1 info: title: Formbricks API v3 description: > **Surveys**: **GET /api/v3/surveys**, **POST /api/v3/surveys**, **POST /api/v3/surveys/generate**, **POST /api/v3/surveys/validate**, **GET /api/v3/surveys/{surveyId}**, **PATCH /api/v3/surveys/{surveyId}**, and **DELETE /api/v3/surveys/{surveyId}**. **Workflows extension**: **GET /api/v3/workflows**, **POST /api/v3/workflows**, **GET /api/v3/workflows/{workflowId}**, **PATCH /api/v3/workflows/{workflowId}**, **DELETE /api/v3/workflows/{workflowId}**, **POST /api/v3/workflows/{workflowId}/duplicate**, **POST /api/v3/workflows/{workflowId}/enable**, **POST /api/v3/workflows/{workflowId}/disable**, **POST /api/v3/workflows/{workflowId}/archive**, **POST /api/v3/workflows/{workflowId}/unarchive**, **POST /api/v3/workflows/{workflowId}/test**, **GET /api/v3/workflows/runs**, and **GET /api/v3/workflows/runs/{runId}**. Authenticate all management endpoints with **session cookie** or **`x-api-key`** (management key with access to the workspace). **Spec location:** source of truth is the multi-file tree at `docs/api-v3-reference/src/` (root `openapi.yml` plus one file per path and component); `docs/api-v3-reference/openapi.yml` is the generated single-file bundle (alongside v2 at `docs/api-v2-reference/openapi.yml`). **workspaceId** `workspaceId` is the canonical container identifier for this API. It is a **required query parameter on collection read endpoints** (`GET /api/v3/surveys`, `GET /api/v3/action-classes`, `GET /api/v3/contact-attribute-keys`) because those operate within a workspace. **`POST /api/v3/surveys` instead requires `workspaceId` in the request body**, not as a query parameter. Single-resource endpoints (`GET`/`PATCH`/`DELETE /api/v3/surveys/{surveyId}`) locate the resource by its globally-unique id and resolve the workspace from it, so they do **not** accept a `workspaceId` query parameter — sending one returns **400** (`Unrecognized key: "workspaceId"`). **Auth** Authenticate with either a session cookie or **`x-api-key`**. In dual-auth mode, V3 checks the API key first when the header is present, otherwise it uses the session path. Unauthenticated callers get **401** before query validation. **Pagination** Cursor-based pagination with **limit** + opaque **cursor** token. Responses return `meta.nextCursor`; pass that value back as `cursor` to fetch the next page. Survey list responses also include `meta.totalCount`, the total number of surveys matching the current filters across all pages. Workflow list responses do not require total counts in Scope 1. There is no `offset` in this contract. **Filtering** Filters use explicit operator-style query parameters under the **`filter[...]` family**. The survey list supports `filter[name][contains]`, `filter[status][in]`, and `filter[type][in]`. The workflow list supports `filter[name][contains]` and `filter[status][in]`; the workflow run list supports `filter[status][in]` and `filter[isDryRun][eq]`. Resource-scoping identifiers (`workspaceId`, `workflowId`, `responseId`) stay plain query parameters. Multi-value filters use repeated keys or comma-separated values (e.g. `filter[status][in]=draft&filter[status][in]=inProgress` or `filter[status][in]=draft,inProgress`). Sorting remains a flat `sortBy` query parameter. **Security** Missing/forbidden workspace returns **403** with a generic message (not **404**) so resource existence is not leaked. Workflow and workflow-run detail endpoints also return **403** for unknown IDs or inaccessible IDs to avoid IDOR leaks. List responses use `private, no-store`. **AI survey creation** `POST /api/v3/surveys/generate` returns a draft `POST /api/v3/surveys` payload plus validation metadata. It does not create a survey. It generates survey content for both `link` and `app` surveys; for `app` it seeds a default `distribution` (display once, no triggers, no targeting) that you finish configuring before publishing. Prompt text is sent to the configured AI provider for generation, but it is not stored by this endpoint, not logged by default, and not included in audit data. **Feedback Records** `/api/v3/feedbackRecords` is served by the **API gateway** (Envoy on Formbricks Cloud, Traefik in the one-click Docker install), which authorizes each call against the dataset and forwards it to the feedback store — not by the application routes that serve the rest of v3. Three consequences: the payload is the store's own, so members and filters are **`snake_case`** (`tenant_id`, `value_text`) rather than v3's camelCase; the dataset is named **`tenant_id`** on the wire and is required on every collection operation (it is the feedback dataset id, which the MCP `list_feedback_datasets` tool reports as `dataset_id`); and errors come in two shapes — gateway refusals (**400**, **401**, **403**, **413**, **503**) are `text/plain`, while the store's own problems are `application/problem+json` with a stable `code`. These eight operations are the whole of the gateway-served surface; any other path it receives under the prefix answers **400**. Authenticate with **`x-api-key`**: the key needs a permission on a workspace the dataset is assigned to — `read` to list, get and search, `write` to create and update, `manage` to delete — and may update or delete only in a dataset assigned to exactly one workspace. **OpenAPI** This spec is **not** produced by `pnpm generate-api-specs` (that script only builds v2 → `docs/api-v2-reference/openapi.yml`). When the route contract changes, edit the files under `docs/api-v3-reference/src/`, then run `pnpm api:v3:bundle` to regenerate the committed single-file bundle. `pnpm api:v3:lint` lints the source tree; `pnpm api:v3:check` (CI) fails when the bundle is stale. **Workflows Scope 1** Workflows are a follow-up extension of the existing v3 Survey API work. The Survey API establishes API-first survey authoring; Workflows build on that same v3 style to automate actions around survey responses through workspace-scoped JSON definitions. Scope 1 models the existing Follow-ups capability as workflows: one `response.completed` trigger with an optional `endingCardIds` filter, and `send_email` actions with Follow-up email field parity. The definition and run shapes mirror the shared Zod schemas in `packages/workflows` (ENG-1100), which are the implementation source of truth for this contract. Workflows use `draft`, `enabled`, and `disabled` lifecycle states plus an `archived` soft-delete state. Status only changes through the lifecycle endpoints (`enable`, `disable`, `archive`, `unarchive`); it is not writable via `POST` or `PATCH`. Enabling validates that the definition is executable and snapshots an immutable workflow version; runs reference that snapshot via `workflowVersionId`. `POST .../test` is a dry run: it validates the definition and resolves the trigger's references synchronously, creating no run and sending no email, and returns `{ workflowId, ok, problems }` directly. Real runs execute asynchronously and are polled via `GET /api/v3/workflows/runs/{runId}`. **Overview migration note** The v3-backed survey overview page intentionally removes actions that are not yet exposed by this contract: `Created by` filtering, `Duplicate`, `Copy...`, `Preview`, and `Copy link`. **Next steps (out of scope for this spec)** Additional v3 survey update endpoints, optional ETag/304, field selection, translation-specific writes, and survey version history. version: 0.1.0 x-implementation-notes: route: apps/web/app/api/v3/surveys/route.ts generate-route: apps/web/app/api/v3/surveys/generate/route.ts query-parser: apps/web/app/api/v3/surveys/parse-v3-surveys-list-query.ts auth: apps/web/app/api/v3/lib/auth.ts workspace-resolution: apps/web/app/api/v3/lib/workspace-context.ts workflow-contract-ticket: ENG-1101 workflow-shared-schemas: packages/workflows/src/types (feat/workflows-types) workflow-prisma-schema: packages/database/schema/workflows.prisma (feat/workflows-prisma-schema) openapi-generated: false spec-source: docs/api-v3-reference/src (regenerate bundle with `pnpm api:v3:bundle`) pagination-model: cursor cursor-pagination: supported servers: - url: https://app.formbricks.com description: >- Formbricks Cloud. Paths in this spec already include the `/api/v3` prefix; self-hosted instances substitute their own origin. security: [] paths: /api/v3/feedbackRecords/{id}/similar: get: tags: - V3 Feedback Records summary: Find similar feedback records description: > Returns the records in the same dataset whose embedded text is closest to the given record's, with cosine similarity scores. The anchor record itself is excluded. The gateway looks the record up to learn its dataset and authorizes against that. Requires an API key with **read** permission (or higher) on a workspace the record's dataset is assigned to. Answers **403** for an unknown or inaccessible id. Answers **404** when the record exists but has no embedding — it has no text, or was created moments ago and is not embedded yet. Answers **503** on instances without an embedding model configured. operationId: getSimilarFeedbackRecordsV3 parameters: - $ref: '#/components/parameters/FeedbackRecordIdPath' - $ref: '#/components/parameters/SimilarityLimitQuery' - $ref: '#/components/parameters/SimilarityCursorQuery' - $ref: '#/components/parameters/MinScoreQuery' responses: '200': description: Similar records retrieved content: application/json: schema: $ref: '#/components/schemas/FeedbackRecordSimilarityResult' examples: matches: summary: One neighbour above the threshold value: data: - feedback_record_id: 018e1234-5678-7abc-8ef0-1234567890aa score: 0.83 field_label: Anything else? value_text: >- Took 40 minutes to get in. Please open more turnstiles. limit: 10 '400': $ref: '#/components/responses/FeedbackRecordsBadRequest' '401': $ref: '#/components/responses/FeedbackRecordsUnauthorized' '403': $ref: '#/components/responses/FeedbackRecordsForbidden' '404': $ref: '#/components/responses/FeedbackRecordsNotFound' '500': $ref: '#/components/responses/FeedbackRecordsInternalServerError' '503': $ref: '#/components/responses/FeedbackRecordsServiceUnavailable' security: - apiKeyAuth: [] components: parameters: FeedbackRecordIdPath: in: path name: id required: true schema: type: string format: uuid description: >- Feedback record id (UUID). The dataset is resolved from the record itself, so the caller cannot choose which dataset it is authorized against. An id that is not a UUID answers **400**, and an id whose dataset the API key cannot reach answers **403** rather than 404, so ids cannot be probed. The gateway caches the record→dataset lookup for 60 seconds, so for up to a minute after a delete the id is still authorized and the store answers **404**; after that the same id answers **403**. SimilarityLimitQuery: in: query name: limit schema: type: integer default: 10 description: >- Page size, at most 100. Unlike the `limit` on `GET /api/v3/feedbackRecords`, this one is never rejected: the search endpoints **clamp** instead of answering 400. A value above 100 is reduced to 100, and `0`, a negative number or a non-numeric value falls back to the default of 10. Read the `limit` in the response to see what was actually applied. SimilarityCursorQuery: in: query name: cursor schema: type: string description: >- Opaque keyset cursor returned as `next_cursor` by the previous page. Omit on the first request. A malformed cursor answers **400**. MinScoreQuery: in: query name: min_score schema: type: number format: float default: 0.7 description: >- Only matches with `score >= min_score` are returned. Like `limit`, this value is **clamped rather than rejected**: above `1` it becomes `1`, below `0` it becomes `0`, and a non-numeric value falls back to the default of `0.7`. That default is conservative — on the embedding model we measured, query→record similarities for genuinely relevant text often landed around `0.55–0.7` — so if a good query returns nothing, lower it (e.g. `0.5`) and filter on the returned `value_text`. Score distributions differ per model, so treat those numbers as an observation rather than a guarantee. schemas: FeedbackRecordSimilarityResult: type: object additionalProperties: false required: - data - limit properties: data: type: array maxItems: 100 items: $ref: '#/components/schemas/FeedbackRecordSimilarityItem' description: Matches ordered by descending `score`. limit: type: integer description: The page size that was applied. next_cursor: type: string description: >- Opaque keyset cursor for the next page. Present only when a full page was returned and there may be more results. Pass it back unchanged as `cursor`. FeedbackRecordSimilarityItem: type: object additionalProperties: false required: - feedback_record_id - score - field_label - value_text properties: feedback_record_id: type: string format: uuid description: >- The matching record. Fetch it with `GET /api/v3/feedbackRecords/{id}` for the full payload. score: type: number format: double minimum: 0 maximum: 1 description: Cosine similarity, `0` unrelated to `1` identical. field_label: type: string description: >- The record's question text (part of what was embedded). Empty when the record has no label. value_text: type: string description: >- The record's text answer (the text that was embedded). Empty when it has since been cleared — only records with a non-empty `value_text` are embedded in the first place. HubProblem: type: object additionalProperties: false description: >- RFC 9457 problem details (`application/problem+json`) as produced by the feedback store behind the API gateway. Branch on the stable `code` member rather than on `title` or `type`. Note the member names differ from the rest of v3 (`request_id`, not `requestId`) — the payload is passed through unchanged. required: - title - status - code - request_id properties: type: type: string format: uri description: A URI reference identifying the problem type. title: type: string description: >- Short, human-readable summary of the problem type; stable across occurrences. status: type: integer description: HTTP status code. code: type: string description: >- Stable, machine-readable error code. `service_unavailable` means a feature or dependency is temporarily unavailable and the request may be retried later; `tenant_write_conflict` means the write collided with an in-progress dataset purge and may be retried unchanged. Every other code is terminal until the request itself changes. enum: - validation - bad_request - unauthorized - forbidden - not_found - conflict - tenant_write_conflict - method_not_allowed - content_too_large - service_unavailable - internal_server_error detail: type: string description: Human-readable explanation specific to this occurrence. instance: type: string description: >- URI reference identifying this occurrence — the request path **as the feedback store saw it** (`/v1/feedback-records/...`), not the `/api/v3/feedbackRecords/...` path you called. request_id: type: string description: >- Identifier for this request, also returned in the `X-Request-ID` response header; include it when reporting a problem. details: type: object additionalProperties: true description: >- Optional structured context, e.g. `resource_type` on a not-found problem. invalid_params: type: array maxItems: 100 items: $ref: '#/components/schemas/HubInvalidParam' description: Field-level validation failures. Present on `validation` problems. HubInvalidParam: type: object additionalProperties: false description: >- A single invalid request parameter (RFC 9457 `invalid_params` extension member). required: - name - reason properties: name: type: string description: >- Dotted path to the offending request field, e.g. `field_type` or `items[0].field_type`. reason: type: string description: >- Human- and agent-readable explanation of why the value is invalid, naming allowed values or constraints so the request can be corrected without guessing. responses: FeedbackRecordsBadRequest: description: >- Bad Request. From the **gateway** (`text/plain`): a missing or malformed `tenant_id`, a request body that is not JSON, or a path under `/api/v3/feedbackRecords` that is not one of the documented operations. A record id that is not a UUID and a path such as `/count` both fall in that last case and share the one `Unsupported FeedbackRecords route` body, so the two cannot be told apart from the response. From the **feedback store** (`application/problem+json`): schema validation failures — an unknown enum value, an inverted range, a malformed or re-ordered cursor, or a string with NULL bytes or invalid UTF-8. content: text/plain: schema: type: string examples: missingTenant: summary: Gateway — tenant_id missing or malformed value: Invalid or missing tenant_id unsupportedRoute: summary: Gateway — not a documented operation value: Unsupported FeedbackRecords route application/problem+json: schema: $ref: '#/components/schemas/HubProblem' examples: invertedRange: summary: Feedback store — a range filter supplied backwards value: type: https://hub.formbricks.com/problems/validation title: Validation Failed status: 400 code: validation detail: One or more request parameters are invalid request_id: 0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b invalid_params: - name: sentiment_score_min reason: must be less than or equal to sentiment_score_max FeedbackRecordsUnauthorized: description: >- Unauthorized — no credentials, or an API key that does not exist or is revoked. Answered by the gateway as `text/plain`, before the request reaches the feedback store. content: text/plain: schema: type: string example: Unauthorized FeedbackRecordsForbidden: description: >- Forbidden. Answered by the gateway as `text/plain` whenever the request cannot be authorized: the dataset does not exist, is archived, or is not assigned to a workspace the API key has the required permission on; the organization lacks the Unify Feedback entitlement; a mutation was attempted with an API key on a dataset shared by more than one workspace; or the record id does not exist. Existence is not leaked: an unknown dataset or record is refused here rather than with a 404. The single-record operations are the one exception, and only for a minute after a delete — see their `404`. content: text/plain: schema: type: string example: Forbidden FeedbackRecordsNotFound: description: >- Not Found from the feedback store (`application/problem+json`, `code: not_found`), for one of two reasons. Usually the record exists but has **no embedding** for the current model: it has no text, or was created moments ago and is not embedded yet. It can also mean the record itself is **gone** — deleted after the gateway authorized the call against its cached dataset (see the `id` parameter). content: application/problem+json: schema: $ref: '#/components/schemas/HubProblem' FeedbackRecordsInternalServerError: description: >- Internal Server Error from the feedback store (`application/problem+json`, `code: internal_server_error`). content: application/problem+json: schema: $ref: '#/components/schemas/HubProblem' FeedbackRecordsServiceUnavailable: description: >- Service Unavailable. From the **gateway** (`text/plain`): the record's dataset could not be resolved because the feedback store did not answer, the authorization service itself was unreachable, or the record's stored `tenant_id` is not a dataset id this API can address. From the **feedback store** (`application/problem+json`, `code: service_unavailable`): the operation needs a capability that is not configured on this instance — semantic search and similar records require an embedding model. content: text/plain: schema: type: string example: Feedback record lookup failed application/problem+json: schema: $ref: '#/components/schemas/HubProblem' securitySchemes: apiKeyAuth: type: apiKey in: header name: x-api-key description: > Management API key; must include **workspaceId** as an allowed workspace with read, write, or manage permission. ````