Nextdocs Api Prod

Showing 25 of 44 from the live probe.

• Get current user

  Returns the authenticated user's profile and quota information.

• List organizations

  Returns the organizations the authenticated user belongs to. Each entry has an id that can be passed as org_id to scope subsequent calls to that organization.

• List assets

  Returns a paginated list of the user's assets.

• Get an asset

  Returns a single asset by ID.

• Create an asset

  Creates an asset record from a fetchable HTTPS source URL, optionally linked to a brand. Data URLs and base64 payloads are not accepted.

• Update an asset

  Partially updates an asset. Only provided fields are changed.

• Delete an asset

  Deletes an asset.

• List artifacts

  Returns a paginated list of the user's artifacts.

• Get an artifact

  Returns a single artifact by ID, including page count and metadata.

• Create an artifact

  Synchronously creates a canvas artifact via AI generation. Waits for completion and returns the ready artifact with a url field linking to the NextDocs editor. Supported types: presentation, document, social, image. Pass attachments to guide visual style with up to 10 image attachments. Best for small artifacts (1-3 pages). For larger artifacts or latency-sensitive callers, use artifacts.create_async.

• Create an artifact asynchronously

  Asynchronously queues canvas artifact generation. Returns immediately with status="generating". Poll artifacts.get(id) until status is "ready" or "failed". Supported types: presentation, document, social, image. Supports attachments and multiple design variations via num_copies. When num_copies > 1 the response includes a variations array of separate artifacts (poll each); present them to the user as options A/B/C/D. Use this for 4+ page artifacts or when the calling environment has tool-call ti

• Update an artifact

  Partially updates an artifact. Currently supports renaming.

• Delete an artifact

  Permanently deletes an artifact.

• Create an export

  Synchronously exports an artifact. Waits for the export pipeline and returns the completed export with a download URL. If the response has status "failed" with error.code "GOOGLE_AUTH_REQUIRED", the user's Google account is not connected. For larger artifacts or latency-sensitive callers, use exports.create_async.

• Create an export asynchronously

  Asynchronously queues an artifact export. Returns immediately with status "processing". Poll exports.get(id) until status is "completed" or "failed". Use this for multi-page PDFs/PPTX or when the calling environment has tool-call timeouts.

• Get an export

  Returns the current status of an export by ID. When completed, download_url points at a directly fetchable export asset.

• List themes

  Returns a paginated list of the user's themes.

• Get a theme

  Returns a single theme by ID.

• Create a theme

  Creates a custom theme with the specified colors and fonts.

• Update a theme

  Partially updates a theme. Only provided fields are changed.

• Delete a theme

  Deletes a theme. Fails with 409 if any brand kits still reference it.

• List brands

  Returns a paginated list of the user's brand kits.

• Get a brand

  Returns a single brand kit by ID, including its theme and linked assets.

• Create a brand

  Creates a brand kit with the specified name and theme_id and optional AI instruction. theme_id must reference a theme owned by the user or a system theme key. Add assets to the brand by passing brand_id when creating or updating assets.

• Update a brand

  Partially updates a brand kit. Only provided fields are changed.