Skip to main content
Code Tool lets your agent execute JavaScript code as a function call — no external server needed. Unlike custom functions that send HTTP requests to your endpoint, code tools run directly in Retell’s sandbox. The LLM decides when to call the code tool based on the function name, description, and conversation context.

Create a Code Tool

1

Add a Code Tool

In the agent’s Functions section, click + Add and select Code.
Function type dropdown showing the Code option
2

Set name and description

  • Name: A unique identifier (alphanumeric, dashes, underscores). Example: calculate_shipping_cost
  • Description: Explain what the tool does and when to call it. The LLM uses this to decide when the function is appropriate. Example: “Calculate shipping cost based on the customer’s zip code and order weight.”
3

Write JavaScript

Write your JavaScript code in the editor. You have access to dynamic variables, call metadata, and the fetch function for HTTP requests. See JavaScript Environment below for details.
Code Tool editor with name, description, code, and configuration options
// Example: calculate shipping based on dynamic variables
const weight = parseFloat(dv.order_weight);
const zone = dv.shipping_zone;

let cost;
if (zone === "local") {
  cost = weight * 0.5;
} else if (zone === "domestic") {
  cost = weight * 1.2;
} else {
  cost = weight * 3.0;
}
return { shipping_cost: "$" + cost.toFixed(2), zone: zone };
4

Set response variables (optional)

Use Store Fields as Variables to extract values from your code’s return value and save them as dynamic variables. Specify a variable name and the JSON path to the value.For example, if your code returns { "shipping_cost": "$6.00", "zone": "domestic" }:
Variable NameJSON PathExtracted Value
shipping_costshipping_cost"$6.00"
shipping_zonezone"domestic"
5

Configure speech settings

  • Speak During Execution: When enabled, the agent says something while the code runs (e.g., “Let me calculate that for you.”). Choose Prompt or Static Text.
  • Speak After Execution: When enabled (default), the LLM speaks about the result. Turn off if you want the tool to run silently.
6

Update your prompt

Guide the LLM on when to use the code tool in your agent’s prompt. For example:
When the customer asks about shipping costs, use the calculate_shipping_cost
tool to compute the cost based on their order details.
7

Test your code

Click Run Code at the bottom of the editor to test. Use the Dynamic Variables dropdown in the editor to set test values for your variables (e.g., give order_weight a value of “5”) — these values are only used during testing and won’t affect your live agent. The output panel will show the result and any console.log() output.
Code Tool editor showing test output after clicking Run Code

JavaScript Environment

Your code runs in a JavaScript sandbox with the following globals available. The code editor provides autocomplete — as you type, it will suggest available globals, dynamic variable names, and built-in functions.

dv — Dynamic Variables

Access your agent’s dynamic variables as properties on the dv object. All values are strings.
const name = dv.customer_name;       // "John Doe"
const orderId = dv.order_id;         // "78542"
const total = parseFloat(dv.amount); // Convert to number if needed

metadata — Call Metadata

Access metadata passed when the call was created via the API. This is the same object you pass in the metadata field of the Create Call API.
const customerId = metadata.customer_id;
const priority = metadata.priority_level;

fetch(url) — HTTP Requests

Make HTTP requests to external APIs. Works like the standard Fetch API.
// GET request
const response = await fetch("https://api.example.com/data");
const data = await response.json();

// POST request
const response = await fetch("https://api.example.com/submit", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ name: dv.customer_name })
});

console.log() — Debugging

Log output for debugging. Logs appear in the test output panel when using Run Code.
console.log("Customer:", dv.customer_name);
console.log("API response:", JSON.stringify(data));
  • Your code can return any value (object, string, number) or return nothing at all.
  • Standard JavaScript built-ins are available: Math, JSON, Date, Array, Object, String methods, etc.
  • External packages (require, import) are not available. Use fetch() for external integrations.
  • Code is limited to 5,000 characters.

Examples

Format data from dynamic variables

// Combine and format customer info
const fullName = dv.first_name + " " + dv.last_name;
const summary = `Customer ${fullName} (ID: ${dv.customer_id}) requested a callback.`;
return { full_name: fullName, summary: summary };

Fetch data from an external API

// Look up order status from your API
const response = await fetch("https://api.example.com/orders/" + dv.order_id, {
  headers: { "Authorization": "Bearer " + dv.api_token }
});
const order = await response.json();
return {
  status: order.status,
  items: order.items.length,
  total: "$" + order.total.toFixed(2)
};

Conditional logic with API call

// Route based on customer tier
const response = await fetch("https://api.example.com/customers/" + dv.customer_id);
const customer = await response.json();

if (customer.tier === "premium") {
  return { action: "priority_support", wait_time: "0 minutes" };
} else if (customer.tier === "standard") {
  return { action: "standard_queue", wait_time: "5 minutes" };
} else {
  return { action: "general_queue", wait_time: "10 minutes" };
}

Response Variables

Response variables let you extract specific values from your code’s return value and store them as dynamic variables. Specify each variable as a name and a JSON path using dot notation:
Path SyntaxExampleExtracts
Top-level fieldstatusresult.status
Nested fielddata.order.idresult.data.order.id
Array elementitems[0].nameFirst item’s name
If a path doesn’t exist in the return value, the variable is skipped (no error).

Configuration

  • Timeout: How long the code can run before timing out. Range: 5–60 seconds. Default: 30 seconds.
  • Speak During Execution: When enabled, the agent says something while the code runs. Choose between Prompt (LLM generates the message) or Static Text (exact text you provide). Recommended when your code takes more than 1 second.
  • Speak After Execution: When enabled (default), the LLM speaks about the result after execution. Turn off to run the tool silently (e.g., for background logging).
The code result is capped at 15,000 characters to prevent overloading the LLM context.

FAQ

No. The code runs in a lightweight JavaScript sandbox without access to require or import. You can use all standard JavaScript built-ins (Math, JSON, Date, Array methods, etc.) and the fetch() function for external API calls.
If your code exceeds the timeout or throws an error, the execution is marked as failed and the error message is returned to the LLM. Response variables will not be extracted.
Yes. The fetch() function is async, so you can use await to wait for HTTP responses. Top-level await is supported.
Use Code Tool for logic that doesn’t require your own server — data formatting, simple API calls via fetch, calculations. Use Custom Function when you need access to your internal systems, databases, or complex server-side logic.