---
title: "API"
description: "Public HTTP API, TypeScript SDK, and OpenAPI 3.1 contract for Nuxt SEO Pro."
canonical_url: "https://nuxtseo.com/docs/nuxt-seo-pro/guides/api"
---

Nuxt SEO Pro exposes a versioned HTTP interface under `/api/v1`.

[View the OpenAPI 3.1 document](/docs/api/openapi.json) for the exact paths, request schemas, responses, scopes, and errors shipped by the current API.

Authenticate with a Team API token. Mint one under Settings, then API tokens, and send it as `Authorization: Bearer <token>`{lang="html"}:

```sh
curl -H "Authorization: Bearer nsp_your_token" \
  https://nuxtseo.com/api/v1/sites
```

`GET /api/v1/account/token` describes the credential on the request: the Team, the role, the granted scopes, and the expiry. Compare its granted scopes with the operation's OpenAPI requirements before calling it. Authorization also checks role, Team access, and entitlement.

Use `@nuxtseo/sdk` when you call the API from TypeScript. It reads the executable descriptors from `@nuxtseo/protocol`, validates requests and responses, and supports browser sessions or bearer tokens through explicit transports.

Those descriptors generate the OpenAPI file. Check the hosted contract for the deployed API rather than assuming a local checkout has the same version.

For terminal and script use, the [CLI](/docs/nuxt-seo-pro/guides/cli) wraps the SDK and adds exit codes.

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.