Business GPT API

Version 3

Path Table

Method	Path	Description
GET	/health	Returns Ok (200) Status Code if the system is healthy, otherwise an InternalServerError (500).
GET	/v2/assistant-options	Endpoint for retrieving a all assistant options.
GET	/v2/assistants	Endpoint for listing all assistants.
POST	/v2/assistants	Endpoint for creating an assistant.
DELETE	/v2/assistants/{uuid}	Endpoint for deleting an assistant (does not include default/legacy assistants).
GET	/v2/assistants/{uuid}	Endpoint for retrieving an custom assistant (does not include default/legacy assistants)
PATCH	/v2/assistants/{uuid}	Endpoint for updating an assistant.
PUT	/v2/assistants/{uuid}	Endpoint for updating an assistant.
POST	/v2/audio/transcriptions	Endpoint for chatting with the custom model
POST	/v2/chat/completions	Endpoint for chatting with the custom model
GET	/v2/configuration	Endpoint for retrieving the configuration.
PUT	/v2/configuration	Endpoint for updating the configuration.
GET	/v2/consumption/{month}	Endpoint for retrieving the consumption data.
GET	/v2/containers	Endpoint for listing all containers.
POST	/v2/containers	Endpoint for creating a container.
DELETE	/v2/containers/{uuid}	Endpoint for deleting a container.
GET	/v2/containers/{uuid}	Endpoint for retrieving a container.
PUT	/v2/containers/{uuid}	Endpoint for updating a container.
GET	/v2/containers/{uuid}/documents	Endpoint for retrieving a all documents in a container.
GET	/v2/documents	Endpoint for listing all content.
POST	/v2/documents	Endpoint for uploading a new file.
PUT	/v2/documents-status	Endpoint for retrieving the status of multiple documents.
DELETE	/v2/documents/{uuid}	Endpoint for deleting files and its metadata.
GET	/v2/documents/{uuid}	Endpoint for requesting metadata about a file.
PUT	/v2/documents/{uuid}	Endpoint for updating files metadata.
GET	/v2/documents/{uuid}/download	Endpoint for downloading files.
PUT	/v2/documents/{uuid}/indexing-priority	Endpoint for prioritizing the indexing of a file.
POST	/v2/embeddings	Endpoint for chatting with the custom model
GET	/v2/groups	Endpoint for retrieving all groups.
POST	/v2/groups	Endpoint for retrieving all groups.
DELETE	/v2/groups/{uuid}	Endpoint for deleting a group.
PUT	/v2/groups/{uuid}	Endpoint for retrieving all groups.
GET	/v2/identity	Endpoint for retrieving the configuration.

Reference Table

Name	Path	Description
ApplicationPermission	#/components/schemas/ApplicationPermission	represents the different roles of the application.
AuthConfigurationDTO	#/components/schemas/AuthConfigurationDTO
ChatCompletionMessage	#/components/schemas/ChatCompletionMessage
ChatCompletionMessageContentImage	#/components/schemas/ChatCompletionMessageContentImage
ChatCompletionMessageContentText	#/components/schemas/ChatCompletionMessageContentText
ChatResponseChoice	#/components/schemas/ChatResponseChoice
ConsumptionStorageDto	#/components/schemas/ConsumptionStorageDto
ConsumptionType	#/components/schemas/ConsumptionType
ContainerDto	#/components/schemas/ContainerDto	A container is a virtual group that holds many files.
DocumentDTOStatus	#/components/schemas/DocumentDTOStatus
DocumentDTOStatusResponse	#/components/schemas/DocumentDTOStatusResponse
DocumentIntelligenceBillingItem	#/components/schemas/DocumentIntelligenceBillingItem
DocumentSearchToolDto	#/components/schemas/DocumentSearchToolDto
Embedding	#/components/schemas/Embedding
EmbeddingUsage	#/components/schemas/EmbeddingUsage
FileIndexingStatus	#/components/schemas/FileIndexingStatus
FileInfoDto	#/components/schemas/FileInfoDto	holds the file meta data.
FrontendSettingsDto	#/components/schemas/FrontendSettingsDto
FunctionDefinition	#/components/schemas/FunctionDefinition
FunctionTool	#/components/schemas/FunctionTool
GroupDTO	#/components/schemas/GroupDTO
HealthDetailedStatus	#/components/schemas/HealthDetailedStatus	Contains information about the application sub-systems health.
Image	#/components/schemas/Image
ImageToolDto	#/components/schemas/ImageToolDto
IndexingJobStatusDto	#/components/schemas/IndexingJobStatusDto
InternetBreakoutTool	#/components/schemas/InternetBreakoutTool
LLMCapability	#/components/schemas/LLMCapability
LanguageConfiguration	#/components/schemas/LanguageConfiguration
LanguageConfigurationDto	#/components/schemas/LanguageConfigurationDto
LanguageConfigurationDto100	#/components/schemas/LanguageConfigurationDto100
LanguageConfigurationDto4000	#/components/schemas/LanguageConfigurationDto4000
LanguageConfigurationDto500	#/components/schemas/LanguageConfigurationDto500
ModelBillingItem	#/components/schemas/ModelBillingItem
ModelOptionDto	#/components/schemas/ModelOptionDto
NewsConfiguration	#/components/schemas/NewsConfiguration
Parameters	#/components/schemas/Parameters
ReferenceDto	#/components/schemas/ReferenceDto	represents a reference to another resource.
RestrictedAssistantDto	#/components/schemas/RestrictedAssistantDto
SecurityClass	#/components/schemas/SecurityClass
SortOrder	#/components/schemas/SortOrder
TemplateVariableDto	#/components/schemas/TemplateVariableDto	A template variable is a variable that can be used in the prompt template.
ToolCall	#/components/schemas/ToolCall
ToolFunction	#/components/schemas/ToolFunction
Tools	#/components/schemas/Tools
ToolsDto	#/components/schemas/ToolsDto	similar to https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
ToolsResourcesDocumentSearchDto	#/components/schemas/ToolsResourcesDocumentSearchDto	resources used by the 'document_search' tool
ToolsResourcesDocumentSearchReferencesDto	#/components/schemas/ToolsResourcesDocumentSearchReferencesDto	resources used by the 'document_search' tool
ToolsResourcesDto	#/components/schemas/ToolsResourcesDto
ToolsResourcesWithReferencesDto	#/components/schemas/ToolsResourcesWithReferencesDto
UploadGroupDTO	#/components/schemas/UploadGroupDTO
bearerAuth	#/components/securitySchemes/bearerAuth

