MindStudio To API Custom Function Skill

MindStudio Function Builder

Produce a complete, ready-to-paste MindStudio custom function for any API the user wants to connect. Always output all three sections: Code Tab, Configuration Tab, and Test Data Tab.

What to gather before writing

Before writing, collect (from the conversation or by asking):

1. API endpoint — the full URL to call 2. HTTP method — GET, POST, etc. 3. Authentication — API key header name, Bearer token, Basic auth, OAuth, or none 4. Required fields — what parameters/body fields the API needs 5. Optional fields — any useful optional params (like research_effort, language, model, etc.) 6. Response shape — what fields come back (ask or infer from docs/examples) 7. Output variables — what the user wants to store in their workflow after the call 8. Execution environment — Sandbox (default, fast) or Virtual Machine (needed for npm packages)

If the user pastes API docs or a code example, extract all of the above from it directly. Only ask for what's missing.

Output Format

Always produce exactly these three sections, in this order, formatted as fenced code blocks.

Section 1 — Code Tab (JavaScript)

Rules:

Template structure:

// --- Read config ---
const apiKey   = ai.config.apiKey;
const inputVal = ai.config.inputField;   // inputVariable type: value is already resolved, read directly from ai.config
const optional = ai.config.optionalField || "default_value";
// --- Validate ---
if (!apiKey)   throw new Error("Missing API key. Set it in block configuration.");
if (!inputVal) throw new Error("Missing [field]. Provide it in block configuration.");
ai.log("Calling [API name]...");
// --- Request ---
const url = "https://api.example.com/endpoint";
const res = await fetch(url, {
  method: "POST",           // or GET, etc.
  headers: {
    "Authorization": Bearer ${apiKey},   // adjust per API auth style
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    field: inputVal,
    option: optional
  })
});
if (!res.ok) {
  const err = await res.text();
  throw new Error([API name] error (${res.status}): ${err});
}
const data = await res.json();
ai.log("Done. Storing results...");
// --- Store outputs ---
// outputVariableName type: user names the variable, so use ai.vars[ai.config.outputMain] pattern
ai.vars[ai.config.outputMain]  = data.someField ?? JSON.stringify(data);
ai.vars[ai.config.outputRaw]   = JSON.stringify(data);

Section 2 — Configuration Tab

Rules:

Template:

config = {
  configurationSections: [
    {
      title: "API Settings",
      items: [
        {
          type: "secret",
          label: "API Key",
          variable: "apiKey",
          helpText: "Your [API name] API key. Stored securely, not transferred on remix."
        },
        {
          type: "inputVariable",
          label: "Input Field Label",
          variable: "inputField",
          helpText: "Description of what this input does. Use a {{variable}} from your workflow or type a value directly."
        },
        {
          type: "select",
          label: "Option Label",
          variable: "optionalField",
          helpText: "Description of this option.",
          selectOptions: [
            { label: "Option A", value: "value_a" },
            { label: "Option B", value: "value_b" }
          ]
        }
      ]
    },
    {
      title: "Output",
      items: [
        {
          type: "outputVariableName",
          label: "Main Output Variable",
          variable: "outputMain",
          helpText: "Workflow variable where the main result will be stored."
        },
        {
          type: "outputVariableName",
          label: "Raw Response Variable",
          variable: "outputRaw",
          helpText: "Workflow variable for the full raw JSON response."
        }
      ]
    }
  ]
}

Section 3 — Test Data Tab

Rules:

Template:

environment = {
  vars: {},
  config: {
    apiKey:        "your-api-key-here",
    inputField:    "A realistic example input for this API",
    optionalField: "value_a",
    outputMain:    "result",
    outputRaw:     "resultJSON"
  }
}

API Authentication Patterns

| Auth type | Header / approach | |-----------|-------------------| | API key header | "X-API-Key": apiKey | | Bearer token | "Authorization": \Bearer ${apiKey}\` | | Basic auth | "Authorization": "Basic " + btoa(user + ":" + pass) | | No auth | Omit headers object or leave empty |

Execution Environment Notes

Sandbox (default — use unless told otherwise):

Virtual Machine (use when npm packages needed):

import * as someLib from 'some-lib';
export const handler = async () => {
  // your code here
  ai.vars.result = someLib.doSomething();
};

Common Mistakes to Avoid

  let query = "?token=" + apiKey;
  if (symbol) query += "&symbol=" + encodeURIComponent(symbol);
  const url = "https://api.example.com/endpoint" + query;