Skip to main content
POST
/
api
/
core
/
guided_search_fields
/
knowledge_asset
/
{knowledge_asset_id}
Create guided search field for knowledge asset
curl --request POST \
  --url https://api.example.com/api/core/guided_search_fields/knowledge_asset/{knowledge_asset_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "label": {
    "de": "<string>",
    "en": "<string>"
  },
  "type": "text",
  "placeholder": {
    "de": "<string>",
    "en": "<string>"
  },
  "required": false,
  "prompt_enrichment": "<string>",
  "help_text": {
    "de": "<string>",
    "en": "<string>"
  },
  "options": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "label": {
    "de": "<string>",
    "en": "<string>"
  },
  "type": "text",
  "placeholder": {
    "de": "<string>",
    "en": "<string>"
  },
  "required": false,
  "prompt_enrichment": "<string>",
  "help_text": {
    "de": "<string>",
    "en": "<string>"
  },
  "options": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Bearer token authentication. Format: 'Bearer '

Path Parameters

knowledge_asset_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
string[] | 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
string[] | null