coze-api

Name: coze-api
Availability: InStock
Author: staruhub

Call Coze API v3 endpoints for chat, workflows, and message retrieval.

662|124|Updated Oct 31, 2025

Search Tags:#workflow #api #streaming #chat #coze

Ready to run

npx skills add https://github.com/staruhub/ClaudeSkills --skill coze-api

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: coze-api
Source: https://github.com/staruhub/ClaudeSkills/tree/main/skills/coze-api/coze-api
Command: npx skills add https://github.com/staruhub/ClaudeSkills --skill coze-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires requests, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides a complete guide to calling Coze API for conversational AI, workflow execution, and message management.

Core Features & Use Cases

Chat API: both streaming and non-streaming conversations.
Workflow API: run published workflows.
Message management: query chat status and list messages.

Quick Start

Obtain a PAT and Bot ID, configure the client, and start a chat with a user message.

Frequently Asked Questions about coze-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I integrate Coze API into my application for chat conversations?▼

Coze API integration enables streaming and non-streaming chat through authenticated requests using a PAT token, bot ID, and user ID. Configure the client with your credentials, then send messages to the /v3/chat endpoint with proper headers and payload schemas to start conversations.

What's the difference between streaming and non-streaming modes in Coze chat?▼

Streaming mode delivers responses incrementally in real time, while non-streaming returns the complete response at once. Each mode pairs with an auto_save_history setting that determines whether the conversation state persists, affecting subsequent message queries and chat retrieval.

How do I run workflows with the Coze API?▼

Workflow execution uses the /v3/workflows/run endpoint with your bot ID, user ID, and PAT token authentication. POST your workflow parameters and inputs to invoke published workflows and receive execution results.

Can I retrieve chat history and list messages after a conversation?▼

Yes. The /v3/chat/retrieve endpoint fetches chat status and metadata, while /v3/chat/message/list returns all messages in a conversation. Both require proper authentication and the chat ID from your initial conversation setup.

What authentication does Coze API require?▼

Coze API requires a Personal Access Token (PAT) for authentication, supplied in request headers. You also need your bot ID and user ID to identify the bot instance and conversation participant in all API calls.

Do I need external dependencies to call Coze API endpoints?▼

The requests library is the primary dependency for making HTTP calls to Coze v3 endpoints. It handles authentication headers, payload construction, and response parsing for chat, workflow, and message management operations.