@mastra/client-js 0.0.0-error-handler-fix-20251020202607 → 0.0.0-esbuild-bundle-worker-20260807182016

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/CHANGELOG.md +9405 -3
  2. package/LICENSE.md +15 -0
  3. package/README.md +11 -13
  4. package/dist/_types/@ai-sdk_provider/dist/index.d.ts +1587 -0
  5. package/dist/_types/@ai-sdk_provider-utils/dist/index.d.ts +379 -0
  6. package/dist/_types/@ai-sdk_ui-utils/dist/index.d.ts +820 -0
  7. package/dist/agent-learning.d.ts +182 -0
  8. package/dist/agent-learning.d.ts.map +1 -0
  9. package/dist/client.d.ts +767 -80
  10. package/dist/client.d.ts.map +1 -1
  11. package/dist/docs/SKILL.md +52 -0
  12. package/dist/docs/assets/SOURCE_MAP.json +6 -0
  13. package/dist/docs/references/docs-agents-a2a.md +340 -0
  14. package/dist/docs/references/docs-editor-overview.md +349 -0
  15. package/dist/docs/references/docs-long-running-agents-schedules.md +201 -0
  16. package/dist/docs/references/docs-long-running-agents-signals.md +426 -0
  17. package/dist/docs/references/docs-server-auth-auth0.md +262 -0
  18. package/dist/docs/references/docs-server-auth-clerk.md +154 -0
  19. package/dist/docs/references/docs-server-auth-firebase.md +294 -0
  20. package/dist/docs/references/docs-server-auth-jwt.md +116 -0
  21. package/dist/docs/references/docs-server-auth-supabase.md +139 -0
  22. package/dist/docs/references/docs-server-auth-workos.md +271 -0
  23. package/dist/docs/references/docs-server-mastra-client.md +323 -0
  24. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-messages.md +97 -0
  25. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +282 -0
  26. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-v4-messages.md +81 -0
  27. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-v5-messages.md +78 -0
  28. package/dist/docs/references/reference-client-js-agents.md +959 -0
  29. package/dist/docs/references/reference-client-js-conversations.md +137 -0
  30. package/dist/docs/references/reference-client-js-error-handling.md +18 -0
  31. package/dist/docs/references/reference-client-js-logs.md +26 -0
  32. package/dist/docs/references/reference-client-js-mastra-client.md +96 -0
  33. package/dist/docs/references/reference-client-js-memory.md +237 -0
  34. package/dist/docs/references/reference-client-js-observability.md +183 -0
  35. package/dist/docs/references/reference-client-js-responses.md +219 -0
  36. package/dist/docs/references/reference-client-js-telemetry.md +22 -0
  37. package/dist/docs/references/reference-client-js-tools.md +46 -0
  38. package/dist/docs/references/reference-client-js-vectors.md +81 -0
  39. package/dist/docs/references/reference-client-js-workflows.md +393 -0
  40. package/dist/docs/references/reference-editor-versioning.md +130 -0
  41. package/dist/index.cjs +7638 -3257
  42. package/dist/index.cjs.map +1 -1
  43. package/dist/index.d.ts +9 -0
  44. package/dist/index.d.ts.map +1 -1
  45. package/dist/index.js +7606 -3252
  46. package/dist/index.js.map +1 -1
  47. package/dist/observability/collector.d.ts +45 -0
  48. package/dist/observability/collector.d.ts.map +1 -0
  49. package/dist/observability/index.d.ts +14 -0
  50. package/dist/observability/index.d.ts.map +1 -0
  51. package/dist/observability/types.d.ts +27 -0
  52. package/dist/observability/types.d.ts.map +1 -0
  53. package/dist/resources/a2a.d.ts +80 -11
  54. package/dist/resources/a2a.d.ts.map +1 -1
  55. package/dist/resources/agent-builder.d.ts +57 -72
  56. package/dist/resources/agent-builder.d.ts.map +1 -1
  57. package/dist/resources/agent-controller.d.ts +589 -0
  58. package/dist/resources/agent-controller.d.ts.map +1 -0
  59. package/dist/resources/agent.d.ts +368 -59
  60. package/dist/resources/agent.d.ts.map +1 -1
  61. package/dist/resources/base.d.ts +2 -1
  62. package/dist/resources/base.d.ts.map +1 -1
  63. package/dist/resources/channels.d.ts +63 -0
  64. package/dist/resources/channels.d.ts.map +1 -0
  65. package/dist/resources/conversations.d.ts +15 -0
  66. package/dist/resources/conversations.d.ts.map +1 -0
  67. package/dist/resources/index.d.ts +14 -0
  68. package/dist/resources/index.d.ts.map +1 -1
  69. package/dist/resources/mcp-tool.d.ts +5 -5
  70. package/dist/resources/mcp-tool.d.ts.map +1 -1
  71. package/dist/resources/memory-thread.d.ts +51 -16
  72. package/dist/resources/memory-thread.d.ts.map +1 -1
  73. package/dist/resources/observability.d.ts +222 -19
  74. package/dist/resources/observability.d.ts.map +1 -1
  75. package/dist/resources/processor-provider.d.ts +15 -0
  76. package/dist/resources/processor-provider.d.ts.map +1 -0
  77. package/dist/resources/processor.d.ts +20 -0
  78. package/dist/resources/processor.d.ts.map +1 -0
  79. package/dist/resources/responses.d.ts +22 -0
  80. package/dist/resources/responses.d.ts.map +1 -0
  81. package/dist/resources/run.d.ts +256 -0
  82. package/dist/resources/run.d.ts.map +1 -0
  83. package/dist/resources/stored-agent.d.ts +112 -0
  84. package/dist/resources/stored-agent.d.ts.map +1 -0
  85. package/dist/resources/stored-mcp-client.d.ts +30 -0
  86. package/dist/resources/stored-mcp-client.d.ts.map +1 -0
  87. package/dist/resources/stored-prompt-block.d.ts +83 -0
  88. package/dist/resources/stored-prompt-block.d.ts.map +1 -0
  89. package/dist/resources/stored-scorer.d.ts +83 -0
  90. package/dist/resources/stored-scorer.d.ts.map +1 -0
  91. package/dist/resources/stored-skill.d.ts +40 -0
  92. package/dist/resources/stored-skill.d.ts.map +1 -0
  93. package/dist/resources/stored-workflow.d.ts +18 -0
  94. package/dist/resources/stored-workflow.d.ts.map +1 -0
  95. package/dist/resources/tool-provider.d.ts +80 -0
  96. package/dist/resources/tool-provider.d.ts.map +1 -0
  97. package/dist/resources/tool.d.ts +4 -4
  98. package/dist/resources/vector.d.ts +9 -9
  99. package/dist/resources/vector.d.ts.map +1 -1
  100. package/dist/resources/workflow.d.ts +32 -231
  101. package/dist/resources/workflow.d.ts.map +1 -1
  102. package/dist/resources/workspace.d.ts +129 -0
  103. package/dist/resources/workspace.d.ts.map +1 -0
  104. package/dist/route-types.generated.d.ts +18087 -0
  105. package/dist/route-types.generated.d.ts.map +1 -0
  106. package/dist/tools.d.ts +3 -6
  107. package/dist/tools.d.ts.map +1 -1
  108. package/dist/types.d.ts +2740 -197
  109. package/dist/types.d.ts.map +1 -1
  110. package/dist/utils/client-tool-model-output.d.ts +16 -0
  111. package/dist/utils/client-tool-model-output.d.ts.map +1 -0
  112. package/dist/utils/index.d.ts +65 -4
  113. package/dist/utils/index.d.ts.map +1 -1
  114. package/dist/utils/process-a2a-stream.d.ts +4 -0
  115. package/dist/utils/process-a2a-stream.d.ts.map +1 -0
  116. package/dist/utils/process-client-tools.d.ts.map +1 -1
  117. package/dist/utils/process-mastra-stream.d.ts +8 -7
  118. package/dist/utils/process-mastra-stream.d.ts.map +1 -1
  119. package/dist/utils/stream-transforms.d.ts +9 -0
  120. package/dist/utils/stream-transforms.d.ts.map +1 -0
  121. package/dist/utils/verify-agent-card-signature.d.ts +21 -0
  122. package/dist/utils/verify-agent-card-signature.d.ts.map +1 -0
  123. package/dist/utils/zod-to-json-schema.d.ts +11 -2
  124. package/dist/utils/zod-to-json-schema.d.ts.map +1 -1
  125. package/package.json +26 -19
  126. package/dist/resources/network-memory-thread.d.ts +0 -47
  127. package/dist/resources/network-memory-thread.d.ts.map +0 -1
