GET/api/v1/ai/pages/status

Check AI availability

Which AI features you can use, on a page (slug) or for a new page in a workspace (workspace). When they're off, enabled is false and reason says why: signin, encrypted, off, not_configured, workspace_off, blocked, daily or monthly. It also lists the actions, tones and languages the other endpoints take.

Token optionalOr edit secret120 per minute per IP

Guide: AI in pages

Code samples and Try it

Query parameters

#
  • slugstring

    A page's address. Up to 64 characters.

  • workspacestring

    A workspace's id, for a new page there. Up to 64 characters.

Headers

#
  • X-Read-Passwordstring

    The password of a password-protected document.

  • X-Edit-Secretstring

    The document's edit secret (sk_…), for a document published without an account. See Edit key.

  • X-Markdrop-Workspacestring

    A workspace's id: answer only if the document is in that workspace, else 404. Workspace domains send it; you rarely need it.

Responses

#
  • 200OK.
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
Did this page help?