Namespaces

ovok.bots

Run a server-side bot with a JSON input.

  • Stable unknown
  • Release candidate since 0.4.49-rc.4
  • Development since 0.4.49-dev.517+4645a0a

Runs a bot configured on the project and returns its output. The caller needs permission to run that bot.

Run a bot

const output = await ovok.bots.execute('https://example.com/bots|daily-summary', {
  patientId: '123',
});
  • The first argument is the bot's system|value identifier.
  • The input and output are plain JSON objects (Record<string, unknown>). Their shape is whatever the bot defines.
  • Calls POST bots?identifier=.... A failing bot surfaces as an OvokError subclass; see errors and retries.
  • Bots can have side effects, so the call is not retried after a network failure.

Reference

Last updated on

On this page