package/dist/client.d.ts CHANGED
@@ -1,121 +1,158 @@
1
- import type { AITraceRecord, AITracesPaginatedArg, WorkflowInfo } from '@mastra/core';
1
+ import type { ListScoresResponse, Trajectory } from '@mastra/core/evals';
2
2
  import type { ServerDetailInfo } from '@mastra/core/mcp';
3
- import type { RuntimeContext } from '@mastra/core/runtime-context';
4
- import { Agent, MemoryThread, Tool, Workflow, Vector, BaseResource, A2A, MCPTool, AgentBuilder } from './resources/index.js';
5
- import { NetworkMemoryThread } from './resources/network-memory-thread.js';
6
- import type { ClientOptions, CreateMemoryThreadParams, CreateMemoryThreadResponse, GetAgentResponse, GetLogParams, GetLogsParams, GetLogsResponse, GetMemoryThreadParams, GetMemoryThreadResponse, GetTelemetryParams, GetTelemetryResponse, GetToolResponse, GetWorkflowResponse, SaveMessageToMemoryParams, SaveMessageToMemoryResponse, McpServerListResponse, McpServerToolListResponse, GetNetworkMemoryThreadParams, CreateNetworkMemoryThreadParams, SaveNetworkMessageToMemoryParams, GetScorerResponse, GetScoresByScorerIdParams, GetScoresResponse, GetScoresByRunIdParams, GetScoresByEntityIdParams, GetScoresBySpanParams, SaveScoreParams, SaveScoreResponse, GetAITracesResponse, GetMemoryConfigParams, GetMemoryConfigResponse, GetMemoryThreadMessagesResponse } from './types.js';
3
+ import type { RequestContext } from '@mastra/core/request-context';
4
+ import type { PaginationInfo, TraceRecord, GetTraceLightResponse, GetSpanResponse, ListTracesArgs, ListTracesResponse, ListTracesLightResponse, ListBranchesArgs, ListBranchesResponse, GetBranchArgs, GetBranchResponse, ListLogsArgs, ListLogsResponse, ListScoresArgs, ListScoresResponse as ListScoresResponseNew, CreateScoreBody, CreateScoreResponse, GetScoreAggregateArgs, GetScoreAggregateResponse, GetScoreBreakdownArgs, GetScoreBreakdownResponse, GetScoreTimeSeriesArgs, GetScoreTimeSeriesResponse, GetScorePercentilesArgs, GetScorePercentilesResponse, ListFeedbackArgs, ListFeedbackResponse, CreateFeedbackBody, CreateFeedbackResponse, GetFeedbackAggregateArgs, GetFeedbackAggregateResponse, GetFeedbackBreakdownArgs, GetFeedbackBreakdownResponse, GetFeedbackTimeSeriesArgs, GetFeedbackTimeSeriesResponse, GetFeedbackPercentilesArgs, GetFeedbackPercentilesResponse, GetMetricAggregateArgs, GetMetricAggregateResponse, GetMetricBreakdownArgs, GetMetricBreakdownResponse, GetMetricTimeSeriesArgs, GetMetricTimeSeriesResponse, GetMetricPercentilesArgs, GetMetricPercentilesResponse, GetMetricNamesArgs, GetMetricNamesResponse, GetMetricLabelKeysArgs, GetMetricLabelKeysResponse, GetMetricLabelValuesArgs, GetMetricLabelValuesResponse, GetEntityTypesResponse, GetEntityNamesArgs, GetEntityNamesResponse, GetServiceNamesResponse, GetEnvironmentsResponse, GetTagsArgs, GetTagsResponse } from '@mastra/core/storage';
5
+ import type { WorkflowInfo } from '@mastra/core/workflows';
6
+ import { Agent, MemoryThread, Tool, Processor, Workflow, Vector, BaseResource, A2A, A2AV1, MCPTool, AgentBuilder, Conversations, StoredAgent, StoredWorkflow, StoredPromptBlock, StoredMCPClient, StoredScorer, StoredSkill, ToolProvider, ProcessorProvider, Workspace, Responses, Channels, AgentController } from './resources/index.js';
7
+ import type { ListScoresBySpanParams, LegacyTracesPaginatedArg, LegacyGetTracesResponse } from './resources/observability.js';
8
+ import type { ClientOptions, CreateMemoryThreadParams, CreateMemoryThreadResponse, GetAgentResponse, AgentVersionIdentifier, GetLogParams, GetLogsParams, GetLogsResponse, GetToolResponse, GetProcessorResponse, GetWorkflowResponse, SaveMessageToMemoryParams, SaveMessageToMemoryResponse, McpServerListResponse, McpServerToolListResponse, GetScorerResponse, ListScoresByScorerIdParams, ListScoresByRunIdParams, ListScoresByEntityIdParams, SaveScoreParams, SaveScoreResponse, GetMemoryConfigParams, GetMemoryConfigResponse, ListMemoryThreadMessagesResponse, MemorySearchResponse, ListAgentsModelProvidersResponse, ListMemoryThreadsParams, ListMemoryThreadsResponse, ListStoredAgentsParams, ListStoredAgentsResponse, CreateStoredAgentParams, StoredAgentResponse, ListStoredWorkflowsParams, ListStoredWorkflowsResponse, UpsertStoredWorkflowParams, UpsertStoredWorkflowResponse, ListStoredPromptBlocksParams, ListStoredPromptBlocksResponse, CreateStoredPromptBlockParams, StoredPromptBlockResponse, ListStoredScorersParams, ListStoredScorersResponse, CreateStoredScorerParams, StoredScorerResponse, ListStoredMCPClientsParams, ListStoredMCPClientsResponse, CreateStoredMCPClientParams, StoredMCPClientResponse, ListStoredSkillsParams, ListStoredSkillsResponse, CreateStoredSkillParams, StoredSkillResponse, GetSystemPackagesResponse, BuilderSettingsResponse, BuilderAvailableModelsResponse, PermissionPatternsResponse, InfrastructureStatusResponse, ListBuilderRegistriesResponse, BuilderRegistrySearchResponse, BuilderRegistryPopularResponse, BuilderRegistryPreviewResponse, BuilderRegistryInstallBody, BuilderRegistryInstallResponse, ListScoresResponse as ListScoresResponseOld, GetObservationalMemoryParams, GetObservationalMemoryResponse, AwaitBufferStatusParams, AwaitBufferStatusResponse, GetMemoryStatusResponse, ListWorkspacesResponse, ListStoredWorkspacesParams, ListStoredWorkspacesResponse, StoredWorkspaceResponse, ListVectorsResponse, ListEmbeddersResponse, DatasetRecord, DatasetItem, DatasetExperiment, DatasetExperimentResult, ListExperimentsParams, ExperimentReviewCounts, CreateDatasetParams, UpdateDatasetParams, AddDatasetItemParams, UpdateDatasetItemParams, BatchInsertDatasetItemsParams, BatchDeleteDatasetItemsParams, GenerateDatasetItemsParams, GeneratedItem, TriggerDatasetExperimentParams, UpdateExperimentResultParams, CompareExperimentsParams, CompareExperimentsResponse, DatasetItemVersionResponse, DatasetVersionResponse, ListToolProvidersResponse, GetProcessorProvidersResponse, ListBackgroundTasksParams, ListBackgroundTasksResponse, BackgroundTaskResponse, StreamBackgroundTasksParams, ListSchedulesParams, ListSchedulesResponse, ScheduleResponse, ListScheduleTriggersParams, ListScheduleTriggersResponse, CreateScheduleInput, UpdateScheduleInput, RunScheduleResponse } from './types.js';
7
9
  export declare class MastraClient extends BaseResource {
8
10
  private observability;
11
+ readonly conversations: Conversations;
12
+ readonly responses: Responses;
13
+ readonly channels: Channels;
9
14
  constructor(options: ClientOptions);
10
15
  /**
11
16
  * Retrieves all available agents
12
- * @param runtimeContext - Optional runtime context to pass as query parameter
17
+ * @param requestContext - Optional request context to pass as query parameter
13
18
  * @returns Promise containing map of agent IDs to agent details
14
19
  */
15
- getAgents(runtimeContext?: RuntimeContext | Record<string, any>): Promise<Record<string, GetAgentResponse>>;
20
+ listAgents(requestContext?: RequestContext | Record<string, any>, partial?: boolean): Promise<Record<string, GetAgentResponse>>;
21
+ listAgentsModelProviders(): Promise<ListAgentsModelProvidersResponse>;
16
22
  /**
17
23
  * Gets an agent instance by ID
18
24
  * @param agentId - ID of the agent to retrieve
25
+ * @param version - Optional version selector for stored agent overrides
19
26
  * @returns Agent instance
20
27
  */
21
- getAgent(agentId: string): Agent;
28
+ getAgent(agentId: string, version?: AgentVersionIdentifier): Agent;
22
29
  /**
23
- * Retrieves memory threads for a resource
24
- * @param params - Parameters containing the resource ID
25
- * @returns Promise containing array of memory threads
30
+ * Lists the agent controllers hosted on the connected Mastra instance.
31
+ * @returns Promise containing an array of agent controller identifiers
26
32
  */
27
- getMemoryThreads(params: GetMemoryThreadParams): Promise<GetMemoryThreadResponse>;
33
+ listAgentControllers(): Promise<{
34
+ id: string;
35
+ }[]>;
36
+ /**
37
+ * Scopes to an agent controller hosted on the connected Mastra instance. Use
38
+ * `getAgentController(id).session(resourceId)` to create/resume a session,
39
+ * stream its events, and send messages.
40
+ * @param controllerId - The id the agent controller is registered under on Mastra
41
+ */
42
+ getAgentController(controllerId: string): AgentController;
43
+ /**
44
+ * Lists memory threads with optional filtering by resourceId and/or metadata
45
+ * @param params - Parameters containing optional filters, pagination options, and request context
46
+ * @returns Promise containing paginated array of memory threads with metadata
47
+ */
48
+ listMemoryThreads(params?: ListMemoryThreadsParams): Promise<ListMemoryThreadsResponse>;
28
49
  /**
29
50
  * Retrieves memory config for a resource
30
- * @param params - Parameters containing the resource ID
31
- * @returns Promise containing array of memory threads
51
+ * @param params - Parameters containing the resource ID and optional request context
52
+ * @returns Promise containing memory configuration
32
53
  */
33
54
  getMemoryConfig(params: GetMemoryConfigParams): Promise<GetMemoryConfigResponse>;
34
55
  /**
35
56
  * Creates a new memory thread
36
- * @param params - Parameters for creating the memory thread
57
+ * @param params - Parameters for creating the memory thread including optional request context
37
58
  * @returns Promise containing the created memory thread
38
59
  */
39
60
  createMemoryThread(params: CreateMemoryThreadParams): Promise<CreateMemoryThreadResponse>;
40
61
  /**
41
62
  * Gets a memory thread instance by ID
42
63
  * @param threadId - ID of the memory thread to retrieve
64
+ * @param agentId - Optional agent ID. When not provided, uses storage directly
43
65
  * @returns MemoryThread instance
44
66
  */
45
- getMemoryThread(threadId: string, agentId: string): MemoryThread;
46
- getThreadMessages(threadId: string, opts?: {
67
+ getMemoryThread({ threadId, agentId }: {
68
+ threadId: string;
47
69
  agentId?: string;
48
- networkId?: string;
49
- }): Promise<GetMemoryThreadMessagesResponse>;
50
- deleteThread(threadId: string, opts?: {
70
+ }): MemoryThread;
71
+ /**
72
+ * Lists messages for a thread.
73
+ * @param threadId - ID of the thread
74
+ * @param opts - Optional parameters including agentId, networkId, and requestContext
75
+ * - When agentId is provided, uses the agent's memory
76
+ * - When networkId is provided, uses the network endpoint
77
+ * - When neither is provided, uses storage directly
78
+ * @returns Promise containing the thread messages
79
+ */
80
+ listThreadMessages(threadId: string, opts?: {
51
81
  agentId?: string;
52
82
  networkId?: string;
83
+ requestContext?: RequestContext | Record<string, any>;
84
+ includeSystemReminders?: boolean;
85
+ }): Promise<ListMemoryThreadMessagesResponse>;
86
+ deleteThread(threadId: string, opts: {
87
+ agentId: string;
88
+ networkId?: never;
89
+ requestContext?: RequestContext | Record<string, any>;
90
+ } | {
91
+ networkId: string;
92
+ agentId?: never;
93
+ requestContext?: RequestContext | Record<string, any>;
53
94
  }): Promise<{
54
95
  success: boolean;
55
96
  message: string;
56
97
  }>;
57
98
  /**
58
99
  * Saves messages to memory
59
- * @param params - Parameters containing messages to save
100
+ * @param params - Parameters containing messages to save and optional request context
60
101
  * @returns Promise containing the saved messages
61
102
  */
62
103
  saveMessageToMemory(params: SaveMessageToMemoryParams): Promise<SaveMessageToMemoryResponse>;
63
104
  /**
64
105
  * Gets the status of the memory system
65
- * @returns Promise containing memory system status
66
- */
67
- getMemoryStatus(agentId: string): Promise<{
68
- result: boolean;
69
- }>;
70
- /**
71
- * Retrieves memory threads for a resource
72
- * @param params - Parameters containing the resource ID
73
- * @returns Promise containing array of memory threads
74
- */
75
- getNetworkMemoryThreads(params: GetNetworkMemoryThreadParams): Promise<GetMemoryThreadResponse>;
76
- /**
77
- * Creates a new memory thread
78
- * @param params - Parameters for creating the memory thread
79
- * @returns Promise containing the created memory thread
80
- */
81
- createNetworkMemoryThread(params: CreateNetworkMemoryThreadParams): Promise<CreateMemoryThreadResponse>;
82
- /**
83
- * Gets a memory thread instance by ID
84
- * @param threadId - ID of the memory thread to retrieve
85
- * @returns MemoryThread instance
106
+ * @param agentId - The agent ID
107
+ * @param opts - Optional parameters including resourceId, threadId, and requestContext
108
+ * @returns Promise containing memory system status including observational memory info
86
109
  */
87
- getNetworkMemoryThread(threadId: string, networkId: string): NetworkMemoryThread;
110
+ getMemoryStatus(agentId: string, requestContext?: RequestContext | Record<string, any>, opts?: {
111
+ resourceId?: string;
112
+ threadId?: string;
113
+ }): Promise<GetMemoryStatusResponse>;
88
114
  /**
89
- * Saves messages to memory
90
- * @param params - Parameters containing messages to save
91
- * @returns Promise containing the saved messages
115
+ * Gets observational memory data for a resource or thread
116
+ * @param params - Parameters containing agentId, resourceId, threadId, and optional request context
117
+ * @returns Promise containing the current OM record and history
92
118
  */
93
- saveNetworkMessageToMemory(params: SaveNetworkMessageToMemoryParams): Promise<SaveMessageToMemoryResponse>;
119
+ getObservationalMemory(params: GetObservationalMemoryParams): Promise<GetObservationalMemoryResponse>;
94
120
  /**
95
- * Gets the status of the memory system
96
- * @returns Promise containing memory system status
121
+ * Blocks until any in-flight observational memory buffering completes, then returns the updated record
122
+ * @param params - Parameters containing agentId, resourceId, threadId
123
+ * @returns Promise containing the updated OM record after buffering completes
97
124
  */
98
- getNetworkMemoryStatus(networkId: string): Promise<{
99
- result: boolean;
100
- }>;
125
+ awaitBufferStatus(params: AwaitBufferStatusParams): Promise<AwaitBufferStatusResponse>;
101
126
  /**
102
127
  * Retrieves all available tools
103
- * @param runtimeContext - Optional runtime context to pass as query parameter
128
+ * @param requestContext - Optional request context to pass as query parameter
104
129
  * @returns Promise containing map of tool IDs to tool details
105
130
  */
106
- getTools(runtimeContext?: RuntimeContext | Record<string, any>): Promise<Record<string, GetToolResponse>>;
131
+ listTools(requestContext?: RequestContext | Record<string, any>): Promise<Record<string, GetToolResponse>>;
107
132
  /**
108
133
  * Gets a tool instance by ID
109
134
  * @param toolId - ID of the tool to retrieve
110
135
  * @returns Tool instance
111
136
  */
112
137
  getTool(toolId: string): Tool;
138
+ /**
139
+ * Retrieves all available processors
140
+ * @param requestContext - Optional request context to pass as query parameter
141
+ * @returns Promise containing map of processor IDs to processor details
142
+ */
143
+ listProcessors(requestContext?: RequestContext | Record<string, any>): Promise<Record<string, GetProcessorResponse>>;
144
+ /**
145
+ * Gets a processor instance by ID
146
+ * @param processorId - ID of the processor to retrieve
147
+ * @returns Processor instance
148
+ */
149
+ getProcessor(processorId: string): Processor;
113
150
  /**
114
151
  * Retrieves all available workflows
115
- * @param runtimeContext - Optional runtime context to pass as query parameter
152
+ * @param requestContext - Optional request context to pass as query parameter
116
153
  * @returns Promise containing map of workflow IDs to workflow details
117
154
  */
118
- getWorkflows(runtimeContext?: RuntimeContext | Record<string, any>): Promise<Record<string, GetWorkflowResponse>>;
155
+ listWorkflows(requestContext?: RequestContext | Record<string, any>, partial?: boolean): Promise<Record<string, GetWorkflowResponse>>;
119
156
  /**
120
157
  * Gets a workflow instance by ID
121
158
  * @param workflowId - ID of the workflow to retrieve
@@ -143,7 +180,7 @@ export declare class MastraClient extends BaseResource {
143
180
  * @param params - Parameters for filtering logs
144
181
  * @returns Promise containing array of log messages
145
182
  */
146
- getLogs(params: GetLogsParams): Promise<GetLogsResponse>;
183
+ listLogs(params: GetLogsParams): Promise<GetLogsResponse>;
147
184
  /**
148
185
  * Gets logs for a specific run
149
186
  * @param params - Parameters containing run ID to retrieve
@@ -154,23 +191,21 @@ export declare class MastraClient extends BaseResource {
154
191
  * List of all log transports
155
192
  * @returns Promise containing list of log transports
156
193
  */
157
- getLogTransports(): Promise<{
194
+ listLogTransports(): Promise<{
158
195
  transports: string[];
159
196
  }>;
160
- /**
161
- * List of all traces (paged)
162
- * @param params - Parameters for filtering traces
163
- * @returns Promise containing telemetry data
164
- */
165
- getTelemetry(params?: GetTelemetryParams): Promise<GetTelemetryResponse>;
166
197
  /**
167
198
  * Retrieves a list of available MCP servers.
168
- * @param params - Optional parameters for pagination (limit, offset).
199
+ * @param params - Optional parameters for pagination (page, perPage, or deprecated offset, limit).
169
200
  * @returns Promise containing the list of MCP servers and pagination info.
170
201
  */
171
202
  getMcpServers(params?: {
172
- limit?: number;
203
+ page?: number;
204
+ perPage?: number;
205
+ /** @deprecated Use page instead */
173
206
  offset?: number;
207
+ /** @deprecated Use perPage instead */
208
+ limit?: number;
174
209
  }): Promise<McpServerListResponse>;
175
210
  /**
176
211
  * Retrieves detailed information for a specific MCP server.
@@ -195,12 +230,45 @@ export declare class MastraClient extends BaseResource {
195
230
  * @returns MCPTool instance.
196
231
  */
197
232
  getMcpServerTool(serverId: string, toolId: string): MCPTool;
233
+ /**
234
+ * Lists resources available on an MCP server.
235
+ * @param serverId - The ID of the MCP server.
236
+ * @returns Promise containing the list of resources.
237
+ */
238
+ getMcpServerResources(serverId: string): Promise<{
239
+ resources: Array<{
240
+ uri: string;
241
+ name: string;
242
+ description?: string;
243
+ mimeType?: string;
244
+ _meta?: Record<string, unknown>;
245
+ }>;
246
+ }>;
247
+ /**
248
+ * Reads the content of a resource from an MCP server.
249
+ * Used for fetching ui:// MCP App HTML content.
250
+ * @param serverId - The ID of the MCP server.
251
+ * @param uri - The resource URI to read.
252
+ * @returns Promise containing the resource content.
253
+ */
254
+ readMcpServerResource(serverId: string, uri: string): Promise<{
255
+ contents: Array<{
256
+ uri: string;
257
+ text?: string;
258
+ blob?: string;
259
+ }>;
260
+ }>;
198
261
  /**
199
262
  * Gets an A2A client for interacting with an agent via the A2A protocol
200
263
  * @param agentId - ID of the agent to interact with
201
264
  * @returns A2A client instance
202
265
  */
203
266
  getA2A(agentId: string): A2A;
267
+ /**
268
+ * Gets an A2A Protocol v1.0 client for an agent.
269
+ * @param agentId - ID of the agent to interact with
270
+ */
271
+ getA2AV1(agentId: string): A2AV1;
204
272
  /**
205
273
  * Retrieves the working memory for a specific thread (optionally resource-scoped).
206
274
  * @param agentId - ID of the agent.
@@ -208,11 +276,20 @@ export declare class MastraClient extends BaseResource {
208
276
  * @param resourceId - Optional ID of the resource.
209
277
  * @returns Working memory for the specified thread or resource.
210
278
  */
211
- getWorkingMemory({ agentId, threadId, resourceId, }: {
279
+ getWorkingMemory({ agentId, threadId, resourceId, requestContext, }: {
212
280
  agentId: string;
213
281
  threadId: string;
214
282
  resourceId?: string;
283
+ requestContext?: RequestContext | Record<string, any>;
215
284
  }): Promise<unknown>;
285
+ searchMemory({ agentId, resourceId, threadId, searchQuery, memoryConfig, requestContext, }: {
286
+ agentId: string;
287
+ resourceId: string;
288
+ threadId?: string;
289
+ searchQuery: string;
290
+ memoryConfig?: any;
291
+ requestContext?: RequestContext | Record<string, any>;
292
+ }): Promise<MemorySearchResponse>;
216
293
  /**
217
294
  * Updates the working memory for a specific thread (optionally resource-scoped).
218
295
  * @param agentId - ID of the agent.
@@ -220,50 +297,92 @@ export declare class MastraClient extends BaseResource {
220
297
  * @param workingMemory - The new working memory content.
221
298
  * @param resourceId - Optional ID of the resource.
222
299
  */
223
- updateWorkingMemory({ agentId, threadId, workingMemory, resourceId, }: {
300
+ updateWorkingMemory({ agentId, threadId, workingMemory, resourceId, requestContext, }: {
224
301
  agentId: string;
225
302
  threadId: string;
226
303
  workingMemory: string;
227
304
  resourceId?: string;
305
+ requestContext?: RequestContext | Record<string, any>;
228
306
  }): Promise<unknown>;
229
307
  /**
230
308
  * Retrieves all available scorers
309
+ * @param requestContext - Optional request context to pass as query parameter
231
310
  * @returns Promise containing list of available scorers
232
311
  */
233
- getScorers(): Promise<Record<string, GetScorerResponse>>;
312
+ listScorers(requestContext?: RequestContext | Record<string, any>): Promise<Record<string, GetScorerResponse>>;
234
313
  /**
235
314
  * Retrieves a scorer by ID
236
315
  * @param scorerId - ID of the scorer to retrieve
237
316
  * @returns Promise containing the scorer
238
317
  */
239
318
  getScorer(scorerId: string): Promise<GetScorerResponse>;
240
- getScoresByScorerId(params: GetScoresByScorerIdParams): Promise<GetScoresResponse>;
319
+ listScoresByScorerId(params: ListScoresByScorerIdParams): Promise<ListScoresResponseOld>;
241
320
  /**
242
321
  * Retrieves scores by run ID
243
322
  * @param params - Parameters containing run ID and pagination options
244
323
  * @returns Promise containing scores and pagination info
245
324
  */
246
- getScoresByRunId(params: GetScoresByRunIdParams): Promise<GetScoresResponse>;
325
+ listScoresByRunId(params: ListScoresByRunIdParams): Promise<ListScoresResponseOld>;
247
326
  /**
248
327
  * Retrieves scores by entity ID and type
249
328
  * @param params - Parameters containing entity ID, type, and pagination options
250
329
  * @returns Promise containing scores and pagination info
251
330
  */
252
- getScoresByEntityId(params: GetScoresByEntityIdParams): Promise<GetScoresResponse>;
331
+ listScoresByEntityId(params: ListScoresByEntityIdParams): Promise<ListScoresResponseOld>;
253
332
  /**
254
333
  * Saves a score
255
334
  * @param params - Parameters containing the score data to save
256
335
  * @returns Promise containing the saved score
257
336
  */
258
337
  saveScore(params: SaveScoreParams): Promise<SaveScoreResponse>;
259
- /**
260
- * Retrieves model providers with available keys
261
- * @returns Promise containing model providers with available keys
262
- */
263
- getModelProviders(): Promise<string[]>;
264
- getAITrace(traceId: string): Promise<AITraceRecord>;
265
- getAITraces(params: AITracesPaginatedArg): Promise<GetAITracesResponse>;
266
- getScoresBySpan(params: GetScoresBySpanParams): Promise<GetScoresResponse>;
338
+ /** Retrieves a specific trace by ID. */
339
+ getTrace(traceId: string): Promise<TraceRecord>;
340
+ /** Retrieves a lightweight trace by ID (timeline fields only, excludes heavy fields). */
341
+ getTraceLight(traceId: string): Promise<GetTraceLightResponse>;
342
+ /** Retrieves a single span with full details by trace ID and span ID. */
343
+ getSpan(traceId: string, spanId: string): Promise<GetSpanResponse>;
344
+ /** Extracts a structured trajectory from a trace's spans. */
345
+ getTraceTrajectory(traceId: string): Promise<Trajectory>;
346
+ /**
347
+ * Retrieves paginated list of traces with optional filtering.
348
+ * This is the legacy API preserved for backward compatibility.
349
+ *
350
+ * @param params - Parameters for pagination and filtering (legacy format)
351
+ * @returns Promise containing paginated traces and pagination info
352
+ * @deprecated Use {@link listTraces} instead for new features like ordering and more filters.
353
+ */
354
+ getTraces(params: LegacyTracesPaginatedArg): Promise<LegacyGetTracesResponse>;
355
+ /**
356
+ * Retrieves paginated list of traces with optional filtering and sorting.
357
+ * This is the new API with improved filtering options.
358
+ *
359
+ * @param params - Parameters for pagination, filtering, and ordering
360
+ * @returns Promise containing paginated traces and pagination info
361
+ */
362
+ listTraces(params?: ListTracesArgs): Promise<ListTracesResponse>;
363
+ /**
364
+ * Retrieves paginated list of traces carrying only the fields a trace list renders.
365
+ * Same contract as {@link listTraces}, but rows omit the `attributes`/`input`/`output`
366
+ * blobs and carry a short `inputPreview` instead.
367
+ *
368
+ * @param params - Parameters for pagination, filtering, and ordering
369
+ * @returns Promise containing paginated lightweight traces and pagination info
370
+ */
371
+ listTracesLight(params?: ListTracesArgs): Promise<ListTracesLightResponse>;
372
+ /**
373
+ * Retrieves a paginated list of trace branches with optional filtering and sorting.
374
+ * Each row is a branch-anchor span (AGENT_RUN, WORKFLOW_RUN, TOOL_CALL, etc.) including
375
+ * ones nested under a different root entity. Pairs with {@link getBranch} to expand
376
+ * a single branch into its subtree.
377
+ */
378
+ listBranches(params?: ListBranchesArgs): Promise<ListBranchesResponse>;
379
+ /**
380
+ * Retrieves the subtree of spans rooted at a given span. The optional `depth` field
381
+ * bounds descendant levels below the anchor (0 = anchor only; omitted = full subtree).
382
+ */
383
+ getBranch(params: GetBranchArgs): Promise<GetBranchResponse>;
384
+ listScoresBySpan(params: ListScoresBySpanParams): Promise<ListScoresResponse>;
385
+ /** Scores one or more traces using a specified scorer (fire-and-forget). */
267
386
  score(params: {
268
387
  scorerName: string;
269
388
  targets: Array<{
@@ -274,5 +393,573 @@ export declare class MastraClient extends BaseResource {
274
393
  status: string;
275
394
  message: string;
276
395
  }>;
396
+ /** Retrieves a paginated list of observability logs. */
397
+ listLogsVNext(params?: ListLogsArgs): Promise<ListLogsResponse>;
398
+ /** Retrieves a paginated list of observability scores. */
399
+ listScores(params?: ListScoresArgs): Promise<ListScoresResponseNew>;
400
+ /** Creates a single score record in the observability store. */
401
+ createScore(params: CreateScoreBody): Promise<CreateScoreResponse>;
402
+ /** Returns an aggregated score value with optional period-over-period comparison. */
403
+ getScoreAggregate(params: GetScoreAggregateArgs): Promise<GetScoreAggregateResponse>;
404
+ /** Returns score values grouped by specified dimensions. */
405
+ getScoreBreakdown(params: GetScoreBreakdownArgs): Promise<GetScoreBreakdownResponse>;
406
+ /** Returns score values bucketed by time interval with optional grouping. */
407
+ getScoreTimeSeries(params: GetScoreTimeSeriesArgs): Promise<GetScoreTimeSeriesResponse>;
408
+ /** Returns percentile values for scores bucketed by time interval. */
409
+ getScorePercentiles(params: GetScorePercentilesArgs): Promise<GetScorePercentilesResponse>;
410
+ /** Retrieves a paginated list of feedback records. */
411
+ listFeedback(params?: ListFeedbackArgs): Promise<ListFeedbackResponse>;
412
+ /** Creates a single feedback record in the observability store. */
413
+ createFeedback(params: CreateFeedbackBody): Promise<CreateFeedbackResponse>;
414
+ /** Returns an aggregated feedback value with optional period-over-period comparison. */
415
+ getFeedbackAggregate(params: GetFeedbackAggregateArgs): Promise<GetFeedbackAggregateResponse>;
416
+ /** Returns feedback values grouped by specified dimensions. */
417
+ getFeedbackBreakdown(params: GetFeedbackBreakdownArgs): Promise<GetFeedbackBreakdownResponse>;
418
+ /** Returns feedback values bucketed by time interval with optional grouping. */
419
+ getFeedbackTimeSeries(params: GetFeedbackTimeSeriesArgs): Promise<GetFeedbackTimeSeriesResponse>;
420
+ /** Returns percentile values for feedback bucketed by time interval. */
421
+ getFeedbackPercentiles(params: GetFeedbackPercentilesArgs): Promise<GetFeedbackPercentilesResponse>;
422
+ /** Returns an aggregated metric value with optional period-over-period comparison. */
423
+ getMetricAggregate(params: GetMetricAggregateArgs): Promise<GetMetricAggregateResponse>;
424
+ /** Returns metric values grouped by specified dimensions. */
425
+ getMetricBreakdown(params: GetMetricBreakdownArgs): Promise<GetMetricBreakdownResponse>;
426
+ /** Returns metric values bucketed by time interval with optional grouping. */
427
+ getMetricTimeSeries(params: GetMetricTimeSeriesArgs): Promise<GetMetricTimeSeriesResponse>;
428
+ /** Returns percentile values for a metric bucketed by time interval. */
429
+ getMetricPercentiles(params: GetMetricPercentilesArgs): Promise<GetMetricPercentilesResponse>;
430
+ /** Returns distinct metric names with optional prefix filtering. */
431
+ getMetricNames(params?: GetMetricNamesArgs): Promise<GetMetricNamesResponse>;
432
+ /** Returns distinct label keys for a given metric. */
433
+ getMetricLabelKeys(params: GetMetricLabelKeysArgs): Promise<GetMetricLabelKeysResponse>;
434
+ /** Returns distinct values for a given metric label key. */
435
+ getMetricLabelValues(params: GetMetricLabelValuesArgs): Promise<GetMetricLabelValuesResponse>;
436
+ /** Returns distinct entity types from observability data. */
437
+ getEntityTypes(): Promise<GetEntityTypesResponse>;
438
+ /** Returns distinct entity names with optional type filtering. */
439
+ getEntityNames(params?: GetEntityNamesArgs): Promise<GetEntityNamesResponse>;
440
+ /** Returns distinct service names from observability data. */
441
+ getServiceNames(): Promise<GetServiceNamesResponse>;
442
+ /** Returns distinct environments from observability data. */
443
+ getEnvironments(): Promise<GetEnvironmentsResponse>;
444
+ /** Returns distinct tags with optional entity type filtering. */
445
+ getTags(params?: GetTagsArgs): Promise<GetTagsResponse>;
446
+ /**
447
+ * Lists all stored agents with optional pagination
448
+ * @param params - Optional pagination and ordering parameters
449
+ * @returns Promise containing paginated list of stored agents
450
+ */
451
+ listStoredAgents(params?: ListStoredAgentsParams): Promise<ListStoredAgentsResponse>;
452
+ /**
453
+ * Creates a new stored agent
454
+ * @param params - Agent configuration including id, name, instructions, model, etc.
455
+ * @returns Promise containing the created stored agent
456
+ */
457
+ createStoredAgent(params: CreateStoredAgentParams): Promise<StoredAgentResponse>;
458
+ /**
459
+ * Gets a stored agent instance by ID for further operations (details, update, delete)
460
+ * @param storedAgentId - ID of the stored agent to retrieve
461
+ * @returns StoredAgent instance
462
+ */
463
+ getStoredAgent(storedAgentId: string): StoredAgent;
464
+ /**
465
+ * Lists stored workflow definitions, optionally filtered by status or author
466
+ * @param params - Optional filters: `status` ('active' | 'archived') and `authorId`
467
+ * @returns Promise containing the matching definitions and a total count
468
+ */
469
+ listStoredWorkflows(params?: ListStoredWorkflowsParams): Promise<ListStoredWorkflowsResponse>;
470
+ /**
471
+ * Creates or replaces a stored workflow definition and live-registers it on the server.
472
+ * Optional `dependencies` lets helper workflows referenced by the root definition be
473
+ * saved in the same request; their ids are echoed back as `dependencyIds`.
474
+ * @param params - The workflow definition (id, schemas, graph) plus optional helper dependencies
475
+ * @returns Promise containing the persisted definition and any dependency ids
476
+ */
477
+ upsertStoredWorkflow(params: UpsertStoredWorkflowParams): Promise<UpsertStoredWorkflowResponse>;
478
+ /**
479
+ * Gets a stored workflow instance by ID for further operations (details, delete).
480
+ * To execute a stored workflow, use `getWorkflow(id).createRun()` like any other workflow.
481
+ * @param storedWorkflowId - ID of the stored workflow definition
482
+ * @returns StoredWorkflow instance
483
+ */
484
+ getStoredWorkflow(storedWorkflowId: string): StoredWorkflow;
485
+ /**
486
+ * Lists all stored prompt blocks with optional pagination
487
+ * @param params - Optional pagination and ordering parameters
488
+ * @returns Promise containing paginated list of stored prompt blocks
489
+ */
490
+ listStoredPromptBlocks(params?: ListStoredPromptBlocksParams): Promise<ListStoredPromptBlocksResponse>;
491
+ /**
492
+ * Creates a new stored prompt block
493
+ * @param params - Prompt block configuration including name, content, rules, etc.
494
+ * @returns Promise containing the created stored prompt block
495
+ */
496
+ createStoredPromptBlock(params: CreateStoredPromptBlockParams): Promise<StoredPromptBlockResponse>;
497
+ /**
498
+ * Gets a stored prompt block instance by ID for further operations (details, update, delete)
499
+ * @param storedPromptBlockId - ID of the stored prompt block to retrieve
500
+ * @returns StoredPromptBlock instance
501
+ */
502
+ getStoredPromptBlock(storedPromptBlockId: string): StoredPromptBlock;
503
+ /**
504
+ * Lists all stored scorer definitions with optional pagination
505
+ * @param params - Optional pagination and ordering parameters
506
+ * @returns Promise containing paginated list of stored scorer definitions
507
+ */
508
+ listStoredScorers(params?: ListStoredScorersParams): Promise<ListStoredScorersResponse>;
509
+ /**
510
+ * Creates a new stored scorer definition
511
+ * @param params - Scorer definition configuration
512
+ * @returns Promise containing the created stored scorer definition
513
+ */
514
+ createStoredScorer(params: CreateStoredScorerParams): Promise<StoredScorerResponse>;
515
+ /**
516
+ * Gets a stored scorer definition instance by ID for further operations (details, update, delete)
517
+ * @param storedScorerId - ID of the stored scorer definition
518
+ * @returns StoredScorer instance
519
+ */
520
+ getStoredScorer(storedScorerId: string): StoredScorer;
521
+ /**
522
+ * Lists all stored MCP clients with optional pagination
523
+ * @param params - Optional pagination and ordering parameters
524
+ * @returns Promise containing paginated list of stored MCP clients
525
+ */
526
+ listStoredMCPClients(params?: ListStoredMCPClientsParams): Promise<ListStoredMCPClientsResponse>;
527
+ /**
528
+ * Creates a new stored MCP client
529
+ * @param params - MCP client configuration
530
+ * @returns Promise containing the created stored MCP client
531
+ */
532
+ createStoredMCPClient(params: CreateStoredMCPClientParams): Promise<StoredMCPClientResponse>;
533
+ /**
534
+ * Gets a stored MCP client instance by ID for further operations (details, update, delete)
535
+ * @param storedMCPClientId - ID of the stored MCP client
536
+ * @returns StoredMCPClient instance
537
+ */
538
+ getStoredMCPClient(storedMCPClientId: string): StoredMCPClient;
539
+ /**
540
+ * Lists all stored skills with optional pagination
541
+ * @param params - Optional pagination and ordering parameters
542
+ * @returns Promise containing paginated list of stored skills
543
+ */
544
+ listStoredSkills(params?: ListStoredSkillsParams): Promise<ListStoredSkillsResponse>;
545
+ /**
546
+ * Creates a new stored skill
547
+ * @param params - Skill configuration
548
+ * @returns Promise containing the created stored skill
549
+ */
550
+ createStoredSkill(params: CreateStoredSkillParams): Promise<StoredSkillResponse>;
551
+ /**
552
+ * Gets a stored skill instance by ID for further operations (details, update, delete)
553
+ * @param storedSkillId - ID of the stored skill
554
+ * @returns StoredSkill instance
555
+ */
556
+ getStoredSkill(storedSkillId: string): StoredSkill;
557
+ /**
558
+ * Lists all registered tool providers
559
+ * @returns Promise containing list of tool provider info
560
+ */
561
+ listToolProviders(): Promise<ListToolProvidersResponse>;
562
+ /**
563
+ * Gets a tool provider instance by ID for further operations (listToolkits, listTools, getToolSchema)
564
+ * @param providerId - ID of the tool provider
565
+ * @returns ToolProvider instance
566
+ */
567
+ getToolProvider(providerId: string): ToolProvider;
568
+ /**
569
+ * Lists all registered processor providers
570
+ * @returns Promise containing list of processor provider info
571
+ */
572
+ getProcessorProviders(): Promise<GetProcessorProvidersResponse>;
573
+ /**
574
+ * Gets a processor provider instance by ID for further operations
575
+ * @param providerId - ID of the processor provider
576
+ * @returns ProcessorProvider instance
577
+ */
578
+ getProcessorProvider(providerId: string): ProcessorProvider;
579
+ /**
580
+ * Retrieves installed Mastra packages and their versions
581
+ * @returns Promise containing the list of installed Mastra packages
582
+ */
583
+ getSystemPackages(): Promise<GetSystemPackagesResponse>;
584
+ /**
585
+ * Retrieves agent builder settings for UI gating.
586
+ * Returns feature flags and configuration set by admin.
587
+ * @returns Promise containing builder settings
588
+ */
589
+ getBuilderSettings(): Promise<BuilderSettingsResponse>;
590
+ /**
591
+ * Retrieves the AI providers/models available under the active builder model
592
+ * policy. The server applies the EE allowlist, so the result can be rendered
593
+ * directly in the model picker.
594
+ * @returns Promise containing the policy-filtered providers/models
595
+ */
596
+ getBuilderAvailableModels(): Promise<BuilderAvailableModelsResponse>;
597
+ /**
598
+ * Retrieves the authoritative list of valid permission-pattern strings.
599
+ * Used by Studio to validate route→permission literals and gate the sidebar.
600
+ * @returns Promise containing the permission patterns
601
+ */
602
+ getPermissionPatterns(): Promise<PermissionPatternsResponse>;
603
+ /**
604
+ * Retrieves Agent Builder infrastructure configuration and resolution status.
605
+ * Requires `infrastructure:read` permission.
606
+ * @returns Promise containing infrastructure status
607
+ */
608
+ getInfrastructureStatus(): Promise<InfrastructureStatusResponse>;
609
+ /**
610
+ * Lists known skill registries surfaced by the Agent Builder config.
611
+ * Each entry reports whether the registry is enabled. Disabled or unknown
612
+ * registries return 404 from registry-scoped routes.
613
+ * Requires `stored-skills:read` permission.
614
+ */
615
+ listBuilderRegistries(): Promise<ListBuilderRegistriesResponse>;
616
+ /**
617
+ * Search a builder skill registry. The registry must be enabled or the
618
+ * server returns 404.
619
+ * Requires `stored-skills:read` permission.
620
+ */
621
+ searchBuilderRegistry(registryId: string, params: {
622
+ q: string;
623
+ limit?: number;
624
+ }): Promise<BuilderRegistrySearchResponse>;
625
+ /**
626
+ * Fetch the popular skills feed from a builder skill registry.
627
+ * Requires `stored-skills:read` permission.
628
+ */
629
+ getBuilderRegistryPopular(registryId: string, params?: {
630
+ limit?: number;
631
+ offset?: number;
632
+ }): Promise<BuilderRegistryPopularResponse>;
633
+ /**
634
+ * Fetch the rendered preview content for a single registry skill.
635
+ * Requires `stored-skills:read` permission.
636
+ */
637
+ getBuilderRegistryPreview(registryId: string, params: {
638
+ owner: string;
639
+ repo: string;
640
+ path: string;
641
+ }): Promise<BuilderRegistryPreviewResponse>;
642
+ /**
643
+ * Install a registry skill into the builder's stored-skills DB.
644
+ * Returns 409 when a stored skill with the derived id already exists.
645
+ * Requires `stored-skills:write` permission.
646
+ */
647
+ installBuilderRegistrySkill(registryId: string, body: BuilderRegistryInstallBody): Promise<BuilderRegistryInstallResponse>;
648
+ /**
649
+ * Lists all workspaces from both Mastra instance and agents
650
+ * @returns Promise containing array of workspace items
651
+ */
652
+ listWorkspaces(): Promise<ListWorkspacesResponse>;
653
+ /**
654
+ * Gets the workspace resource for filesystem, search, and skills operations
655
+ * @param workspaceId - Workspace ID to target
656
+ * @returns Workspace instance
657
+ */
658
+ getWorkspace(workspaceId: string): Workspace;
659
+ /**
660
+ * Lists stored workspace configurations from the database
661
+ * @param params - Optional filter and pagination parameters
662
+ * @returns Promise containing paginated list of stored workspaces
663
+ */
664
+ listStoredWorkspaces(params?: ListStoredWorkspacesParams): Promise<ListStoredWorkspacesResponse>;
665
+ /**
666
+ * Gets a specific stored workspace by ID
667
+ * @param id - The workspace ID
668
+ * @returns Promise containing the stored workspace
669
+ */
670
+ getStoredWorkspace(id: string): Promise<StoredWorkspaceResponse>;
671
+ /**
672
+ * Lists all available vector stores
673
+ * @returns Promise containing list of available vector stores
674
+ */
675
+ listVectors(): Promise<ListVectorsResponse>;
676
+ /**
677
+ * Lists all available embedding models
678
+ * @returns Promise containing list of available embedders
679
+ */
680
+ listEmbedders(): Promise<ListEmbeddersResponse>;
681
+ /**
682
+ * Lists all datasets with optional pagination
683
+ */
684
+ listDatasets(pagination?: {
685
+ page?: number;
686
+ perPage?: number;
687
+ }): Promise<{
688
+ datasets: DatasetRecord[];
689
+ pagination: PaginationInfo;
690
+ }>;
691
+ /**
692
+ * Gets a single dataset by ID. Optionally scope the lookup to a specific
693
+ * tenant organization/project — the server returns 404 if the dataset does
694
+ * not belong to the given tenant.
695
+ */
696
+ getDataset(datasetId: string, tenancy?: {
697
+ organizationId?: string;
698
+ projectId?: string;
699
+ }): Promise<DatasetRecord>;
700
+ /**
701
+ * Creates a new dataset
702
+ */
703
+ createDataset(params: CreateDatasetParams): Promise<DatasetRecord>;
704
+ /**
705
+ * Updates a dataset. Tenancy fields, when provided, scope the existence
706
+ * check on the server side so that a caller can only update datasets that
707
+ * belong to the given tenant.
708
+ */
709
+ updateDataset(params: UpdateDatasetParams): Promise<DatasetRecord>;
710
+ /**
711
+ * Deletes a dataset. When tenancy fields are supplied, the server only
712
+ * deletes the dataset if it belongs to the given tenant (silent no-op
713
+ * otherwise).
714
+ */
715
+ deleteDataset(datasetId: string, tenancy?: {
716
+ organizationId?: string;
717
+ projectId?: string;
718
+ }): Promise<{
719
+ success: boolean;
720
+ }>;
721
+ /**
722
+ * Lists items in a dataset with optional pagination, search, and version filter
723
+ */
724
+ listDatasetItems(datasetId: string, params?: {
725
+ page?: number;
726
+ perPage?: number;
727
+ search?: string;
728
+ version?: number | null;
729
+ }): Promise<{
730
+ items: DatasetItem[];
731
+ pagination: PaginationInfo;
732
+ }>;
733
+ /**
734
+ * Gets a single dataset item by ID
735
+ */
736
+ getDatasetItem(datasetId: string, itemId: string): Promise<DatasetItem>;
737
+ /**
738
+ * Adds an item to a dataset
739
+ */
740
+ addDatasetItem(params: AddDatasetItemParams): Promise<DatasetItem>;
741
+ /**
742
+ * Updates a dataset item
743
+ */
744
+ updateDatasetItem(params: UpdateDatasetItemParams): Promise<DatasetItem>;
745
+ /**
746
+ * Deletes a dataset item
747
+ */
748
+ deleteDatasetItem(datasetId: string, itemId: string): Promise<{
749
+ success: boolean;
750
+ }>;
751
+ /**
752
+ * Batch inserts items to a dataset
753
+ */
754
+ batchInsertDatasetItems(params: BatchInsertDatasetItemsParams): Promise<{
755
+ items: DatasetItem[];
756
+ count: number;
757
+ }>;
758
+ /**
759
+ * Batch deletes items from a dataset
760
+ */
761
+ batchDeleteDatasetItems(params: BatchDeleteDatasetItemsParams): Promise<{
762
+ success: boolean;
763
+ deletedCount: number;
764
+ }>;
765
+ /**
766
+ * Generates synthetic dataset items using AI. Items are returned for review, not auto-saved.
767
+ */
768
+ generateDatasetItems(params: GenerateDatasetItemsParams): Promise<{
769
+ items: GeneratedItem[];
770
+ }>;
771
+ /**
772
+ * Cluster experiment failures using AI to identify common failure patterns.
773
+ */
774
+ clusterFailures(params: {
775
+ modelId: string;
776
+ items: Array<{
777
+ id: string;
778
+ input: unknown;
779
+ output?: unknown;
780
+ error?: string;
781
+ scores?: Record<string, number>;
782
+ existingTags?: string[];
783
+ }>;
784
+ availableTags?: string[];
785
+ prompt?: string;
786
+ }): Promise<{
787
+ clusters: Array<{
788
+ id: string;
789
+ label: string;
790
+ description: string;
791
+ itemIds: string[];
792
+ }>;
793
+ proposedTags?: Array<{
794
+ itemId: string;
795
+ tags: string[];
796
+ reason: string;
797
+ }>;
798
+ }>;
799
+ /**
800
+ * Lists versions for a dataset item
801
+ */
802
+ getItemHistory(datasetId: string, itemId: string): Promise<{
803
+ history: DatasetItemVersionResponse[];
804
+ }>;
805
+ /**
806
+ * Gets a specific version of a dataset item
807
+ */
808
+ getDatasetItemVersion(datasetId: string, itemId: string, datasetVersion: number): Promise<DatasetItemVersionResponse>;
809
+ /**
810
+ * Lists versions for a dataset
811
+ */
812
+ listDatasetVersions(datasetId: string, pagination?: {
813
+ page?: number;
814
+ perPage?: number;
815
+ }): Promise<{
816
+ versions: DatasetVersionResponse[];
817
+ pagination: PaginationInfo;
818
+ }>;
819
+ /**
820
+ * Lists all experiments across all datasets
821
+ */
822
+ listExperiments(params?: ListExperimentsParams): Promise<{
823
+ experiments: DatasetExperiment[];
824
+ pagination: PaginationInfo;
825
+ }>;
826
+ /**
827
+ * Gets review status counts aggregated per experiment
828
+ */
829
+ getExperimentReviewSummary(): Promise<{
830
+ counts: ExperimentReviewCounts[];
831
+ }>;
832
+ /**
833
+ * Lists experiments for a dataset
834
+ */
835
+ listDatasetExperiments(datasetId: string, params?: ListExperimentsParams): Promise<{
836
+ experiments: DatasetExperiment[];
837
+ pagination: PaginationInfo;
838
+ }>;
839
+ /**
840
+ * Gets a single dataset experiment by ID
841
+ */
842
+ getDatasetExperiment(datasetId: string, experimentId: string): Promise<DatasetExperiment>;
843
+ /**
844
+ * Lists results for a dataset experiment
845
+ */
846
+ listDatasetExperimentResults(datasetId: string, experimentId: string, pagination?: {
847
+ page?: number;
848
+ perPage?: number;
849
+ }): Promise<{
850
+ results: DatasetExperimentResult[];
851
+ pagination: PaginationInfo;
852
+ }>;
853
+ /**
854
+ * Updates an experiment result's status, tags, and/or comment
855
+ */
856
+ updateDatasetExperimentResult(params: UpdateExperimentResultParams): Promise<DatasetExperimentResult>;
857
+ /**
858
+ * Triggers a new dataset experiment
859
+ */
860
+ triggerDatasetExperiment(params: TriggerDatasetExperimentParams): Promise<{
861
+ experimentId: string;
862
+ status: 'pending' | 'running' | 'completed' | 'failed';
863
+ totalItems: number;
864
+ succeededCount: number;
865
+ failedCount: number;
866
+ startedAt: string | Date;
867
+ completedAt: string | Date | null;
868
+ results: Array<{
869
+ itemId: string;
870
+ itemDatasetVersion: number | null;
871
+ input: unknown;
872
+ output: unknown | null;
873
+ groundTruth: unknown | null;
874
+ error: string | null;
875
+ startedAt: string | Date;
876
+ completedAt: string | Date;
877
+ retryCount: number;
878
+ scores: Array<{
879
+ scorerId: string;
880
+ scorerName: string;
881
+ score: number | null;
882
+ reason: string | null;
883
+ error: string | null;
884
+ }>;
885
+ }>;
886
+ }>;
887
+ /**
888
+ * Updates the status, tags, and/or comment on an experiment result
889
+ */
890
+ updateExperimentResult(params: UpdateExperimentResultParams): Promise<DatasetExperimentResult>;
891
+ /**
892
+ * Compares two dataset experiments for regression detection
893
+ */
894
+ compareExperiments(params: CompareExperimentsParams): Promise<CompareExperimentsResponse>;
895
+ /**
896
+ * Lists background tasks with optional filtering and pagination.
897
+ */
898
+ listBackgroundTasks(params?: ListBackgroundTasksParams): Promise<ListBackgroundTasksResponse>;
899
+ /**
900
+ * Gets a single background task by ID.
901
+ */
902
+ getBackgroundTask(backgroundTaskId: string): Promise<BackgroundTaskResponse>;
903
+ /**
904
+ * Opens an SSE stream of background task events (completed/failed).
905
+ * Returns a Response that can be consumed as a ReadableStream.
906
+ */
907
+ streamBackgroundTasks(params?: StreamBackgroundTasksParams): Promise<import("stream/web").ReadableStream<unknown>>;
908
+ /**
909
+ * Lists schedules — agent schedules and workflow schedules — with optional
910
+ * filtering by agentId, workflowId, or status. Agent schedules can
911
+ * additionally be filtered by threadId, resourceId, or name.
912
+ */
913
+ listSchedules(params?: ListSchedulesParams): Promise<ListSchedulesResponse>;
914
+ /**
915
+ * Gets a single schedule by ID.
916
+ */
917
+ getSchedule(scheduleId: string): Promise<ScheduleResponse>;
918
+ /**
919
+ * Creates a schedule. Pass `agentId` (plus `prompt`) to schedule an agent,
920
+ * or `workflowId` (plus optional `inputData`) to schedule a workflow.
921
+ * By default each call creates a new schedule with a random id
922
+ * (`agent_<uuid>` for agents, `schedule_<uuid>` for workflows) — pass `id`
923
+ * to choose a stable id instead; creating one with an id that already
924
+ * exists throws.
925
+ *
926
+ * Trigger (fire) history is read through `listScheduleTriggers(schedule.id)`.
927
+ */
928
+ createSchedule(options: CreateScheduleInput): Promise<ScheduleResponse>;
929
+ /**
930
+ * Patches an existing schedule. Fields apply to the matching target type;
931
+ * agent-only fields on a workflow schedule are rejected. `threadId` /
932
+ * `resourceId` are immutable — to retarget, delete and recreate.
933
+ */
934
+ updateSchedule(scheduleId: string, patch: UpdateScheduleInput): Promise<ScheduleResponse>;
935
+ /**
936
+ * Deletes a schedule.
937
+ */
938
+ deleteSchedule(scheduleId: string): Promise<{
939
+ message: string;
940
+ }>;
941
+ /**
942
+ * Fires a schedule manually, out-of-band from the cron schedule. Behaves
943
+ * like a scheduled fire but does not advance `nextFireAt`. The returned
944
+ * `claimId` is the trigger row's runId — look it up via
945
+ * `listScheduleTriggers(scheduleId)`.
946
+ */
947
+ runSchedule(scheduleId: string): Promise<RunScheduleResponse>;
948
+ /**
949
+ * Lists trigger history for a schedule, ordered by actualFireAt descending.
950
+ */
951
+ listScheduleTriggers(scheduleId: string, params?: ListScheduleTriggersParams): Promise<ListScheduleTriggersResponse>;
952
+ /**
953
+ * Pauses a schedule. The scheduler tick loop will skip paused schedules.
954
+ * Idempotent — pausing an already-paused schedule returns the current state unchanged.
955
+ * Pause status survives redeploys.
956
+ */
957
+ pauseSchedule(scheduleId: string): Promise<ScheduleResponse>;
958
+ /**
959
+ * Resumes a paused schedule. Recomputes nextFireAt from 'now' so a long-paused schedule
960
+ * does not fire a backlog. Idempotent — resuming an already-active schedule returns
961
+ * the current state unchanged.
962
+ */
963
+ resumeSchedule(scheduleId: string): Promise<ScheduleResponse>;
277
964
  }
278
965
  //# sourceMappingURL=client.d.ts.map