Swagger Petstore - OpenAPI 3.0
POST/pet

Create a pet

Creates a new pet in the store. Supply name and photoUrls; you can also provide a category, tags, and a status of available, pending, or sold. The response includes the created pet resource.

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

6 body fields

Pet details to add to the store.

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

4 status codes
200Returns the pet object, including its identifier, name, photos, and any supplied category, 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 input fails validation.
defaultUnexpected error

Error handling

A 400 is returned for invalid input, and a 422 for a validation exception. name and photoUrls are required; status must be available, pending, or sold.