# API key (API v1, deprecated)

Deprecated: API v1 keeps working for existing integrations but gets no new features. New integrations should use API v2 (https://public-api.dapi.digital/docs/guides/quickstart.md).

Check that an API key works and which account it belongs to.

## Endpoints

-   [GET `/v1/me`](https://public-api.dapi.digital/docs/v1/reference/api-key.md#v1_getMe)

## The API key status object

### Attributes

-   `server_running` (boolean): Always `true` when you receive a `200` - confirms the server is reachable.
-   `api_key` (value): Identity and activation status of the key used to authenticate this request.
-   `rate_limit` (value): Current rate-limit counters for this key. Use `remaining` and `reset_at` to throttle your integration proactively.

**The API key status object**

```json
{
  "server_running": true,
  "api_key": null,
  "rate_limit": null
}
```

## API key health check

GET `/v1/me`

- **Credentials**: Any active API key.

- **For**: Designers

- **Operation id**: `v1_getMe`

Returns server status, API key identity, and current rate-limit counters for the authenticated key. Call this to confirm connectivity and check how many requests remain before the limit resets.

### Returns 200 OK

API key is valid and the server is reachable. Returns [the API key status object](https://public-api.dapi.digital/docs/v1/reference/api-key.md#v1_me_status_object).

### Responses

-   `200`: API key is valid and the server is reachable.
-   `401`: API key is missing, invalid, or inactive.
-   `429`: Rate limit exceeded - wait until the window resets before retrying.

Errors use [the v1 error body](https://public-api.dapi.digital/docs/v1/reference.md#errors).

**Request**

```bash
curl "https://public-api.dapi.digital/v1/me" \
  -H "x-api-key: $DAPI_API_KEY"
```

---

3DAPI API Docs. This page on the web: https://public-api.dapi.digital/docs/v1/reference/api-key. Index of every page: https://public-api.dapi.digital/docs/llms.txt.
