# Modern PetstoreAPI Docs ## Docs - [Create Chat Completion](https://docs2.petstoreapi.com/api-reference/chat/create-chat-completion.md): Creates a model response for a chat conversation with the Pet Adoption Advisor AI. Supports streaming responses using Server-Sent Events (SSE). - [Pay Order](https://docs2.petstoreapi.com/api-reference/payments/pay-order.md): Process payment for an existing order. - [Add a new pet to the store.](https://docs2.petstoreapi.com/api-reference/pet/add-a-new-pet-to-the-store.md): Add a new pet to the store. - [Create Pet](https://docs2.petstoreapi.com/api-reference/pet/create-pet.md): Add a new pet to the store catalog, making it available for adoption. - [Delete Pet](https://docs2.petstoreapi.com/api-reference/pet/delete-pet.md): Delete a pet from the system. Staff only. - [Deletes a pet.](https://docs2.petstoreapi.com/api-reference/pet/deletes-a-pet.md): Delete a pet. - [Find pet by ID.](https://docs2.petstoreapi.com/api-reference/pet/find-pet-by-id.md): Returns a single pet. - [Finds Pets by status.](https://docs2.petstoreapi.com/api-reference/pet/finds-pets-by-status.md): Multiple status values can be provided with comma separated strings. - [Finds Pets by tags.](https://docs2.petstoreapi.com/api-reference/pet/finds-pets-by-tags.md): Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. - [Get Pet](https://docs2.petstoreapi.com/api-reference/pet/get-pet.md): Retrieve detailed information about a specific pet. - [List Pets](https://docs2.petstoreapi.com/api-reference/pet/list-pets.md): Retrieve a paginated list of pets available for adoption with optional filtering. - [Update an existing pet.](https://docs2.petstoreapi.com/api-reference/pet/update-an-existing-pet.md): Update an existing pet by Id. - [Update Pet](https://docs2.petstoreapi.com/api-reference/pet/update-pet.md): Update information for an existing pet. Staff only. - [Updates a pet in the store with form data.](https://docs2.petstoreapi.com/api-reference/pet/updates-a-pet-in-the-store-with-form-data.md): Updates a pet resource based on the form data. - [Upload Pet Image](https://docs2.petstoreapi.com/api-reference/pet/upload-pet-image.md): Upload an image for the specified pet. Requires authentication and write:pets permission. - [Uploads an image.](https://docs2.petstoreapi.com/api-reference/pet/uploads-an-image.md): Upload image of the pet. - [Callback Example](https://docs2.petstoreapi.com/api-reference/store/callback-example.md): Handles order events and supports asynchronous processing with Callback. - [Create Order](https://docs2.petstoreapi.com/api-reference/store/create-order.md): Create a new order in the store. - [Delete Order](https://docs2.petstoreapi.com/api-reference/store/delete-order.md): Delete an existing order by its unique identifier. - [Delete purchase order by identifier.](https://docs2.petstoreapi.com/api-reference/store/delete-purchase-order-by-identifier.md): For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors. - [Find purchase order by ID.](https://docs2.petstoreapi.com/api-reference/store/find-purchase-order-by-id.md): For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions. - [Get Order](https://docs2.petstoreapi.com/api-reference/store/get-order.md): Retrieve order information by order ID. - [List Inventory](https://docs2.petstoreapi.com/api-reference/store/list-inventory.md): Returns a mapping of status codes to quantities. - [Place an order for a pet.](https://docs2.petstoreapi.com/api-reference/store/place-an-order-for-a-pet.md): Place a new order in the store. - [Returns pet inventories by status.](https://docs2.petstoreapi.com/api-reference/store/returns-pet-inventories-by-status.md): Returns a map of status codes to quantities. - [Create Token (Login)](https://docs2.petstoreapi.com/api-reference/user/create-token-login.md): Authenticate user and obtain an access token. - [Create user.](https://docs2.petstoreapi.com/api-reference/user/create-user.md): This can only be done by the logged in user. - [Creates list of users with given input array.](https://docs2.petstoreapi.com/api-reference/user/creates-list-of-users-with-given-input-array.md): Creates list of users with given input array. - [Delete User](https://docs2.petstoreapi.com/api-reference/user/delete-user.md): Delete a user account. Only the logged-in user can perform this operation. - [Delete user resource.](https://docs2.petstoreapi.com/api-reference/user/delete-user-resource.md): This can only be done by the logged in user. - [Get User](https://docs2.petstoreapi.com/api-reference/user/get-user.md): Retrieve user information by user ID. - [Get user by user name.](https://docs2.petstoreapi.com/api-reference/user/get-user-by-user-name.md): Get user detail based on username. - [Logs out current logged in user session.](https://docs2.petstoreapi.com/api-reference/user/logs-out-current-logged-in-user-session.md): Log user out of the system. - [Logs user into the system.](https://docs2.petstoreapi.com/api-reference/user/logs-user-into-the-system.md): Log into the system. - [Update User](https://docs2.petstoreapi.com/api-reference/user/update-user.md): Update user information. Only the logged-in user can perform this operation. - [Update user resource.](https://docs2.petstoreapi.com/api-reference/user/update-user-resource.md): This can only be done by the logged in user. - [Order status changed event](https://docs2.petstoreapi.com/api-reference/webhooks/order-status-changed-event.md): Triggered when an order's status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows. - [Payment succeeded event](https://docs2.petstoreapi.com/api-reference/webhooks/payment-succeeded-event.md): Triggered when a payment is successfully processed and confirmed. This webhook notifies your system of successful payment transactions, enabling real-time updates for order fulfillment, customer notifications, and accounting workflows. - [Modern Petstore API: A New Gold Standard for OpenAPI](https://docs2.petstoreapi.com/index.md): *Building the API Example the Industry Deserves* - [API Protocols Guide](https://docs2.petstoreapi.com/protocols.md): Modern Petstore API supports **multiple API protocols and specifications**, making it the most comprehensive reference implementation available. Choose the protocol that best fits your use case. - [PetstoreAPI GraphQL Protocol Guide](https://docs2.petstoreapi.com/protocols/graphql.md): **Modern Petstore API** provides GraphQL support for flexible, efficient data fetching where clients request exactly what they need in a single query. Our GraphQL endpoint at `https://api.petstoreapi.com/v1/graphql` enables complex nested queries, multiple resources in single requests, and precise f… - [PetstoreAPI gRPC Protocol Guide](https://docs2.petstoreapi.com/protocols/grpc.md): **Modern Petstore API** provides gRPC support for high-performance Remote Procedure Call (RPC) communication using Protocol Buffers for binary serialization. Our gRPC service at `api.petstoreapi.com:443` delivers ultra-low latency and high throughput for microservice-to-microservice communication wi… - [PetstoreAPI MCP (Model Context Protocol) Guide](https://docs2.petstoreapi.com/protocols/mcp.md): **Modern Petstore API** provides Model Context Protocol (MCP) support enabling AI assistants like Claude Desktop to directly interact with our API through structured tools and resources. Our MCP server implementation exposes pet queries, order management, and search capabilities as AI-consumable too… - [PetstoreAPI MQTT Protocol Guide](https://docs2.petstoreapi.com/protocols/mqtt.md): **Modern Petstore API** provides MQTT (Message Queuing Telemetry Transport) support for IoT devices and resource-constrained environments. Our MQTT broker at `mqtts://mqtt.petstoreapi.com:8883` enables publish/subscribe messaging for pet health monitoring devices, order status updates, payment notif… - [PetstoreAPI RAML Protocol Guide](https://docs2.petstoreapi.com/protocols/raml.md): The Modern Petstore API provides a comprehensive **RAML (RESTful API Modeling Language)** specification for API design and documentation. - [PetstoreAPI REST Protocol Guide](https://docs2.petstoreapi.com/protocols/rest.md): The Modern Petstore REST API is built with **pure RESTful principles** as the foundation. It serves as the reference implementation for proper API design. - [PetstoreAPI Socket.IO Protocol Guide](https://docs2.petstoreapi.com/protocols/socketio.md): **Modern Petstore API** provides Socket.IO support for real-time, bidirectional communication with automatic fallback to HTTP long-polling when WebSocket is unavailable. Our Socket.IO implementation powers the customer support chat system at `wss://api.petstoreapi.com`, featuring room-based messagin… - [PetstoreAPI Server-Sent Events (SSE) Protocol Guide](https://docs2.petstoreapi.com/protocols/sse.md): **Modern Petstore API** provides Server-Sent Events (SSE) support for real-time streaming from server to client over HTTP. Our SSE implementation is primarily used for AI chat streaming responses via the `/v1/chat/completions` endpoint, enabling real-time token-by-token delivery of AI-generated cont… - [PetstoreAPI WADL Protocol Guide](https://docs2.petstoreapi.com/protocols/wadl.md): The Modern Petstore API provides a comprehensive **WADL (Web Application Description Language)** specification for HTTP-based web services. - [PetstoreAPI Webhooks Protocol Guide](https://docs2.petstoreapi.com/protocols/webhooks.md): **Modern Petstore API** provides webhook support for event-driven HTTP callbacks where our server pushes real-time notifications to your endpoints. Our webhook system delivers events for pet adoptions, order status changes, payment confirmations, and pet availability updates directly to your registe… - [PetstoreAPI WebSocket Protocol Guide](https://docs2.petstoreapi.com/protocols/websocket.md): **Modern Petstore API** provides WebSocket support for full-duplex, low-latency communication over a single TCP connection. Our WebSocket implementation enables real-time customer support chat through the `/v1/ws/chat` endpoint, allowing bidirectional messaging between users and support agents with… - [PetstoreAPI WSDL Protocol Guide](https://docs2.petstoreapi.com/protocols/wsdl.md): The Modern Petstore API provides a **WSDL (Web Services Description Language)** specification for SOAP-based enterprise integration. - [Quick Start Guide](https://docs2.petstoreapi.com/quick-start.md): Get started with the Modern Petstore API in minutes. This guide covers all available protocols and provides ready-to-use examples for the SaaS platform. ## OpenAPI Specs - [modern-petstore-3.1.openapi](https://docs2.petstoreapi.com/api-reference/modern-petstore-3.1.openapi.json) - [classic-petstore-3.0.openapi](https://docs2.petstoreapi.com/api-reference/classic-petstore-3.0.openapi.json) - [openapi](https://docs2.petstoreapi.com/api-reference/openapi.json) ## Optional - [Home](https://petstoreapi.com/)