Path Details

---

[GET]/health

• Summary
  Returns Ok (200) Status Code if the system is healthy, otherwise an InternalServerError (500).

Responses

• 200 Contains information about the application health.

application/json

// Contains information about the application health.
{
  healthy: boolean
  status: Partial(#/components/schemas/HealthDetailedStatus) & Partial(null)
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Contains information about the application health.

application/json

// Contains information about the application health.
{
  healthy: boolean
  status: Partial(#/components/schemas/HealthDetailedStatus) & Partial(null)
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/assistant-options

• Summary
  Endpoint for retrieving a all assistant options.

Responses

• 200 Options available for configuring an assistant.

application/json

// Options available for configuring an assistant.
{
  completion_models: {
    capabilities?: enum[image_generation, text_completion, vision_image, embedding, speech_to_text][]
    label: {
      de?: Partial(string) & Partial(null)
      en?: Partial(string) & Partial(null)
    }
    name: string
  }[]
  prompt_template_variables: {
  }
  // similar to https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
  tools: {
    type: enum[images, document_search, internet_breakout]
  }[]
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/assistants

• Summary
  Endpoint for listing all assistants.

Parameters(Query)

offset?: integer

page_size?: integer //default: 20

search_string?: Partial(string) & Partial(null)

sort_by?: enum[name_de, name_en, active] //default: name_en

order_by?: enum[asc, desc]

Responses

• 200

application/json

{
  count: integer
  items: {
    active: boolean
    capabilities?: enum[image_generation, text_completion, vision_image, embedding, speech_to_text][]
    completion_model: string
    container_count: Partial(integer) & Partial(null)
    group_count: Partial(integer) & Partial(null)
    id: string
    information_message?: Partial(#/components/schemas/LanguageConfigurationDto500) & Partial(null)
    label: {
      de?: Partial(string) & Partial(null)
      en?: Partial(string) & Partial(null)
    }
    legacy: boolean
    parameter_values: {
      temperature?: Partial(number) & Partial(null)
      top_p?: Partial(number) & Partial(null)
    }
    security_class: enum[internal, open]
    start_message?: Partial(#/components/schemas/LanguageConfigurationDto4000) & Partial(null)
    // similar to https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
    tools: {
      type: enum[images, document_search, internet_breakout]
    }[]
    tools_resources: {
      document_search?: Partial(#/components/schemas/ToolsResourcesDocumentSearchReferencesDto) & Partial(null)
    }
  }[]
  offset: integer
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[POST]/v2/assistants

• Summary
  Endpoint for creating an assistant.

RequestBody

• application/json

// The assistant as viewed by users with elevated permissions.
{
  active: boolean
  completion_model: string
  groups?: string[]
  information_message?: Partial(#/components/schemas/LanguageConfigurationDto500) & Partial(null)
  label: {
    de?: Partial(string) & Partial(null)
    en?: Partial(string) & Partial(null)
  }
  parameter_values: {
    temperature?: Partial(number) & Partial(null)
    top_p?: Partial(number) & Partial(null)
  }
  start_message?: Partial(#/components/schemas/LanguageConfigurationDto4000) & Partial(null)
  // This is max. 16k, if you set the ENV variable as SYSTEM_PROMPT_MAX_LENGTH. Default: 4k
  system_prompt: string
  // similar to https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
  tools: {
    type: enum[images, document_search, internet_breakout]
  }[]
  tools_resources: {
    document_search?: Partial(#/components/schemas/ToolsResourcesDocumentSearchDto) & Partial(null)
  }
}

Responses

• 200 The assistant as viewed by users with elevated permissions.

application/json

{
  active: boolean
  completion_model: string
  // represents a reference to another resource.
  groups: {
    id: string
    label: string
  }[]
  id: string
  information_message?: Partial(#/components/schemas/LanguageConfigurationDto500) & Partial(null)
  label: {
    de?: Partial(string) & Partial(null)
    en?: Partial(string) & Partial(null)
  }
  legacy: boolean
  order: Partial(integer) & Partial(null)
  parameter_values: {
    temperature?: Partial(number) & Partial(null)
    top_p?: Partial(number) & Partial(null)
  }
  security_class: enum[internal, open]
  start_message?: Partial(#/components/schemas/LanguageConfigurationDto4000) & Partial(null)
  // This is max. 16k, if you set the ENV variable as SYSTEM_PROMPT_MAX_LENGTH. Default: 4k
  system_prompt: string
  time_created: string
  time_updated: Partial(string) & Partial(null)
  // similar to https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
  tools: {
    type: enum[images, document_search, internet_breakout]
  }[]
  tools_resources: {
    document_search?: Partial(#/components/schemas/ToolsResourcesDocumentSearchReferencesDto) & Partial(null)
  }
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[DELETE]/v2/assistants/{uuid}

• Summary
  Endpoint for deleting an assistant (does not include default/legacy assistants).

Responses

• 200 represents a delete response.

application/json

{
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/assistants/{uuid}

• Summary
  Endpoint for retrieving an custom assistant (does not include default/legacy assistants)

Responses

• 200 The assistant as viewed by users with elevated permissions.

application/json

{
  active: boolean
  completion_model: string
  // represents a reference to another resource.
  groups: {
    id: string
    label: string
  }[]
  id: string
  information_message?: Partial(#/components/schemas/LanguageConfigurationDto500) & Partial(null)
  label: {
    de?: Partial(string) & Partial(null)
    en?: Partial(string) & Partial(null)
  }
  legacy: boolean
  order: Partial(integer) & Partial(null)
  parameter_values: {
    temperature?: Partial(number) & Partial(null)
    top_p?: Partial(number) & Partial(null)
  }
  security_class: enum[internal, open]
  start_message?: Partial(#/components/schemas/LanguageConfigurationDto4000) & Partial(null)
  // This is max. 16k, if you set the ENV variable as SYSTEM_PROMPT_MAX_LENGTH. Default: 4k
  system_prompt: string
  time_created: string
  time_updated: Partial(string) & Partial(null)
  // similar to https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
  tools: {
    type: enum[images, document_search, internet_breakout]
  }[]
  tools_resources: {
    document_search?: Partial(#/components/schemas/ToolsResourcesDocumentSearchReferencesDto) & Partial(null)
  }
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[PATCH]/v2/assistants/{uuid}

• Summary
  Endpoint for updating an assistant.

RequestBody

• application/json

{
  active: boolean
}

Responses

• 200 The assistant as viewed by users with elevated permissions.

application/json

{
  active: boolean
  completion_model: string
  // represents a reference to another resource.
  groups: {
    id: string
    label: string
  }[]
  id: string
  information_message?: Partial(#/components/schemas/LanguageConfigurationDto500) & Partial(null)
  label: {
    de?: Partial(string) & Partial(null)
    en?: Partial(string) & Partial(null)
  }
  legacy: boolean
  order: Partial(integer) & Partial(null)
  parameter_values: {
    temperature?: Partial(number) & Partial(null)
    top_p?: Partial(number) & Partial(null)
  }
  security_class: enum[internal, open]
  start_message?: Partial(#/components/schemas/LanguageConfigurationDto4000) & Partial(null)
  // This is max. 16k, if you set the ENV variable as SYSTEM_PROMPT_MAX_LENGTH. Default: 4k
  system_prompt: string
  time_created: string
  time_updated: Partial(string) & Partial(null)
  // similar to https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
  tools: {
    type: enum[images, document_search, internet_breakout]
  }[]
  tools_resources: {
    document_search?: Partial(#/components/schemas/ToolsResourcesDocumentSearchReferencesDto) & Partial(null)
  }
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[PUT]/v2/assistants/{uuid}

• Summary
  Endpoint for updating an assistant.

RequestBody

• application/json

// The assistant as viewed by users with elevated permissions.
{
  active: boolean
  completion_model: string
  groups?: string[]
  id: string
  information_message?: Partial(#/components/schemas/LanguageConfigurationDto500) & Partial(null)
  label: {
    de?: Partial(string) & Partial(null)
    en?: Partial(string) & Partial(null)
  }
  order: Partial(integer) & Partial(null)
  parameter_values: {
    temperature?: Partial(number) & Partial(null)
    top_p?: Partial(number) & Partial(null)
  }
  start_message?: Partial(#/components/schemas/LanguageConfigurationDto4000) & Partial(null)
  // This is max. 16k, if you set the ENV variable as SYSTEM_PROMPT_MAX_LENGTH. Default: 4k
  system_prompt: string
  // similar to https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
  tools: {
    type: enum[images, document_search, internet_breakout]
  }[]
  tools_resources: {
    document_search?: Partial(#/components/schemas/ToolsResourcesDocumentSearchDto) & Partial(null)
  }
}

Responses

• 200 The assistant as viewed by users with elevated permissions.

application/json

{
  active: boolean
  completion_model: string
  // represents a reference to another resource.
  groups: {
    id: string
    label: string
  }[]
  id: string
  information_message?: Partial(#/components/schemas/LanguageConfigurationDto500) & Partial(null)
  label: {
    de?: Partial(string) & Partial(null)
    en?: Partial(string) & Partial(null)
  }
  legacy: boolean
  order: Partial(integer) & Partial(null)
  parameter_values: {
    temperature?: Partial(number) & Partial(null)
    top_p?: Partial(number) & Partial(null)
  }
  security_class: enum[internal, open]
  start_message?: Partial(#/components/schemas/LanguageConfigurationDto4000) & Partial(null)
  // This is max. 16k, if you set the ENV variable as SYSTEM_PROMPT_MAX_LENGTH. Default: 4k
  system_prompt: string
  time_created: string
  time_updated: Partial(string) & Partial(null)
  // similar to https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
  tools: {
    type: enum[images, document_search, internet_breakout]
  }[]
  tools_resources: {
    document_search?: Partial(#/components/schemas/ToolsResourcesDocumentSearchReferencesDto) & Partial(null)
  }
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[POST]/v2/audio/transcriptions

• Summary
  Endpoint for chatting with the custom model

• Description

This endpoint is used to chat with a given chat approach.
It is a protected endpoint and requires a valid JWT token to access it.

RequestBody

• multipart/form-data

{
  file: string
  language?: Partial(string) & Partial(null)
  model: string
}

Responses

• 200

application/json

{
  text: string
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[POST]/v2/chat/completions

• Summary
  Endpoint for chatting with the custom model

• Description

This endpoint is used to chat with a given chat approach.
It is a protected endpoint and requires a valid JWT token to access it.

RequestBody

• application/json

// ChatRequest represents the chat request data.
// 
// https://platform.openai.com/docs/api-reference/chat/create
{
  frequency_penalty?: Partial(number) & Partial(null)
  logit_bias?: Partial({
   }) & Partial(null)
  logprobs?: Partial(boolean) & Partial(null)
  max_completion_tokens?: Partial(integer) & Partial(null)
  max_tokens?: Partial(integer) & Partial(null)
  messages: {
    content: Partial(string) & Partial(     undefined?: Partial(#/components/schemas/ChatCompletionMessageContentImage) & Partial(#/components/schemas/ChatCompletionMessageContentText)[]) & Partial(null)
    name?: Partial(string) & Partial(null)
    role: Partial(string) & Partial(null)
    tool?: Partial(string) & Partial(null)
    tool_call_id?: Partial(string) & Partial(null)
    tool_calls?: Partial({
       function: {
         arguments: string
         name: Partial(string) & Partial(null)
       }
       id: Partial(string) & Partial(null)
       type: Partial(string) & Partial(null)
     }[]) & Partial(null)
  }[]
  modalities?: string[]
  // model is not the model name. You have to use the assistant UUID.
  model: string
  n?: Partial(integer) & Partial(null)
  parallel_tool_calls?: Partial(boolean) & Partial(null)
  prediction?: Partial() & Partial(null)
  presence_penalty?: Partial(number) & Partial(null)
  reasoning_effort?: Partial(string) & Partial(null)
  response_format?: Partial() & Partial(null)
  seed?: Partial(integer) & Partial(null)
  stop?: Partial(string) & Partial(string[]) & Partial(null)
  stream?: boolean
  temperature?: Partial(number) & Partial(null)
  tool_choice?: Partial() & Partial(null)
  tools?: Partial(#/components/schemas/DocumentSearchToolDto) & Partial(#/components/schemas/InternetBreakoutTool) & Partial(#/components/schemas/ImageToolDto) & Partial(#/components/schemas/FunctionTool)[]
  top_logprobs?: Partial(integer) & Partial(null)
  top_p?: Partial(number) & Partial(null)
  user?: Partial(string) & Partial(null)
}

Responses

• 200

application/json

{
  choices: {
    finish_reason: Partial(string) & Partial(null)
    index: integer
    message: {
      content: Partial(string) & Partial(       undefined?: Partial(#/components/schemas/ChatCompletionMessageContentImage) & Partial(#/components/schemas/ChatCompletionMessageContentText)[]) & Partial(null)
      name?: Partial(string) & Partial(null)
      role: Partial(string) & Partial(null)
      tool?: Partial(string) & Partial(null)
      tool_call_id?: Partial(string) & Partial(null)
      tool_calls?: Partial({
         function: {
           arguments: string
           name: Partial(string) & Partial(null)
         }
         id: Partial(string) & Partial(null)
         type: Partial(string) & Partial(null)
       }[]) & Partial(null)
    }
  }[]
  created: integer
  id: string
  model: string
  object?: string //default: chat.completion
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/configuration

• Summary
  Endpoint for retrieving the configuration.

• Description

This endpoint is used to retrieve configuration options, like base settings for models.
It is a protected endpoint and requires a valid JWT token to access it.

Responses

• 200

application/json

{
  accent_color: string
  auth_configuration: {
    auth_client_id: string
    auth_provider: string
  }
  background: integer
  budget_reached: boolean
  company_logo_url: Partial(string) & Partial(null)
  company_name: string
  feature_flags: {
  }
  frontend_settings: {
    file_size_limit_mb: integer
    private_files_limit: integer
    system_prompt_max_length: integer
  }
  news: Partial(#/components/schemas/LanguageConfiguration) & Partial(null)
  telekom_news: Partial(#/components/schemas/NewsConfiguration) & Partial(null)
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[PUT]/v2/configuration

• Summary
  Endpoint for updating the configuration.

• Description

This endpoint is used to update configuration options, like base settings for models.

RequestBody

• application/json

{
  accent_color: string
  background: integer
  company_logo_url: Partial(string) & Partial(null)
  company_name: string
  news: Partial(#/components/schemas/LanguageConfiguration) & Partial(null)
  telekom_news: Partial(#/components/schemas/NewsConfiguration) & Partial(null)
}

Responses

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/consumption/{month}

• Summary
  Endpoint for retrieving the consumption data.

• Description

This Endpoint is used to retrieve consumptio data.
It is a protected endpoint and requires a valid JWT token to access it.

Responses

• 200 Consumption information for the current period.

application/json

// Consumption information for the current period.
{
  billing_items?: Partial(#/components/schemas/DocumentIntelligenceBillingItem) & Partial(#/components/schemas/ModelBillingItem)[]
  chatting_cost: number
  currency: enum[EUR, USD]
  indexing_cost: number
  overall_budget: number
  overall_cost: number
  overall_remaining_budget: number
  percentage_budget_used: integer
  period_end: string
  period_start: string
  storage: {
    file_count: integer
    files_size: integer
  }
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/containers

• Summary
  Endpoint for listing all containers.

• Description

It is a protected endpoint and requires a valid JWT token to access it.

Parameters(Query)

offset?: integer

page_size?: integer //default: 20

search_string?: Partial(string) & Partial(null)

by_assistant?: Partial(string) & Partial(null)

sort_by?: string //default: name

order_by?: enum[asc, desc]

Responses

• 200

application/json

{
  count: integer
  // A container is a virtual group that holds many files.
  items: {
    color?: string
    description?: Partial(string) & Partial(null)
    display_name: string
    document_count: integer
    // represents a reference to another resource.
    groups: {
      id: string
      label: string
    }[]
    id: string
    status: enum[not_indexed, indexing, indexed, error]
  }[]
  offset: integer
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[POST]/v2/containers

• Summary
  Endpoint for creating a container.

• Description

It is a protected endpoint and requires a valid JWT token to access it.

RequestBody

• application/json

// A container is a virtual group that holds many files.
{
  color?: string
  description?: Partial(string) & Partial(null)
  display_name: string
  groups?: string[]
}

Responses

• 200 A container is a virtual group that holds many files.

application/json

// A container is a virtual group that holds many files.
{
  color?: string
  description?: Partial(string) & Partial(null)
  display_name: string
  document_count: integer
  // represents a reference to another resource.
  groups: {
    id: string
    label: string
  }[]
  id: string
  status: enum[not_indexed, indexing, indexed, error]
}

• 400 DuplicateEntryProblem(lang: gettext.NullTranslations)

application/json

{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type?: string //default: tag:businessgpt@telekom.de,2024-09-01:DuplicateEntry
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[DELETE]/v2/containers/{uuid}

• Summary
  Endpoint for deleting a container.

• Description

It is a protected endpoint and requires a valid JWT token to access it.

Responses

• 200 represents a delete response.

application/json

{
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/containers/{uuid}

• Summary
  Endpoint for retrieving a container.

• Description

It is a protected endpoint and requires a valid JWT token to access it.

Responses

• 200 A container is a virtual group that holds many files.

application/json

// A container is a virtual group that holds many files.
{
  color?: string
  description?: Partial(string) & Partial(null)
  display_name: string
  document_count: integer
  // represents a reference to another resource.
  groups: {
    id: string
    label: string
  }[]
  id: string
  status: enum[not_indexed, indexing, indexed, error]
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[PUT]/v2/containers/{uuid}

• Summary
  Endpoint for updating a container.

• Description

It is a protected endpoint and requires a valid JWT token to access it.

RequestBody

• application/json

// A container is a virtual group that holds many files.
{
  color?: string
  description?: Partial(string) & Partial(null)
  display_name: string
  groups?: string[]
  id: string
}

Responses

• 200 A container is a virtual group that holds many files.

application/json

// A container is a virtual group that holds many files.
{
  color?: string
  description?: Partial(string) & Partial(null)
  display_name: string
  document_count: integer
  // represents a reference to another resource.
  groups: {
    id: string
    label: string
  }[]
  id: string
  status: enum[not_indexed, indexing, indexed, error]
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/containers/{uuid}/documents

• Summary
  Endpoint for retrieving a all documents in a container.

• Description

It is a protected endpoint and requires a valid JWT token to access it.

Parameters(Query)

offset?: integer

page_size?: integer //default: 20

search_string?: Partial(string) & Partial(null)

status?: Partial(#/components/schemas/IndexingJobStatusDto) & Partial(null)

sort_by?: enum[name, indexed, id, mimetype, file_extension, time_created, time_updated] //default: name

order_by?: enum[asc, desc]

Responses

• 200

application/json

{
  count: integer
  currentlyIndexingCount: integer
  errorIndexedCount: integer
  indexedCount: integer
  // holds the file meta data.
  items: {
    backlink?: Partial(string) & Partial(null)
    // represents a reference to another resource.
    containers: {
      id: string
      label: string
    }[]
    description: string
    file_extension: Partial(string) & Partial(null)
    id: string
    index_error: Partial(string) & Partial(null)
    indexed: enum[not_indexed, indexing, indexed, error]
    mimetype: Partial(string) & Partial(null)
    name: string
    time_created: string
    time_updated: Partial(string) & Partial(null)
    version: integer
  }[]
  notIndexedCount: integer
  offset: integer
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/documents

• Summary
  Endpoint for listing all content.

• Description

This endpoint is used to retrieve a list of all content.
It is a protected endpoint and requires a valid JWT token to access it.

Parameters(Query)

offset?: integer

page_size?: integer //default: 20

search_string?: Partial(string) & Partial(null)

status?: Partial(#/components/schemas/IndexingJobStatusDto) & Partial(null)

sort_by?: enum[name, indexed, id, mimetype, file_extension, time_created, time_updated] //default: name

order_by?: enum[asc, desc]

Responses

• 200

application/json

{
  count: integer
  currentlyIndexingCount: integer
  errorIndexedCount: integer
  indexedCount: integer
  // holds the file meta data.
  items: {
    backlink?: Partial(string) & Partial(null)
    // represents a reference to another resource.
    containers: {
      id: string
      label: string
    }[]
    description: string
    file_extension: Partial(string) & Partial(null)
    id: string
    index_error: Partial(string) & Partial(null)
    indexed: enum[not_indexed, indexing, indexed, error]
    mimetype: Partial(string) & Partial(null)
    name: string
    time_created: string
    time_updated: Partial(string) & Partial(null)
    version: integer
  }[]
  notIndexedCount: integer
  offset: integer
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[POST]/v2/documents

• Summary
  Endpoint for uploading a new file.

• Description

This endpoint is used to upload the given file to the storage.
It is a protected endpoint and requires a valid JWT token to access it.

RequestBody

• multipart/form-data

// holds the file meta data for creating a new file.
{
  backlink?: Partial(string) & Partial(null)
  container: string
  data: string
  description: string
  mimetype: Partial(string) & Partial(null)
  name: string
  reference_id?: Partial(string) & Partial(null)
}

Responses

• 200 holds the file meta data.

application/json

// holds the file meta data.
{
  backlink?: Partial(string) & Partial(null)
  // represents a reference to another resource.
  containers: {
    id: string
    label: string
  }[]
  description: string
  file_extension: Partial(string) & Partial(null)
  id: string
  index_error: Partial(string) & Partial(null)
  indexed: enum[not_indexed, indexing, indexed, error]
  mimetype: Partial(string) & Partial(null)
  name: string
  time_created: string
  time_updated: Partial(string) & Partial(null)
  version: integer
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[PUT]/v2/documents-status

• Summary
  Endpoint for retrieving the status of multiple documents.

RequestBody

• application/json

{
  document_ids?: string[]
}

Responses

• 200

application/json

{
  id: string
  status: enum[pending, started, completed, error, finished]
}[]

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[DELETE]/v2/documents/{uuid}

• Summary
  Endpoint for deleting files and its metadata.

• Description

It is a protected endpoint and requires a valid JWT token to access it.

Responses

• 200 represents a delete response.

application/json

{
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/documents/{uuid}

• Summary
  Endpoint for requesting metadata about a file.

• Description

It is a protected endpoint and requires a valid JWT token to access it.

Responses

• 200 holds the file meta data.

application/json

// holds the file meta data.
{
  backlink?: Partial(string) & Partial(null)
  // represents a reference to another resource.
  containers: {
    id: string
    label: string
  }[]
  description: string
  file_extension: Partial(string) & Partial(null)
  id: string
  index_error: Partial(string) & Partial(null)
  indexed: enum[not_indexed, indexing, indexed, error]
  mimetype: Partial(string) & Partial(null)
  name: string
  time_created: string
  time_updated: Partial(string) & Partial(null)
  version: integer
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[PUT]/v2/documents/{uuid}

• Summary
  Endpoint for updating files metadata.

• Description

It is a protected endpoint and requires a valid JWT token to access it.

RequestBody

• application/json

// holds the file meta data, for updating an existing file.
{
  containers?: string[]
  description: string
  id: string
  mimetype: Partial(string) & Partial(null)
  name: string
}

Responses

• 200 holds the file meta data.

application/json

// holds the file meta data.
{
  backlink?: Partial(string) & Partial(null)
  // represents a reference to another resource.
  containers: {
    id: string
    label: string
  }[]
  description: string
  file_extension: Partial(string) & Partial(null)
  id: string
  index_error: Partial(string) & Partial(null)
  indexed: enum[not_indexed, indexing, indexed, error]
  mimetype: Partial(string) & Partial(null)
  name: string
  time_created: string
  time_updated: Partial(string) & Partial(null)
  version: integer
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/documents/{uuid}/download

• Summary
  Endpoint for downloading files.

• Description

This endpoint is used to download the given file.
It is a protected endpoint and requires a valid JWT token to access it.

Responses

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[PUT]/v2/documents/{uuid}/indexing-priority

• Summary
  Endpoint for prioritizing the indexing of a file.

Responses

• 200

application/json

{
  "title": "FileIndexActionDTO"
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[POST]/v2/embeddings

• Summary
  Endpoint for chatting with the custom model

• Description

This endpoint is used to chat with a given chat approach.
It is a protected endpoint and requires a valid JWT token to access it.

RequestBody

• application/json

// Request for generating an embedding.
// Link: https://platform.openai.com/docs/api-reference/embeddings
{
  encoding_format: Partial(string) & Partial(string)
  input: Partial(string) & Partial(string[])
  model: string
}

Responses

• 200 Response containing the embedding vector. Link: https://platform.openai.com/docs/api-reference/embeddings

application/json

// Response containing the embedding vector.
// Link: https://platform.openai.com/docs/api-reference/embeddings
{
  data: {
    embedding?: number[]
    index: integer
    object?: string //default: embedding
  }[]
  model: string
  object?: string //default: list
  usage: {
    prompt_tokens: integer
    total_tokens: integer
  }
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/groups

• Summary
  Endpoint for retrieving all groups.

Parameters(Query)

offset?: integer

page_size?: integer //default: 20

search_string?: Partial(string) & Partial(null)

show_hidden?: boolean

sort_by?: enum[name, label, id, time_created, time_updated] //default: name

order_by?: enum[asc, desc]

Responses

• 200

application/json

{
  count: integer
  items: {
    hidden: boolean
    id: string
    label: string
    name: string
    time_created: string
    time_updated: Partial(string) & Partial(null)
  }[]
  offset: integer
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[POST]/v2/groups

• Summary
  Endpoint for retrieving all groups.

RequestBody

• application/json

{
  hidden: boolean
  label: string
  name: string
}[]

Responses

• 200

application/json

{
  hidden: boolean
  id: string
  label: string
  name: string
  time_created: string
  time_updated: Partial(string) & Partial(null)
}[]

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[DELETE]/v2/groups/{uuid}

• Summary
  Endpoint for deleting a group.

• Description

It is a protected endpoint and requires a valid JWT token to access it.

Responses

• 200 represents a delete response.

application/json

{
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[PUT]/v2/groups/{uuid}

• Summary
  Endpoint for retrieving all groups.

RequestBody

• application/json

{
  hidden: boolean
  id: string
  label: string
  name: string
}

Responses

• 200

application/json

{
  hidden: boolean
  id: string
  label: string
  name: string
  time_created: string
  time_updated: Partial(string) & Partial(null)
}

• 400 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

---

[GET]/v2/identity

• Summary
  Endpoint for retrieving the configuration.

• Description

This endpoint is used to retrieve configuration options, like base settings for models.
It is a protected endpoint and requires a valid JWT token to access it.

Responses

• 200 Holds roles, groups and permissions of a user for the frontend.

application/json

// Holds roles, groups and permissions of a user for the frontend.
{
  groups?: string[]
  // represents the different roles of the application.
  // 
  // As documented in https://confluence.telekom-mms.com/display/BGTPPM/Roles+and+rights
  permissions?: enum[configuration_read, configuration_update, consumption_read, containers_super_admin, assistants_create, assistants_read, assistants_update, assistants_delete, containers_create, containers_read, containers_update, containers_delete, private_containers_access, documents_create, documents_read, documents_update, documents_delete, groups_create, groups_read, groups_update, groups_delete, indexing_create][]
  private_container_id: string
  roles?: string[]
}

• 401 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 403 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 404 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 415 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 429 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 500 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 501 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

• 503 Our extension of the Standard, inspired by RFC8457 https://www.rfc-editor.org/rfc/rfc9457.html

application/json

// Our extension of the Standard, inspired by RFC8457
// https://www.rfc-editor.org/rfc/rfc9457.html
{
  detail?: Partial(string) & Partial(null)
  errors?: Partial({
   }) & Partial(null)
  status: integer
  title: string
  trace_id?: Partial(string) & Partial(null)
  type: string
}

References

#/components/schemas/ApplicationPermission

{
  "description": "represents the different roles of the application.\n\nAs documented in https://confluence.telekom-mms.com/display/BGTPPM/Roles+and+rights",
  "enum": [
    "configuration_read",
    "configuration_update",
    "consumption_read",
    "containers_super_admin",
    "assistants_create",
    "assistants_read",
    "assistants_update",
    "assistants_delete",
    "containers_create",
    "containers_read",
    "containers_update",
    "containers_delete",
    "private_containers_access",
    "documents_create",
    "documents_read",
    "documents_update",
    "documents_delete",
    "groups_create",
    "groups_read",
    "groups_update",
    "groups_delete",
    "indexing_create"
  ],
  "title": "ApplicationPermission",
  "type": "string"
}

#/components/schemas/AuthConfigurationDTO

{
  auth_client_id: string
  auth_provider: string
}

#/components/schemas/ChatCompletionMessage

{
  content: Partial(string) & Partial(   undefined?: Partial(#/components/schemas/ChatCompletionMessageContentImage) & Partial(#/components/schemas/ChatCompletionMessageContentText)[]) & Partial(null)
  name?: Partial(string) & Partial(null)
  role: Partial(string) & Partial(null)
  tool?: Partial(string) & Partial(null)
  tool_call_id?: Partial(string) & Partial(null)
  tool_calls?: Partial({
     function: {
       arguments: string
       name: Partial(string) & Partial(null)
     }
     id: Partial(string) & Partial(null)
     type: Partial(string) & Partial(null)
   }[]) & Partial(null)
}

#/components/schemas/ChatCompletionMessageContentImage

{
  image_url: Partial(#/components/schemas/Image) & Partial(null)
  type?: string //default: image_url
}

#/components/schemas/ChatCompletionMessageContentText

{
  text: Partial(string) & Partial(null)
  type?: string //default: text
}

#/components/schemas/ChatResponseChoice

{
  finish_reason: Partial(string) & Partial(null)
  index: integer
  message: {
    content: Partial(string) & Partial(     undefined?: Partial(#/components/schemas/ChatCompletionMessageContentImage) & Partial(#/components/schemas/ChatCompletionMessageContentText)[]) & Partial(null)
    name?: Partial(string) & Partial(null)
    role: Partial(string) & Partial(null)
    tool?: Partial(string) & Partial(null)
    tool_call_id?: Partial(string) & Partial(null)
    tool_calls?: Partial({
       function: {
         arguments: string
         name: Partial(string) & Partial(null)
       }
       id: Partial(string) & Partial(null)
       type: Partial(string) & Partial(null)
     }[]) & Partial(null)
  }
}

#/components/schemas/ConsumptionStorageDto

{
  file_count: integer
  files_size: integer
}

#/components/schemas/ConsumptionType

{
  "enum": [
    "indexing",
    "chatting",
    "image_generation"
  ],
  "title": "ConsumptionType",
  "type": "string"
}

#/components/schemas/ContainerDto

// A container is a virtual group that holds many files.
{
  color?: string
  description?: Partial(string) & Partial(null)
  display_name: string
  document_count: integer
  // represents a reference to another resource.
  groups: {
    id: string
    label: string
  }[]
  id: string
  status: enum[not_indexed, indexing, indexed, error]
}

#/components/schemas/DocumentDTOStatus

{
  "enum": [
    "pending",
    "started",
    "completed",
    "error",
    "finished"
  ],
  "title": "DocumentDTOStatus",
  "type": "string"
}

#/components/schemas/DocumentDTOStatusResponse

{
  id: string
  status: enum[pending, started, completed, error, finished]
}

#/components/schemas/DocumentIntelligenceBillingItem

{
  billing_group: enum[indexing, chatting, image_generation]
  current_cost: number
  label: string
  price_per_unit: number
  type: string
  unit: enum[tokens, pages, images]
  used_unit_count: integer
}

#/components/schemas/DocumentSearchToolDto

{
  containers?: Partial(string[]) & Partial(null)
  documents?: Partial(string[]) & Partial(null)
  top_k?: Partial(integer) & Partial(null)
  type?: string //default: document_search
}

#/components/schemas/Embedding

{
  embedding?: number[]
  index: integer
  object?: string //default: embedding
}

#/components/schemas/EmbeddingUsage

{
  prompt_tokens: integer
  total_tokens: integer
}

#/components/schemas/FileIndexingStatus

{
  "enum": [
    "not_indexed",
    "indexing",
    "indexed",
    "error"
  ],
  "title": "FileIndexingStatus",
  "type": "string"
}

#/components/schemas/FileInfoDto

// holds the file meta data.
{
  backlink?: Partial(string) & Partial(null)
  // represents a reference to another resource.
  containers: {
    id: string
    label: string
  }[]
  description: string
  file_extension: Partial(string) & Partial(null)
  id: string
  index_error: Partial(string) & Partial(null)
  indexed: enum[not_indexed, indexing, indexed, error]
  mimetype: Partial(string) & Partial(null)
  name: string
  time_created: string
  time_updated: Partial(string) & Partial(null)
  version: integer
}

#/components/schemas/FrontendSettingsDto

{
  file_size_limit_mb: integer
  private_files_limit: integer
  system_prompt_max_length: integer
}

#/components/schemas/FunctionDefinition

{
  description?: string
  name: string
  strict?: boolean
}

#/components/schemas/FunctionTool

{
  function: {
    description?: string
    name: string
    strict?: boolean
  }
  type?: string //default: function
}

#/components/schemas/GroupDTO

{
  hidden: boolean
  id: string
  label: string
  name: string
  time_created: string
  time_updated: Partial(string) & Partial(null)
}

#/components/schemas/HealthDetailedStatus

// Contains information about the application sub-systems health.
{
  budget?: Partial(integer) & Partial(null)
  commit_hash?: Partial(string) & Partial(null)
  commit_tag?: Partial(string) & Partial(null)
  current_budget_usd?: Partial(number) & Partial(null)
  database_code_migration_level?: Partial(integer) & Partial(null)
  database_migration_level?: Partial(string) & Partial(null)
  status_database?: Partial(boolean) & Partial(null)
  status_openai?: Partial(boolean) & Partial(null)
  status_search?: Partial(boolean) & Partial(null)
  status_user_authentication?: Partial(boolean) & Partial(null)
}

#/components/schemas/Image

{
  b64_json?: Partial(string) & Partial(null)
  url?: Partial(string) & Partial(null)
}

#/components/schemas/ImageToolDto

{
  model?: Partial(string) & Partial(null)
  size?: Partial(string) & Partial(null)
  type?: string //default: images
}

#/components/schemas/IndexingJobStatusDto

{
  "enum": [
    "pending",
    "started",
    "completed",
    "error"
  ],
  "title": "IndexingJobStatusDto",
  "type": "string"
}

#/components/schemas/InternetBreakoutTool

{
  type?: string //default: internet_breakout
}

#/components/schemas/LLMCapability

{
  "enum": [
    "image_generation",
    "text_completion",
    "vision_image",
    "embedding",
    "speech_to_text"
  ],
  "title": "LLMCapability",
  "type": "string"
}

#/components/schemas/LanguageConfiguration

{
  de?: Partial(string) & Partial(null)
  en?: Partial(string) & Partial(null)
}

#/components/schemas/LanguageConfigurationDto

{
  de?: Partial(string) & Partial(null)
  en?: Partial(string) & Partial(null)
}

#/components/schemas/LanguageConfigurationDto100

{
  de?: Partial(string) & Partial(null)
  en?: Partial(string) & Partial(null)
}

#/components/schemas/LanguageConfigurationDto4000

{
  de?: Partial(string) & Partial(null)
  en?: Partial(string) & Partial(null)
}

#/components/schemas/LanguageConfigurationDto500

{
  de?: Partial(string) & Partial(null)
  en?: Partial(string) & Partial(null)
}

#/components/schemas/ModelBillingItem

{
  billing_group: enum[indexing, chatting, image_generation]
  current_cost: number
  label: string
  model_key: string
  price_per_unit: number
  token_type: Partial(string) & Partial(null)
  type: string
  unit: enum[tokens, pages, images]
  used_unit_count: integer
}

#/components/schemas/ModelOptionDto

{
  capabilities?: enum[image_generation, text_completion, vision_image, embedding, speech_to_text][]
  label: {
    de?: Partial(string) & Partial(null)
    en?: Partial(string) & Partial(null)
  }
  name: string
}

#/components/schemas/NewsConfiguration

{
  content?: Partial(#/components/schemas/LanguageConfiguration) & Partial(null)
  version?: Partial(integer) & Partial(null)
}

#/components/schemas/Parameters

{
  temperature?: Partial(number) & Partial(null)
  top_p?: Partial(number) & Partial(null)
}

#/components/schemas/ReferenceDto

// represents a reference to another resource.
{
  id: string
  label: string
}

#/components/schemas/RestrictedAssistantDto

{
  active: boolean
  capabilities?: enum[image_generation, text_completion, vision_image, embedding, speech_to_text][]
  completion_model: string
  container_count: Partial(integer) & Partial(null)
  group_count: Partial(integer) & Partial(null)
  id: string
  information_message?: Partial(#/components/schemas/LanguageConfigurationDto500) & Partial(null)
  label: {
    de?: Partial(string) & Partial(null)
    en?: Partial(string) & Partial(null)
  }
  legacy: boolean
  parameter_values: {
    temperature?: Partial(number) & Partial(null)
    top_p?: Partial(number) & Partial(null)
  }
  security_class: enum[internal, open]
  start_message?: Partial(#/components/schemas/LanguageConfigurationDto4000) & Partial(null)
  // similar to https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
  tools: {
    type: enum[images, document_search, internet_breakout]
  }[]
  tools_resources: {
    document_search?: Partial(#/components/schemas/ToolsResourcesDocumentSearchReferencesDto) & Partial(null)
  }
}

#/components/schemas/SecurityClass

{
  "enum": [
    "internal",
    "open"
  ],
  "title": "SecurityClass",
  "type": "string"
}

#/components/schemas/SortOrder

{
  "enum": [
    "asc",
    "desc"
  ],
  "title": "SortOrder",
  "type": "string"
}

#/components/schemas/TemplateVariableDto

// A template variable is a variable that can be used in the prompt template.
{
  description: {
    de?: Partial(string) & Partial(null)
    en?: Partial(string) & Partial(null)
  }
  name: string
}

#/components/schemas/ToolCall

{
  function: {
    arguments: string
    name: Partial(string) & Partial(null)
  }
  id: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

#/components/schemas/ToolFunction

{
  arguments: string
  name: Partial(string) & Partial(null)
}

#/components/schemas/Tools

{
  "enum": [
    "images",
    "document_search",
    "internet_breakout"
  ],
  "title": "Tools",
  "type": "string"
}

#/components/schemas/ToolsDto

// similar to https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
{
  type: enum[images, document_search, internet_breakout]
}

#/components/schemas/ToolsResourcesDocumentSearchDto

// resources used by the 'document_search' tool
{
  containers?: string[]
  top_k?: Partial(integer) & Partial(null)
}

#/components/schemas/ToolsResourcesDocumentSearchReferencesDto

// resources used by the 'document_search' tool
{
  // represents a reference to another resource.
  containers: {
    id: string
    label: string
  }[]
  top_k?: Partial(integer) & Partial(null)
}

#/components/schemas/ToolsResourcesDto

{
  document_search?: Partial(#/components/schemas/ToolsResourcesDocumentSearchDto) & Partial(null)
}

#/components/schemas/ToolsResourcesWithReferencesDto

{
  document_search?: Partial(#/components/schemas/ToolsResourcesDocumentSearchReferencesDto) & Partial(null)
}

#/components/schemas/UploadGroupDTO

{
  hidden: boolean
  label: string
  name: string
}

#/components/securitySchemes/bearerAuth

{
  "bearerFormat": "JWT",
  "scheme": "bearer",
  "type": "http"
}