This is a modern Pet Store API based on the OpenAPI 3.2 specification. It demonstrates contemporary API design patterns and best practices including RESTful compliance, proper HTTP methods, structured error responses (RFC 9457), and modern authentication flows. Key features include pet catalog browsing, adoption workflow, order management, user accounts, AI-powered chat advisor, and real-time event notifications via webhooks. The API showcases OpenAPI 3.2 capabilities like hierarchical tags, QUERY HTTP method, OAuth device flow, and server-sent events. Some useful links: - [API Documentation](https://docs.petstoreapi.com) - [Source Code Repository](https://github.com/petstoreapi/PetstoreAPI) - [OpenAPI Specification](https://petstoreapi.com/v1/specs/modern-petstore-3.2.openapi.yaml) Version: 1.0.0 Unique identifier for the pet Retrieve detailed information about a specific pet. Successful response with pet details Update information for an existing pet. Staff only. Pet updated successfully Delete a pet from the system. Staff only. Pet deleted successfully Retrieve a paginated list of pets available for adoption with optional filtering. Filter by pet species Filter by adoption status Minimum age in months Maximum age in months Filter by pet size Filter pets that are good with children Page number for pagination Number of items per page Successful response with pet collection Add a new pet to the store catalog, making it available for adoption. ## Pet Lifecycle Workflow When a new pet enters the system: 1. **Intake**: Staff creates a pet record with this endpoint (status: `available`) 2. **Profile**: Pet details include species, breed, age, medical info, photos, and adoption fee 3. **Discovery**: Pet appears in search results and listings 4. **Adoption Application**: Potential adopters can apply through the adoption endpoints 5. **Adoption**: Once approved, pet status changes to `adopted` 6. **Post-Adoption**: Pet record is retained for historical purposes **Access**: This operation requires staff permissions (`write:pets` scope or valid Bearer token). Only authenticated staff members can add pets to the system. Pet created successfully Creates a model response for a chat conversation with the Pet Adoption Advisor AI. Supports streaming responses using Server-Sent Events (SSE). ## Pet Adoption Advisor Our AI assistant helps users: - Get personalized pet recommendations - Learn about pet care and adoption process - Answer questions about specific pets - Provide breed information and compatibility advice ## Streaming Mode When `stream: true`, the response is sent as Server-Sent Events (SSE), with each token delivered incrementally. This provides a better user experience for longer responses. ### Stream Format Each chunk is sent as: ``` data: {"id":"chatcmpl_abc","object":"chat.completion.chunk","choices":[{"delta":{"content":"Hello"},"index":0}]} ``` The stream ends with: ``` data: [DONE] ``` ## Non-Streaming Mode When `stream: false` or omitted, returns a complete response object. Successful response. Format depends on the `stream` parameter. Upload an image for the specified pet. Requires authentication and write:pets permission. Operation successful Process payment for an existing order. ## Payment Workflow Payment processing follows this workflow: 1. **Create Order**: First create an order using `POST /orders` (status: `placed`) 2. **Submit Payment**: Call this endpoint with payment details (card or bank account) 3. **Payment Processing**: The payment is processed with status `processing` 4. **Payment Result**: - **Success**: Payment status becomes `succeeded`, order status updates to `approved` - **Failure**: Payment status becomes `failed`, order remains `placed` and can be retried 5. **Receipt**: After successful payment, retrieve the receipt from the order details **Security Note**: Sensitive payment data (like CVC codes) are `writeOnly` and never returned in responses. Card numbers and account numbers are masked when read. Payment successful Returns a mapping of status codes to quantities. Values to filter inventory status (comma-separated). Operation successful Create a new order in the store. Operation successful Unique identifier for the order Retrieve order information by order ID. Operation successful Handles order events and supports asynchronous processing with Callback. Callback enqueued successfully. Delete an existing order by its unique identifier. Resource deleted successfully Create a new user in the system. User created successfully. Unique identifier for the user Retrieve user information by user ID. Operation successful Update user information. Only the logged-in user can perform this operation. User updated successfully. Delete a user account. Only the logged-in user can perform this operation. Resource deleted successfully Authenticate user and obtain an access token. Login successful