Skip to content
maxf-docs-dev-7
Get started
API Reference

Pets

Update an existing pet
pets.update(PetUpdateParams**kwargs) -> Pet
PUT/pet
Add a new pet to the store
pets.create(PetCreateParams**kwargs) -> Pet
POST/pet
Finds Pets by status
pets.find_by_status(PetFindByStatusParams**kwargs) -> PetFindByStatusResponse
GET/pet/findByStatus
Finds Pets by tags
pets.find_by_tags(PetFindByTagsParams**kwargs) -> PetFindByTagsResponse
GET/pet/findByTags
Find pet by ID
pets.retrieve(intpet_id) -> Pet
GET/pet/{petId}
Updates a pet in the store with form data
pets.update_by_id(intpet_id, PetUpdateByIDParams**kwargs)
POST/pet/{petId}
Deletes a pet
pets.delete(intpet_id)
DELETE/pet/{petId}
uploads an image
pets.upload_image(intpet_id, Optional[object]image, PetUploadImageParams**kwargs) -> PetUploadImageResponse
POST/pet/{petId}/uploadImage
ModelsExpand Collapse
class Category: …
id: Optional[int]
name: Optional[str]
class Pet: …
name: str
photo_urls: List[str]
id: Optional[int]
category: Optional[Category]
id: Optional[int]
name: Optional[str]
status: Optional[Literal["available", "pending", "sold"]]

pet status in the store

Accepts one of the following:
"available"
"pending"
"sold"
tags: Optional[List[Tag]]
id: Optional[int]
name: Optional[str]