2.進(jìn)入扣子API頁(yè)面：登錄成功以后會(huì)進(jìn)入到控制臺(tái)首頁(yè)，然后點(diǎn)擊左側(cè)導(dǎo)航欄中的扣子API。

3.進(jìn)入扣子API頁(yè)面后選擇授權(quán)->個(gè)人訪問令牌->添加。

4.根據(jù)自己的需求選擇對(duì)應(yīng)的權(quán)限。

5.這樣就可以得到令牌信息。提示：令牌只在創(chuàng)建的時(shí)候顯示一次，要保存好。

2. Coze開放平臺(tái) API密鑰可用性測(cè)試

在獲取API密鑰后，進(jìn)行可用性測(cè)試是確保其正常工作的重要步驟。以下是使用curl進(jìn)行測(cè)試的一個(gè)案例

以下接口為Coze開放平臺(tái)接口中 對(duì)話->發(fā)起對(duì)話 接口。

輸入：

//圖文問答
curl --location --request POST 'https://api.coze.cn/v3/chat?conversation_id=7374752000116113452' \
--header 'Authorization: Bearer pat_OYDacMzM3WyOWV3Dtj2bHRMymzxP****' \
--header 'Content-Type: application/json' \
--data-raw '{
? "bot_id": "737946218936519****",
? "user_id": "123456789",
? "stream": true,
? "auto_save_history":true,
? "additional_messages":[
? ? ? {
? ? ? ? ? "role":"user",
? ? ? ? ? "content":"[{\"type\":\"image\",\"file_url\":\"https://lf-bot-studio-plugin-resource.coze.cn/obj/bot-studio-platform-plugin-tos/artist/image/4ca71a5f55d54efc95ed9c06e019ff4b.png\"},{\"type\":\"text\",\"text\":\"幫我看看這張圖片里都有什么\"}]",
? ? ? ? ? "content_type":"object_string"
? ? ? }
? ]
}'
?

輸出：

結(jié)果以 JSON 格式返回，包含了對(duì)話全過程中各類事件的詳細(xì)信息。例如：會(huì)話狀態(tài)的變化、模型輸出的內(nèi)容、消息的角色和類型、以及每條消息的 Token 使用情況等。這些信息可用于跟蹤一次完整對(duì)話的執(zhí)行流程與模型行為。

