API Reference

http-client

Classes#AIGNEHTTPClient<U>#Http client for interacting with a remote AIGNE server. AIGNEHTTPClient provides a client-side interface that matches the AIGNE API, allowing applications to invoke agents and receive responses from a remote AIGNE instance.
Examples#Here's a simple example of how to use AIGNEClient:
const client = new AIGNEHTTPClient({ url });

const response = await client.invoke("chat", { message: "hello" });

console.log(response); // Output: {message: "Hello world!"}Here's an example of how to use AIGNEClient with streaming response:
const client = new AIGNEHTTPClient({ url });

const stream = await client.invoke(
  "chat",
  { message: "hello" },
  { streaming: true },
);

let text = "";
for await (const chunk of stream) {
  if (isAgentResponseDelta(chunk)) {
    if (chunk.delta.text?.message) text += chunk.delta.text.message;
  }
}

console.log(text); // Output: "Hello world!"Extends#BaseClient
Type Parameters#Type Parameter
Default type
U extends UserContext
UserContext
Implements#Context<U>
Constructors#Constructor#new AIGNEHTTPClient<U>(options): AIGNEHTTPClient<U>
Creates a new AIGNEClient instance.
Parameters#Parameter
Type
Description
options
AIGNEHTTPClientOptions
Configuration options for connecting to the AIGNE server
Returns#AIGNEHTTPClient<U>
Overrides#BaseClient.constructor
Properties#id#id: string
Implementation of#Context.id
rootId#rootId: string
Implementation of#Context.rootId
usage#usage: ContextUsage
Implementation of#Context.usage
userContext#userContext: U
Implementation of#Context.userContext
memories#memories: Pick<Memory, "content">[] = []
Implementation of#Context.memories
model#model: ClientChatModel
Implementation of#Context.model
agents#agents: never[] = []
Implementation of#Context.agents
Methods#invoke()#Call Signature#invoke<I, O>(agent): UserAgent<I, O>
Create a user agent to consistently invoke an agent
Type Parameters#Type Parameter
I extends Message
O extends Message
Parameters#Parameter
Type
Description
agent
string | Agent<I, O>
Agent to invoke
Returns#UserAgent<I, O>
User agent
Implementation of#Context.invoke
Call Signature#invoke<I, O>(agent, message, options): Promise<[O, Agent<any, any>]>
Invoke an agent with a message and return the output and the active agent
Type Parameters#Type Parameter
I extends Message
O extends Message
Parameters#Parameter
Type
Description
agent
string | Agent<I, O>
Agent to invoke
message
I
Message to pass to the agent
options
AIGNEHTTPClientInvokeOptions & { returnActiveAgent: true; streaming?: false; }
-
Returns#Promise<[O, Agent<any, any>]>
the output of the agent and the final active agent
Implementation of#Context.invoke
Call Signature#invoke<I, O>(agent, message, options): Promise<[AgentResponseStream<O>, Promise<Agent<any, any>>]>
Type Parameters#Type Parameter
I extends Message
O extends Message
Parameters#Parameter
Type
agent
string | Agent<I, O>
message
I
options
AIGNEHTTPClientInvokeOptions & { returnActiveAgent: true; streaming: true; }
Returns#Promise<[AgentResponseStream<O>, Promise<Agent<any, any>>]>
Implementation of#Context.invoke
Call Signature#invoke<I, O>(agent, message, options?): Promise<O>
Invoke an agent with a message
Type Parameters#Type Parameter
I extends Message
O extends Message
Parameters#Parameter
Type
Description
agent
string | Agent<I, O>
Agent to invoke
message
I
Message to pass to the agent
options?
AIGNEHTTPClientInvokeOptions & { returnActiveAgent?: false; streaming?: false; }
-
Returns#Promise<O>
the output of the agent
Implementation of#Context.invoke
Call Signature#invoke<I, O>(agent, message, options): Promise<AgentResponseStream<O>>
Type Parameters#Type Parameter
I extends Message
O extends Message
Parameters#Parameter
Type
agent
string | Agent<I, O>
message
I
options
AIGNEHTTPClientInvokeOptions & { returnActiveAgent?: false; streaming: true; }
Returns#Promise<AgentResponseStream<O>>
Implementation of#Context.invoke
Call Signature#invoke<I, O>(agent, message, options): Promise<O | AgentResponseStream<O>>
Type Parameters#Type Parameter
I extends Message
O extends Message
Parameters#Parameter
Type
agent
string | Agent<I, O>
message
I
options
AIGNEHTTPClientInvokeOptions & { returnActiveAgent?: false; }
Returns#Promise<O | AgentResponseStream<O>>
Implementation of#Context.invoke
Call Signature#invoke<I, O>(agent, message?, options?): UserAgent<I, O> | Promise<AgentResponse<O> | [AgentResponse<O>, Agent<any, any>]>
Type Parameters#Type Parameter
I extends Message
O extends Message
Parameters#Parameter
Type
agent
string | Agent<I, O>
message?
I
options?
AIGNEHTTPClientInvokeOptions
Returns#UserAgent<I, O> | Promise<AgentResponse<O> | [AgentResponse<O>, Agent<any, any>]>
Implementation of#Context.invoke
publish()#publish(_topic, _payload, _options?): void
Publish a message to a topic, the aigne will invoke the listeners of the topic
Parameters#Parameter
Type
_topic
string | string[]
_payload
string | Message | Omit<MessagePayload, "context">
_options?
InvokeOptions<UserContext>
Returns#void
Implementation of#Context.publish
subscribe()#Call Signature#subscribe(topic, listener?): Promise<MessagePayload>
Parameters#Parameter
Type
topic
string | string[]
listener?
undefined
Returns#Promise<MessagePayload>
Implementation of#Context.subscribe
Call Signature#subscribe(topic, listener): Unsubscribe
Parameters#Parameter
Type
topic
string | string[]
listener
MessageQueueListener
Returns#Unsubscribe
Implementation of#Context.subscribe
Call Signature#subscribe(topic, listener?): Unsubscribe | Promise<MessagePayload>
Parameters#Parameter
Type
topic
string | string[]
listener?
MessageQueueListener
Returns#Unsubscribe | Promise<MessagePayload>
Implementation of#Context.subscribe
Call Signature#subscribe(topic, listener?): Unsubscribe | Promise<MessagePayload>
Parameters#Parameter
Type
topic
string | string[]
listener?
MessageQueueListener
Returns#Unsubscribe | Promise<MessagePayload>
Implementation of#Context.subscribe
unsubscribe()#unsubscribe(_topic, _listener): void
Parameters#Parameter
Type
_topic
string | string[]
_listener
MessageQueueListener
Returns#void
Implementation of#Context.unsubscribe
newContext()#newContext(_options?): Context
Create a child context with the same configuration as the parent context. If reset is true, the child context will have a new state (such as: usage).
Parameters#Parameter
Type
_options?
{ reset?: boolean; }
_options.reset?
boolean
Returns#Context
new context
Implementation of#Context.newContext
emit()#emit<K>(_eventName, ..._args): boolean
Type Parameters#Type Parameter
K extends keyof ContextEventMap
Parameters#Parameter
Type
_eventName
K
..._args
Args<K, ContextEmitEventMap>
Returns#boolean
Implementation of#Context.emit
on()#on<K>(_eventName, _listener): this
Type Parameters#Type Parameter
K extends keyof ContextEventMap
Parameters#Parameter
Type
_eventName
K
_listener
Listener<K, ContextEventMap>
Returns#this
Implementation of#Context.on
once()#once<K>(_eventName, _listener): this
Type Parameters#Type Parameter
K extends keyof ContextEventMap
Parameters#Parameter
Type
_eventName
K
_listener
Listener<K, ContextEventMap>
Returns#this
Implementation of#Context.once
off()#off<K>(_eventName, _listener): this
Type Parameters#Type Parameter
K extends keyof ContextEventMap
Parameters#Parameter
Type
_eventName
K
_listener
Listener<K, ContextEventMap>
Returns#this
Implementation of#Context.off
_invoke()#Call Signature#_invoke<I, O>(agent, input, options?): Promise<O>
Invokes an agent in non-streaming mode and returns the complete response.
Type Parameters#Type Parameter
I extends Message
O extends Message
Parameters#Parameter
Type
Description
agent
string
Name of the agent to invoke
input
string | I
Input message for the agent
options?
AIGNEHTTPClientInvokeOptions & { streaming?: false; }
Options with streaming mode explicitly set to false or omitted
Returns#Promise<O>
The complete agent response
Example#Here's a simple example of how to use AIGNEClient:
const client = new AIGNEHTTPClient({ url });

