Save ai project state

Saves the current in-progress project state for an AI tutoring session, so it can be restored later.

POST /++save_ai_project_state

AI Tutor Sessions

Authentication

Public — no authentication required. Also requires a registered Integrator subscription.

This endpoint requires the calling application to be registered as an Integrator. Every call must identify the registration via a registration_id parameter (or an X-Client-Id header), and authenticate using one of the following methods, selected with the subscription_method parameter:

  • referer — The request's HTTP Referer header must match one of the domains authorized for this Integrator registration.
  • ip — The request's source IP address must match one of the IP addresses authorized for this Integrator registration.
  • client_token — A client token issued at registration time is supplied with the request.

Register as an Integrator and configure authorized domains, IP addresses, or a client token.

Request

Content type: application/json

NameInTypeRequiredDescription
BODYbodystringNo—
tokenbodystringNo—
project_statebodystringNo—

Example request body

{
  "BODY": "example_value",
  "token": "REDACTED",
  "project_state": "published"
}

Responses

StatusMeaning
200Successful response.
400Invalid JSON body.
404Session not found.
401Unauthorized - missing or invalid Integrator authentication (registration_id/X-Client-Id, plus referer/IP/client_token).
403Forbidden - the current user or Integrator registration does not have sufficient permissions.

Example response (illustrative - field names only, values are placeholders)

{
  "saved": "example_value"
}