The Dog
REST API documentation for the TheDogAPI created by ThatAPICompany. Documentation and tutorials available at https://docs.thedogapi.com
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
REST API documentation for the TheDogAPI created by ThatAPICompany. Documentation and tutorials available at https://docs.thedogapi.com
Endpoints 70
Pets
- GETList pets for the authenticated account
/pets - POSTCreate a pet with optional images
/pets - POSTUpload additional images for an existing pet
/pets/:petId/images - POSTUpload an additional video for an existing pet
/pets/:petId/videosSend the video in the multipart field file, up to 200 MB. MP4, MOV, WebM, AVI, MPEG and 3GP are accepted. The type is read from the file itself, so a generic… - GETList available portrait styles
/pets/portrait-styles - GETGet a pet by ID
/pets/:petId - DELETEDelete a pet
/pets/:petId - PATCHUpdate pet metadata
/pets/:petId - GETGet only the AI generated portraits for a pet
/pets/:petId/portraits - POSTAnalyse the body condition score (BCS) for a pet based on their images
/pets/:petId/body-condition-score - POSTEstimate the age of a pet based on their images
/pets/:petId/estimated-age - POSTAnalyze genealogy/breed from all pet images
/pets/:petId/genealogy - POSTEvaluate Muscle Condition from all pet images as a wasting risk flag
/pets/:petId/muscle-condition-score - POSTEstimate weight and size for a pet based on photos
/pets/:petId/estimated-weight - GETGet personalised health tips for a pet based on their images and health scores
/pets/:petId/health-tipsReturns a blend of breed-standard seeded tips (filtered by primary breed) and AI-generated personalised tips. Results are cached per pet per request signature… - POSTGenerate an AI portrait for a pet
/pets/:petId/portrait - GETList vet reviews of this pet's body condition scores, newest first
/pets/:petId/body-condition-score/reviews - GETList a pet's visits, most recent first
/pets/:petId/visits - POSTRecord a vet visit, with its clinical notes and measurements
/pets/:petId/visitsOne call writes the visit, its items and its observations in a single transaction. Reposting the same external_id for the same source_system updates that… - GETGet a single visit with its notes and measurements
/pets/:petId/visits/:visitId - POSTRecord a pet's exercise band, weight or body condition score
/pets/:petId/observationsFor inputs collected outside a vet visit. exercise_band is the actual daily exercise (lt_30, 30_60 or gt_60 minutes). The calculators read the latest value of…
Calculators
- POSTDaily energy requirement (RER and MER) for a weight, breed or pet
/calculators/energy-requirementRER = 70 x kg^0.75; MER = RER x a life stage factor (AAHA 2021 Nutrition and Weight Management Guidelines). For adult dogs the factor follows actual daily… - POSTWeight-loss plan: daily kcal at ideal weight, staged by body condition band
/calculators/weight-loss-planIdeal weight from a vet-entered value, a weight recorded at BCS 5, the BCS (each point above 5 is about 10% overweight, AAHA 2014) or the breed range. Feeds…
Breeds
- GETList the registered colour/pattern variants for a breed
/breeds/:id/coloursReturns the palette of colour/pattern variants valid for this breed - breed-specific variants (e.g. Birman colourpoints) plus any that apply species-wide. - GETSearch breeds by name
/breeds/search - GETList breeds
/breeds - GETList available breed groups
/breeds/breed-groups - GETRetrieve a breed by identifier
/breeds/:id
Images
- GETSearch for public images
/images/search - GETRetrieve an image by id
/images/:id - DELETEDelete an uploaded image
/images/:id - GETGet the latest breed identification labels for an image
/images/:id/labels - POSTUpload an image
/images/uploadUploads an image for processing. This is an opaque asynchronous operation. The response includes a links.status URL which SHOULD be polled to check the… - GETGet the processing status of an uploaded image
/images/:id/statusReturns the current processing status of the image. Clients should poll this endpoint until the status changes from to_be_reviewed to clean or unsafe, then… - POSTUpload an image and wait for analysis to complete
/images/upload-syncThis endpoint uploads an image and waits for analysis to complete before returning the result. The response includes the analysis status and any detected tags. - POSTRequest an image to be made public
/images/:imageId/public-requests - DELETECancel a pending public request
/images/:imageId/public-requests - GETGet the public request status for an image
/images/:imageId/public-requests/status
Health Tips
- GETGet a list of health tips
/health-tipsRetrieve health tips with optional filtering by breed or species, and pagination support. - GETGet health tips for a specific breed
/health-tips/breed/:breedIdRetrieve all health tips for a specific breed with pagination support. - GETGet a health tip by ID
/health-tips/:idRetrieve a specific health tip by its unique identifier.
Facts
- GETGet a list of facts
/factsRetrieve facts with optional filtering by breed or species, and pagination support. - GETGet a random fact
/facts/randomRetrieve a completely random fact from all available facts. - GETGet facts by breed
/facts/breed/:breedIdRetrieve all facts for a specific breed with pagination support. - GETGet a random fact for a specific breed
/facts/breed/:breedId/randomRetrieve a random fact for the specified breed. - GETGet a random fact for a specific species
/facts/species/:speciesId/randomRetrieve a random fact for the specified species. - GETGet a fact by ID
/facts/:idRetrieve a specific fact by its unique identifier.
Breed Bans
- GETList countries with breed legislation
/breeds/bans/countries - GETGet breed bans and legislation by country
/breeds/bans/country?country=AUReturns all breed bans, restrictions, and characteristic-based legislation for a country. If the country does not have national-level legislation, returns… - GETGet all bans for a specific breed globally
/breeds/bans/breed/:breedIdReturns every country and jurisdiction where this breed is banned, restricted, or requires a permit.
Webhooks
- GETList all webhook endpoints
/webhooks - POSTCreate a new webhook endpoint
/webhooks - GETList available webhook topics
/webhooks/topics - GETGet a specific webhook endpoint
/webhooks/:id - DELETEDelete a webhook endpoint
/webhooks/:id - POSTIssue a new signing secret for this endpoint. The old one stops working immediately.
/webhooks/:id/rotate-secret
Accounts
- GETGet enabled feature flags for the current account
/accounts/features - GETGet current upload quota usage and remaining limit
/accounts/quota - GETList the analysis capabilities on this account and whether each is switched on
/accounts/capabilities - PATCHSwitch a capability off (or back on) for this account. Off makes its endpoints return 403.
/accounts/capabilities/:capabilityId
Votes
- GETList votes for the authenticated user
/votes - POSTCreate a vote
/votes - GETGet a vote by ID
/votes/:vote_id
Favourites
- GETList favourites for the authenticated user
/favourites - POSTCreate a favourite for the authenticated user
/favourites - GETRetrieve a favourite by identifier
/favourites/:id - DELETEDelete a favourite
/favourites/:id
Categories
- GETRetrieve a category by identifier
/categories/:id - GETList categories
/categories
Sub IDs
- GETGet detailed list of sub_ids used in the account along with counts representing usage activity
/sub-ids
API details
- Base URL
https://api.thedogapi.com/v1- Authentication
- An API key in the x-api-key header
- Operations
- 70 operations on 59 pathsGET 43POST 20DELETE 5PATCH 2
- Main resources
- Pets 21Images 10Facts 6Webhooks 6Breeds 5Accounts 4Favourites 4Breed Bans 3Health Tips 3Votes 3
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.7.1 - Links
- OpenAPI document · Support
How to test the The Dog in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the The Dog collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the x-api-key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List pets for the authenticated account” (GET /pets), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the The Dog?
REST API documentation for the TheDogAPI created by ThatAPICompany. Documentation and tutorials available at https://docs.thedogapi.com It is listed under Data & analytics and has 70 endpoints.
Who publishes the The Dog?
It is listed from Thedogapi's public API description (an OpenAPI document), not published by Thedogapi on Swastik Codes. Anyone who controls thedogapi.com can claim the profile by adding a DNS TXT record.
What is the base URL of the The Dog?
Requests go to https://api.thedogapi.com/v1. Endpoint paths are added to this base URL.
How do I authenticate with the The Dog?
With an API key in the x-api-key header.
How many endpoints does the The Dog have?
70 operations on 59 paths (43 GET, 20 POST, 5 DELETE, 2 PATCH). The largest groups are Pets, Images, Facts, Webhooks.
Is forking the The Dog free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.