API reference · Terminal
Make a folder
POST /api/v1/terminal/makeA new folder of live cards, first on your Terminal: from a template, from cards you already have ( ids ), or empty ( title alone). The templates and what fills them: game ( {"game": "grow a garden"} : its players live, then the cards its page shows), genre ( {"genre": "Tycoon"} ), word ( {"word": "egg"} ) and studio ( {"studio": "p2012478972"} ), and breaking-out , new-and-growing , ideas-to-build and roblox-now , which need nothing. Needs an API key. Terminal and routines open with the new RoTerminal: on an account it isn’t open on yet, the answer is permission_denied .
This endpoint needs an API key. See Authentication.
Parameters
- template string
- The folder’s template: game , genre , word , studio , breaking-out , new-and-growing , ideas-to-build or roblox-now .
- fill object
- What fills the template, like {"game": "grow a garden"} or {"genre": "Tycoon"} .
- ids list
- Instead of a template: the cards to put in it.
- title string
- The folder’s name. Alone, it makes an empty folder.
Example
curl -X POST https://roterminal.co/api/v1/terminal/make \ -H "Authorization: Bearer $ROTERMINAL_API_KEY" \ -H "Content-Type: application/json" \ -d '{"template":"game","title":"Grow a Garden"}' import RoTerminal from 'roterminal' const rt = new RoTerminal ({ apiKey: process.env.ROTERMINAL_API_KEY }) const { data } = await rt.terminal. make ({ template: 'game' , title: 'Grow a Garden' }) from roterminal import RoTerminal rt = RoTerminal () # reads ROTERMINAL_API_KEY data = rt.terminal. make (template= "game" , title= "Grow a Garden" )[ "data" ]Response
Every response is { data, link, as_of } . The fields of data are below.
Fields
The fields in data . A field with nothing to say is left out.
- folder object
- The new folder: its ID and name. 2 fields
- id string
- name string
- Its name.
- made boolean
- True when it was made.
- cards integer
- How many cards are in it.
- holds list of strings
- Its cards’ titles.
- note string
- What the answer means, in a sentence, when there’s something to say.