Build API Docs with Apidog
SSE API Documentations
Copy Page
Build API Docs with Apidog
Overview
REST API Documentations
Basics
API-Design First Approach
Specify an endpoint
Components
Common parameters
Global parameters
Schemas
Overview
Create a new schema
Build a schema
Generate Schemas from JSON etc.
Advanced features
Custom endpoint fields
Endpoint status
Appearance of parameter lists
Endpoint unique idenfication
Example: Pet Store
Get user info
Find pet by ID
Add a new pet to the store
Update an existing pet
Deletes a pet
Finds Pets by status
SOAP API Documentations
How to Use Apidog to Write SOAP API Documentation
Example: WebService
WebService: Number To Words
SOAP: Add integers
SOAP/WSDL: Ebay
Example: Mastercard
Purchase Request
Submit a purchase request
GraphQL Documentation
How to Write GraphQL API Documentation Using Apidog
Example: Github
Introduction to GraphQL
Queries
Public schema
WebSocket Documentations
How to Use Apidog to Write WebSocket API Documentation
Example: Coinbase
Overview
Channel
SSE API Documentations
Example: Anthropic
Streaming Messages
Messages
gRPC API Documentations
How to Use Apidog for gRPC API Documentation and Testing
Example: Proto Documentation
Protocol Documentation
SSE API Documentations
Copy Page
Example: Anthropic
Streaming Messages
When creating a Message, you can set "stream": true to incrementally stream the response using server-sent events (SSE). Streaming with SDKs...
Messages
POST
/v1/messages
Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation.The Messages...
Previous
Channel
Next
Streaming Messages