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, if provided, must be available, pending, or sold. A 200 response returns 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. Send the body as JSON, XML, or URL-encoded form data; name and photoUrls are required.

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

4 status codes
200Returns the pet record, including 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 validation fails.
defaultReturned when an unexpected error occurs.

Error handling

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