Skip to content

Use with AI tools

Markdown versions of every page, llms.txt, and instructions to give your coding agent.

These docs are written to be read by people and by AI tools alike.

  • Add .md to any page address for its Markdown, for example /webhooks.md.
  • Send Accept: text/markdown to any page address and you get the same Markdown.
  • /llms.txt lists every page with a one-line summary.
  • /llms-full.txt is the whole documentation, reference included, in one file.
  • /openapi.json is the OpenAPI 3.1 description of every endpoint and event.

Instructions for your coding agent

Paste this into your project's AGENTS.md, CLAUDE.md or editor rules when you build against NOWScale:

## NOWScale API
- Docs: https://docs.nowscale.com/llms-full.txt (OpenAPI: https://docs.nowscale.com/openapi.json)
- Base URL https://api.nowscale.com/v1, header `Authorization: Bearer $NOWSCALE_API_KEY`. Never put the key in client code.
- Send `Idempotency-Key` on every POST that creates something; retry 429 after Retry-After and 5xx with backoff.
- Errors are application/problem+json; branch on `code`.
- Verify webhook signatures (Standard Webhooks, secret starts with whsec_) on the raw body before parsing.
- Scheduling a TikTok target needs `privacy_level` chosen by the creator and `consent: true` after showing TikTok's consent text.

Keys for agents

Give an agent its own key with only the permissions it needs, limited to the Projects it works on, and an expiry date. Keys without posts:publish can prepare posts but never schedule them without review.