Interface: ClientOptions

Generated from the public TypeScript API.

Options to createAgentClient.

• Pass baseUrl to connect to an already-running server (remote transport).
• Omit baseUrl to spawn a local cognitio serve via the existing SDK.

​

Properties

​

baseUrl?

optional baseUrl?: string;

Absolute URL of a running cognitio server. If set, no server is spawned.

---

​

control?

optional control?: ControlOptions;

Control-channel dispatcher readiness and reconnect tuning.

---

​

directory?

optional directory?: string;

Working directory sent to the server on session creation.

---

​

headers?

optional headers?: Record<string, string>;

Headers sent on every remote HTTP/SSE request, including Authorization. Requires baseUrl.

---

​

spawn?

optional spawn?: SpawnOptions;

Override spawn behavior. Not used when baseUrl is provided.

---

​

workspaceId?

optional workspaceId?: string;

Optional workspace id passed through to the server.