Interface manuals

REST manual

Use author routes, errors, and response fields.

Before you start

A Jot API key. Use the REST setup guide first.

The REST base URL is https://jot.winnersight.ai/api/. Send a Jot key in the X-API-Key header. Use HTTPS. The operation reference maps Jot tasks to REST routes, MCP identifiers, and jotcli commands. Use the OpenAPI schema for exact request and response fields.

Request behavior

Create and update routes return the saved note and its canonical URL. An omitted update field stays unchanged. A field that accepts null can clear its saved value. The note's listed value controls listings. It does not make a note private.

Some account actions require a browser session. Claiming a temporary note also requires the browser cookie from its publication. A scoped key cannot create another key. Create keys from your signed-in browser session.

Export

GET /api/export streams one ZIP download. It includes notes, media, profile details, and a URL map. The server does not store a second account archive. A broken connection can leave an incomplete local file. Check the ZIP before you rely on it.

Errors

An error response contains a detail field. A 401 means authentication failed. A 403 means the key lacks permission or the account does not own the resource. A 404 means Jot cannot find the requested resource. A 409 reports a state conflict.

A 422 reports an invalid request field. A 503 can report unavailable storage.