Run Pipe langbase.pipes.run()

interface RunOptions {
	name: string;
	apiKey?: string;
	llmKey?: string;
	messages: Message[];
	variables?: Variable[];
	threadId?: string;
	rawResponse?: boolean;
	tools?: Tool[];
	memory?: Memory[];
}

Following are the properties of the options object.

The name of the pipe to run. E.g. ai-agent.

Pipe name and the User/Org API key is used to run the pipe.

API key of the pipe you want to run.

If provided, pipe.run() will use this key instead of user/org key to identify and run the pipe.

LLM API key for the pipe. If not provided, the LLM key from Pipe/User/Organization keyset will be used.

Explore the example to learn more.

A messages array including the following properties. Optional if variables are provided.

interface Message {
	role: 'user' | 'assistant' | 'system'| 'tool';
	content: string | null;
	name?: string;
	tool_call_id?: string;
	tool_calls?: ToolCall[];
}

A variables array including the name and value params. Optional if messages are provided.

interface Variable {
	name: string;
	value: string;
}

The ID of the thread. Enable if you want to continue the conversation in the same thread from the second message onwards. Works only with deployed pipes.

• If threadId is not provided, a new thread will be created. E.g. first message of a new chat will not have a threadId.
• After the first message, a new threadId will be returned.
• Use this threadId to continue the conversation in the same thread from the second message onwards.

Enable if you want to get complete raw LLM response.

Default: false

A list of tools the model may call.

interface ToolsOptions {
	type: 'function';
	function: FunctionOptions
}

An array of memory objects that specify the memories your pipe should use at run time.

If memories are defined here, they will override the default pipe memories, which will be ignored. All referenced memories must exist in your account.

"memory": [
  { "name": "runtime-memory-1" },
  { "name": "runtime-memory-2" }
]

If this property is not set or is empty, the pipe will fall back to using its default memories.

Default: undefined

Each memory in the array follows this structure:

interface Memory {
    name: string;
}

The generated text completion.

The ID of the thread. Useful for a chat pipe to continue the conversation in the same thread. Optional.

The ID of the raw response.

The object type name of the response.

The timestamp of the response creation.

The model used to generate the response.

A list of chat completion choices. Can contain more than one elements if n is greater than 1.

interface ChoiceGenerate {
	index: number;
	message: Message;
	logprobs: boolean | null;
	finish_reason: string;
}

The usage object including the following properties.

interface Usage {
	prompt_tokens: number;
	completion_tokens: number;
	total_tokens: number;
}

This fingerprint represents the backend configuration that the model runs with.

The different headers of the response.

The ID of the thread. Useful for a chat pipe to continue the conversation in the same thread. Optional.

The different headers of the response.

Stream is an object with a streamed sequence of StreamChunk objects.

type StreamResponse = ReadableStream<StreamChunk>;

StreamChunk