Tools overview

curl -X POST https://api.in.talqing.com/v1/tools \
  -H "Authorization: Bearer $TALQING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "check_order_status",
    "description": "Look up where a customer order is. Use it once the caller has given you their order number and asks where the order is, when it will arrive, or whether it has shipped.",
    "json_schema": {
      "type": "object",
      "properties": {
        "order_id": {
          "type": "string",
          "description": "The order number the caller read out, digits only, e.g. 4417029. Ask for it if they have not said it."
        }
      },
      "required": ["order_id"]
    },
    "operations": [
      {
        "kind": "http",
        "config": {
          "method": "GET",
          "url": "https://api.example.com/orders/{{args.order_id}}",
          "headers": { "Authorization": "Bearer {{secrets.SHOP_API_KEY}}" },
          "timeout": 10
        },
        "silent": true,
        "publish_fields": [
          { "path": "status", "store": "tooldata" },
          { "path": "estimated_delivery", "key": "eta", "store": "tooldata" }
        ]
      },
      {
        "kind": "say",
        "config": {
          "text": "Order {{args.order_id}} is {{tooldata.status}}, and it should reach you {{tooldata.eta}}."
        }
      }
    ]
  }'

const tool = await talqing.tools.create({
  createToolRequest: {
    name: "check_order_status",
    description:
      "Look up where a customer order is. Use it once the caller has given you their order number and asks where the order is, when it will arrive, or whether it has shipped.",
    json_schema: {
      type: "object",
      properties: {
        order_id: {
          type: "string",
          description:
            "The order number the caller read out, digits only, e.g. 4417029. Ask for it if they have not said it.",
        },
      },
      required: ["order_id"],
    },
    operations: [
      {
        kind: "http",
        config: {
          method: "GET",
          url: "https://api.example.com/orders/{{args.order_id}}",
          headers: { Authorization: "Bearer {{secrets.SHOP_API_KEY}}" },
          timeout: 10,
        },
        silent: true,
        publish_fields: [
          { path: "status", store: "tooldata" },
          { path: "estimated_delivery", key: "eta", store: "tooldata" },
        ],
      },
      {
        kind: "say",
        config: {
          text: "Order {{args.order_id}} is {{tooldata.status}}, and it should reach you {{tooldata.eta}}.",
        },
      },
    ],
  },
});

await talqing.tools.publish({
  tool_id: tool.id,
  publishToolRequest: { changelog: "First version" },
});

tool = talqing.tools.create(
    name="check_order_status",
    description=(
        "Look up where a customer order is. Use it once the caller has given you "
        "their order number and asks where the order is, when it will arrive, or "
        "whether it has shipped."
    ),
    json_schema={
        "type": "object",
        "properties": {
            "order_id": {
                "type": "string",
                "description": (
                    "The order number the caller read out, digits only, e.g. 4417029. "
                    "Ask for it if they have not said it."
                ),
            }
        },
        "required": ["order_id"],
    },
    operations=[
        {
            "kind": "http",
            "config": {
                "method": "GET",
                "url": "https://api.example.com/orders/{{args.order_id}}",
                "headers": {"Authorization": "Bearer {{secrets.SHOP_API_KEY}}"},
                "timeout": 10,
            },
            "silent": True,
            "publish_fields": [
                {"path": "status", "store": "tooldata"},
                {"path": "estimated_delivery", "key": "eta", "store": "tooldata"},
            ],
        },
        {
            "kind": "say",
            "config": {
                "text": "Order {{args.order_id}} is {{tooldata.status}}, and it should reach you {{tooldata.eta}}."
            },
        },
    ],
)

talqing.tools.publish(tool["id"], changelog="First version")

curl -X PATCH https://api.in.talqing.com/v1/agents/9c1e6f42-7b30-4a55-9d18-2f0a6c4b8e31 \
  -H "Authorization: Bearer $TALQING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "config": {
      "name": "Order desk",
      "channel": "voice",
      "prompt": "You are the order desk for Northwind. Answer delivery questions.",
      "llm": { "provider": "openai", "model": "gpt-4.1" },
      "tools": [{ "tool_id": "2b7d1f08-4c9a-4e6b-8f21-0d5a3c7e9b44" }]
    }
  }'

const agent = await talqing.agents.get({ agent_id });

await talqing.agents.update({
  agent_id,
  updateAgentRequest: {
    config: { ...agent.config, tools: [{ tool_id: tool.id }] },
  },
});
await talqing.agents.publish({ agent_id });

agent = talqing.agents.get(agent_id)

talqing.agents.update(
    agent_id,
    config={**agent["config"], "tools": [{"tool_id": tool["id"]}]},
)
talqing.agents.publish(agent_id)