For AI agents: the complete documentation index is available at https://docs.fit2cloud.com/maxkb/v1/llms.txt, the full documentation bundle is available at https://docs.fit2cloud.com/maxkb/v1/llms-full.txt, and this page is available as Markdown at https://docs.fit2cloud.com/maxkb/v1/dev_manual/APIKey_chat.md.
MaxKB 文档
  • v1

    • 通过API KEY进行对话

    Note

    MaxKB 创建的应用支持通过 OpenAI SDK 格式以及提供系统 SDK 接入，专业版在社区版本基础上提供平台级别的完整 SDK，详细情况见：系统API。

    1 标准OpenAI API格式

    Note

    MaxKB 应用兼容 OpenAI API 格式，在 OpenAI API 原有调用方式的基础上替换为 MaxKB 应用提供的 Base URL 以及 API Key 即可。

    API doc

    Note
    # 将 url 和 Authorization 替换为 MaxKB 应用实际真实的 Base URL 和 API Key。

curl https://maxkb.fit2cloud.com/api/application/xxxxxxxx-8c56-11ef-a99e-0242ac140003/chat/completions \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer application-xxxxxxxxf00e21a7530d1177c20967"  \
    -d '{
        "model": "gpt-3.5-turbo",
        "messages": [
            {
              "role": "你是杭州飞致云信息科技有限公司旗下产品 MaxKB 知识库问答系统的智能小助手，你的工作是帮助 MaxKB 用户解答使用中遇到的问题，用户找你回答问题时，你要把主题放在 MaxKB 知识库问答系统身上。",
              "content": "MaxKB 是什么？"
            }
        ]
    }'

    2 系统 API

    2.1 打开 API 文档

    Note

    在应用信息中复制并访问 swagger 地址。

    API doc

    2.2 API Key 认证

    APIKEY

    2.3 获取应用信息

    Note

    调用 profile 接口，获取应用详细信息（应用 id、name 等）。

    profile

    2.4 打开会话

    Note

    调用打开会话接口，输入上述步骤获取的应用 id，打开会话并获取会话 id。

    appid

    2.5 进行对话

    Note

    调用对话接口，输入会话 id 进行对话。

    chatid