> ## Documentation Index
> Fetch the complete documentation index at: https://cognitio-agent.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK reference

> Generated from the public TypeScript API.

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](https://cognitio-agent.mintlify.site/quickstart.md) and return here for exact options and return types.

## Start with these APIs

| API | Use it for |
| - | - |
| [Agent](https://cognitio-agent.mintlify.site/api-reference/classes/Agent.md) | Reusable configuration, one-off tasks, streams, and conversations. |
| [Session](https://cognitio-agent.mintlify.site/api-reference/classes/Session.md) | Multiple messages in one conversation, forks, and checkpoints. |
| [query](https://cognitio-agent.mintlify.site/api-reference/functions/query.md) | One streamed task without managing an Agent object. |
| [defineTool](https://cognitio-agent.mintlify.site/api-reference/functions/defineTool.md) | A function the model can call in your application. |
| [createAgentClient](https://cognitio-agent.mintlify.site/api-reference/functions/createAgentClient.md) | Direct control over a local or remote runtime and session handles. |
| [shutdown](https://cognitio-agent.mintlify.site/api-reference/functions/shutdown.md) | Application teardown for facade-owned runtimes. |

See [AgentOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/AgentOptions.md) for agent configuration and [RunResult](https://cognitio-agent.mintlify.site/api-reference/interfaces/RunResult.md) for completed high-level runs. Low-level session operations return [ResultMessage](https://cognitio-agent.mintlify.site/api-reference/interfaces/ResultMessage.md).

The **SDK reference** is the interface most applications use. The **[runtime HTTP API](https://cognitio-agent.mintlify.site/http-api/overview.md)** and protocol types under **Advanced** describe the underlying server for direct integrations; you do not need them to use `Agent`.

## Exported API

## Classes

* [Agent](https://cognitio-agent.mintlify.site/api-reference/classes/Agent.md)
* [Session](https://cognitio-agent.mintlify.site/api-reference/classes/Session.md)

## Interfaces

* [AgentClient](https://cognitio-agent.mintlify.site/api-reference/interfaces/AgentClient.md)
* [AgentDefinition](https://cognitio-agent.mintlify.site/api-reference/interfaces/AgentDefinition.md)
* [AgentOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/AgentOptions.md)
* [AgentSessionOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/AgentSessionOptions.md)
* [AgentStream](https://cognitio-agent.mintlify.site/api-reference/interfaces/AgentStream.md)
* [AgentStreamOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/AgentStreamOptions.md)
* [AppliedSettings](https://cognitio-agent.mintlify.site/api-reference/interfaces/AppliedSettings.md)
* [CheckpointHandle](https://cognitio-agent.mintlify.site/api-reference/interfaces/CheckpointHandle.md)
* [CheckpointingConfig](https://cognitio-agent.mintlify.site/api-reference/interfaces/CheckpointingConfig.md)
* [ClaudePluginSpec](https://cognitio-agent.mintlify.site/api-reference/interfaces/ClaudePluginSpec.md)
* [ClientOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/ClientOptions.md)
* [CommandDefinition](https://cognitio-agent.mintlify.site/api-reference/interfaces/CommandDefinition.md)
* [CompactResult](https://cognitio-agent.mintlify.site/api-reference/interfaces/CompactResult.md)
* [ControlOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/ControlOptions.md)
* [HookEntry](https://cognitio-agent.mintlify.site/api-reference/interfaces/HookEntry.md)
* [HookEventPayload](https://cognitio-agent.mintlify.site/api-reference/interfaces/HookEventPayload.md)
* [HookResult](https://cognitio-agent.mintlify.site/api-reference/interfaces/HookResult.md)
* [InlinePluginSpec](https://cognitio-agent.mintlify.site/api-reference/interfaces/InlinePluginSpec.md)
* [LocalMcpServer](https://cognitio-agent.mintlify.site/api-reference/interfaces/LocalMcpServer.md)
* [McpPromptDefinition](https://cognitio-agent.mintlify.site/api-reference/interfaces/McpPromptDefinition.md)
* [McpResourceDefinition](https://cognitio-agent.mintlify.site/api-reference/interfaces/McpResourceDefinition.md)
* [ModelUsageSummary](https://cognitio-agent.mintlify.site/api-reference/interfaces/ModelUsageSummary.md)
* [OutputFormatSpec](https://cognitio-agent.mintlify.site/api-reference/interfaces/OutputFormatSpec.md)
* [PostCompactHookData](https://cognitio-agent.mintlify.site/api-reference/interfaces/PostCompactHookData.md)
* [PreCompactHookData](https://cognitio-agent.mintlify.site/api-reference/interfaces/PreCompactHookData.md)
* [PromptTurn](https://cognitio-agent.mintlify.site/api-reference/interfaces/PromptTurn.md)
* [QueryOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/QueryOptions.md)
* [RateLimitEvent](https://cognitio-agent.mintlify.site/api-reference/interfaces/RateLimitEvent.md)
* [RemoteMcpServer](https://cognitio-agent.mintlify.site/api-reference/interfaces/RemoteMcpServer.md)
* [ResultMessage](https://cognitio-agent.mintlify.site/api-reference/interfaces/ResultMessage.md)
* [RunOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/RunOptions.md)
* [RunResult](https://cognitio-agent.mintlify.site/api-reference/interfaces/RunResult.md)
* [RuntimeConfig](https://cognitio-agent.mintlify.site/api-reference/interfaces/RuntimeConfig.md)
* [SdkError](https://cognitio-agent.mintlify.site/api-reference/interfaces/SdkError.md)
* [SdkMcpServer](https://cognitio-agent.mintlify.site/api-reference/interfaces/SdkMcpServer.md)
* [SessionContext](https://cognitio-agent.mintlify.site/api-reference/interfaces/SessionContext.md)
* [SessionCreateOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/SessionCreateOptions.md)
* [SessionListFilter](https://cognitio-agent.mintlify.site/api-reference/interfaces/SessionListFilter.md)
* [SessionNamespace](https://cognitio-agent.mintlify.site/api-reference/interfaces/SessionNamespace.md)
* [SessionResumeOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/SessionResumeOptions.md)
* [SessionUsage](https://cognitio-agent.mintlify.site/api-reference/interfaces/SessionUsage.md)
* [SkillDefinition](https://cognitio-agent.mintlify.site/api-reference/interfaces/SkillDefinition.md)
* [SpawnOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/SpawnOptions.md)
* [StreamOptions](https://cognitio-agent.mintlify.site/api-reference/interfaces/StreamOptions.md)
* [TaskNotificationEvent](https://cognitio-agent.mintlify.site/api-reference/interfaces/TaskNotificationEvent.md)
* [TaskProgressEvent](https://cognitio-agent.mintlify.site/api-reference/interfaces/TaskProgressEvent.md)
* [TaskStartedEvent](https://cognitio-agent.mintlify.site/api-reference/interfaces/TaskStartedEvent.md)
* [TaskStoppedEvent](https://cognitio-agent.mintlify.site/api-reference/interfaces/TaskStoppedEvent.md)
* [ToolContext](https://cognitio-agent.mintlify.site/api-reference/interfaces/ToolContext.md)
* [UsageSummary](https://cognitio-agent.mintlify.site/api-reference/interfaces/UsageSummary.md)

## Type Aliases

* [AgentMessage](https://cognitio-agent.mintlify.site/api-reference/type-aliases/AgentMessage.md)
* [AnthropicModelId](https://cognitio-agent.mintlify.site/api-reference/type-aliases/AnthropicModelId.md)
* [ApiAuth](https://cognitio-agent.mintlify.site/api-reference/type-aliases/ApiAuth.md)
* [Auth](https://cognitio-agent.mintlify.site/api-reference/type-aliases/Auth.md)
* [AuthContent](https://cognitio-agent.mintlify.site/api-reference/type-aliases/AuthContent.md)
* [CanUseToolCallback](https://cognitio-agent.mintlify.site/api-reference/type-aliases/CanUseToolCallback.md)
* [CognitioConfig](https://cognitio-agent.mintlify.site/api-reference/type-aliases/CognitioConfig.md)
* [CognitioEvent](https://cognitio-agent.mintlify.site/api-reference/type-aliases/CognitioEvent.md)
* [CognitioMessage](https://cognitio-agent.mintlify.site/api-reference/type-aliases/CognitioMessage.md)
* [CognitioPart](https://cognitio-agent.mintlify.site/api-reference/type-aliases/CognitioPart.md)
* [CognitioSession](https://cognitio-agent.mintlify.site/api-reference/type-aliases/CognitioSession.md)
* [DeepseekModelId](https://cognitio-agent.mintlify.site/api-reference/type-aliases/DeepseekModelId.md)
* [ExternalMcpServer](https://cognitio-agent.mintlify.site/api-reference/type-aliases/ExternalMcpServer.md)
* [GoogleModelId](https://cognitio-agent.mintlify.site/api-reference/type-aliases/GoogleModelId.md)
* [GroqModelId](https://cognitio-agent.mintlify.site/api-reference/type-aliases/GroqModelId.md)
* [HookCallback](https://cognitio-agent.mintlify.site/api-reference/type-aliases/HookCallback.md)
* [HookData](https://cognitio-agent.mintlify.site/api-reference/type-aliases/HookData.md)
* [HookEventName](https://cognitio-agent.mintlify.site/api-reference/type-aliases/HookEventName.md)
* [HookRegistration](https://cognitio-agent.mintlify.site/api-reference/type-aliases/HookRegistration.md)
* [KnownModelId](https://cognitio-agent.mintlify.site/api-reference/type-aliases/KnownModelId.md)
* [MistralModelId](https://cognitio-agent.mintlify.site/api-reference/type-aliases/MistralModelId.md)
* [ModelId](https://cognitio-agent.mintlify.site/api-reference/type-aliases/ModelId.md)
* [OAuth](https://cognitio-agent.mintlify.site/api-reference/type-aliases/OAuth.md)
* [OpenaiModelId](https://cognitio-agent.mintlify.site/api-reference/type-aliases/OpenaiModelId.md)
* [OutputOf](https://cognitio-agent.mintlify.site/api-reference/type-aliases/OutputOf.md)
* [PermissionDecision](https://cognitio-agent.mintlify.site/api-reference/type-aliases/PermissionDecision.md)
* [PermissionMode](https://cognitio-agent.mintlify.site/api-reference/type-aliases/PermissionMode.md)
* [PermissionRuleset](https://cognitio-agent.mintlify.site/api-reference/type-aliases/PermissionRuleset.md)
* [PluginSpec](https://cognitio-agent.mintlify.site/api-reference/type-aliases/PluginSpec.md)
* [PromptInput](https://cognitio-agent.mintlify.site/api-reference/type-aliases/PromptInput.md)
* [PromptPart](https://cognitio-agent.mintlify.site/api-reference/type-aliases/PromptPart.md)
* [Query](https://cognitio-agent.mintlify.site/api-reference/type-aliases/Query.md)
* [RewindResult](https://cognitio-agent.mintlify.site/api-reference/type-aliases/RewindResult.md)
* [RuntimeMcpServer](https://cognitio-agent.mintlify.site/api-reference/type-aliases/RuntimeMcpServer.md)
* [SdkErrorKind](https://cognitio-agent.mintlify.site/api-reference/type-aliases/SdkErrorKind.md)
* [SpawnServerRequest](https://cognitio-agent.mintlify.site/api-reference/type-aliases/SpawnServerRequest.md)
* [SystemPromptSpec](https://cognitio-agent.mintlify.site/api-reference/type-aliases/SystemPromptSpec.md)
* [ThinkingConfig](https://cognitio-agent.mintlify.site/api-reference/type-aliases/ThinkingConfig.md)
* [TodoItem](https://cognitio-agent.mintlify.site/api-reference/type-aliases/TodoItem.md)
* [ToolDefinition](https://cognitio-agent.mintlify.site/api-reference/type-aliases/ToolDefinition.md)
* [TransportKind](https://cognitio-agent.mintlify.site/api-reference/type-aliases/TransportKind.md)
* [WellKnownAuth](https://cognitio-agent.mintlify.site/api-reference/type-aliases/WellKnownAuth.md)
* [XaiModelId](https://cognitio-agent.mintlify.site/api-reference/type-aliases/XaiModelId.md)

## Variables

* [models](https://cognitio-agent.mintlify.site/api-reference/variables/models.md)
* [NEUTRAL\_BASE\_PROMPT](https://cognitio-agent.mintlify.site/api-reference/variables/NEUTRAL_BASE_PROMPT.md)
* [PermissionDecision](https://cognitio-agent.mintlify.site/api-reference/variables/PermissionDecision.md)

## Functions

* [claudeCompat](https://cognitio-agent.mintlify.site/api-reference/functions/claudeCompat.md)
* [createAgentClient](https://cognitio-agent.mintlify.site/api-reference/functions/createAgentClient.md)
* [createSdkMcpServer](https://cognitio-agent.mintlify.site/api-reference/functions/createSdkMcpServer.md)
* [defineAgent](https://cognitio-agent.mintlify.site/api-reference/functions/defineAgent.md)
* [defineCommand](https://cognitio-agent.mintlify.site/api-reference/functions/defineCommand.md)
* [defineHook](https://cognitio-agent.mintlify.site/api-reference/functions/defineHook.md)
* [defineOutputFormat](https://cognitio-agent.mintlify.site/api-reference/functions/defineOutputFormat.md)
* [definePlugin](https://cognitio-agent.mintlify.site/api-reference/functions/definePlugin.md)
* [defineSkill](https://cognitio-agent.mintlify.site/api-reference/functions/defineSkill.md)
* [defineTool](https://cognitio-agent.mintlify.site/api-reference/functions/defineTool.md)
* [isSdkError](https://cognitio-agent.mintlify.site/api-reference/functions/isSdkError.md)
* [query](https://cognitio-agent.mintlify.site/api-reference/functions/query.md)
* [shutdown](https://cognitio-agent.mintlify.site/api-reference/functions/shutdown.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.