ファイルリストの検索

GET /sdk/knowledgeBases/{knowledgeBaseId:^[1-9]\d*$}/materialRepositorys

リクエストパラメータ

名称 位置 タイプ 必須 説明
knowledgeBaseId:^[1-9]\d*$ path string はい none
knowledgeBaseId query integer はい ナレッジベースID
categoryId query integer いいえ カテゴリID
name query string いいえ ファイル名（あいまい検索）
status query integer いいえ ナレッジステータス：1-公開済み、4-未発効
accessLevel query integer いいえ アクセス権限、0：外部公開可、1：内部のみ
pageSize query integer はい none
pageNum query integer はい none
Content-Type header string いいえ none

リクエスト例

curl --location 'https://kcs.t1.in.tryudesk.com/api/sdk/knowledgeBases/281/materialRepositorys?knowledgeBaseId=281' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzAwMDAwMDIsImFwcElkIjoiNDY3Yzk4N2EtMjk0YS00NDk2LTRhZDctYzIyM2Y4ZDdiZjhmIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyMzA4NDg0LCJpYXQiOjE3NjIzMDU0ODQsInVzZXJJZCI6Mn0.puGWiu8FXVA9gqkHq5WB8F5mddZyk9EjzyEnCJMfZGf-EG-x8nZO0whRO-w0Vzr4smoEMYQlXhgwQvYxVH69xFQrLwpqQKVhq1pDjzoT46OTTAEGKMblFxWvf1FUEyQjr7yoqqBlxBcXOcDSjaohxDrRHZBJse0EMo8jijHPqKA'

レスポンス例

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 20,
        "total": 1
    },
    "data": [
        {
            "id": 101198,
            "createUserId": 2,
            "createUserUsername": "Admin123456",
            "createTime": "2025-09-18 16:47:36",
            "updateUserId": 2,
            "updateTime": "2025-11-04 15:26:12",
            "deleteFlag": 0,
            "categoryIdMultiple": [
                11913
            ],
            "knowledgeCreateBool": true,
            "knowledgeManageBool": true,
            "knowledgeBaseId": 281,
            "name": "ChatGPT 常见问题解答.docx",
            "url": "https://staging-udesk.oss-cn-beijing.aliyuncs.com/Data/30000002/9241aa18-acab-448d-8fe9-b234a3413f4c/ChatGPT 常见问题解答.docx",
            "encodingUrl": "https://staging-udesk.oss-cn-beijing.aliyuncs.com/Data/30000002/9241aa18-acab-448d-8fe9-b234a3413f4c/ChatGPT%20%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98%E8%A7%A3%E7%AD%94.docx",
            "previewUrl": "https://espreview.s4.udesk.cn/onlinePreview?url=RDZDQUNBQ0VDRDg0OTE5MUNEQ0FERkQ5RDdEMEQ5OTNDQkRBREJDREQ1OTBEMUNEQ0Q5M0RERDA5M0RDREJEN0Q0RDdEMEQ5OTBERkQyRDdDN0NCRDBERENEOTBEREQxRDM5MUZBREZDQURGOTE4RDhFOEU4RThFOEU4RThDOTE4NzhDOEE4RkRGREY4Rjg2OTNERkREREZEQzkzOEE4QTg2REE5Mzg2RDhEQjg3OTNEQzhDOEQ4QURGOEQ4QThGOEREODhBREQ5MUZERDZERkNBRjlFRUVBOUU1QjA2MDY1NjE5M0Y1NzI5MTA1NzFDMjY1NjE5MUQ1OTEzMkE5MERBRDFEREM2ODFEREQxRDBDQURCRDBDQTgz",
            "uid": "9570882d-a3ba-42ee-936d-483ffd828d5d",
            "type": "ATTACHMENT",
            "source": 2,
            "size": 47777,
            "shareOutside": false,
            "shareFlag": true,
            "downloadFlag": true,
            "generateOutlineStatus": 0,
            "sdkSendFlag": 0,
            "sdkUseFlag": 0,
            "tags": [
                {
                    "id": 142,
                    "createUserId": 2,
                    "createTime": "2025-11-04 14:57:23",
                    "updateUserId": 2,
                    "updateTime": "2025-11-04 14:57:23",
                    "deleteFlag": 0,
                    "company": {
                        "id": 30000002,
                        "deleteFlag": 0
                    },
                    "knowledgeBaseId": 281,
                    "knowledgeId": 101198,
                    "tagId": 782,
                    "tagName": "标签-带固定时长"
                }
            ],
            "langCode": "ZH-CN",
            "availableTimeType": 1,
            "startTime": "2025-11-04 00:00:00",
            "endTime": "2025-11-24 23:59:59",
            "accessLevel": 0,
            "favoriteFlag": 0,
            "browseCount": 0,
            "valid": true,
            "status": 1,
            "uagentSyncStatus": 1,
            "uagentTaskId": "f862e875-13c9-4865-94a8-877cd1a976bf",
            "uagentLastSyncTime": "2025-11-04 15:29:25",
            "uagentSyncRetryTimes": 0
        }
    ]
}

