---
title: "List every endpoint, with discovery and authentication pointers."
method: GET
path: "/api/v1"
tags: ["Platform"]
---

# List every endpoint, with discovery and authentication pointers.

`GET /api/v1`

## Request

- Base URL: `https://deepsearch.app`
- URL: `https://deepsearch.app/api/v1`
- Auth: none required

The REST entry point. Returns the endpoint inventory, the scope each one needs, where the machine-readable contract lives, how to authenticate, and how to use the sandbox. No credentials required - this is what to read before you have a key.

## Response `200`

The endpoint index.

- ApiIndex
  - `object` 'api_index', required
  - `api_version` 'v1', required
  - `base_url` string, uri
  - `documentation` object
  - `authentication` object
  - `sandbox` object
  - `endpoints` object[], required
    - `method` string, required
    - `path` string, required
    - `scope` string, nullable
    - `summary` string, required
  - `links` object[], required
    - `rel` string, required
    - `url` string, uri, required
    - `type` string, required
    - `title` string, required

## Other responses

- `429`: Too many anonymous requests from this IP.

---

[API](https://skmtc.dev/deepsearch/apis/deepsearch-api.md) · [All operations](https://skmtc.dev/deepsearch/apis/deepsearch-api/llms.txt) · [OpenAPI document](https://skmtc.dev/deepsearch/apis/deepsearch-api/revisions/85fc8e2576a3?raw)