Ares API Documentation

Overview

The Ares API is a powerful tool that takes a query as input and generates a detailed response along with the URLs from which the answer was derived. It is particularly useful for obtaining information related to specific queries.

Get your api key here

Sample Code for Python

import requests
import json

url = "https://api-ares.traversaal.ai/live/predict"

payload = { "query": ["taco spots in San Francisco"] }
headers = {
  "x-api-key": "_your api key_",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

Sample Endpoints using Curl:

curl --request POST \
  --url https://api-ares.traversaal.ai/live/predict \
  --header 'content-type: application/json' \
  --header 'x-api-key: _your_api key_' \
  --data '{
  "query":
  ["Good Indian food in Seattle?"]
}'

Sample Endpoint using JavaScript (Node.js):

const fetch = require('node-fetch');

const apiUrl = 'https://api-ares.traversaal.ai/live/predict';
const apiKey = "_your api key_",;

const requestData = {
  query: ['taco spots in San Francisco']
};

fetch(apiUrl, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': apiKey
  },
  body: JSON.stringify(requestData)
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

Note: Make sure to install the node-fetch library if you're running this in a Node.js environment.

These examples demonstrate how to make a POST request to the Ares API's predict endpoint using both curl and JavaScript. You can modify the requestData object to include different queries as needed.

Output Format

The generated output is provided in JSON format and contains two main components:

1. Response Text

The response_text field contains the detailed answer to the query. In this example, it provides information about the top taco spots in San Francisco, including details about each spot.

{
  "data": {
    "response_text": "
1. Papito: Located at 1457 18th St, San Francisco, CA 94107, Papito is known for their delicious baja fish tacos.
2. Nopalito's: If you're looking for a healthier option, head to Nopalito's at 306 Broderick St, San Francisco, CA 94117. This modern, all-organic Mexican restaurant offers make-it-yourself-style tacos with a platter of carnitas, curtido cabbage slaw, and tangy salsa cruda. Their house-made tortillas are a standout.
3. Barrio: For a meal with a view of the Golden Gate Bridge, visit Barrio at 1609 Powell St, San Francisco, CA 94133. Their no-frills tacos, especially the Cochinita Pibil marinated pork tacos, are a must-try. Each taco order comes with a side of beans and rice.
4. Bonita Taqueria and Rotisserie: Located at 2257 Chestnut St, San Francisco, CA 94123, Bonita Taqueria and Rotisserie is a hidden gem. Try their mahi-mahi tacos with tangy coleslaw, guacamole, and arbol chile oil. They also offer great vegetarian options.
5. Cielito Lindo: If you're looking for an authentic taqueria experience, visit Cielito Lindo at 3440 Balboa St, San Francisco, CA 94121. Their quesa birria tacos, with tender meat, gooey cheese, and consomme, are a highlight. Don't forget to add their hot sauce for an extra kick.
6. Lolo's: Located at 974 Valencia St, San Francisco, CA 94110, Lolo's offers a range of exciting tacos. Try their original creations like the Taco Tropical, a spiced, panko-coated shrimp taco with a vibrant salsa and chipotle aioli. Their jicama tortilla adds a refreshing crunch.
7. Senor Sisig: With a location in the Mission District and a food truck, Senor Sisig offers Filipino-fusion style tacos. Their tofu option is a showstopper, topped with onions, lettuce, fresh jalapeños, and a zesty cilantro cream sauce. Don't miss their website to track down their food truck stops.
8. Tacorea: If you can't decide between Mexican or Asian, Tacorea at 809 Bush St, San Francisco, CA 94108 is the place for you. Their Korean fusion tacos, like the Bulugoi street tacos, are mind-blowing. The sweet chili hot sauce adds a delicious kick, and they even come with a side of tater tots.
9. Hook Fish Co.: Located at 4542 Irving St, San Francisco, CA 94122, Hook Fish Co. is a must-stop for fish tacos. Their poké tacos with crunchy slaw, spicy aioli, and avocado on fresh house-made tortillas will transport you to the Hawaiian Islands.\n\n
10. Tacos El Patron: Tacos El Patron at 1500 S Van Ness Ave #100, San Francisco, CA 94110 serves the best tacos in San Francisco. Their menu offers a wide variety of proteins, and their quesa birria tacos are a standout with tender meat, fresh onions, and melty cheese. Embrace the messiness and enjoy every bite.",
    
  }
}

2. Web URLs

The web_url field contains a list of URLs from which the information in the response was sourced. These URLs can be useful for further exploration and verification.

"web_url": [
      "https://sf.eater.com/maps/best-tacos-san-francisco",
      "https://www.sftravel.com/article/where-to-find-best-tacos-san-francisco",
      "https://lataco.com/san-francisco-best-tacos-guide",
      "https://www.femalefoodie.com/restaurant-reviews/best-tacos-in-san-francisco/",
      "https://www.reddit.com/r/AskSF/comments/13gyfd7/taco_spot/",
      "https://www.yelp.com/search?find_desc=Best+Tacos&find_loc=San+Francisco%2C+CA",
      "https://traveloutlandish.com/blog/best-tacos-in-san-francisco-taquerias/",
      "https://www.foodtalkcentral.com/t/sf-chronicle-bay-area-tacos/15225",
      "https://www.yelp.com/search?find_desc=Tacos&find_loc=South+San+Francisco%2C+CA",
      "https://rysullivan.medium.com/the-perfect-sf-taco-crawl-f65cff4c6a0b"
    ]

Ares API Documentation

Overview​

Sample Code for Python​

Sample Endpoints using Curl:​

Sample Endpoint using JavaScript (Node.js):​

Output Format​

1. Response Text​

2. Web URLs​