返却結果

ステータスコード ステータスコードの意味 説明 データモデル
200 OK なし Inline

返却データ構造

ステータスコード 200

名前 タイプ 必須 制約 日本語名 説明
» succeed boolean true none なし
» code integer true none なし
» bizCode string true none なし
» message string true none なし
» visible boolean true none なし
» paging object true none なし
»» pageNum integer true none なし
»» pageSize integer true none なし
»» total integer true none なし
» data [object] true none なし
»» id integer false none ファイルID
»» createUserId integer false none 作成ユーザーID
»» createUserUsername integer false none 作成ユーザー名
»» createTime string false none 作成時間
»» updateUserId string false none 更新ユーザーID
»» updateTime string true none 更新時間
»» deleteFlag string false none 削除フラグ
»» categoryIdMultiple string false none カテゴリーID
»» knowledgeCreateBool string false none 権限フラグ
»» knowledgeManageBool string true none 権限フラグ
»» knowledgeBaseId string true none ナレッジスペースID
»» name integer true none ファイル名
»» url integer true none 素材アドレス
»» encodingUrl integer true none ファイル保存アドレス
»» previewUrl integer true none ファイルプレビューアドレス
»» uid integer true none ファイルUID
»» type integer true none ファイルタイプ
»» source integer true none 1:Q&A同期 2:手動アップロード，3：SGチケット，4：UDチケット
»» size integer true none ファイルサイズ
»» shareOutside boolean true none 外部共有可否
»» shareFlag boolean true none 共有可否
»» downloadFlag boolean true none ダウンロード可否
»» generateOutlineStatus integer true none 目録生成ステータス
»» sdkSendFlag integer true none SDK送信スイッチ
»» sdkUseFlag integer true none SDK使用スイッチ
»» tags [object] true none タグ
»»» id integer true none ナレッジ関連付けタグID
»»» createUserId integer true none 作成者ID
»»» createTime string true none 作成時間
»»» updateUserId integer true none 更新者ID
»»» updateTime string true none 更新時間
»»» deleteFlag integer true none 削除フラグ
»»» company {object} true none テナント情報
»»»» id integer true none テナントID
»»»» deleteFlag integer true none 削除フラグ
»»» knowledgeBaseId integer true none ナレッジスペースID
»»» knowledgeId integer true none ナレッジID
»»» tagId integer true none タグID
»»» tagName string true none タグ名
»» langCode string true none 言語
»» availableTimeType integer true none 有効タイプ，0-永久有効，1-固定日付有効
»» startTime string true none 有効開始時間
»» endTime string true none 有効終了時間
»» accessLevel integer true none アクセス権限，0：外部可，1：内部のみ
»» favoriteFlag integer true none お気に入り数
»» browseCount integer true none 閲覧数
»» valid boolean true none 有効かどうか
»» status integer true none ナレッジステータス
»» uagentSyncStatus integer true none Uagent同期タスクステータス
»» uagentTaskId string true none タスクID
»» uagentLastSyncTime string true none 最終同期時間
»» uagentSyncRetryTimes integer true none 同期リトライ回数
## ファイルアップロード ステップ1：Udesk OSS署名URLの取得

GET /oss/efficiency

リクエストパラメータ

