Registre-se gratuitamente

Overview

Authentication, environments, and the public NextDocs v1 resource model.

NextDocs Public API v1

NextDocs exposes a versioned public API for creating artifacts, managing brands and themes, launching exports, and polling async jobs.

Production: https://api.nextdocs.io

Staging: https://api.stg.nextdocs.io

All public endpoints live under /v1. The docs-native API reference at API Reference is generated from the live OpenAPI document.

Authentication

All endpoints require an API key. Include it in the Authorization header:

Authorization: Bearer nxd_your_api_key

Create an API key in your API settings.

Public Resources

POST /v1/artifacts creates an artifact synchronously.
POST /v1/artifacts/async queues artifact creation and returns a job.
POST /v1/exports creates an export synchronously.
POST /v1/exports/async queues an export job.
GET /v1/jobs/{id} returns job status and results for async work.
GET /v1/embed/{artifactId} returns embeddable artifact payloads.
GET /v1/brands and GET /v1/themes list reusable styling resources.

Environments

Production docs should target https://api.nextdocs.io.
Staging docs should target https://api.stg.nextdocs.io.
Use the environment-specific API key and base URL that match the workspace you are testing.