Skip to main content
GET
/
api
/
core
/
guided_search_fields
/
use_case
/
{use_case_id}
Get guided search fields for use case by ids
curl --request GET \
  --url https://api.example.com/api/core/guided_search_fields/use_case/{use_case_id} \
  --header 'Authorization: Bearer <token>'
[
  {
    "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

use_case_id
string
required

Query Parameters

ids
string
required

Comma-separated guided search field ids

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