Skip to main content
POST
/
api
/
core
/
guided_search_fields
/
use_case
/
{use_case_id}
Create guided search field
curl --request POST \
  --url https://api.example.com/api/core/guided_search_fields/use_case/{use_case_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "label": {
    "en": "<string>",
    "de": "<string>",
    "es": "<string>",
    "fr": "<string>",
    "it": "<string>",
    "nl": "<string>",
    "pl": "<string>",
    "pt": "<string>",
    "sv": "<string>"
  },
  "type": "text",
  "placeholder": {
    "en": "<string>",
    "de": "<string>",
    "es": "<string>",
    "fr": "<string>",
    "it": "<string>",
    "nl": "<string>",
    "pl": "<string>",
    "pt": "<string>",
    "sv": "<string>"
  },
  "required": false,
  "prompt_enrichment": "<string>",
  "help_text": {
    "en": "<string>",
    "de": "<string>",
    "es": "<string>",
    "fr": "<string>",
    "it": "<string>",
    "nl": "<string>",
    "pl": "<string>",
    "pt": "<string>",
    "sv": "<string>"
  },
  "options": [
    {
      "en": "<string>",
      "de": "<string>",
      "es": "<string>",
      "fr": "<string>",
      "it": "<string>",
      "nl": "<string>",
      "pl": "<string>",
      "pt": "<string>",
      "sv": "<string>"
    }
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "label": {
    "en": "<string>",
    "de": "<string>",
    "es": "<string>",
    "fr": "<string>",
    "it": "<string>",
    "nl": "<string>",
    "pl": "<string>",
    "pt": "<string>",
    "sv": "<string>"
  },
  "type": "text",
  "placeholder": {
    "en": "<string>",
    "de": "<string>",
    "es": "<string>",
    "fr": "<string>",
    "it": "<string>",
    "nl": "<string>",
    "pl": "<string>",
    "pt": "<string>",
    "sv": "<string>"
  },
  "required": false,
  "prompt_enrichment": "<string>",
  "help_text": {
    "en": "<string>",
    "de": "<string>",
    "es": "<string>",
    "fr": "<string>",
    "it": "<string>",
    "nl": "<string>",
    "pl": "<string>",
    "pt": "<string>",
    "sv": "<string>"
  },
  "options": [
    {
      "en": "<string>",
      "de": "<string>",
      "es": "<string>",
      "fr": "<string>",
      "it": "<string>",
      "nl": "<string>",
      "pl": "<string>",
      "pt": "<string>",
      "sv": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Format: 'Bearer '

Path Parameters

​
use_case_id
string
required

Body

application/json
​
id
string
required
​
name
string
required
​
label
MultilingualText · object
required

Pydantic model for a multilingual text.

​
type
string
default:text
​
placeholder
MultilingualText · object

Pydantic model for a multilingual text.

​
required
boolean
default:false
​
prompt_enrichment
string | null
​
help_text
MultilingualText · object

Pydantic model for a multilingual text.

​
options
MultilingualText · object[] | null

Response

Successful Response

​
id
string
required
​
name
string
required
​
label
MultilingualText · object
required

Pydantic model for a multilingual text.

​
type
string
default:text
​
placeholder
MultilingualText · object

Pydantic model for a multilingual text.

​
required
boolean
default:false
​
prompt_enrichment
string | null
​
help_text
MultilingualText · object

Pydantic model for a multilingual text.

​
options
MultilingualText · object[] | null