Swagger Petstore - OpenAPI 3.0

Name: Swagger Petstore - OpenAPI 3.0 API
Brand: Swagger Petstore API
Availability: InStock

✓ Official Vendor SpecDeveloper ToolsExample Apioauth219 EndpointsREST

For Agents

Manage pet store inventory, process orders, and handle user accounts through the canonical OpenAPI 3.0 example API.

Connect the Swagger Petstore - OpenAPI 3.0 to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Swagger Petstore - OpenAPI 3.0, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Swagger Petstore - OpenAPI 3.0 API.

Create, read, update, and delete pets with name, category, photoUrls, tags, and status

Find pets by status (available, pending, sold) or by tags with array filters

Upload pet images with multipart form data

Manage store inventory and retrieve available stock counts by status

GET STARTED

Start building with Swagger Petstore - OpenAPI 3.0 API

Explore with Jentic

View OpenAPI Document

Jentic publishes the agent-ready OpenAPI specification for the Swagger Petstore example API, the canonical reference implementation for OpenAPI 3.0. This sample Pet Store Server demonstrates REST API design patterns, authentication schemes, and data modeling best practices. Manage pet inventory with full CRUD operations, process store orders, and handle user accounts. Supports both OAuth 2.0 and API key authentication. Includes operations for finding pets by status or tags, uploading pet images, managing inventory, and placing orders. Widely used for API learning, tooling validation, and OpenAPI specification testing.

Use Cases

Patterns agents use Swagger Petstore - OpenAPI 3.0 API for, with concrete tasks.

★ OpenAPI Learning and Tooling Validation

The Swagger Petstore is the canonical example for learning OpenAPI 3.0 specification structure, testing code generators, validating API documentation tools, and demonstrating REST API design patterns. It includes common patterns like resource CRUD, filtering by status or tags, file uploads, authentication flows, and error handling. Use this for teaching REST API development, testing OpenAPI-based SDKs, or validating API gateway configurations.

Use the Swagger Petstore API to demonstrate how to find pets by status, create a new pet with tags, upload a pet photo, and place an order through a REST API

AI Agent API Integration Testing

AI agents use the Swagger Petstore through Jentic to test API integration workflows, validate tool-calling patterns, and develop agentic API interaction logic without impacting production systems. The agent searches Jentic for 'petstore api', receives the full operation schema with pet, store, and user resources, and executes test scenarios. Ideal for training agents on REST patterns, authentication handling, and error recovery before connecting to real-world APIs.

Search for available pets, create a new pet named 'Max' with status 'available' and tags ['friendly', 'trained'], upload a photo, then place an order for pet ID 123

REST API Design Pattern Reference

Study common REST API design patterns including resource collections, query parameter filtering, path parameter identification, request body schemas, status-based filtering, pagination concepts, and authentication flows. The Petstore demonstrates how to model relationships (pet -> category, pet -> tags), handle file uploads, manage user sessions, and structure error responses with standard HTTP status codes.

Analyze the Petstore API structure to extract patterns for filtering (findByStatus, findByTags), resource identification (GET /pet/{petId}), and batch operations (POST /user/createWithList)

Authentication Flow Demonstration

The Petstore supports both OAuth 2.0 (with implicit flow and scopes write:pets, read:pets) and API key authentication (via api_key header). Use this to learn how to implement multiple authentication schemes in a single API, scope-based authorization, session management with login/logout endpoints, and security scheme configuration in OpenAPI. Demonstrates how different operations require different auth levels.

Demonstrate both authentication methods: first authenticate with OAuth 2.0 to create a pet (write:pets scope), then use API key auth to retrieve pet details, and finally logout to terminate the session

Key Endpoints

19 endpoints — jentic publishes the agent-ready openapi specification for the swagger petstore example api, the canonical reference implementation for openapi 3.

METHOD

PATH

DESCRIPTION

GET

/pet/findByStatus

Find pets by status (available, pending, sold) with comma-separated values

GET

/pet/findByTags

Find pets by tags with array query parameters

GET

/pet/{petId}

Retrieve a specific pet by ID

POST

/pet