const response = await client.invoke("chat", { message: "hello" });

console.log(response); // Output: {message: "Hello world!"}Call Signature#_invoke<I, O>(agent, input, options): Promise<AgentResponseStream<O>>
Invokes an agent with streaming mode enabled and returns a stream of response chunks.
Type Parameters#Type Parameter
I extends Message
O extends Message
Parameters#Parameter
Type
Description
agent
string
Name of the agent to invoke
input
string | I
Input message for the agent
options
AIGNEHTTPClientInvokeOptions & { streaming: true; }
Options with streaming mode explicitly set to true
Returns#Promise<AgentResponseStream<O>>
A stream of agent response chunks
Example#Here's an example of how to use AIGNEClient with streaming response:
const client = new AIGNEHTTPClient({ url });

const stream = await client.invoke(
  "chat",
  { message: "hello" },
  { streaming: true },
);

let text = "";
for await (const chunk of stream) {
  if (isAgentResponseDelta(chunk)) {
    if (chunk.delta.text?.message) text += chunk.delta.text.message;
  }
}

console.log(text); // Output: "Hello world!"Call Signature#_invoke<I, O>(agent, input, options?): Promise<AgentResponse<O>>
Invokes an agent with the given input and options.
Type Parameters#Type Parameter
I extends Message
O extends Message
Parameters#Parameter
Type
Description
agent
string
Name of the agent to invoke
input
string | I
Input message for the agent
options?
AIGNEHTTPClientInvokeOptions
Options for the invocation
Returns#Promise<AgentResponse<O>>
Either a complete response or a response stream depending on the streaming option
getAgent()#getAgent<I, O>(options): Promise<ClientAgent<I, O>>
Type Parameters#Type Parameter
Default type
I extends Message
Message
O extends Message
Message
Parameters#Parameter
Type
options
ClientAgentOptions<I, O>
Returns#Promise<ClientAgent<I, O>>
Interfaces#AIGNEHTTPClientOptions#Configuration options for the AIGNEHTTPClient.
Extends#BaseClientOptions

