Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Cognitio Agent SDK home page

GitHub
Contact

Overview

SDK reference

Classes

Class: Agent
Class: Session

Functions

Function: claudeCompat()
Function: createAgentClient()
Function: createSdkMcpServer()
Function: defineAgent()
Function: defineCommand()
Function: defineHook()
Function: defineOutputFormat()
Function: definePlugin()
Function: defineSkill()
Function: defineTool()
Function: isSdkError()
Function: query()
Function: shutdown()

Interfaces

Interface: AgentClient
Interface: AgentDefinition
Interface: AgentOptions
Interface: AgentSessionOptions
Interface: AgentStream
Interface: AgentStreamOptions
Interface: AppliedSettings
Interface: CheckpointHandle
Interface: CheckpointingConfig
Interface: ClaudePluginSpec
Interface: ClientOptions
Interface: CommandDefinition
Interface: CompactResult
Interface: ControlOptions
Interface: HookEntry<Event>
Interface: HookEventPayload<Event>
Interface: HookResult
Interface: InlinePluginSpec
Interface: LocalMcpServer
Interface: McpPromptDefinition
Interface: McpResourceDefinition
Interface: ModelUsageSummary
Interface: OutputFormatSpec<Output>
Interface: PostCompactHookData
Interface: PreCompactHookData
Interface: PromptTurn
Interface: QueryOptions
Interface: RateLimitEvent
Interface: RemoteMcpServer
Interface: ResultMessage
Interface: RunOptions
Interface: RunResult
Interface: RuntimeConfig
Interface: SdkError
Interface: SdkMcpServer
Interface: SessionContext
Interface: SessionCreateOptions
Interface: SessionListFilter
Interface: SessionNamespace
Interface: SessionResumeOptions
Interface: SessionUsage
Interface: SkillDefinition
Interface: SpawnOptions
Interface: StreamOptions
Interface: TaskNotificationEvent
Interface: TaskProgressEvent
Interface: TaskStartedEvent
Interface: TaskStoppedEvent
Interface: ToolContext
Interface: UsageSummary

Types

Type Alias: AgentMessage
Type Alias: AnthropicModelId
Type Alias: ApiAuth
Type Alias: Auth
Type Alias: AuthContent
Type Alias: CanUseToolCallback
Type Alias: CognitioConfig
Type Alias: CognitioEvent
Type Alias: CognitioMessage
Type Alias: CognitioPart
Type Alias: CognitioSession
Type Alias: DeepseekModelId
Type Alias: ExternalMcpServer
Type Alias: GoogleModelId
Type Alias: GroqModelId
Type Alias: HookCallback<Event>
Type Alias: HookData<Event>
Type Alias: HookEventName
Type Alias: HookRegistration
Type Alias: KnownModelId
Type Alias: MistralModelId
Type Alias: ModelId
Type Alias: OAuth
Type Alias: OpenaiModelId
Type Alias: OutputOf<Format>
Type Alias: PermissionDecision
Type Alias: PermissionMode
Type Alias: PermissionRuleset
Type Alias: PluginSpec
Type Alias: PromptInput
Type Alias: PromptPart
Type Alias: Query
Type Alias: RewindResult
Type Alias: RuntimeMcpServer
Type Alias: SdkErrorKind
Type Alias: SpawnServerRequest
Type Alias: SystemPromptSpec
Type Alias: ThinkingConfig
Type Alias: TodoItem
Type Alias: ToolDefinition<Input, Output>
Type Alias: TransportKind
Type Alias: WellKnownAuth
Type Alias: XaiModelId

Variables

Variable: NEUTRAL_BASE_PROMPT
Variable: PermissionDecision
Variable: models

Supporting

PermissionDecision
SdkMcpHost
ToolContext
ToolDefinitionBase

Types

Type Alias: PermissionRuleset

Generated from the public TypeScript API.

type PermissionRuleset = WirePermissionRuleset;

Ordered runtime permission rules containing permission, pattern and action fields.

Type Alias: PermissionMode

Type Alias: PluginSpec

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform