Swagger Petstore - OpenAPI 3.0
POST/pet

Add a pet to the store

Creates a new pet record in the store. Provide name and photoUrls; status, when supplied, must be available, pending, or sold. The response contains the created pet record.

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

6 body fields

Pet details to add to the store. The body can be sent as JSON, XML, or URL-encoded form data; name and photoUrls are required.

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

4 status codes
200Returns the created pet object, including its identifier, name, photo URLs, 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 pet payload fails validation.
defaultUnexpected error

Error handling

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