OutputAdvisorServerToolItem - TypeScript SDK

OutputAdvisorServerToolItem type definition

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

An openrouter:advisor server tool output item

Example Usage

1import { OutputAdvisorServerToolItem } from "@openrouter/sdk/models";
2
3let value: OutputAdvisorServerToolItem = {
4 status: "completed",
5 type: "openrouter:advisor",
6};

Fields

FieldTypeRequiredDescriptionExample
advicestringThe advisor model’s response (the advice text returned to the executor).
errorstringError message when the advisor call did not produce advice.
idstringN/A
instanceNamestringProvider-safe function name of the specific advisor instance that produced this item (e.g. openrouter_advisor__1). Present only when more than one advisor tool is configured; omitted for the default single advisor. Echo this field back unchanged so the advisor’s cross-request memory stays namespaced to the correct instance. This identity is positional: it is derived from the index of the advisor entry in the request tools array, so clients must keep the order of advisor tool entries stable across requests in a conversation. Reordering or inserting advisor entries shifts these names and causes each advisor’s cross-request memory to be attributed to the wrong instance.openrouter_advisor__1
modelstringSlug of the advisor model that was consulted.
promptstringThe prompt the executor sent to the advisor.
statusmodels.ToolCallStatus✔️N/Acompleted
typemodels.OutputAdvisorServerToolItemType✔️N/A