sequentum-mcp 1.0.0
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.
- package/CHANGELOG.md +47 -0
- package/LICENSE +21 -0
- package/README.md +191 -0
- package/dist/api-client.d.ts +185 -0
- package/dist/api-client.d.ts.map +1 -0
- package/dist/api-client.js +476 -0
- package/dist/api-client.js.map +1 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +1172 -0
- package/dist/index.js.map +1 -0
- package/dist/types.d.ts +417 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +91 -0
- package/dist/types.js.map +1 -0
- package/docs/tool-reference.md +782 -0
- package/docs/troubleshooting.md +313 -0
- package/package.json +63 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## [1.0.0] - 2026-01-16
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
|
|
7
|
+
- Initial release of Sequentum MCP
|
|
8
|
+
- **Agent Management** tools:
|
|
9
|
+
- `list_agents` - List all web scraping agents with filtering and pagination
|
|
10
|
+
- `get_agent` - Get detailed agent information and input parameters
|
|
11
|
+
- `search_agents` - Search agents by name or description
|
|
12
|
+
- **Run Management** tools:
|
|
13
|
+
- `get_agent_runs` - Get execution history for an agent
|
|
14
|
+
- `get_run_status` - Get current status of a specific run
|
|
15
|
+
- `start_agent` - Start agent execution (async or sync mode)
|
|
16
|
+
- `stop_agent` - Stop a running agent
|
|
17
|
+
- **File Management** tools:
|
|
18
|
+
- `get_run_files` - List output files from a completed run
|
|
19
|
+
- `get_file_download_url` - Get temporary download URL for files
|
|
20
|
+
- **Version Management** tools:
|
|
21
|
+
- `get_agent_versions` - List all saved versions of an agent
|
|
22
|
+
- `restore_agent_version` - Restore agent to a previous version
|
|
23
|
+
- **Schedule Management** tools:
|
|
24
|
+
- `list_agent_schedules` - List all schedules for an agent
|
|
25
|
+
- `create_agent_schedule` - Create new schedules (RunOnce, RunEvery, CRON)
|
|
26
|
+
- `delete_agent_schedule` - Remove a schedule from an agent
|
|
27
|
+
- `get_scheduled_runs` - Get upcoming scheduled runs across all agents
|
|
28
|
+
- **Billing & Credits** tools:
|
|
29
|
+
- `get_credits_balance` - Get current credits balance
|
|
30
|
+
- `get_spending_summary` - Get spending summary for date range
|
|
31
|
+
- `get_credit_history` - Get credit transaction history
|
|
32
|
+
- **Space Management** tools:
|
|
33
|
+
- `list_spaces` - List all accessible spaces
|
|
34
|
+
- `get_space` - Get space details
|
|
35
|
+
- `get_space_agents` - List agents in a space
|
|
36
|
+
- `search_space_by_name` - Find space by name
|
|
37
|
+
- `run_space_agents` - Start all agents in a space
|
|
38
|
+
- **Analytics & Diagnostics** tools:
|
|
39
|
+
- `get_runs_summary` - Get aggregate run statistics
|
|
40
|
+
- `get_records_summary` - Get extraction/export statistics
|
|
41
|
+
- `get_run_diagnostics` - Get detailed diagnostics for a run
|
|
42
|
+
- `get_latest_failure` - Get diagnostics for most recent failure
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
[Unreleased]: https://github.com/sequentum/se4-mcp-server/compare/v1.0.0...HEAD
|
|
47
|
+
[1.0.0]: https://github.com/sequentum/se4-mcp-server/releases/tag/v1.0.0
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Sequentum
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
# Sequentum MCP
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/sequentum-mcp)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
5
|
+
|
|
6
|
+
`sequentum-mcp` lets your AI coding assistant (such as Claude, Cursor, or Copilot)
|
|
7
|
+
control and manage your Sequentum web scraping agents. It acts as a Model Context Protocol
|
|
8
|
+
(MCP) server, giving your AI assistant access to the full power of the Sequentum platform
|
|
9
|
+
for agent automation, monitoring, and data extraction.
|
|
10
|
+
|
|
11
|
+
## [Tool Reference](./docs/tool-reference.md) | [Troubleshooting](./docs/troubleshooting.md) | [Changelog](./CHANGELOG.md)
|
|
12
|
+
|
|
13
|
+
## Key Features
|
|
14
|
+
|
|
15
|
+
- **Agent management**: List, search, and get detailed information about your web scraping agents.
|
|
16
|
+
- **Run automation**: Start, stop, and monitor agent executions with real-time status tracking.
|
|
17
|
+
- **Schedule management**: Create and manage automated schedules using cron expressions.
|
|
18
|
+
- **Analytics & diagnostics**: Get run statistics, error analysis, and suggested fixes for failures.
|
|
19
|
+
- **Space organization**: Manage agent workspaces and run batch operations across spaces.
|
|
20
|
+
|
|
21
|
+
## Disclaimers
|
|
22
|
+
|
|
23
|
+
`sequentum-mcp` exposes your Sequentum account data to MCP clients, allowing them to
|
|
24
|
+
view, run, and manage your web scraping agents. Keep your API key secure and avoid
|
|
25
|
+
sharing sensitive information that you don't want accessible to MCP clients.
|
|
26
|
+
|
|
27
|
+
## Requirements
|
|
28
|
+
|
|
29
|
+
- [Node.js](https://nodejs.org/) v18 or higher
|
|
30
|
+
- [npm](https://www.npmjs.com/)
|
|
31
|
+
- Sequentum account with API access
|
|
32
|
+
|
|
33
|
+
## Getting Started
|
|
34
|
+
|
|
35
|
+
Add the following config to your MCP client:
|
|
36
|
+
|
|
37
|
+
```json
|
|
38
|
+
{
|
|
39
|
+
"mcpServers": {
|
|
40
|
+
"sequentum": {
|
|
41
|
+
"command": "npx",
|
|
42
|
+
"args": ["-y", "sequentum-mcp"],
|
|
43
|
+
"env": {
|
|
44
|
+
"SEQUENTUM_API_KEY": "sk-your-api-key-here"
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Get Your API Key
|
|
52
|
+
|
|
53
|
+
1. Log in to the [Sequentum Control Center](https://dashboard.sequentum.com)
|
|
54
|
+
2. Go to **Settings** → **API Keys**
|
|
55
|
+
3. Click **Create API Key** and copy the generated key (starts with `sk-`)
|
|
56
|
+
|
|
57
|
+
### MCP Client Configuration Files
|
|
58
|
+
|
|
59
|
+
| Client | Config File Location |
|
|
60
|
+
|--------|---------------------|
|
|
61
|
+
| Claude Desktop (Windows) | `%APPDATA%\Claude\claude_desktop_config.json` |
|
|
62
|
+
| Claude Desktop (macOS) | `~/Library/Application Support/Claude/claude_desktop_config.json` |
|
|
63
|
+
| Cursor | `Cursor Settings` → `MCP` → `New MCP Server` |
|
|
64
|
+
|
|
65
|
+
## Your First Prompt
|
|
66
|
+
|
|
67
|
+
Enter the following prompt in your MCP client to check if everything is working:
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
What agents ran yesterday?
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Your MCP client should return a list of your Sequentum agents with their IDs, names, and status.
|
|
74
|
+
|
|
75
|
+
### Other Useful Prompts
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
Run agent <agent name> now.
|
|
79
|
+
Is agent <agent name> still running?
|
|
80
|
+
What agents are scheduled to run today?
|
|
81
|
+
Download the extracted data from agent <agent name>.
|
|
82
|
+
How many records were found the last time <agent name> was run?
|
|
83
|
+
What is my current balance?
|
|
84
|
+
Schedule agent <agent name> to run every Monday at 9am.
|
|
85
|
+
Look at the run log for <agent name> run at 9:22am. What caused the agent to fail?
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Tools
|
|
89
|
+
|
|
90
|
+
<!-- BEGIN AUTO GENERATED TOOLS -->
|
|
91
|
+
|
|
92
|
+
- **Agent Management** (3 tools)
|
|
93
|
+
- [`list_agents`](docs/tool-reference.md#list_agents)
|
|
94
|
+
- [`get_agent`](docs/tool-reference.md#get_agent)
|
|
95
|
+
- [`search_agents`](docs/tool-reference.md#search_agents)
|
|
96
|
+
- **Run Management** (4 tools)
|
|
97
|
+
- [`get_agent_runs`](docs/tool-reference.md#get_agent_runs)
|
|
98
|
+
- [`get_run_status`](docs/tool-reference.md#get_run_status)
|
|
99
|
+
- [`start_agent`](docs/tool-reference.md#start_agent)
|
|
100
|
+
- [`stop_agent`](docs/tool-reference.md#stop_agent)
|
|
101
|
+
- **File Management** (2 tools)
|
|
102
|
+
- [`get_run_files`](docs/tool-reference.md#get_run_files)
|
|
103
|
+
- [`get_file_download_url`](docs/tool-reference.md#get_file_download_url)
|
|
104
|
+
- **Version Management** (2 tools)
|
|
105
|
+
- [`get_agent_versions`](docs/tool-reference.md#get_agent_versions)
|
|
106
|
+
- [`restore_agent_version`](docs/tool-reference.md#restore_agent_version)
|
|
107
|
+
- **Schedule Management** (4 tools)
|
|
108
|
+
- [`list_agent_schedules`](docs/tool-reference.md#list_agent_schedules)
|
|
109
|
+
- [`create_agent_schedule`](docs/tool-reference.md#create_agent_schedule)
|
|
110
|
+
- [`delete_agent_schedule`](docs/tool-reference.md#delete_agent_schedule)
|
|
111
|
+
- [`get_scheduled_runs`](docs/tool-reference.md#get_scheduled_runs)
|
|
112
|
+
- **Billing & Credits** (3 tools)
|
|
113
|
+
- [`get_credits_balance`](docs/tool-reference.md#get_credits_balance)
|
|
114
|
+
- [`get_spending_summary`](docs/tool-reference.md#get_spending_summary)
|
|
115
|
+
- [`get_credit_history`](docs/tool-reference.md#get_credit_history)
|
|
116
|
+
- **Space Management** (5 tools)
|
|
117
|
+
- [`list_spaces`](docs/tool-reference.md#list_spaces)
|
|
118
|
+
- [`get_space`](docs/tool-reference.md#get_space)
|
|
119
|
+
- [`get_space_agents`](docs/tool-reference.md#get_space_agents)
|
|
120
|
+
- [`search_space_by_name`](docs/tool-reference.md#search_space_by_name)
|
|
121
|
+
- [`run_space_agents`](docs/tool-reference.md#run_space_agents)
|
|
122
|
+
- **Analytics & Diagnostics** (4 tools)
|
|
123
|
+
- [`get_runs_summary`](docs/tool-reference.md#get_runs_summary)
|
|
124
|
+
- [`get_records_summary`](docs/tool-reference.md#get_records_summary)
|
|
125
|
+
- [`get_run_diagnostics`](docs/tool-reference.md#get_run_diagnostics)
|
|
126
|
+
- [`get_latest_failure`](docs/tool-reference.md#get_latest_failure)
|
|
127
|
+
|
|
128
|
+
<!-- END AUTO GENERATED TOOLS -->
|
|
129
|
+
|
|
130
|
+
## Configuration
|
|
131
|
+
|
|
132
|
+
The Sequentum MCP server supports the following environment variables:
|
|
133
|
+
|
|
134
|
+
| Variable | Required | Default | Description |
|
|
135
|
+
|----------|----------|---------|-------------|
|
|
136
|
+
| `SEQUENTUM_API_KEY` | Yes | — | Your Sequentum API key (format: `sk-...`). Get this from the Sequentum Control Center under Settings → API Keys. |
|
|
137
|
+
| `SEQUENTUM_API_URL` | No | `https://dashboard.sequentum.com` | The base URL of your Sequentum instance. Override if using a custom deployment. |
|
|
138
|
+
|
|
139
|
+
Pass them via the `env` property in the JSON configuration:
|
|
140
|
+
|
|
141
|
+
```json
|
|
142
|
+
{
|
|
143
|
+
"mcpServers": {
|
|
144
|
+
"sequentum": {
|
|
145
|
+
"command": "npx",
|
|
146
|
+
"args": ["-y", "sequentum-mcp"],
|
|
147
|
+
"env": {
|
|
148
|
+
"SEQUENTUM_API_KEY": "sk-your-api-key-here"
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
To use a custom Sequentum instance, add the `SEQUENTUM_API_URL`:
|
|
156
|
+
|
|
157
|
+
```json
|
|
158
|
+
{
|
|
159
|
+
"mcpServers": {
|
|
160
|
+
"sequentum": {
|
|
161
|
+
"command": "npx",
|
|
162
|
+
"args": ["-y", "sequentum-mcp"],
|
|
163
|
+
"env": {
|
|
164
|
+
"SEQUENTUM_API_KEY": "sk-your-api-key-here",
|
|
165
|
+
"SEQUENTUM_API_URL": "https://your-custom-instance.sequentum.com"
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
## Troubleshooting
|
|
173
|
+
|
|
174
|
+
| Error | Solution |
|
|
175
|
+
|-------|----------|
|
|
176
|
+
| `SEQUENTUM_API_KEY required` | Add your API key to the `env` section of the MCP config |
|
|
177
|
+
| `API Error 401: Unauthorized` | Your API key is invalid or expired. Generate a new one from the Control Center. |
|
|
178
|
+
| `API Error 404: Not Found` | The agent, run, or file doesn't exist, or you don't have access to it. |
|
|
179
|
+
| `API Error 429: Too Many Requests` | Rate limit exceeded. Wait a moment and try again. |
|
|
180
|
+
|
|
181
|
+
For more troubleshooting help, see the [Troubleshooting Guide](./docs/troubleshooting.md).
|
|
182
|
+
|
|
183
|
+
## Links
|
|
184
|
+
|
|
185
|
+
- [Sequentum Dashboard](https://dashboard.sequentum.com)
|
|
186
|
+
- [Sequentum API Documentation](https://dashboard.sequentum.com/api-docs/index.html)
|
|
187
|
+
- [Model Context Protocol](https://modelcontextprotocol.io/)
|
|
188
|
+
|
|
189
|
+
## License
|
|
190
|
+
|
|
191
|
+
MIT © [Sequentum](https://sequentum.com)
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Sequentum API Client
|
|
3
|
+
* Handles all HTTP communication with the Sequentum Control Center API
|
|
4
|
+
*/
|
|
5
|
+
import { AgentApiModel, AgentRunApiModel, AgentRunFileApiModel, AgentVersionModel, StartAgentRequest, AgentScheduleApiModel, CreateScheduleRequest, UpcomingScheduleApiModel, CreditsBalanceApiModel, SpendingSummaryApiModel, CreditHistoryApiModel, SpaceApiModel, SpaceAgentApiModel, RunSpaceAgentsResultApiModel, RunsSummaryApiModel, RecordsSummaryApiModel, RunDiagnosticsApiModel, ListAgentsRequest, PaginatedAgentsResponse } from "./types.js";
|
|
6
|
+
export declare class SequentumApiClient {
|
|
7
|
+
private baseUrl;
|
|
8
|
+
private apiKey;
|
|
9
|
+
private requestTimeoutMs;
|
|
10
|
+
/**
|
|
11
|
+
* Create a new Sequentum API client
|
|
12
|
+
* @param baseUrl - The base URL of the Sequentum API (e.g., https://dashboard.sequentum.com)
|
|
13
|
+
* @param apiKey - The API key (sk-...) for authentication
|
|
14
|
+
* @param requestTimeoutMs - Request timeout in milliseconds (default: 30000)
|
|
15
|
+
*/
|
|
16
|
+
constructor(baseUrl: string, apiKey: string, requestTimeoutMs?: number);
|
|
17
|
+
/**
|
|
18
|
+
* Make an authenticated request to the API
|
|
19
|
+
*/
|
|
20
|
+
private request;
|
|
21
|
+
/**
|
|
22
|
+
* Make an authenticated request that doesn't expect a response body
|
|
23
|
+
*/
|
|
24
|
+
private requestVoid;
|
|
25
|
+
/**
|
|
26
|
+
* Get all agents accessible to the authenticated user
|
|
27
|
+
* @param filters - Optional filters for the agent list
|
|
28
|
+
* @returns Array of agents, or paginated response if pagination params are provided
|
|
29
|
+
*/
|
|
30
|
+
getAllAgents(filters?: ListAgentsRequest): Promise<AgentApiModel[] | PaginatedAgentsResponse>;
|
|
31
|
+
/**
|
|
32
|
+
* Get detailed information about a specific agent
|
|
33
|
+
* @param agentId - The ID of the agent
|
|
34
|
+
*/
|
|
35
|
+
getAgent(agentId: number): Promise<AgentApiModel>;
|
|
36
|
+
/**
|
|
37
|
+
* Search for agents by name or description
|
|
38
|
+
* @param query - The search term to match against agent names and descriptions
|
|
39
|
+
* @param maxRecords - Maximum number of results to return (default: 50, max: 1000)
|
|
40
|
+
*/
|
|
41
|
+
searchAgents(query: string, maxRecords?: number): Promise<AgentApiModel[]>;
|
|
42
|
+
/**
|
|
43
|
+
* Get run history for an agent
|
|
44
|
+
* @param agentId - The ID of the agent
|
|
45
|
+
* @param maxRecords - Maximum number of records to return (default: 50)
|
|
46
|
+
*/
|
|
47
|
+
getAgentRuns(agentId: number, maxRecords?: number): Promise<AgentRunApiModel[]>;
|
|
48
|
+
/**
|
|
49
|
+
* Get the status of a specific run
|
|
50
|
+
* @param agentId - The ID of the agent
|
|
51
|
+
* @param runId - The ID of the run to check
|
|
52
|
+
*/
|
|
53
|
+
getRunStatus(agentId: number, runId: number): Promise<AgentRunApiModel>;
|
|
54
|
+
/**
|
|
55
|
+
* Start an agent execution
|
|
56
|
+
* @param agentId - The ID of the agent to run
|
|
57
|
+
* @param request - The run configuration
|
|
58
|
+
* @returns Run details or direct results if running synchronously
|
|
59
|
+
*/
|
|
60
|
+
startAgent(agentId: number, request: StartAgentRequest): Promise<AgentRunApiModel | string>;
|
|
61
|
+
/**
|
|
62
|
+
* Stop a running agent
|
|
63
|
+
* @param agentId - The ID of the agent
|
|
64
|
+
* @param runId - The ID of the run to stop
|
|
65
|
+
*/
|
|
66
|
+
stopAgent(agentId: number, runId: number): Promise<void>;
|
|
67
|
+
/**
|
|
68
|
+
* Get all output files from a run
|
|
69
|
+
* @param agentId - The ID of the agent
|
|
70
|
+
* @param runId - The ID of the run
|
|
71
|
+
*/
|
|
72
|
+
getRunFiles(agentId: number, runId: number): Promise<AgentRunFileApiModel[]>;
|
|
73
|
+
/**
|
|
74
|
+
* Get a download URL for a run file
|
|
75
|
+
* @param agentId - The ID of the agent
|
|
76
|
+
* @param runId - The ID of the run
|
|
77
|
+
* @param fileId - The ID of the file
|
|
78
|
+
*/
|
|
79
|
+
downloadRunFile(agentId: number, runId: number, fileId: number): Promise<{
|
|
80
|
+
redirectUrl: string;
|
|
81
|
+
}>;
|
|
82
|
+
/**
|
|
83
|
+
* Get all versions of an agent
|
|
84
|
+
* @param agentId - The ID of the agent
|
|
85
|
+
*/
|
|
86
|
+
getAgentVersions(agentId: number): Promise<AgentVersionModel[]>;
|
|
87
|
+
/**
|
|
88
|
+
* Restore an agent to a previous version
|
|
89
|
+
* @param agentId - The ID of the agent
|
|
90
|
+
* @param versionNumber - The version number to restore
|
|
91
|
+
* @param comments - Comments explaining the restoration
|
|
92
|
+
*/
|
|
93
|
+
restoreAgentVersion(agentId: number, versionNumber: number, comments: string): Promise<void>;
|
|
94
|
+
/**
|
|
95
|
+
* Get all schedules for an agent
|
|
96
|
+
* @param agentId - The ID of the agent
|
|
97
|
+
*/
|
|
98
|
+
getAgentSchedules(agentId: number): Promise<AgentScheduleApiModel[]>;
|
|
99
|
+
/**
|
|
100
|
+
* Create a new schedule for an agent
|
|
101
|
+
* @param agentId - The ID of the agent
|
|
102
|
+
* @param request - The schedule configuration
|
|
103
|
+
*/
|
|
104
|
+
createAgentSchedule(agentId: number, request: CreateScheduleRequest): Promise<AgentScheduleApiModel>;
|
|
105
|
+
/**
|
|
106
|
+
* Delete a schedule from an agent
|
|
107
|
+
* @param agentId - The ID of the agent
|
|
108
|
+
* @param scheduleId - The ID of the schedule to delete
|
|
109
|
+
*/
|
|
110
|
+
deleteAgentSchedule(agentId: number, scheduleId: number): Promise<void>;
|
|
111
|
+
/**
|
|
112
|
+
* Get upcoming scheduled runs
|
|
113
|
+
* @param startDate - Optional start date (ISO format)
|
|
114
|
+
* @param endDate - Optional end date (ISO format)
|
|
115
|
+
*/
|
|
116
|
+
getUpcomingSchedules(startDate?: string, endDate?: string): Promise<UpcomingScheduleApiModel[]>;
|
|
117
|
+
/**
|
|
118
|
+
* Get the current credits balance
|
|
119
|
+
*/
|
|
120
|
+
getCreditsBalance(): Promise<CreditsBalanceApiModel>;
|
|
121
|
+
/**
|
|
122
|
+
* Get spending summary for a date range
|
|
123
|
+
* @param startDate - Optional start date (ISO format)
|
|
124
|
+
* @param endDate - Optional end date (ISO format)
|
|
125
|
+
*/
|
|
126
|
+
getSpendingSummary(startDate?: string, endDate?: string): Promise<SpendingSummaryApiModel>;
|
|
127
|
+
/**
|
|
128
|
+
* Get credit transaction history
|
|
129
|
+
* @param pageIndex - Page number (1-based, default: 1)
|
|
130
|
+
* @param recordsPerPage - Records per page (default: 50, max: 100)
|
|
131
|
+
*/
|
|
132
|
+
getCreditHistory(pageIndex?: number, recordsPerPage?: number): Promise<CreditHistoryApiModel>;
|
|
133
|
+
/**
|
|
134
|
+
* Get all spaces accessible to the user
|
|
135
|
+
*/
|
|
136
|
+
getAllSpaces(): Promise<SpaceApiModel[]>;
|
|
137
|
+
/**
|
|
138
|
+
* Get a specific space by ID
|
|
139
|
+
* @param spaceId - The ID of the space
|
|
140
|
+
*/
|
|
141
|
+
getSpace(spaceId: number): Promise<SpaceApiModel>;
|
|
142
|
+
/**
|
|
143
|
+
* Get all agents in a space
|
|
144
|
+
* @param spaceId - The ID of the space
|
|
145
|
+
*/
|
|
146
|
+
getSpaceAgents(spaceId: number): Promise<SpaceAgentApiModel[]>;
|
|
147
|
+
/**
|
|
148
|
+
* Search for a space by name
|
|
149
|
+
* @param name - The name of the space to search for
|
|
150
|
+
*/
|
|
151
|
+
searchSpaceByName(name: string): Promise<SpaceApiModel>;
|
|
152
|
+
/**
|
|
153
|
+
* Run all agents in a space
|
|
154
|
+
* @param spaceId - The ID of the space
|
|
155
|
+
* @param inputParameters - Optional JSON input parameters
|
|
156
|
+
*/
|
|
157
|
+
runSpaceAgents(spaceId: number, inputParameters?: string): Promise<RunSpaceAgentsResultApiModel>;
|
|
158
|
+
/**
|
|
159
|
+
* Get runs summary for a date range
|
|
160
|
+
* @param startDate - Optional start date (ISO format)
|
|
161
|
+
* @param endDate - Optional end date (ISO format)
|
|
162
|
+
* @param status - Optional status filter
|
|
163
|
+
* @param includeDetails - Whether to include failed run details
|
|
164
|
+
*/
|
|
165
|
+
getRunsSummary(startDate?: string, endDate?: string, status?: string, includeDetails?: boolean): Promise<RunsSummaryApiModel>;
|
|
166
|
+
/**
|
|
167
|
+
* Get records summary for a date range
|
|
168
|
+
* @param startDate - Optional start date (ISO format)
|
|
169
|
+
* @param endDate - Optional end date (ISO format)
|
|
170
|
+
* @param agentId - Optional agent ID filter
|
|
171
|
+
*/
|
|
172
|
+
getRecordsSummary(startDate?: string, endDate?: string, agentId?: number): Promise<RecordsSummaryApiModel>;
|
|
173
|
+
/**
|
|
174
|
+
* Get diagnostics for a specific run
|
|
175
|
+
* @param agentId - The ID of the agent
|
|
176
|
+
* @param runId - The ID of the run
|
|
177
|
+
*/
|
|
178
|
+
getRunDiagnostics(agentId: number, runId: number): Promise<RunDiagnosticsApiModel>;
|
|
179
|
+
/**
|
|
180
|
+
* Get the latest failure for an agent
|
|
181
|
+
* @param agentId - The ID of the agent
|
|
182
|
+
*/
|
|
183
|
+
getLatestFailure(agentId: number): Promise<RunDiagnosticsApiModel>;
|
|
184
|
+
}
|
|
185
|
+
//# sourceMappingURL=api-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-client.d.ts","sourceRoot":"","sources":["../src/api-client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,aAAa,EACb,gBAAgB,EAChB,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EAEjB,qBAAqB,EACrB,qBAAqB,EACrB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,aAAa,EACb,kBAAkB,EAClB,4BAA4B,EAC5B,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,YAAY,CAAC;AAEpB,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,gBAAgB,CAAS;IAEjC;;;;;OAKG;gBACS,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAE,MAAc;IAM7E;;OAEG;YACW,OAAO;IAkErB;;OAEG;YACW,WAAW;IA0DzB;;;;OAIG;IACG,YAAY,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,EAAE,GAAG,uBAAuB,CAAC;IA8BnG;;;OAGG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIvD;;;;OAIG;IACG,YAAY,CAChB,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,aAAa,EAAE,CAAC;IAc3B;;;;OAIG;IACG,YAAY,CAChB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAO9B;;;;OAIG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAM7E;;;;;OAKG;IACG,UAAU,CACd,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,gBAAgB,GAAG,MAAM,CAAC;IAsBrC;;;;OAIG;IACG,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU9D;;;;OAIG;IACG,WAAW,CACf,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAMlC;;;;;OAKG;IACG,eAAe,CACnB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAUnC;;;OAGG;IACG,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAMrE;;;;;OAKG;IACG,mBAAmB,CACvB,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAchB;;;OAGG;IACG,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAM1E;;;;OAIG;IACG,mBAAmB,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,qBAAqB,CAAC;IAqBjC;;;;OAIG;IACG,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO7E;;;;OAIG;IACG,oBAAoB,CACxB,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,wBAAwB,EAAE,CAAC;IActC;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAI1D;;;;OAIG;IACG,kBAAkB,CACtB,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,uBAAuB,CAAC;IAUnC;;;;OAIG;IACG,gBAAgB,CACpB,SAAS,CAAC,EAAE,MAAM,EAClB,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,qBAAqB,CAAC;IAcjC;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAI9C;;;OAGG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIvD;;;OAGG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAMpE;;;OAGG;IACG,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAM7D;;;;OAIG;IACG,cAAc,CAClB,OAAO,EAAE,MAAM,EACf,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,4BAA4B,CAAC;IAgBxC;;;;;;OAMG;IACG,cAAc,CAClB,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,EACf,cAAc,CAAC,EAAE,OAAO,GACvB,OAAO,CAAC,mBAAmB,CAAC;IAa/B;;;;;OAKG;IACG,iBAAiB,CACrB,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,sBAAsB,CAAC;IAWlC;;;;OAIG;IACG,iBAAiB,CACrB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,sBAAsB,CAAC;IAMlC;;;OAGG;IACG,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAKzE"}
|