Variables

const variable = await client.variable.create({
  key: "target_url",
  value: "https://example.com/products",
  dataType: "STRING",
});

console.log("Variable created:", variable.id);

curl -X POST "https://api.kadoa.com/v4/variables" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "target_url",
    "value": "https://example.com/products",
    "dataType": "STRING"
  }'

> "Create a variable called target_url with value https://example.com/products"

const variables = await client.variable.list();

for (const variable of variables) {
  console.log(`${variable.key}: ${variable.value} (${variable.dataType})`);
}

curl -X GET "https://api.kadoa.com/v4/variables" \
  -H "x-api-key: YOUR_API_KEY"

> "List my variables"

const variable = await client.variable.get("VARIABLE_ID");

console.log(variable.key);
console.log(variable.value);
console.log(variable.dataType);

curl -X GET "https://api.kadoa.com/v4/variables/VARIABLE_ID" \
  -H "x-api-key: YOUR_API_KEY"

> "Show me the target_url variable"

const updated = await client.variable.update("VARIABLE_ID", {
  value: "https://example.com/products/v2",
});

console.log("Variable updated:", updated.key);

curl -X PATCH "https://api.kadoa.com/v4/variables/VARIABLE_ID" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "value": "https://example.com/products/v2"
  }'

> "Update the target_url variable to https://example.com/products/v2"

await client.variable.delete("VARIABLE_ID");

curl -X DELETE "https://api.kadoa.com/v4/variables/VARIABLE_ID" \
  -H "x-api-key: YOUR_API_KEY"

> "Delete the target_url variable"

// Create a variable
await client.variable.create({
  key: "search_term",
  value: "ESG reports",
  dataType: "STRING",
});

// Use it in a workflow prompt; Kadoa replaces @search_term at runtime
const workflow = await client
  .extract({
    urls: ["https://sandbox.kadoa.com/ecommerce"],
    name: "Variable-Driven Search",
    userPrompt: "Search for @search_term and extract all matching results",
    extraction: (builder) =>
      builder
        .entity("Result")
        .field("title", "Result title", "STRING", {
          example: "Annual ESG report",
        })
        .field("url", "Result URL", "LINK", {
          example: "https://example.com/reports/annual-esg-report",
        }),
  })
  .create();