Derive Realtime API

Live presence and cursor sharing on an artifact.

Operations 2

POST /v1/artifacts/{shortId}/presence Presence heartbeat — keep this viewer on the artifact's roster #
POST /v1/artifacts/{shortId}/cursor Broadcast a live cursor frame to the artifact's other viewers #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/derive-to:derive-to-realtime-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

derive-to-realtime-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Derive Realtime API
  version: 1.0.0
  description: 'Derive''s HTTP API. Every response shape here is the single source of truth for the web client — generated from the same Zod schemas that back this reference, so the docs never drift from the running API.


    **Auth:** a session cookie (browser) or a bearer token (agents and the CLI). Most write routes are scoped to the caller''s active workspace. The `/v1` paths are the stable product surface; `/openapi.json` serves this spec and `/docs` renders it.'
tags:
- name: Realtime
  description: Live presence and cursor sharing on an artifact.
paths:
  /v1/artifacts/{shortId}/presence:
    post:
      tags:
      - Realtime
      summary: Presence heartbeat — keep this viewer on the artifact's roster
      parameters:
      - schema:
          type: string
        required: true
        name: shortId
        in: path
      - schema:
          type: string
          description: An anonymous viewer's stable guest token; fixes presence to one row per browser.
        required: false
        description: An anonymous viewer's stable guest token; fixes presence to one row per browser.
        name: g
        in: query
      responses:
        '200':
          description: The current viewers on this artifact.
          content:
            application/json:
              schema:
                type: object
                properties:
                  viewers:
                    type: array
                    items:
                      $ref: '#/components/schemas/Viewer'
                required:
                - viewers
      operationId: postV1ArtifactsByShortIdPresence
      x-operation-id-source: derived
  /v1/artifacts/{shortId}/cursor:
    post:
      tags:
      - Realtime
      summary: Broadcast a live cursor frame to the artifact's other viewers
      parameters:
      - schema:
          type: string
        required: true
        name: shortId
        in: path
      - schema:
          type: string
          description: An anonymous viewer's stable guest token; fixes presence to one row per browser.
        required: false
        description: An anonymous viewer's stable guest token; fixes presence to one row per browser.
        name: g
        in: query
      responses:
        '204':
          description: Fanned out (ephemeral; nothing stored).
      operationId: postV1ArtifactsByShortIdCursor
      x-operation-id-source: derived
components:
  schemas:
    Viewer:
      type: object
      properties:
        id:
          type: string
          description: 'The viewer''s id: a signed-in user''s id, or a stable anonymous viewer id'
        name:
          type: string
          description: 'Display name: a user''s @handle, or a friendly handle for anonymous viewers'
        role:
          type:
          - string
          - 'null'
          description: The viewer's effective role on this artifact, or null if they have none
      required:
      - id
      - name
      - role