RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.
Go agent-harnessagent-native-databaseagentic-aiagentic-retrievalagentic-searchaiai-agentscontext-enginecontext-engineeringcontext-managementharness-engineeringknowledge-compilationragretrieval-augmented-generationretrieval-harnesssearch-harness
/*
* Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { history } from '@/utils/simple-history-util';
import axios from 'axios';
import message from '@/components/ui/message';
import { Authorization } from '@/constants/authorization';
import i18n from '@/locales/config';
import { Routes } from '@/routes';
import api from '@/utils/api';
import { adminStorage } from '@/utils/authorization-util';
import { convertTheKeysOfTheObjectToSnake } from '@/utils/common-util';
import { ResultCode, RetcodeMessage } from '@/utils/request';
import {
adaptServiceDetail,
adaptServiceList,
GoServiceStatus,
} from './admin-service-adapter';
const request = axios.create({
timeout: 300000,
});
request.interceptors.request.use((config) => {
const data = convertTheKeysOfTheObjectToSnake(config.data);
const params = convertTheKeysOfTheObjectToSnake(config.params) as any;
const newConfig = { ...config, data, params };
// @ts-ignore
if (!newConfig.skipToken) {
newConfig.headers.set(Authorization, adminStorage.getAuthorization());
}
return newConfig;
});
request.interceptors.response.use(
(response) => {
if (response.config.responseType === 'blob') {
return response;
}
const { data } = response ?? {};
if (data?.code === 100) {
message.error(data?.message, { position: 'top-right' });
} else if (data?.code === 401) {
message.error(data?.message, {
description: data?.message,
position: 'top-right',
});
adminStorage.removeAll();
history.push(Routes.Admin);
window.location.reload();
} else if (data?.code && data.code !== 0) {
message.error(`${i18n.t('message.hint')}: ${data?.code}`, {
description: data?.message,
position: 'top-right',
});
}
return response;
},
(error) => {
const { response } = error;
const { data } = response ?? {};
if (error.message === 'Failed to fetch') {
message.error({
description: i18n.t('message.networkAnomalyDescription'),
message: i18n.t('message.networkAnomaly'),
});
} else if (data?.code === 100) {
message.error(data?.message);
} else if (response.status === 401 || data?.code === 401) {
message.error({
message: data?.message || response.statusText,
description:
data?.message || RetcodeMessage[response?.status as ResultCode],
duration: 3,
});
adminStorage.removeAll();
history.push(Routes.Admin);
window.location.reload();
} else if (data?.code && data.code !== 0) {
message.error({
message: `${i18n.t('message.hint')}: ${data?.code}`,
description: data?.message,
duration: 3,
});
} else if (response.status) {
message.error({
message: `${i18n.t('message.requestError')} ${response.status}: ${response.config.url}`,
description:
RetcodeMessage[response.status as ResultCode] || response.statusText,
});
} else if (response.status === 413 || response?.status === 504) {
message.error(RetcodeMessage[response?.status as ResultCode]);
}
throw error;
},
);
const {
adminLogin,
adminLogout,
adminListUsers,
adminCreateUser,
adminGetUserDetails,
adminUpdateUserStatus,
adminUpdateUserPassword,
adminDeleteUser,
adminListUserDatasets,
adminListUserAgents,
adminListServices,
adminShowServiceDetails,
adminListRoles,
adminListRolesWithPermission,
adminCreateRole,
adminDeleteRole,
adminUpdateRoleDescription,
adminGetRolePermissions,
adminAssignRolePermissions,
adminRevokeRolePermissions,
adminGetUserPermissions,
adminUpdateUserRole,
adminListResources,
adminListWhitelist,
adminCreateWhitelistEntry,
adminUpdateWhitelistEntry,
adminDeleteWhitelistEntry,
adminImportWhitelist,
adminGetSystemVersion,
adminListSandboxProviders,
adminGetSandboxProviderSchema,
adminGetSandboxConfig,
adminSetSandboxConfig,
adminTestSandboxConnection,
} = api;
type ResponseData<D = NonNullable<unknown>> = {
code: number;
message: string;
data: D;
};
export const login = (params: { email: string; password: string }) =>
request.post<ResponseData<AdminService.LoginData>>(adminLogin, params);
export const logout = () => request.post<ResponseData<void>>(adminLogout);
export const listUsers = () =>
request.get<ResponseData<AdminService.ListUsersItem[]>>(adminListUsers, {});
export const createUser = (email: string, password: string) =>
request.post<ResponseData<Record<string, unknown>>>(adminCreateUser, {
username: email,
password,
});
export const grantSuperuser = (email: string) =>
request.put<ResponseData<void>>(api.adminSetSuperuser(email));
export const revokeSuperuser = (email: string) =>
request.delete<ResponseData<void>>(api.adminSetSuperuser(email));
export const getUserDetails = (email: string) =>
request.get<ResponseData<[AdminService.UserDetail]>>(
adminGetUserDetails(email),
);
export const listUserDatasets = (email: string) =>
request.get<ResponseData<AdminService.ListUserDatasetItem[]>>(
adminListUserDatasets(email),
);
export const listUserAgents = (email: string) =>
request.get<ResponseData<AdminService.ListUserAgentItem[]>>(
adminListUserAgents(email),
);
export const updateUserStatus = (email: string, status: 'on' | 'off') =>
request.put(adminUpdateUserStatus(email), { activate_status: status });
export const updateUserPassword = (email: string, password: string) =>
request.put(adminUpdateUserPassword(email), { new_password: password });
export const deleteUser = (email: string) =>
request.delete(adminDeleteUser(email));
export const listServices = async () => {
const { data } =
await request.get<ResponseData<GoServiceStatus[]>>(adminListServices);
return data.code === 0 ? adaptServiceList(data.data) : [];
};
export const showServiceDetails = async (serviceId: number | string) => {
const { data } = await request.get<ResponseData<GoServiceStatus>>(
adminShowServiceDetails(encodeURIComponent(String(serviceId))),
);
return data.code === 0 ? adaptServiceDetail(data.data) : undefined;
};
export const createRole = (params: {
roleName: string;
description?: string;
}) =>
request.post<ResponseData<AdminService.RoleDetail>>(adminCreateRole, params);
export const updateRoleDescription = (role: string, description: string) =>
request.put<ResponseData<AdminService.RoleDetail>>(
adminUpdateRoleDescription(role),
{ description },
);
export const deleteRole = (role: string) =>
request.delete<ResponseData<ResponseData<never>>>(adminDeleteRole(role));
export const listRoles = () =>
request.get<
ResponseData<{ roles: AdminService.ListRoleItem[]; total: number }>
>(adminListRoles);
export const listRolesWithPermission = () =>
request.get<
ResponseData<{
roles: AdminService.ListRoleItemWithPermission[];
total: number;
}>
>(adminListRolesWithPermission);
export const getRolePermissions = (role: string) =>
request.get<ResponseData<AdminService.RoleDetailWithPermission>>(
adminGetRolePermissions(role),
);
export const assignRolePermissions = (
role: string,
permissions: Partial<AdminService.AssignRolePermissionsInput>,
) =>
request.post<ResponseData<never>>(adminAssignRolePermissions(role), {
new_permissions: permissions,
});
export const revokeRolePermissions = (
role: string,
permissions: Partial<AdminService.RevokeRolePermissionInput>,
) =>
request.delete<ResponseData<never>>(adminRevokeRolePermissions(role), {
data: { revoke_permissions: permissions },
});
export const updateUserRole = (username: string, role: string) =>
request.put<ResponseData<never>>(adminUpdateUserRole(username), {
role_name: role,
});
export const getUserPermissions = (username: string) =>
request.get<ResponseData<AdminService.UserDetailWithPermission>>(
adminGetUserPermissions(username),
);
export const listResources = () =>
request.get<ResponseData<AdminService.ResourceType>>(adminListResources);
export const listWhitelist = () =>
request.get<
ResponseData<{
total: number;
white_list: AdminService.ListWhitelistItem[];
}>
>(adminListWhitelist);
export const createWhitelistEntry = (email: string) =>
request.post<ResponseData<never>>(adminCreateWhitelistEntry, { email });
export const updateWhitelistEntry = (id: number, email: string) =>
request.put<ResponseData<never>>(adminUpdateWhitelistEntry(id), { email });
export const deleteWhitelistEntry = (email: string) =>
request.delete<ResponseData<never>>(adminDeleteWhitelistEntry(email));
export const importWhitelistFromExcel = (file: File) => {
const fd = new FormData();
fd.append('file', file);
return request.post<ResponseData<never>>(adminImportWhitelist, fd);
};
export const getSystemVersion = () =>
request.get<ResponseData<{ version: string }>>(adminGetSystemVersion);
// Sandbox settings APIs
export const listSandboxProviders = () =>
request.get<ResponseData<AdminService.SandboxProvider[]>>(
adminListSandboxProviders,
);
export const getSandboxProviderSchema = (providerId: string) =>
request.get<ResponseData<Record<string, AdminService.SandboxConfigField>>>(
adminGetSandboxProviderSchema(providerId),
);
export const getSandboxConfig = (providerType?: string) =>
request.get<ResponseData<AdminService.SandboxConfig>>(adminGetSandboxConfig, {
params: { provider_type: providerType },
});
export const setSandboxConfig = (params: {
providerType: string;
config: Record<string, unknown>;
}) =>
request.post<ResponseData<AdminService.SandboxConfig>>(
adminSetSandboxConfig,
{
provider_type: params.providerType,
config: params.config,
},
);
export const testSandboxConnection = (params: {
providerType: string;
config: Record<string, unknown>;
}) =>
request.post<
ResponseData<{
success: boolean;
message: string;
details?: {
exit_code: number;
execution_time: number;
stdout: string;
stderr: string;
};
}>
>(adminTestSandboxConnection, {
provider_type: params.providerType,
config: params.config,
});