---
title: "Api Instant Search"
method: POST
path: "/v1/instant_search"
tags: ["embed v1"]
---

# Api Instant Search

`POST /v1/instant_search`

## Request

- Base URL: `https://api.branchly.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.branchly.io/v1/instant_search`
- Auth: none declared

## Headers

- `Origin` string, nullable
- `x-api-key` string, nullable

## Request body

- SearchRequest
  - `session_id` string, required
  - `navigator_id` string, required
  - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form'
  - `query` string, required
  - `filters` FacetFilter[]: List of filters to apply.
    - `field_name` 'tags', required: The field name for the facet filter, currently only 'tags' is supported.
    - `key` 'page_metadata.article.tags' | 'custom_metadata.tags', required: The key for the facet filter. Must be inferred from application settings or style.
    - `match` MatchValue, required
      - `value` union, required
        - string
        - boolean
        - integer
        - string[]
  - `locale` string, required
  - `url` string, uri, nullable

## Response `200`

Successful Response

- SearchResultAPI[]
  - `score` number, required
  - `vertex_id` string, required
  - `chunk_id` string, required
  - `highlight` string, required
  - `title` string, required
  - `locale` string, required
  - `label` 'entry' | 'content' | 'contact' | 'tool' | 'fallback' | 'integration' | 'style' | 'chat_navigator_style' | 'search_style' | 'search_result' | 'navigator' | 'feedback', required
  - `source` string, nullable
  - `page_metadata` PageMetadata
    - `title` string, nullable
    - `description` string, nullable
    - `url` string, uri, nullable
    - `type` string, nullable
    - `article` PageMetadataArticle
      - `published_time` string, date-time, nullable
      - `modified_time` string, date-time, nullable
      - `tags` string[]: one of multiple article:tag, category_name of helpspace page, or from openAPI mapping
    - `images` PageMetadataImage[]
      - `url` string, uri, required
      - `secure_url` string, uri, nullable
      - `type` string, nullable
      - `width` integer, nullable
      - `height` integer, nullable
      - `alt` string, nullable
  - `custom_metadata` object
  - `html_element_id` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/branchly/apis/branchly-io-api.md) · [All operations](https://skmtc.dev/branchly/apis/branchly-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/branchly/apis/branchly-io-api/revisions/9ffb024f8ec8?raw)