Audio Description API from Guide Dogs

Overview

This JSON REST API allows you to send over an image or text and receive back responses from each of our dogs just like on the primary page.

Looking for access to the API? Contact us and we will send you additional documentation and an API key.

All endpoints require an API key passed as a header in the request: X-API-KEY: your_api_key_here

Guide Dogs

GET /guide-dogs

Retrieves a list of the available guide dogs and the formats they support.

Example Request

GET /guide-dogs
X-API-KEY: your_api_key_here

Example Response

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Grayfriar",
      "short_description": "Outlines in His Sleep",
      "description": "When Grayfriar reads a description, he really is reading its structure. What is this sentence saying to the listener? How does it fit into the larger picture being created? How could it be more efficient? How could it be more clear? Grayfriar is a great 'Dog for establishing your storytelling building blocks.",
      "long_description": "Greyfriars Bobby was one of the most-loyal dogs in history, and our Grayfriar was named after him.",
      "image": "https://guidedogs.accesshound.com/storage/app/uploads/public/674/c21/fe9/674c21fe95d15924387207.png",
      "alt_text": "DESCRIBING: A square color photograph\nDESCRIPTION: Grayfriar is an anthropomorphized Weimaraner, dark gray in fur, shown from the shoulders up. He's wearing shaded and rounded sunglasses and a leather jacket. The jacket is blue, with brown accents, and the collar includes golden studs around the neck, with the front of the color left open and dangling. He is looking over his left shoulder."
    },
    {
      "id": 2,
      "name": "Balto",
      "short_description": "The Closer",
      "description": "Balto is all about getting the job done. When you are in a pinch, and you need something now, call on Balto to get the descriptive juices flowing. Balto has been trained on the Access Hound style of Audio Description, in terms of format and approach. He doesn't describe yet at the level of human describers, but he's catching up quickly.",
      "long_description": "The historical Balto was a famous sled dog with many twists and turns to his story. Our Balto is a pug, because, we love pugs.",
      "image": "https://guidedogs.accesshound.com/storage/app/uploads/public/674/c2f/17c/674c2f17c5969410538663.png",
      "alt_text": "DESCRIBING: A square color photograph\nDESCRIPTION: A brindle, anthropomorphized pug, Balto is facing the camera and shown from the shoulders up. He's wearing a stylish light-brown leather jacket with an upturned collar. He's also wearing shaded sunglasses. Like all good pugs, he has a furrowed brow that makes him look a bit worried all of the time."
    }
  ],
  "meta": {
    "total": 10,
    "limit": 2,
    "offset": 0
  }
}

Get AD feedback

POST /feedback

Retrieves image or text feedback from the selected dogs.

Example Request

POST /feedback
X-API-KEY: your_api_key_here

Example Request

{
      "guide-dogs": [1, 2],
      "image": "https://example.com/image.png",
      "text": "When you are not logged into the system, we provide this sample text description below as a way to quickly try out the system. We also have a sample photo uploaded. Just pick a 'Dog, and whether you want guidance on the uploaded image or the text, and RELEASE THE HOUNDS!

DESCRIBING: A medium, vertical photograph.

A visitor dressed in beige shorts, brown hiking boots, a bright green long sleeved shirt and wearing a big blue backpack is seen hiking in a mountainous region in Nahanni National Park. The hiker is looking off to one side smiling and is using a hiking pole, which is grasped in one hand.

Behind the hiker gray rocky cliffs rise up sharply into the sky, which is dominated by white fluffy clouds with only a small patch of blue sky showing at the top right corner. At the base of the rock face to the right of the hiker, short yellow grass creeps up the base of the cliff side and continues into the foreground where it meets the route the hiker is travelling upon. To the left of the hiker is a big grey boulder and to the right longer green grass grows.

CAPTION: Nahanni National Park Reserve

RELATED TEXT: We are epic adventures!",
}

Example Response

{
  "success": true,
  "data": [
    {
      "guide-dog": 1,
      "name": "Grayfriar",
      "response": "...",
    },
    {
      "guide-dog": 2,
      "name": "Balto",
      "response": "...",
    }
  ],
  "meta": {
    "total": 2
    "limit": 2,
    "offset": 0
  }
}