AIGNEHTTPClientInvokeOptions#Options for invoking an agent through the AIGNEHTTPClient. Extends the standard AgentInvokeOptions with client-specific options.
Extends#BaseClientInvokeOptions

Parameter	Type	Description
`agent`	`string` \| `Agent`<`I`, `O`>	Agent to invoke
`message`	`I`	Message to pass to the agent
`options`	`AIGNEHTTPClientInvokeOptions` & { `returnActiveAgent`: `true`; `streaming?`: `false`; }	-

Parameter	Type
`agent`	`string` \| `Agent`<`I`, `O`>
`message`	`I`
`options`	`AIGNEHTTPClientInvokeOptions` & { `returnActiveAgent`: `true`; `streaming`: `true`; }

Parameter	Type	Description
`agent`	`string` \| `Agent`<`I`, `O`>	Agent to invoke
`message`	`I`	Message to pass to the agent
`options?`	`AIGNEHTTPClientInvokeOptions` & { `returnActiveAgent?`: `false`; `streaming?`: `false`; }	-

Parameter	Type
`agent`	`string` \| `Agent`<`I`, `O`>
`message`	`I`
`options`	`AIGNEHTTPClientInvokeOptions` & { `returnActiveAgent?`: `false`; `streaming`: `true`; }

Parameter	Type
`agent`	`string` \| `Agent`<`I`, `O`>
`message`	`I`
`options`	`AIGNEHTTPClientInvokeOptions` & { `returnActiveAgent?`: `false`; }

Parameter	Type
`agent`	`string` \| `Agent`<`I`, `O`>
`message?`	`I`
`options?`	`AIGNEHTTPClientInvokeOptions`

Parameter	Type
`_topic`	`string` \| `string`[]
`_payload`	`string` \| `Message` \| `Omit`<`MessagePayload`, `"context"`>
`_options?`	`InvokeOptions`<`UserContext`>

Parameter	Type
`topic`	`string` \| `string`[]
`listener`	`MessageQueueListener`

Parameter	Type
`topic`	`string` \| `string`[]
`listener?`	`MessageQueueListener`

Parameter	Type
`_topic`	`string` \| `string`[]
`_listener`	`MessageQueueListener`

Parameter	Type
`_options?`	{ `reset?`: `boolean`; }
`_options.reset?`	`boolean`

Parameter	Type
`_eventName`	`K`
`_listener`	`Listener`<`K`, `ContextEventMap`>

Parameter	Type	Description
`agent`	`string`	Name of the agent to invoke
`input`	`string` \| `I`	Input message for the agent
`options?`	`AIGNEHTTPClientInvokeOptions` & { `streaming?`: `false`; }	Options with streaming mode explicitly set to false or omitted

Type Parameter	Default type
`I` extends `Message`	`Message`
`O` extends `Message`	`Message`

Getting Started

AIGNE CLI

AIGNE Observability

How to guides

Concepts

FAQ

API Reference

Contributing

http-client

Classes#

AIGNEHTTPClient<U>#

Examples#

Extends#

Type Parameters#

Implements#

Constructors#

Constructor#

Parameters#

Returns#

Overrides#

Properties#

id#

Implementation of#

rootId#

Implementation of#

usage#

Implementation of#

userContext#

Implementation of#

memories#

Implementation of#

model#

Implementation of#

agents#

Implementation of#

Methods#

invoke()#

Call Signature#

Type Parameters#

Parameters#

Returns#

Implementation of#

Call Signature#

Type Parameters#

Parameters#

Returns#

Implementation of#

Call Signature#

Type Parameters#

Parameters#

Returns#

Implementation of#

Call Signature#

Type Parameters#

Parameters#

Returns#

Implementation of#

Call Signature#

Type Parameters#

Parameters#

Returns#

Implementation of#

Call Signature#

Type Parameters#

Parameters#

Returns#

Implementation of#

Call Signature#

Type Parameters#

Parameters#

Returns#

Implementation of#

publish()#

Parameters#

Returns#

Implementation of#

subscribe()#

Call Signature#

Parameters#

Returns#