GraphQL, MCP, and streaming

Veryfront also supports GraphQL, Model Context Protocol (MCP), and WebSocket connections. Run streams use server-sent events (SSE) over REST.

Choose an interface

InterfaceUse it forConnection
GraphQLQuery or mutate supported platform resources.HTTP at /graphql or /api/graphql.
MCPDiscover and invoke supported tools.POST /mcp or POST /projects/{project_reference}/mcp.
SSEFollow run events and reconnect from an event position.HTTP GET to a run stream endpoint.
WebSocketReceive notifications, collaborate, or open interactive sessions.A protocol-specific WebSocket endpoint.

SSE is part of the REST API. GraphQL, MCP, and WebSocket have separate operation or message contracts.

GraphQL

Use https://api.veryfront.com/graphql. The /api/graphql alias routes to the same GraphQL handler.

The GraphQL schema defines available queries, mutations, input types, and results. REST endpoint availability does not imply a matching GraphQL field. See the GraphQL reference.

MCP

Send MCP requests to https://api.veryfront.com/mcp, or use /projects/{project_reference}/mcp when the project must be explicit. The endpoint accepts POST requests and OPTIONS requests for cross-origin resource sharing (CORS) preflight.

Use the MCP discovery endpoints to inspect available tools and schemas. Follow the MCP reference for initialization, authentication, and tool-call messages.

SSE run streams

Use the canonical run UUID to follow events for any run, including conversation runs.

EndpointReference
GET /runs/{run_id}/streamStream run events

To resume the run-scoped stream after an event, send its ID in the Last-Event-ID header. Each stream endpoint defines event IDs, replay behavior, and visibility.

WebSocket connections

Use wss://api.veryfront.com as the WebSocket origin. For example, the run notification path is wss://api.veryfront.com/ws/runs/{runId}/events.

Each WebSocket endpoint defines its authentication, message format, and session behavior.

Available WebSocket paths:

PathPurpose
/ws/runs/{runId}/eventsRun notifications.
/ws/conversations/{conversationId}/eventsConversation notifications.
/ws/{projectId}/eventsProject notifications.
/ws/{projectId}/yjsCollaborative editing.
/ws/{projectId}/logsProject log delivery.
/ws/{projectId}/terminalProject runtime terminal.
/sandboxes/{sandbox_id}/terminalInteractive sandbox terminal.

For sandbox terminal entry points, see the terminal endpoint. For related run and conversation resources, see the Execution API.

Back to REST API reference