UI Guides


Graphistry Setup


REST APIs

Introduction

2.0 REST API Tutorial (cURL)


URL API to Embed & Control

- HTML

- URL Options

- IFrame CSS Style Tips


Authentication (2.0 API)

- Concepts

- Create token

- Refresh token

- Verify token

- Modes: Password, Personal Key, & SSO


Computation

- GFQL Query Endpoint

    - GFQL Operations

    - GFQL Predicates

- Python Query Endpoint

- GFQL UDF Endpoint

- Python UDF Endpoint


Upload Data (2.0 API)

- Concepts

- List Files

- Create File

- Delete File

- Upload File Data

- List Visualization Datasets

- Create Visualization Dataset with Bindings

    - Hypergraphs

- Delete Visualization

- Schema

Basic Bindings

    - Color

    - Color Palettes

    - Edge Weight Bindings

Complex Bindings

    - Colors and Sizes

    - Icons

    - Badges

    - Radial & Horizontal Axis

    - Field Controls Overview

        - Field Inclusion

        - Field Exclusion

        - Computed Fields

- Branding Metadata: Logos, title, backgrounds, & effects

- Upload Node & Edge Data

   - json

   - csv

   - parquet

   - orc

   - arrow


Live Sessions (experimental)

- View


Health Checks


Python Notebooks & API

- PyGraphistry Homepage (GitHub)

- PyGraphistry API (ReadTheDocs)

- Jupyter Notebook Examples (GitHub)

- Pygraphistry Databricks Examples (GitHub)

- Graph Algorithms


Visual Playbooks

- Connectors

- Pivots

- Templates


JavaScript Libraries

- React - Storybook

- React - API

- Browser JS - Storybook

- Browser JS - Example

- Browser JS - API

- Node.js - API

Health Checks

Use these in addition to local calls to `sudo docker compose ps`, `sudo docker stats`, and `sudo docker ps`. Additional services may be checked by non-public routes generally at `:8080/health'.
Route Service Example Description
caddy/health/ caddy curl http://localhost/caddy/health/ External reverse proxy
healthz nginx curl http://localhost/healthz Internal proxy and static content
ht/ caddy, nginx curl http://localhost/ht/ Nexus CMS health
streamgl-gpu/primary/health curl http://localhost/streamgl-gpu/primary/health GPU Visualization service controller
streamgl-gpu/secondary/cpu/health curl http://localhost/streamgl-gpu/secondary/cpu/health GPU Visualization service process (CPU-only)
streamgl-gpu/secondary/gpu/health curl http://localhost/streamgl-gpu/secondary/gpu/health GPU Visualization service process (GPU). WARNING: Check is resource-intensive.
check-workers streamgl-gpu curl http://streamgl-gpu/check-workers Visualization service processes details (call from within Docker network)
streamgl-viz/health streamgl-viz curl http://localhost/streamgl-viz/health Visualization web tier
pivot/health pivot curl http://localhost/pivot/health Investigation automation service
forge-etl/health forge-etl curl http://localhost/forge-etl/health Data pipeline middleware
streamgl-sessions/health streamgl-sessions curl http://localhost/streamgl-sessions/health Session manager middleware
streamgl-vgraph-etl/health streamgl-vgraph-etl curl http://localhost/streamgl-vgraph-etl/health 1.0 API ingest and middleware (json, protobuf, keys)