Saltar al contenido principal

Pets & Pet Analysis

Manage your pets, upload their photos, and leverage powerful AI to analyze their health, age, and breed composition. This controller allows for comprehensive pet profile management and advanced computer vision analysis.

Core Management

Create a Pet

Create a profile for your pet. You can include multiple initial images during creation by repeating the images field.

curl -X POST -H "x-api-key: YOUR-API-KEY" -H "Content-Type: multipart/form-data" \
-F "name=Buddy" \
-F "breed_id=15" \
-F "date_of_birth=2022-06-15" \
-F "sub_id=my-user-123" \
-F "description=My best friend" \
-F "images=@/path/to/front_view.jpg" \
-F "images=@/path/to/side_view.jpg" \
https://api.thedogapi.com/v1/pets

List your Pets

Retrieve a paginated list of all pets associated with your account.

curl -H "x-api-key: YOUR-API-KEY" "https://api.thedogapi.com/v1/pets?limit=10&page=0"

Get Pet Details

Retrieve full profile details for a specific pet, including all their uploaded images.

curl -H "x-api-key: YOUR-API-KEY" https://api.thedogapi.com/v1/pets/{pet_id}

Update a Pet

Update metadata like name, breed, or description.

curl -X PATCH -H "x-api-key: YOUR-API-KEY" -H "Content-Type: application/json" \
-d '{"description": "Loves playing fetch"}' \
https://api.thedogapi.com/v1/pets/{pet_id}

Media Management

Upload Pet Images

To upload additional photos for an existing pet, use the /images sub-resource. This is useful for providing the AI with more reference angles for higher-quality analysis.

curl -X POST -H "x-api-key: YOUR-API-KEY" -H "Content-Type: multipart/form-data" \
-F "images=@/path/to/photo_3.jpg" \
-F "images=@/path/to/photo_4.jpg" \
https://api.thedogapi.com/v1/pets/{pet_id}/images

AI Health & Condition Analysis

Computer vision algorithms analyze your pet's images to provide quantitative and qualitative insights.

Body Condition Score (BCS)

The AI analyzes profile and overhead photos to determine if a pet is underweight, ideal, or overweight.

curl -X POST -H "x-api-key: YOUR-API-KEY" \
https://api.thedogapi.com/v1/pets/{pet_id}/body-condition-score

Example Output

{
"score": 5,
"reasons": [
"Ribs are easily palpable with minimal fat cover.",
"Waist is easily noted when viewed from above.",
"Abdominal tuck is evident when viewed from the side."
],
"generated_at": "2024-03-23T10:00:00.000Z"
}

"Ideal Body Condition Analysis Example"

Muscle Condition Score

Analyzes muscle mass across the spine, scapulae, and hips to identify risks of muscle wasting.

curl -X POST -H "x-api-key: YOUR-API-KEY" \
https://api.thedogapi.com/v1/pets/{pet_id}/muscle-condition-score

Estimated Age

If a pet's exact history is unknown, our AI can estimate their age by analyzing physical indicators.

curl -X POST -H "x-api-key: YOUR-API-KEY" \
https://api.thedogapi.com/v1/pets/{pet_id}/estimated-age

Genealogy & Breed Insights

Understand your pet's ancestry through visual pattern recognition.

curl -X POST -H "x-api-key: YOUR-API-KEY" \
https://api.thedogapi.com/v1/pets/{pet_id}/genealogy

Genealogy Response

{
"breed_mixture": [
{ "id": 121, "name": "Golden Retriever", "percentage": 75 },
{ "id": 149, "name": "Labrador Retriever", "percentage": 25 }
],
"creative_description": "A loyal and energetic companion with a sun-kissed coat.",
"gender_prediction": "male"
}

AI Portraits

Generate stylized, professional-quality artwork featuring your pet.

1. List Available Styles

curl -H "x-api-key: YOUR-API-KEY" https://api.thedogapi.com/v1/pets/portrait-styles

2. Generate Artwork

curl -X POST -H "x-api-key: YOUR-API-KEY" -H "Content-Type: application/json" \
-d '{"style": "studio"}' \
https://api.thedogapi.com/v1/pets/{pet_id}/portrait
StudioPack LeaderBirthday
"Studio Portrait Style""Pack Leader Portrait Style""Birthday Portrait Style"

Cleanup

Delete a Pet

Permanently remove a pet profile and all associated data.

curl -X DELETE -H "x-api-key: YOUR-API-KEY" https://api.thedogapi.com/v1/pets/{pet_id}