Add a new pet to the store with name, category, photoUrls, tags, and status

PUT

/pet

Update an existing pet by ID

DELETE

/pet/{petId}

Delete a pet by ID

POST

/pet/{petId}/uploadImage

Upload a pet image with multipart form data

GET

/store/inventory

Get store inventory counts by status

POST

/store/order

Place an order for a pet

GET

/store/order/{orderId}

Retrieve order details by ID

POST

/user

Create a new user account

GET

/user/login

Log user into the system

GET

/user/logout

Log out current user session

GET

/pet/findByStatus

Find pets by status (available, pending, sold) with comma-separated values

GET

/pet/findByTags

Find pets by tags with array query parameters

GET

/pet/{petId}

Retrieve a specific pet by ID

POST

/pet

Add a new pet to the store with name, category, photoUrls, tags, and status

PUT

/pet

Update an existing pet by ID

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Petstore OAuth tokens and API keys are stored encrypted in the Jentic vault (MAXsystem). Agents submit requests with Jentic injecting credentials — raw secrets never enter the agent's context. Ideal for training agents on authentication patterns without exposing real credentials.

Intent-based discovery

Agents search by intent (e.g., 'example api' or 'openapi demo') and Jentic returns the Petstore operation schemas with full documentation, so the agent can practice API interactions without parsing Swagger UI manually.

Time to first call

Direct Petstore integration: 1-2 hours for understanding the spec, implementing auth, and testing operations. Through Jentic: under 30 minutes — search, load schema, execute test scenarios.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

HTTPBin API

HTTPBin tests HTTP request/response patterns while Petstore demonstrates REST resource modeling

Use HTTPBin to test HTTP mechanics (headers, methods, status codes); use Petstore to learn REST API resource design and OpenAPI patterns

Alternative

JSONPlaceholder API

JSONPlaceholder is another popular example REST API with posts/comments/users resources

Use JSONPlaceholder for simple REST testing with familiar blog-style resources; use Petstore for OpenAPI-compliant examples with authentication flows

FAQs

Specific to using Swagger Petstore - OpenAPI 3.0 API through Jentic.

What is the Swagger Petstore API used for?

The Swagger Petstore is the canonical example API for the OpenAPI specification. It demonstrates REST API design patterns, authentication schemes, and resource modeling best practices. It's widely used for learning OpenAPI, testing code generators, validating API tooling, and teaching REST API development concepts. Not intended for production use — it's an educational reference implementation.

What authentication does the Swagger Petstore API support?

Petstore supports two authentication schemes: OAuth 2.0 with implicit flow (scopes: write:pets, read:pets) for operations that modify data, and API key authentication via the api_key header for read operations. Through Jentic, credentials are stored encrypted and injected at execution time — agents never handle raw secrets or OAuth tokens.

Can I use the Swagger Petstore API for production applications?

No. The Swagger Petstore is a sample/example API designed for learning, testing, and demonstration purposes only. It's not intended for production use. Use it to understand OpenAPI patterns, test API tooling, or train AI agents on REST API interactions before connecting to real-world production APIs.

How do I filter pets by status in the Petstore API?

Use the GET /pet/findByStatus endpoint with the status query parameter set to 'available', 'pending', or 'sold'. Multiple status values can be provided as comma-separated strings. This demonstrates the standard REST pattern for filtering resource collections by an enumerated attribute.

How do I test API integrations with the Swagger Petstore through Jentic?

Search Jentic for 'petstore api' or 'swagger example api', then load the operation schemas for pet, store, or user resources. Execute test scenarios like creating pets, placing orders, and managing users. Jentic handles authentication injection, so agents can focus on learning API interaction patterns. Install with pip install jentic or sign up at https://app.jentic.com/sign-up.

What REST API patterns does the Petstore demonstrate?

The Petstore demonstrates: resource CRUD operations (POST, GET, PUT, DELETE), query parameter filtering (findByStatus, findByTags), path parameter identification (GET /pet/{petId}), file uploads (POST /pet/{petId}/uploadImage), batch operations (POST /user/createWithList), session management (login/logout), and standard HTTP status codes for error handling.