---
title: "Every endpoint, and what each one costs in credentials"
method: GET
path: "/v1"
tags: ["Discovery"]
---

# Every endpoint, and what each one costs in credentials

`GET /v1`

## Request

- Base URL: `https://youspot.com`
- URL: `https://youspot.com/v1`
- Auth: none required

The place to start. One JSON document listing every endpoint on this domain, grouped by whether it needs a credential, so an agent can find the surface it needs without crawling. Read this before this OpenAPI document if all you want is the shape of the site.

## Headers

- `If-None-Match` string

## Response `200`

The index.

- AgentIndex
  - `object` 'index', required
  - `name` string
  - `description` string
  - `base_url` string, uri, required
  - `documentation_url` string, uri
  - `endpoints` object[], required
    - `method` string, required
    - `url` string, uri, required
    - `auth` 'none' | 'oauth2', required
    - `anonymous_methods` string[]
    - `description` string
  - `authentication` object, required
  - `machine_readable` object
  - `contact` string

## Other responses

- `304`: The document has not changed since the ETag you sent. No body.

---

[API](https://skmtc.dev/youspot/apis/youspot-http-api.md) · [All operations](https://skmtc.dev/youspot/apis/youspot-http-api/llms.txt) · [OpenAPI document](https://skmtc.dev/youspot/apis/youspot-http-api/revisions/6615ad5d017d?raw)
