SDK reference

Use this reference for the JavaScript and TypeScript API exported by cognitio-agent-sdk. If you are starting a new project, begin with the quickstart and return here for exact options and return types.

Start with these APIs

API	Use it for
Agent	Reusable configuration, one-off tasks, streams, and conversations.
Session	Multiple messages in one conversation, forks, and checkpoints.
query	One streamed task without managing an Agent object.
defineTool	A function the model can call in your application.
createAgentClient	Direct control over a local or remote runtime and session handles.
shutdown	Application teardown for facade-owned runtimes.

See AgentOptions for agent configuration and RunResult for completed high-level runs. Low-level session operations return ResultMessage. The SDK reference is the interface most applications use. The runtime HTTP API and protocol types under Advanced describe the underlying server for direct integrations; you do not need them to use Agent.

Overview

Classes

Functions

Interfaces

Types

Variables

Supporting

Start with these APIs

Exported API

Classes

Interfaces

Type Aliases

Variables

Functions

​Start with these APIs

​Exported API

​Classes

​Interfaces

​Type Aliases

​Variables

​Functions

Start with these APIs

Exported API

Classes

Interfaces

Type Aliases

Variables

Functions