lumail.tools.get

SDK 2.1.0 · API v2 · GET /api/v2/tools/:toolName

MethodGET

/api/v2/tools/:toolName

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.tools.get("list_subscribers");
if (error) {
  throw error;
}
console.log(data.name, data.inputSchema);

Response Examples

{
  "name": "list_subscribers",
  "description": "List contacts newest first.",
  "inputSchema": { "type": "object" }
}

[email protected] · lumail.tools

tools.get(toolName: string): Promise<LumailResult<GetToolResponse>>

One tool and its input schema.

Path Parameters

Name	Type	Description
`toolName`	string	Required. Tool name (`^[a-z0-9_]+$`).

Response Fields

Field	Type	Description
`name`	string	Tool name.
`description`	string	What the tool does.
`category`	string	Optional grouping.
`inputSchema`	object	JSON Schema for the run body.
`outputSchema`	object	Optional JSON Schema for the result.

HTTP also includes endpoint (/api/v2/tools/{name}). data is the tool definition. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.tools.list Nextlumail.tools.run