Skip to main content
Last updated on
Advanced — 0.0.x primitives

You don't need this page for a normal integration. Use the quickstarts and createMythos() instead. These low-level functions remain exported for custom setups.

handshakeRoute

Returns an Express Router with the Mythos publish handshake endpoint.

Signature​

typescript
function handshakeRoute(): Router

Route​

text
GET /.well-known/mythos-handshake?lt=<handshake-jwt>

Parameters​

Query paramRequiredDescription
ltYesHandshake JWT with purpose: "handshake-check"

Returns​

Express Router — mount with app.use(handshakeRoute()).

Responses​

StatusBody
200{ "ok": true, "sdk_version": "0.1.0" }
401{ "error": "Missing launch token" }
401{ "error": "Invalid launch token" }
503{ "error": "Service unavailable" }

Example​

typescript
import express from 'express';
import { handshakeRoute } from '@mythos-work/sdk';

const app = express();
app.use(handshakeRoute());
warning

Use app.use(handshakeRoute()), not app.get('/.well-known/...', handshakeRoute()).

See also​