JavaScript and TypeScript

npm install guidinghand

import GuidingHand from 'guidinghand';

const gh = new GuidingHand(); // reads GUIDINGHAND_API_KEY

// 1. A session: send its invite link to the person at the computer
const session = await gh.sessions.create({ agent_id: 'default', metadata: { ticket: 'T-123' } });
console.log('Send this link:', session.invite_url);

// 2. Wait for their computer to connect
await gh.sessions.waitForConnection(session.session_id);

// 3. Run a task, answering the agent's questions and approvals as they come
const task = await gh.tasks.run(session.session_id, {
  prompt: 'Turn on Dark Mode',
  onEvent: (e) => console.log(e.type, e.message),
  onQuestion: async (q) => 'Work',
  onApproval: async (a) => a.risk !== 'high',
});

console.log(task.status, task.result, task.replay_url);

const task = await gh.tasks.run(session.session_id, {
  prompt: 'Set up the office printer',
  onEvent: (e) => { if (e.type === 'answer') console.log(`${e.data?.answered_by} answered: ${e.message}`); },
  onQuestion: async (q) => (q.customer_can_answer ? null : askMyTeam(q.question, q.options)),
  onApproval: async (a) => (a.customer_can_approve && a.risk !== 'high' ? null : askMyTeamToApprove(a.action)),
});

new GuidingHand({
  apiKey: process.env.GUIDINGHAND_API_KEY, // default
  baseUrl: 'https://guidinghand.ai',        // or https://dev.guidinghand.ai
  timeout: 60_000,                          // per request, in ms
  maxRetries: 2,                            // connection errors, 429 and 5xx
});

for await (const t of gh.tasks.listAll({ agent_id: 'billing', status: 'completed' })) {
  console.log(t.task_id, t.result);
}

import { verifyWebhook } from 'guidinghand';

app.post('/guidinghand', express.raw({ type: 'application/json' }), async (req, res) => {
  const event = await verifyWebhook(req.body, req.header('GuidingHand-Signature'), process.env.GUIDINGHAND_WEBHOOK_SECRET!);
  if (event.type === 'task.completed') console.log(event.data.task!.result);
  if (event.type === 'task.question_answered') console.log(event.data.answer!.answered_by, event.data.answer!.answer);
  if (event.type === 'task.approval_decided') console.log(event.data.decision!.answered_by, event.data.decision!.decision);
  res.sendStatus(200);
});

import { ConflictError } from 'guidinghand';

try {
  await gh.tasks.create(sessionId, { prompt: 'Update the printer driver' });
} catch (e) {
  if (e instanceof ConflictError && e.extra.active_task_id) await gh.tasks.stop(String(e.extra.active_task_id));
  else throw e;
}