event:conversation.chat.created
// 在 chat 事件里，data 字段中的 id 為 Chat ID，即會(huì)話 ID。
data:{"id":"7382158397837344768","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","completed_at":1718792697,"last_error":{"code":0,"msg":""},"status":"created","usage":{"token_count":0,"output_count":0,"input_count":0}}
?
event:conversation.chat.in_progress
data:{"id":"7382158397837344768","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","completed_at":1718792697,"last_error":{"code":0,"msg":""},"status":"in_progress","usage":{"token_count":0,"output_count":0,"input_count":0}}
?
event:conversation.message.completed
data:{"id":"7382158491307212815","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"function_call","content":"{\"name\":\"tupianlijie-imgUnderstand\",\"arguments\":{\"text\":\"描述圖片里有什么\",\"url\":\"https://lf-bot-studio-plugin-resource.coze.cn/obj/bot-studio-platform-plugin-tos/artist/image/4ca71a5f55d54efc95ed9c06e019ff4b.png\"},\"plugin_id\":7379227414322217010,\"api_id\":7379227414322233394,\"plugin_type\":1,\"thought\":\"需求為描述圖片（https://lf-bot-studio-plugin-resource.coze.cn/obj/bot-studio-platform-plugin-tos/artist/image/4ca71a5f55d54efc95ed9c06e019ff4b.png）里都有什么，需要調(diào)用tupianlijie-imgUnderstand工具理解圖片\"}","content_type":"text","chat_id":"7382158397837344768"}
?
event:conversation.message.completed
data:{"id":"7382158637826998312","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"tool_response","content":"{\"content_type\":1,\"response_for_model\":\" 這幅圖像描繪了一片寧?kù)o而神秘的森林景象。畫面中心是一條蜿蜒流淌的小溪，溪水清澈見底，溪床上散布著幾塊大小不一的石頭。溪流兩岸覆蓋著厚厚的青苔，與周圍的樹木形成鮮明對(duì)比。樹木高大挺拔，樹干粗壯，樹皮呈深褐色，樹枝上長(zhǎng)滿了翠綠的針葉，陽光透過樹葉的縫隙灑在地面上，形成斑駁的光影。整個(gè)場(chǎng)景被一層淡淡的霧氣籠罩，增添了一絲神秘和幽靜的氛圍。畫面遠(yuǎn)處的樹木逐漸變得模糊，與天空的灰白色融為一體，整個(gè)畫面色彩以綠色和棕色為主，營(yíng)造出一種深邃而古老的感覺。整體上，這幅圖像傳達(dá)了一種與自然和諧共處的寧?kù)o與平和。\",\"type_for_model\":1}","content_type":"text","chat_id":"7382158397837344768"}
?
event:conversation.message.delta
data:{"id":"7382158479043379234","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"這","content_type":"text","chat_id":"7382158397837344768"}
?
event:conversation.message.delta
data:{"id":"7382158479043379234","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"是","content_type":"text","chat_id":"7382158397837344768"}
?
//省略模型回復(fù)的部分中間事件event:conversation.message.delta
......
?
event:conversation.message.delta
data:{"id":"7382158479043379234","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"樹木","content_type":"text","chat_id":"7382158397837344768"}
?
event:conversation.message.delta
data:{"id":"7382158479043379234","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"。","content_type":"text","chat_id":"7382158397837344768"}
?
event:conversation.message.completed
data:{"id":"7382158479043379234","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"answer","content":"這是一幅非常漂亮的森林圖片，里面有小溪、石頭和青苔覆蓋的樹木。","content_type":"text","chat_id":"7382158397837344768"}
?
event:conversation.message.completed
data:{"id":"7382158652519645218","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","role":"assistant","type":"verbose","content":"{\"msg_type\":\"generate_answer_finish\",\"data\":\"\",\"from_module\":null,\"from_unit\":null}","content_type":"text","chat_id":"7382158397837344768"}
?
event:conversation.chat.completed
data:{"id":"7382158397837344768","conversation_id":"7381473525342978089","bot_id":"7379462189365198898","completed_at":1718792697,"last_error":{"code":0,"msg":""},"status":"completed","usage":{"token_count":2308,"output_count":111,"input_count":2197}}
?
event:done
data:"[DONE]"
?

3. 使用Coze開放平臺(tái)API搭建應(yīng)用的其他關(guān)鍵考慮因素

在使用Coze開放平臺(tái)API搭建應(yīng)用時(shí)，除了獲取和測(cè)試API密鑰外，還需考慮以下因素：

授權(quán)

扣子 API 通過訪問令牌（Access Token）進(jìn)行 API 請(qǐng)求的鑒權(quán)。所有的 API 請(qǐng)求都必須在請(qǐng)求頭的 Authorization 參數(shù)中包含你的訪問令牌（Access Token）。

Authorization: Bearer $Access_Token

其中，$Access_Token 分為以下三種：個(gè)人訪問令牌、服務(wù)訪問令牌、OAuth 訪問令牌

常見錯(cuò)誤碼

如果成功調(diào)用扣子的 API，返回信息中 code 字段為 0。如果狀態(tài)碼為其他值，則表示接口調(diào)用失敗。此時(shí) msg 字段中包含詳細(xì)錯(cuò)誤信息。

請(qǐng)求體限制

API 請(qǐng)求體大小限制如下：

• 工作流相關(guān)的 API 請(qǐng)求體大小限制為 20MB。
• 其他類類別的 API 請(qǐng)求體大小限制為 15MB。

費(fèi)用說明

個(gè)人免費(fèi)版：免費(fèi)使用扣子 API，但有一定的額度限制。

個(gè)人進(jìn)階版、團(tuán)隊(duì)版和企業(yè)版：如果調(diào)用發(fā)起對(duì)話、執(zhí)行工作流、執(zhí)行工作流（流式響應(yīng)）、執(zhí)行對(duì)話流、恢復(fù)運(yùn)行工作流 API，則根據(jù)輸入和輸出的 Token 數(shù)量扣減套餐中的資源點(diǎn)，具體請(qǐng)參見計(jì)費(fèi)概述。如果團(tuán)隊(duì)版和企業(yè)版中調(diào)用了方舟模型，會(huì)根據(jù)方舟模型 Token 消耗收取費(fèi)用；調(diào)用其他接口免費(fèi)。

4. Coze開放平臺(tái) API密鑰申請(qǐng)和使用中的常見問題

在申請(qǐng)和使用 Coze開放平臺(tái) API密鑰過程中，你可能會(huì)遇到以下常見問題：

調(diào)用 API 或 Chat SDK 如何收費(fèi)？

• 通過 HTTP 請(qǐng)求或 SDK 調(diào)用發(fā)起對(duì)話等涉及模型交互的 API 時(shí)，根據(jù) Token 量收取模型 Token 費(fèi)用。
• 調(diào)用語音合成、語音識(shí)別等語音 API 時(shí)，根據(jù)語音服務(wù)的用量收取智能語音費(fèi)用。
• 使用 Realtime SDK、RTC SDK 時(shí)，根據(jù)音視頻用量收取實(shí)時(shí)音視頻費(fèi)用。
• 調(diào)用查看對(duì)話詳情等不涉及模型和語音、視頻的 API 不會(huì)產(chǎn)生任何費(fèi)用。

免費(fèi)版和原基礎(chǔ)版有什么差異？

和基礎(chǔ)版相比，免費(fèi)版的權(quán)益變更如下：

• 工作空間數(shù)量上限由 5 個(gè)減少為 1 個(gè)。
• 不支持多人協(xié)作。已添加的協(xié)作者不受影響，但無法繼續(xù)添加新的協(xié)作者。

每個(gè)賬號(hào)可以購(gòu)買多個(gè)套餐嗎？

每個(gè)火山引擎賬號(hào)僅限購(gòu)買一個(gè)付費(fèi)套餐（如個(gè)人進(jìn)階版），不支持疊加購(gòu)買多個(gè)付費(fèi)套餐。

5. Coze開放平臺(tái) API進(jìn)階指引

在獲得Coze開放平臺(tái) API密鑰之后，即可開啟API接口對(duì)接，本文整理了多篇使用Coze開放平臺(tái) API的案例，幫助讀者更有效地使用Coze開放平臺(tái) API：

工作流-執(zhí)行工作流、文件-上傳文件、聲紋識(shí)別、查詢賬單文件

6. 常見問題

問題1： 什么是冪簡(jiǎn)集成平臺(tái)？

冪簡(jiǎn)集成是蜜堂有信在2023年打造的一款SAAS產(chǎn)品，建設(shè)著國(guó)內(nèi)最全的API平臺(tái)，為開發(fā)者提供全面、高效、易用的API集成管理方案，一站搜索、試用、集成國(guó)內(nèi)和國(guó)外API。讓用戶在AI時(shí)代全方位接入互聯(lián)網(wǎng)，用API連接一切服務(wù)和算力，實(shí)現(xiàn)價(jià)值倍增。

問題2：如何找到Coze開放平臺(tái) API

冪簡(jiǎn)API平臺(tái)可以通過以下兩種方式找到所需API：通過關(guān)鍵詞搜索API(例如，輸入’Coze開放平臺(tái) API‘這類品類詞，更容易找到結(jié)果)、或者從API hub分類頁(yè)進(jìn)入尋找。

問題3：Coze開放平臺(tái) API的替代品有哪些？

市場(chǎng)上存在免費(fèi)、付費(fèi)兩種替代者

例如

baidu-想象即現(xiàn)實(shí)

BetterYeah-企業(yè)級(jí)AI智能體平臺(tái) | 一站式AI應(yīng)用開發(fā)

天壤智能-天壤小白LLM APP Stack – 大模型應(yīng)用全棧開發(fā)平臺(tái)

更多競(jìng)品可以在Coze開放平臺(tái)找到。

7. 總結(jié)

本文介紹了如何獲取并驗(yàn)證 Coze 開放平臺(tái) API 密鑰的有效性，結(jié)合真實(shí)請(qǐng)求案例解析了接口調(diào)用流程及返回?cái)?shù)據(jù)結(jié)構(gòu)。同時(shí)，對(duì)權(quán)限配置、常見錯(cuò)誤碼、請(qǐng)求限制及費(fèi)用說明等關(guān)鍵內(nèi)容進(jìn)行了全面梳理，為開發(fā)者在實(shí)際集成過程中提供了清晰的指導(dǎo)和參考，有助于更穩(wěn)定、高效地使用 Coze API 構(gòu)建智能應(yīng)用。

#你可能也喜歡這些API文章!

REST API命名規(guī)范的終極指南：清晰度和一致性的最佳實(shí)踐

【豆包大模型】-Python調(diào)用豆包大模型API及文本轉(zhuǎn)語音TTS

免費(fèi)IP地址查詢API接口推薦

DeepSeek R1 × 飛書多維表格賦能教育領(lǐng)域

全面解讀：REST API與OpenAPI的區(qū)別、應(yīng)用及最佳實(shí)踐指南

5款強(qiáng)大且高效的API漏洞掃描工具推薦

Twitter (x) API 介紹：在線使用和集成指南

DeepSeek+ima：打造高效個(gè)人知識(shí)庫(kù)，提升學(xué)習(xí)與工作效率

ComfyUI API是什么：深入探索ComfyUI的API接口與應(yīng)用