Skip to main content

Introduction

Welcome to the Quickstart Guide for integrating comprehensive, high-quality answers with precise and reliable citations using our APIs. This guide will walk you through the initial setup and provide you with sample code to perform your first search.

Get Your API Key

Select a you.com plan or an API plan. The system will ask you to add information about you, including your credit card. When done, the system will redirect you to the main page of the platform. From there, click on your name, then on API Console: Going to the API console in you.com To create a new API key, go to the API Keys section, give a name to your API key, and create it: Creating a new API key in you.com Copy your API key somewhere safe and click on Done to complete the process: Completing the API key creation in you.com The platform will automatically create a new section where all your API keys are stored: Creating a new API key in you.com

Make Your API Calls

Integrate the endpoints into your applications, and get answers from our APIs. Replace YOUR_API_KEY in the code with your actual API key:
API Key
YOUR_API_KEY = "your_actual_api_key_here"
Make your first API call with our Search API:

    curl --request GET \
      --url 'https://api.ydc-index.io/v1/search?query=insert_your_query_here' \
      --header 'X-API-Key: YOUR_API_KEY'
The Search API is designed to return LLM-ready web results based on a user’s query. Imagine you want to feed an LLM with the results that come from a research like “What is the capital of the USA?”. To do so, write the following:

    curl --request GET \
      --url 'https://api.ydc-index.io/v1/search?query=What%20is%20the%20capital%20of%20the%20USA%3F' \
      --header 'X-API-Key: YOUR_API_KEY'
The result you will obtain is the following:
{
  "results": {
    "web": [
      {
        "url": "https://en.wikipedia.org/wiki/List_of_capitals_in_the_United_States",
        "title": "List of capitals in the United States - Wikipedia",
        "description": "In the following table, the \"Since\" column shows the year that the city began serving as the state's capital (or the capital of the entities that preceded it). The MSA/μSA and CSA columns display the population of the metro area the city is a part of, and should not be construed to mean the ...",
        "snippets": [
          "In the following table, the \"Since\" column shows the year that the city began serving as the state's capital (or the capital of the entities that preceded it). The MSA/μSA and CSA columns display the population of the metro area the city is a part of, and should not be construed to mean the population of the city's sphere of influence or that the city is an anchor for the metro area.",
          "An insular area is a United States territory that is neither a part of one of the fifty states nor a part of the District of Columbia, the nation's federal district. Those insular areas with territorial capitals are listed below.",
          "The building served as the capitol until 1907, when the Dawes Act finally dissolved the Cherokee Nation and Tahlequah became the county seat of Cherokee County, Oklahoma. The Cherokee National government was re-established in 1938 and Tahlequah remains the capital of the modern Cherokee Nation; it is also the capital of the United Keetoowah Band of Cherokee Indians.",
          "Some Cherokees fleeing the Federal Army, sent for the \"round up\", fled to the remote settlements separated from the rest of the Cherokee Territory in Georgia and North Carolina, in order to remain in their homeland. In the 20th century, their descendants organized as the Eastern Band of Cherokee Indians; its capital is at Cherokee, North Carolina, in the tribally-controlled Qualla Boundary.",
          "After Removal from their Alabama-Georgia homeland, the Creek national government met near Hot Springs which was then part of their new territory as prescribed in the Treaty of Cusseta. Because some Creeks fought with the Confederacy in the American Civil War, the Union forced the Creeks to cede over 3,000,000-acre (1,200,000 ha) - half of their land in what is now Arkansas. ... Served as the National capital after the American Civil War."
        ],
        "thumbnail_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/7/7a/View_of_Empire_State_Building_from_Rockefeller_Center_New_York_City_dllu_%28cropped%29.jpg/1200px-View_of_Empire_State_Building_from_Rockefeller_Center_New_York_City_dllu_%28cropped%29.jpg",
        "page_age": "2025-09-06T20:05:44",
        "favicon_url": "https://you.com/favicon?domain=en.wikipedia.org&size=128"
      },
      {
        "url": "https://www.worldatlas.com/articles/what-is-the-capital-of-the-united-states-of-america.html",
        "title": "What Is the Capital of the USA? - WorldAtlas",
        "description": "Washington, D.C. is the capital of the United States of America.",
        "snippets": [
          "The capital city of the United States of America is Washington, D.C., and can be referred to formally as the District of Columbia or more informally as D.C. or Washington. In 2017, the city had a population of 6,131,977 and an approximate size of 68.34 square miles.",
          "This climate is prone to thunderstorms, which may be sometimes accompanied by tornadoes. The highest temperature ever recorded in D.C. was 106 °F in 1918, while the lowest was −15 °F in 1899. The economy of the capital is booming, with a steady performance compared to the other US states.",
          "Data shows that the capital consistently ranks first among the top ten US states in terms of GDP between 2009 and 2016. In 2016 alone, the GDP per capita was $160,472, a figure that is almost three times as large as that of the GDP of the second-highest state, Massachusetts.",
          "Tourism is the second largest contributor to D.C.’s economy, as the city receives an annual average of almost 20 million visitors. Aside from the obvious allure of visiting a city that is a country's capital, there are several other features that attract visitors from all over the world every year."
        ],
        "thumbnail_url": "https://www.worldatlas.com/r/w1200-q80/upload/a3/ff/46/shutterstock-796865242.jpg",
        "page_age": "2019-07-16T20:44:56",
        "favicon_url": "https://you.com/favicon?domain=www.worldatlas.com&size=128"
      },
      {
        //Content omitted for brevity
      }
    ]
  },
  "metadata": {
    "query": "what is the capital of the USA?",
    "search_uuid": "c7df26d5-8255-4f70-8b88-64d156775be6",
    "latency": 0.47196125984191895
  }
}
Hooray! You made your first API call with one of our top-notch APIs in a matter of seconds. To learn more about our APIs and how to use them, read the API reference section.
I