Documentation

Getting an API Key

1. Open the Dashboard and navigate to Settings
2. Scroll to the API Keys section
3. Click New API Key, enter a name, and click Create
4. Copy the key immediately — it is shown only once

API keys start with as_lnch-

REST API Examples

Create a project

curl -X POST https://aslaunch.com/api/agent/projects \
  -H "X-API-Key: as_lnch-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "My App Screenshots", "defaultLanguageCode": "en"}'

# Response: {"projectId": "abc123..."}

List projects

curl https://aslaunch.com/api/agent/projects \
  -H "X-API-Key: as_lnch-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

# Response: {"projects": [{"id": "...", "name": "...", "screenCount": 3}]}

Add a screen

curl -X POST https://aslaunch.com/api/agent/projects/{projectId}/screens \
  -H "X-API-Key: as_lnch-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"order": 0, "config": {"version": "6.3.0", "objects": []}}'

# Response: {"screenId": "xyz789..."}

Update a screen

curl -X PATCH https://aslaunch.com/api/agent/projects/{projectId}/screens/{screenId} \
  -H "X-API-Key: as_lnch-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"config": {"version": "6.3.0", "objects": [...]}}'

# Response: {"screenId": "xyz789..."}

Screen Config Format

A minimal empty canvas:

{
  "version": "6.3.0",
  "objects": [],
  "background": "#ffffff"
}

Example with a text element:

{
  "version": "6.3.0",
  "objects": [
    {
      "type": "textbox",
      "left": 40,
      "top": 100,
      "width": 295,
      "text": "Hello, World!",
      "fontSize": 32,
      "fontWeight": "bold",
      "fill": "#ffffff",
      "__id": "title-text",
      "name": "Title"
    }
  ],
  "background": "#1a1a2e"
}

Custom properties recognized by Aslaunch: