Перейти к содержанию

organizations

POST /api/organizations/ensure

Ensure Organization

Request Body:

Поле Тип Обязательное Описание
shared_org_id Shared Org Id да
is_visible Is Visible да

Response 200: Successful Response

Поле Тип Обязательное Описание
status Status нет
shared_org_id Shared Org Id нет
is_visible Is Visible нет

Ошибки:

Код Описание
422 Validation Error

POST /api/organizations/sync

Sync Organizations

Авторизация: Bearer Token

Response 200: Successful Response

Поле Тип Обязательное Описание
added Added нет
total Total нет

GET /api/organizations

List Organizations

Авторизация: Bearer Token

Query параметры:

Параметр Тип По умолчанию Описание
search Search

Response 200: Successful Response

array[OrgResponse]

Поле Тип Обязательное Описание
id Id нет
shared_org_id Shared Org Id нет
name Name нет
region_name Region Name нет
prefix Prefix нет
parent_ids array[integer] нет
is_visible Is Visible нет
sort_order Sort Order нет

Ошибки:

Код Описание
422 Validation Error

GET /api/organizations/tree

Get Organizations Tree

Авторизация: Bearer Token

Response 200: Successful Response

array[OrgTreeNode]

Поле Тип Обязательное Описание
id Id нет
shared_org_id Shared Org Id нет
name Name нет
region_name Region Name нет
prefix Prefix нет
parent_ids array[integer] нет
is_visible Is Visible нет
sort_order Sort Order нет
children array[object] нет

GET /api/organizations/{org_id}

Get Organization

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
org_id Org Id

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
shared_org_id Shared Org Id нет
name Name нет
region_name Region Name нет
prefix Prefix нет
parent_ids array[integer] нет
is_visible Is Visible нет
sort_order Sort Order нет

Ошибки:

Код Описание
422 Validation Error

PUT /api/organizations/{org_id}

Update Organization

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
org_id Org Id

Request Body:

Поле Тип Обязательное Описание
parent_ids Parent Ids нет
is_visible Is Visible нет
sort_order Sort Order нет

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
shared_org_id Shared Org Id нет
name Name нет
region_name Region Name нет
prefix Prefix нет
parent_ids array[integer] нет
is_visible Is Visible нет
sort_order Sort Order нет

Ошибки:

Код Описание
422 Validation Error

GET /api/organizations/{org_id}/settings

Get Org Settings

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
org_id Org Id

Response 200: Successful Response

Поле Тип Обязательное Описание
organization_id Organization Id нет
classifier_id Classifier Id нет
classifier_name Classifier Name нет
caller_summary_prompt Caller Summary Prompt нет
operator_summary_prompt Operator Summary Prompt нет

Ошибки:

Код Описание
422 Validation Error

PUT /api/organizations/{org_id}/settings

Update Org Settings

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
org_id Org Id

Request Body:

Поле Тип Обязательное Описание
classifier_id Classifier Id нет
caller_summary_prompt Caller Summary Prompt нет
operator_summary_prompt Operator Summary Prompt нет

Response 200: Successful Response

Поле Тип Обязательное Описание
organization_id Organization Id нет
classifier_id Classifier Id нет
classifier_name Classifier Name нет
caller_summary_prompt Caller Summary Prompt нет
operator_summary_prompt Operator Summary Prompt нет

Ошибки:

Код Описание
422 Validation Error

POST /api/organizations/{org_id}/generate-prompts

Generate Prompts

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
org_id Org Id

Request Body:

Body

Response 200: Successful Response

Поле Тип Обязательное Описание
caller_summary_prompt Caller Summary Prompt нет
operator_summary_prompt Operator Summary Prompt нет

Ошибки:

Код Описание
422 Validation Error