cURL
curl --request POST \ --url https://api.example.com/api/core/use_cases/create \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "id": "<string>", "label": { "de": "<string>", "en": "<string>" }, "description": { "de": "<string>", "en": "<string>" } } '
{ "id": "<string>", "label": { "de": "<string>", "en": "<string>" }, "disclaimer": { "disclaimer_text": { "de": "<string>", "en": "<string>" }, "disclaimer_url": "<string>" }, "description": { "de": "<string>", "en": "<string>" }, "knowledge_asset_ids": [ "<string>" ], "knowledge_source_ids": [ "<string>" ], "external_links": [ { "display_name": "<string>", "url": "<string>", "icon": "<string>", "is_global": false } ], "glossary": "<string>", "glossary_filename": "<string>", "glossary_description": "<string>", "show_to_unauthorized_users": false, "can_contain_personal_knowledge_assets": false, "org_entity_ids": [ "<string>" ], "quick_action_ids": [ "<string>" ], "query_splitting": true, "show_knowledge_assets": true, "enable_additional_questions": true, "guided_search_field_ids": [ "<string>" ], "context_about_users": "<string>", "context_about_company": "<string>", "context_about_documents": "<string>", "tonality": "<string>", "enable_targeted_web_search": true, "feedback_form_config": {}, "privacy_policy": { "privacy_policy_text": { "de": "Mit Absenden des Feedbacks erklärst du dich mit der Verarbeitung deiner personenbezogenen\n Daten einverstanden (sofern du dich nicht für ein anonymes Feedback entschieden hast). \n Bitte beachte auch unsere Datenschutzhinweise, die Informationen zu deinem Widerrufsrecht enthalten.", "en": "By submitting your feedback, you consent to the processing of your personal data\n (unless you have opted for anonymous feedback). Please also note our privacy policy, which \n contains information about your right of withdrawal." }, "privacy_policy_url": "<string>" }, "allow_url_retrieval_from_prompt": false, "is_personal_space": false, "enable_file_upload": false, "disable_reranking": false }
Bearer token authentication. Format: 'Bearer '
Pydantic model for a multilingual text.
Show child attributes
Successful Response
Response schema for use case data involved in the GET use_cases request.
Was this page helpful?