---
title: "Api Navigation V1"
method: POST
path: "/v1/navigation"
tags: ["embed v1"]
---

# Api Navigation V1

`POST /v1/navigation`

## 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/navigation`
- Auth: none declared

## Headers

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

## Request body

- NavigationRequest
  - `session_id` string, required
  - `navigator_id` string, required
  - `embed_type` 'chat' | 'search' | 'chat_widget' | 'search_interface' | 'voice' | 'api' | 'form'
  - `entry` 'navigation' | 'search' | 'qa' | 'sa' | 'form_submission' | 'voice' | 'form' | 'form_routing'
  - `selected_nodes` VertexAPIInShort[], nullable
    - `id` string, required
    - `label` 'entry' | 'content' | 'contact' | 'tool' | 'fallback' | 'integration' | 'style' | 'chat_navigator_style' | 'search_style' | 'search_result' | 'navigator' | 'feedback'
    - `title` object, nullable
    - `icon_url` string, nullable
  - `locale` string, required
  - `url` string, uri, nullable

## Response `200`

Successful Response

- NavigationResponse
  - `navigator_id` string, required
  - `session_id` string, required
  - `entry` 'navigation' | 'search' | 'qa' | 'sa' | 'form_submission' | 'voice' | 'form' | 'form_routing'
  - `selected_nodes` VertexAPIOutText[], required
    - `id` string, required
    - `label` 'entry' | 'content' | 'contact' | 'tool' | 'fallback' | 'integration' | 'style' | 'chat_navigator_style' | 'search_style' | 'search_result' | 'navigator' | 'feedback', required
    - `title` object
    - `icon_url` string, nullable
    - `text` object
    - `form` FormAPIOutput
      - `tool_id` string, required
      - `form_schema` FormAPISchema, required
        - `properties` union[], required
          - union
            - StringFieldAPI
              - …
            - TextAreaFieldAPI
              - …
            - NumberFieldAPI
              - …
            - SelectFieldAPI
              - …
            - DateFieldAPI
              - …
            - TimeFieldAPI
              - …
            - CheckboxFieldAPI
              - …
      - `arguments` FormToolArguments, required
        - `object` 'form_tool_arguments'
        - `form_title` object, required
        - `submit_message` object, required
        - `submit_button_text` object, required
        - `show_data_privacy_text` boolean
        - `data_privacy_text` object, nullable: Optional data privacy text. If provided, a checkbox should be displayed to the user.
        - `notification_email` union: Used for email forwarding of form submissions. If not provided, no email will be forwarded
          - string, email
          - string[]
      - `values` object, required
  - `selected_node` VertexAPIOut, required
    - `id` string, required
    - `pk` string, required
    - `label` 'entry' | 'content' | 'contact' | 'tool' | 'fallback' | 'integration' | 'style' | 'chat_navigator_style' | 'search_style' | 'search_result' | 'navigator' | 'feedback', required
    - `title` object
    - `text` object
    - `icon_url` string, nullable
    - `source` string, nullable
    - `form` FormAPIOutput
      - `tool_id` string, required
      - `form_schema` FormAPISchema, required
        - `properties` union[], required
          - union
            - StringFieldAPI
              - …
            - TextAreaFieldAPI
              - …
            - NumberFieldAPI
              - …
            - SelectFieldAPI
              - …
            - DateFieldAPI
              - …
            - TimeFieldAPI
              - …
            - CheckboxFieldAPI
              - …
      - `arguments` FormToolArguments, required
        - `object` 'form_tool_arguments'
        - `form_title` object, required
        - `submit_message` object, required
        - `submit_button_text` object, required
        - `show_data_privacy_text` boolean
        - `data_privacy_text` object, nullable: Optional data privacy text. If provided, a checkbox should be displayed to the user.
        - `notification_email` union: Used for email forwarding of form submissions. If not provided, no email will be forwarded
          - string, email
          - string[]
      - `values` object, required
  - `next_nodes` VertexAPIOutShort[], required
    - `id` string, required
    - `label` 'entry' | 'content' | 'contact' | 'tool' | 'fallback' | 'integration' | 'style' | 'chat_navigator_style' | 'search_style' | 'search_result' | 'navigator' | 'feedback', required
    - `title` object
    - `icon_url` 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)