---
title: "Check that a credential works."
method: GET
path: "/api/v1"
tags: ["meta"]
---

# Check that a credential works.

`GET /api/v1`

## Request

- Base URL: `https://harvis.dev`
- URL: `https://harvis.dev/api/v1`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `better-auth.session_token`

The first call to make after creating a key: it does nothing, costs nothing, and says which kind of credential answered.

## Response `200`

Check that a credential works.

- ApiIndex
  - `ok` true, required
  - `via` 'key' | 'session', required: Which credential the request was accepted on.
  - `endpoints` string[], required
  - `documentation` string, required

## Other responses

- `401`: `unauthorized`
- `403`: `suspended`

---

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