Skip to content

Overview

HTTP interface of the @cotal-ai/web reference implementation. This description covers seven read operations; it does not establish a separate stable product or Cloud management API. Start the dashboard using the web service preset described in the operator guide. The server defaults to 127.0.0.1:7799; use the host and port configured for your dashboard.

Open the owner-private launch URL once to exchange its k query token for the cotal_web_session cookie. Keep the session on the same host. With the default bind, the permitted browser origins are http://127.0.0.1:, http://localhost: and http://cotal.localhost:. A custom host uses its own HTTP origin. A cross-origin request is refused before session checks. The readiness nonce only opens /api/meta.

All documented operations use GET and take no request body. Some read handlers also accept other bodyless methods; this description does not promise a 405 response for them. Internal readiness and channel deletion are outside this read reference. The native web service is read-only. Description version 1 identifies this document, not the wire or npm package version.

Dashboard setup and access limits

Information

  • License: Apache-2.0
  • OpenAPI version: 3.1.0

Process-local dashboard session issued by the one-use launch URL.

Security scheme type: apiKey

Cookie parameter name: cotal_web_session

One-use bootstrap token from the owner-private launch URL. It returns HTTP 302 with a session cookie rather than the requested data.

Security scheme type: apiKey

Query parameter name: k