名称 位置 タイプ 必須 説明
knowledgeBaseId query integer はい ナレッジベースID
dataType query string はい ファイルタイプ、document
filename query string はい ファイル名
verify query integer はい 固定値1を指定
Content-Type header string いいえ none

リクエスト例

curl  'https://kcs.t1.in.tryudesk.com/api/oss/efficiency?filename=ChatGPT%20%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98%E8%A7%A3%E7%AD%94.docx&knowledgeBaseId=193&verify=1&dataType=document' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzAwMDAwMDIsImFwcElkIjoiNDY3Yzk4N2EtMjk0YS00NDk2LTRhZDctYzIyM2Y4ZDdiZjhmIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyMzA4NDg0LCJpYXQiOjE3NjIzMDU0ODQsInVzZXJJZCI6Mn0.puGWiu8FXVA9gqkHq5WB8F5mddZyk9EjzyEnCJMfZGf-EG-x8nZO0whRO-w0Vzr4smoEMYQlXhgwQvYxVH69xFQrLwpqQKVhq1pDjzoT46OTTAEGKMblFxWvf1FUEyQjr7yoqqBlxBcXOcDSjaohxDrRHZBJse0EMo8jijHPqKA'

レスポンス例

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "data": {
    "host": "https://staging-udesk.oss-cn-beijing.aliyuncs.com",
    "bucket": "staging-udesk",
    "dir": "Data",
    "key": "Data/30000002/28a99648-ec66-4883-bced-a1f91a5f5735/ChatGPT 常见问题解答.docx",
    "region": "oss-cn-beijing",
    "temporaryId": "STS.NY9njknYUtg8jaa5S9hb2EJCr",
    "policy": "9T8zvs6VmgSTX6KhdipkPWXHVccTNQHMneBN5jYfXDrf",
    "signature": "CAISuQJ1q6Ft5B2yfSjIr5qMJdDfg4Z0w6XTaEfQ0VNsZO0eqo/okDz2IHhMeHZrBeAevv4xlWFX6PcclqpwQIQd9dVSiwYrvPpt6gqET9frma7ctM4p6vCMHWyUFGSIvqv7aPn4S9XwY+qkb0u++AZ43br9c0fJPTXnS+rr76RqddMKRAK1QCNbDdNNXGtYpdQdKGHaOITGUHeooBKJVRA55VIt0D8ktvrjk5DM0HeE0g2mkN1yjp/qP52pY/NrOJpCSNqv1IR0DPGZiHIPsEQarPcs0v0VpmmW4Mv+GEVKphaNKK/T6cZ/mrjLzy6888SuxdmLdp0Q0oS7/+yfQMZUPOLiaS+Wggz0dQd4vCcN4sp4FNC1cj2Gucv0FeK+iChvWklQT3gRGNFMRDIOT3JlJF7UQrDqdM2XCm/LGoABetv44Kexvrek/PvCA2Jlna0KLDGkpBGSNwYGxTHxAARMgqfLzskkCBaVj9VEzoE7r8fnR5b10k7W7FKDfQL2iQ4zbqPUxEv2j22j5X4nZpkxRo+hduBINdOVqDXhoZ9BVjBnv5EnmAPoXNeekd4c/55c0/Vsq9nd+kF4rxkn6EUgAA==",
    "storageType": "oss"
  }
}

レスポンス結果

ステータスコード ステータスコードの意味 説明 データモデル
200 OK none Inline

レスポンスデータ構造

ステータスコード 200

名前 タイプ 必須 制約 日本語名 説明
» succeed boolean true none none
» code integer true none none
» bizCode string true none none
» message string true none none
» visible boolean true none none
» data [object] true none none
»» host string true none none
»» bucket string true none none
»» dir string true none none
»» key string true none none
»» region string true none none
»» temporaryId string true none none
»» policy string true none none
»» signature string true none none
»» storageType string true none 固定でossを入力

ファイルアップロード ステップ2: Udesk OSS署名付きURLへのアップロード

PUT /域名/第一步获取的key

リクエスト例

