woofbot.io is a free API service that generates dog pictures from an array of different breeds.
The current version of woofbot.io API lives at https://api.woofbot.io/v1/
- All API calls should be made as
GET
requests and will return a JSON object by default as well as a HTTP status code of 200, if successful. - In the event of an API call failing,
status
will have the value oferror
and HTTP status code that is NOT 200. Within the response object returned, an element calledmessage
will be visible stating the error message associated with your call.
We always are welcomed to suggestions to our service. Open up an issue with any feedback you may have for us.
Method is used to obtain the list of breeds that the woofbot.io API currently supports.
https://api.woofbot.io/v1/breeds
In the event of a successful reply, the response should look similar to the following:
{
"status": "success",
"response": {
"breeds": [
"Corgi",
"Pug",
"Husky",
"Golden Retriever",
"German Shepherd",
"Pitbull",
"Shiba",
"French Bulldog"
]
}
}
status
- Returnssuccess
on successful completion of API callresponse
- Returns API response objectbreeds
- An array listing supported breeds
Method is used to obtain the amount of pictures associated with one particular breed.
Example Call:
https://api.woofbot.io/v1/breeds/corgi/count
In the event of a successful reply, the response should look similar to the following:
{
"status": "success",
"response": {
"count": {
"amount": 70,
"breed": "corgi"
}
}
}
status
- Returnssuccess
on successful completion of API callresponse
- Returns API response objectcount
- Returnscount
objectamount
- Returns amount of pictures woofbot.io has on particular breedbreed
- Returns breed associated with the amount element
Method is used to obtain a random picture associated with one particular breed.
Example Call:
https://api.woofbot.io/v1/breeds/corgi/image
In the event of a successful reply, the response should look similar to the following:
{
"status": "success",
"response": {
"url": "https://images.woofbot.io/corgi/c8d69b75bd9aff257d9f0c0b95281f56.jpg"
}
}
status
- Returnssuccess
on successful completion of API callresponse
- Returns API response objecturl
- Returns a direct image URL to a picture of the requested breed