coze-api

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.

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.

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.

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.

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.

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.