Swagger Petstore - OpenAPI 3.0
POST/pet

Create a pet

Creates a new pet in the store. Supply name and photoUrls; status can be available, pending, or sold. The response includes the created pet details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Pet details to add to the store; name and photoUrls are required.

idintegeroptional
The pet's unique identifier.
namestringrequired
The pet's name.
categoryobjectoptional
The pet's category, with an identifier and name.
photoUrlsarray<string>required
URLs for photos of the pet.
tagsarray<object>optional
Tags associated with the pet, each with an identifier and name.
statusstringoptional
pet status in the store
Allowed:availablependingsold

4 status codes
200Returns the pet object with its identifier, name, category, photo URLs, tags, and status.
idintegeroptional
namestringrequired
categoryobjectoptional
photoUrlsarray<string>required
tagsarray<object>optional
statusstringoptional
pet status in the store
Allowed:availablependingsold
400Returned when the input is invalid.
422Returned when the request fails validation.
defaultUnexpected error

Error handling

Omitting name or photoUrls returns a 400. A 422 is returned when the request fails validation; status, if supplied, must be available, pending, or sold.