---
title: "Describe the API"
method: GET
path: "/v1"
tags: ["Meta"]
---

# Describe the API

`GET /v1`

## Request

- Base URL: `https://stashr.me`
- URL: `https://stashr.me/v1`
- Auth: none required

Public, unauthenticated description of the API: documentation and OpenAPI links, how to authenticate, the rate-limit policy, and the versioning policy. The one endpoint that needs no credential, so an agent can observe the live X-Request-Id and RateLimit headers before it has a key.

## Response `200`

API description

- object
  - `data` object, required
    - `authentication` object, required
      - `apiKeys` string, uri, required
      - `oauthAuthorizationServer` string, uri
      - `oauthProtectedResource` string, uri
      - `scheme` 'Bearer', required
      - `scopes` string[], required
    - `connectionCheck` string, uri
    - `docs` string, uri, required
    - `llmsTxt` string, uri
    - `mcp` string, uri
    - `name` string, required
    - `openapi` string, uri, required
    - `rateLimit` object
      - `policy` string
      - `requestsPerMinute` object
        - `apiKey` integer
        - `oauthOrSession` integer
    - `version` string, required
    - `versioningPolicy` string, uri

## Other responses

- `429`: Too many requests (error.code rate_limited); wait Retry-After seconds, also given as error.retryAfterMs
- `500`: Something failed on Stashr's side (error.code internal_error); retryable

---

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