Skip to content
Get started

Pets

Add a new pet to the store.
client.pets.create(PetCreateParams { name, photoUrls, id, 3 more } body, RequestOptionsoptions?): Pet { name, photoUrls, id, 3 more }
POST/pets
List all pets.
client.pets.list(RequestOptionsoptions?): PetListResponse { name, photoUrls, id, 3 more }
GET/pets
Find pet by ID.
client.pets.retrieve(numberpetID, RequestOptionsoptions?): Pet { name, photoUrls, id, 3 more }
GET/pets/{petId}
Deletes a pet.
client.pets.delete(numberpetID, RequestOptionsoptions?): void
DELETE/pets/{petId}
ModelsExpand Collapse
Category { id, name }
id?: number
formatint64
name?: string
Error { id, message }
id: string

Machine-readable error code

message: string

Human-readable error message

ErrorResponse { error }
error: Error { id, message }
id: string

Machine-readable error code

message: string

Human-readable error message

Pet { name, photoUrls, id, 3 more }
name: string
photoUrls: Array<string>
id?: number
formatint64
category?: Category { id, name }
id?: number
formatint64
name?: string
status?: "available" | "pending" | "sold"

pet status in the store

Accepts one of the following:
"available"
"pending"
"sold"
tags?: Array<Tag { id, name } >
id?: number
formatint64
name?: string
Tag { id, name }
id?: number
formatint64
name?: string