Shyne đã có mặtBài thuyết trình tốt hơn, nội dung tốt hơn và còn nhiều hơn thế.Khám phá Shyne

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 resources.

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 and waits for AI generation to complete.
  • POST /v1/artifacts/async queues artifact creation and returns the artifact immediately with status="generating".
  • POST /v1/exports creates an export synchronously and waits for the export pipeline to complete.
  • POST /v1/exports/async queues an export and returns the export immediately with status="processing".
  • GET /v1/artifacts/{id} and GET /v1/exports/{id} return the latest status — poll these to track async work.
  • GET /v1/embed/{artifactId} returns embeddable artifact payloads.
  • GET /v1/brands and GET /v1/themes list reusable styling resources.

Base URL

  • All API requests target https://api.nextdocs.io.
  • Use the API key that matches the workspace you are calling.