Swagger Petstore - OpenAPI 3.0
POST/pet

Create a pet in the store

Creates a new pet in the store. Supply name and photoUrls; status can be available, pending, or sold. You can send the pet data as JSON, XML, or URL-encoded form data.

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

6 body fields

Pet details to add to the store. Supply name and photoUrls; the body can use JSON, XML, or URL-encoded form data.

idintegeroptional
The pet's 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 created pet object, including its available pet details.
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 pet data fails validation.
defaultReturned when an unexpected error occurs.

Error handling

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