beta
cables is under heavy development.
There might be one or another bug, please let us know about it!
cables Documentation      How To Use            Working with files            Keyboard Shortcuts            User Interface Walkthrough      Beginner Tutorial            Beginner 1: Drawing A Circle            Beginner 2: Transformations            Beginner 3: Color            More Transformations      intermediate            Image Compositions            Post-Processing 3D Scenes      communication            cables API            Communication with an Arduino via Serial            Communicating with Arduino over MQTT      Exporting And Embedding            How to serve files externally and fix CORS headers            Embedding Patches            External triggers / functions            Embedding Patches            Previewing / uploading exported cables patches      coding ops            Creating Attachments            General op/Port Callbacks            Ports                  Dynamic Ports                  Array Ports                  Boolean ports                  Integer Number Ports                  Object Ports                  String ports                  Trigger Ports                  Floating Point Number Ports            GUI/UI attributes            Hello Op - Part 1            Libraries            Developing Ops            Guidelines            Object Ports            Writing Shaders            Web Audio Op Development      HTML and CSS in cables      Lighting            Lights            Shadows      FAQ            Embedding                  How to remove grey rectangles on touch (mobile)?                  Why doesn't the DownloadTexture op work on iOS?                  How to disable page scrolling on mobile?                  Transparent Canvas            Features and Support                  Will there be support for (animated) GIFs?            General questions            Licences and payment                  What licence do i need to use cables?                  Will I have to pay for it in the future?                  How is my work licenced when using cables?            Does cables support midi and OSC?            Shadertoy            Technical questions            UI / Editor            WebGL1 and WebGL2
cables Documentation» communication» cables API

cables API

you can access cables functionality via an API

to access the API you need to create an API key.

to create an API key goto your settings, select the tab "apikey" and click "create".

API endpoints

  • /api/mypatches
    a list of all your patches

  • /api/project/[PID]/export
    create an export of a patch with the id PID
    the resulting json contains a field path. this is the download path for the exported zip file, relative to https://cables.gl/

    url query parameters:

    • removeIndexHtml - remove index.html from export
    • jsonName - filename of resulting json file
    • combineJS - combine .js and json files into one

accessing the API via CURL

use this to test your apikey via command line:

curl -H 'X-apikey: YOUR_API_KEY' 'http://cables.gl/api/mypatches'

exporting cables projects

cables command line exporter

help cables get better and edit this file on github