chartlink

Creates a workspace and returns its API key (shown ONCE — keep it). Works on a keyless connection; every other tool needs the key. Then put the key where your client keeps it (plugin api_key setting, the Authorization header, or CHARTLINK_API_KEY for the npx bridge) and reconnect.

{
  "type": "object",
  "properties": {
    "name": {
      "description": "A name for the workspace (the project, the newsletter…)",
      "type": "string"
    },
    "ref": {
      "description": "Where you heard of chartlink — free text",
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Returns key name + workspace. Call this first — non-destructive auth check. Everything you write is stamped createdBy/updatedBy = key name.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Templates are named by the NEED they answer (need, asks, tags), each with urls.png (show it to your human) and `columns`: the column ids your data must supply. Pass q with what the person asked for — "map of brazil's states", "ranked bars with flags", "change between two years" — and the list comes back ranked; take the first. Then create_asset with template: <id> and your data — the whole design comes along. Any chart id you were shown works as a template too, not only these.

{
  "type": "object",
  "properties": {
    "q": {
      "description": "What is needed, in the person's words",
      "type": "string"
    },
    "type": {
      "description": "Only this asset type, e.g. \"bar\"",
      "type": "string"
    },
    "tags": {
      "description": "Comma-separated tags every result must carry, e.g. map,united-states",
      "type": "string"
    },
    "limit": {
      "description": "At most this many, best first (default 20)",
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Read this before create_from_template. Returns the template with `contract`: its looks (theme × dataType × surroundings), the knobs JSON Schema, the columns with their roles, the region-code convention with three real codes and a lookup URL, what each dataType expects of the value column, and a complete example call whose shape you copy. Takes an id, the page slug, or the page address as on chartlink.app/maps — sweden/municipalities, us/texas/counties, london/wards — so you can skip list_templates when you know the place.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Template id (ast_…), slug, or page address (place/level)"
    }
  },
  "required": [
    "id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Matches every region value against the template's geography and reports unmatched values with the closest real codes, how many regions would stay grey, and the scale the map would use. No key needed. Use it when unsure of the codes; then create_from_template with the same data and knobs.

{
  "type": "object",
  "properties": {
    "template": {
      "type": "string",
      "description": "Template id, slug, or page address (sweden/municipalities)"
    },
    "data": {
      "type": "object",
      "properties": {
        "columns": {
          "minItems": 1,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "description": "Column identifier referenced by encodings"
              },
              "type": {
                "type": "string",
                "enum": [
                  "string",
                  "number",
                  "date",
                  "boolean"
                ],
                "description": "date columns parse ISO-ish strings on their own: \"2024\", \"2024-03\", \"2024-03-15\", \"2024-Q2\", full ISO timestamps, or epoch numbers. Anything else needs dateFormat."
              },
              "label": {
                "description": "Display label; defaults to id",
                "type": "string"
              },
              "dateFormat": {
                "description": "For date columns whose strings are NOT ISO-ish: a strftime-style parse hint tried first — tokens %Y %m %d %b %B %q %H %M %S, e.g. \"%d/%m/%Y\" for \"15/03/2024\", \"%b %Y\" for \"Mar 2024\". Removes the day/month guess; ISO-ish strings never need it.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "type"
            ],
            "additionalProperties": false
          }
        },
        "rows": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "description": "Row-major values, one array per row, order matching columns"
        }
      },
      "required": [
        "columns",
        "rows"
      ],
      "additionalProperties": false,
      "description": "The data you intend to send"
    },
    "knobs": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "template",
    "data"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

The template's design, your data, your words. `knobs` are the template's settings (get_template shows the schema): theme light|dark|editorial, dataType gradient|buckets|categories and surroundings true|false (then waterColor, landColor) for maps, title/description/source/brand {text, fontFamily, fontSize, color}, backgroundColor, and the scale knobs for the dataType (colormap and direction, range, breaks or classes, categoryColors/categoryOrder). data = {columns: [{id, type}], rows: [[…]]}: use the template's column ids, or exactly two columns (region first, value second) for a map. publish: true makes the URLs live in the same call. A success means it validated AND rendered — look at the preview. Region values that match nothing come back as a 400 listing each with its closest real codes, before anything is made — no separate check needed. `config` is the advanced path: the engine's settings, merged after the knobs.

{
  "type": "object",
  "properties": {
    "template": {
      "type": "string",
      "description": "Template id or slug from list_templates, or the page address (sweden/municipalities, us/texas/counties, london/wards) when you know the place"
    },
    "data": {
      "type": "object",
      "properties": {
        "columns": {
          "minItems": 1,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "description": "Column identifier referenced by encodings"
              },
              "type": {
                "type": "string",
                "enum": [
                  "string",
                  "number",
                  "date",
                  "boolean"
                ],
                "description": "date columns parse ISO-ish strings on their own: \"2024\", \"2024-03\", \"2024-03-15\", \"2024-Q2\", full ISO timestamps, or epoch numbers. Anything else needs dateFormat."
              },
              "label": {
                "description": "Display label; defaults to id",
                "type": "string"
              },
              "dateFormat": {
                "description": "For date columns whose strings are NOT ISO-ish: a strftime-style parse hint tried first — tokens %Y %m %d %b %B %q %H %M %S, e.g. \"%d/%m/%Y\" for \"15/03/2024\", \"%b %Y\" for \"Mar 2024\". Removes the day/month guess; ISO-ish strings never need it.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "type"
            ],
            "additionalProperties": false
          }
        },
        "rows": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "description": "Row-major values, one array per row, order matching columns"
        }
      },
      "required": [
        "columns",
        "rows"
      ],
      "additionalProperties": false,
      "description": "Typed columns + row-major rows, shaped like the template's example"
    },
    "knobs": {
      "description": "The template's knobs — get_template returns their schema",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "publish": {
      "description": "true = published and live in this call; omit while you iterate",
      "type": "boolean"
    },
    "config": {
      "description": "ADVANCED: engine settings deep-merged after the knobs",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "template",
    "data"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

configPatch is DEEP-MERGED: objects merge recursively, arrays replace wholesale, null clears a key — send only what changes. To REMOVE keys (drop document.aspect, delete one of texts[]) pass `config` instead: it REPLACES the whole config (get_asset returns the current one to edit). `data` (if given) replaces rows wholesale. Requires expectedVersion from the last envelope; on 409 re-merge onto the returned `current`. Updating does NOT publish by default — pass publish: true to publish in the same call, or call publish_asset separately.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "expectedVersion": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "publish": {
      "description": "true = publish immediately after this update succeeds (one call instead of two)",
      "type": "boolean"
    },
    "configPatch": {
      "description": "Deep-merged onto the current config",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "config": {
      "description": "REPLACES the whole config — the way to remove keys; applied before configPatch if both are given",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "data": {
      "type": "object",
      "properties": {
        "columns": {
          "minItems": 1,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "description": "Column identifier referenced by encodings"
              },
              "type": {
                "type": "string",
                "enum": [
                  "string",
                  "number",
                  "date",
                  "boolean"
                ],
                "description": "date columns parse ISO-ish strings on their own: \"2024\", \"2024-03\", \"2024-03-15\", \"2024-Q2\", full ISO timestamps, or epoch numbers. Anything else needs dateFormat."
              },
              "label": {
                "description": "Display label; defaults to id",
                "type": "string"
              },
              "dateFormat": {
                "description": "For date columns whose strings are NOT ISO-ish: a strftime-style parse hint tried first — tokens %Y %m %d %b %B %q %H %M %S, e.g. \"%d/%m/%Y\" for \"15/03/2024\", \"%b %Y\" for \"Mar 2024\". Removes the day/month guess; ISO-ish strings never need it.",
                "type": "string"
              }
            },
            "required": [
              "id",
              "type"
            ],
            "additionalProperties": false
          }
        },
        "rows": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "description": "Row-major values, one array per row, order matching columns"
        }
      },
      "required": [
        "columns",
        "rows"
      ],
      "additionalProperties": false,
      "description": "Typed columns + row-major rows. A date column whose strings are not ISO-ish takes dateFormat (e.g. \"%d/%m/%Y\")."
    },
    "title": {
      "type": "string"
    },
    "brand": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "showcase": {
      "description": "Offer this chart as a template in the public gallery and list_templates (once published). Workspace keys only.",
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "expectedVersion"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Makes the draft live. Returns urls: paste urls.embedIframe on iframe platforms; on Substack insert urls.png as an image and link it to urls.page. Pinned history: urls.png + '?v=N'.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "note": {
      "type": "string"
    },
    "premium": {
      "description": "Spend one paid credit to publish as premium (2400px, SVG, your branding, no badge) in this call",
      "type": "boolean"
    }
  },
  "required": [
    "id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Returns a URL opening the visual tweak panel for ONE chart (text, colors, spacing, label nudges) with no login. PUBLISH FIRST: the editor saves and republishes a published chart, it cannot publish a draft. Scope: view, tweak, and republish that chart only — never delete, never spend credits, nothing else in the workspace. OFFER THIS whenever the human's request is aesthetic fine-tuning: handing over the wheel beats a nudge-by-nudge back-and-forth. The secret is shown once; links don't expire and can be revoked with revoke_edit_link.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ast_..."
    }
  },
  "required": [
    "id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

If a capability is missing, a schema fights you, or docs are wrong: record it here so the owner can fix it. One report per distinct issue, with a real description — reports get fixed same-day when they say what you tried, what you expected, and what happened (title-only reports can't be acted on).

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "bug",
        "feature_request",
        "limitation",
        "documentation_gap",
        "other"
      ]
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "minLength": 40,
      "description": "What you tried, what you expected, what happened instead — include the asset id if one is involved"
    },
    "assetId": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "title",
    "description"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}