curl  'https://staging-udesk.oss-cn-beijing.aliyuncs.com/Data/30000002/28a99648-ec66-4883-bced-a1f91a5f5735/ChatGPT%20%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98%E8%A7%A3%E7%AD%94.docx' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzAwMDAwMDIsImFwcElkIjoiNDY3Yzk4N2EtMjk0YS00NDk2LTRhZDctYzIyM2Y4ZDdiZjhmIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyMzA4NDg0LCJpYXQiOjE3NjIzMDU0ODQsInVzZXJJZCI6Mn0.puGWiu8FXVA9gqkHq5WB8F5mddZyk9EjzyEnCJMfZGf-EG-x8nZO0whRO-w0Vzr4smoEMYQlXhgwQvYxVH69xFQrLwpqQKVhq1pDjzoT46OTTAEGKMblFxWvf1FUEyQjr7yoqqBlxBcXOcDSjaohxDrRHZBJse0EMo8jijHPqKA'

リクエストパラメータ

名称 位置 タイプ 必須 説明
key query string はい アップロードステップ1のformData.keyを取得
Content-Type header string いいえ none

レスポンス例

200 Response

{}

レスポンス結果

ステータスコード ステータスコードの意味 説明 データモデル
200 OK none Inline

レスポンスデータ構造

なし

ファイルアップロードステップ3：ファイルの保存

POST /sdk/knowledgeBases/{knowledgeBaseId:^[1-9]\d*$}/materialRepositorys/batchSave

Body リクエストパラメータ

{
  "materials": [
    {
      "key": "Data/30000002/28a99648-ec66-4883-bced-a1f91a5f5735/ChatGPT よくある質問.docx",
      "url": "https://staging-udesk.oss-cn-beijing.aliyuncs.com/Data/30000002/28a99648-ec66-4883-bced-a1f91a5f5735/ChatGPT よくある質問.docx",
      "name": "ChatGPT よくある質問.docx",
      "percent": 100,
      "size": 47777,
      "status": 1,
      "uid": "4700e785-3fb0-4849-98b8-c99055a0df8b"
    }
  ],
  "knowledgeBaseId": "193",
  "categoryIdList": [
    11192
  ],
  "langCode": "ZH-CN",
  "tags": [],
  "accessLevel": 0,
  "availableTimeType": 0
}

リクエストパラメータ

名称 位置 タイプ 必須 説明
knowledgeBaseId:^[1-9]\d*$ path string はい none
knowledgeBaseId query integer はい ナレッジベースID
» categoryIdList body [string] はい カテゴリIDの集合
» materials body [object] はい ファイルオブジェクトの集合
»» key body string はい アップロードステップ1のformData.keyを取得
»» name body string はい ファイル名
»» percent body string はい パーセンテージ
»» size body integer はい ファイルサイズ
»» status body integer はい ファイルステータス、固定値1（公開）を渡す
»» uid body string はい アップロードステップ2のレスポンスパラメータを取得
»» url body string はい アップロードステップ2のレスポンスパラメータを取得
» langCode body string はい none
» tags body [object] はい タグ
» accessLevel body integer はい アクセス権限、0：外部公開可、1：内部のみ
» availableTimeType body integer はい none

リクエスト例

curl  'https://kcs.t1.in.tryudesk.com/api/sdk/knowledgeBases/193/materialRepositorys/batchSave' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzAwMDAwMDIsImFwcElkIjoiNDY3Yzk4N2EtMjk0YS00NDk2LTRhZDctYzIyM2Y4ZDdiZjhmIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyMzA4NDg0LCJpYXQiOjE3NjIzMDU0ODQsInVzZXJJZCI6Mn0.puGWiu8FXVA9gqkHq5WB8F5mddZyk9EjzyEnCJMfZGf-EG-x8nZO0whRO-w0Vzr4smoEMYQlXhgwQvYxVH69xFQrLwpqQKVhq1pDjzoT46OTTAEGKMblFxWvf1FUEyQjr7yoqqBlxBcXOcDSjaohxDrRHZBJse0EMo8jijHPqKA'

レスポンス例

200 Response

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false
}

返却結果

ステータスコード ステータスコードの意味 説明 データモデル
200 OK none Inline

返却データ構造

ステータスコード 200

名前 タイプ 必須 制約 日本語名 説明
» succeed boolean true none none
» code integer true none none
» bizCode string true none none
» message string true none none
» visible boolean true none none