agental-sdk 0.5.0 → 0.7.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/README.md +9 -1
- package/dist/client.d.ts +54 -3
- package/dist/client.js +64 -2
- package/dist/index.d.ts +1 -1
- package/dist/openapi.d.ts +636 -4
- package/dist/types.d.ts +10 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -344,6 +344,14 @@ An account starts on the free plan: nothing a month, and what it runs is paid fr
|
|
|
344
344
|
|
|
345
345
|
`setAutoReload(dollars)` has the card saved at the last purchase charged for a top-up of that much, with tax, when the month's credits and the top-ups run out, and the credits added at once, before any sandbox is stopped: at most three times a day, and not again for a day after a card that would not pay. `setAutoReload(null)` turns it off, and `billing().autoReload` says how it is set. It needs a card saved first: `billing().canAutoReload` says whether it can be set, and the call answers `409 no_card` until then.
|
|
346
346
|
|
|
347
|
+
```ts
|
|
348
|
+
const page = await agental.invoices({ limit: 10 });
|
|
349
|
+
for await (const invoice of agental.allInvoices()) console.log(invoice.number, invoice.status, invoice.totalMicros);
|
|
350
|
+
const { card } = await agental.card();
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
`invoices()` gives the account's invoices from the payment provider, newest first, 25 to a page unless `limit` says otherwise: a plan's months, top-ups and auto-reloads, each with its number, state, what it was for, what it came to in millionths, and its page and PDF (`null` for an admin). Pass a page's `next` as `startingAfter` for the page after it, or let `allInvoices()` read them all. `card()` gives the card the account pays with now: brand, last four, expiry and wallet, or `null` where none is saved.
|
|
354
|
+
|
|
347
355
|
The free plan makes tiny and small sandboxes, the $100 plan medium ones too, and the $500 and $2000 plans every size: `prices.tiers` lists the plans, and each plan's `sizes` says which. A create, fork or template start of a size the plan does not make throws an `ApiError` with the status 402 and the code `size_not_on_plan`, whose message names the plan that makes it. A sandbox made before a change of plan still starts at its own size.
|
|
348
356
|
|
|
349
357
|
## How many you run, and how fast you start them
|
|
@@ -514,7 +522,7 @@ await agental.rotateWebhookSecret(hook.id); // a new signingSecret; the old one
|
|
|
514
522
|
await agental.deleteWebhook(hook.id);
|
|
515
523
|
```
|
|
516
524
|
|
|
517
|
-
`events` takes the kinds of event, such as `sandbox.started`, `sandbox.stopped` and `sandbox.error`. `sandbox.auto_stop_set` is a running sandbox's stop moved: its `data` has `autoStopAt`, `previousAutoStopAt`, and `by`, `account` or `sandbox`.
|
|
525
|
+
`events` takes the kinds of event, such as `sandbox.started`, `sandbox.stopped` and `sandbox.error`. `sandbox.auto_stop_set` is a running sandbox's stop moved: its `data` has `autoStopAt`, `previousAutoStopAt`, and `by`, `account` or `sandbox`. A group by its name and `.*`, such as `headroom.*` or `sandbox.*`, takes every kind of the group and any added to it later; a `*` anywhere else is refused. The `headroom.*` events are your organization's, about no sandbox: `headroom.burst_started` and `headroom.burst_ended` (a stretch over the free burst, with what it cost), `headroom.refused` (starts refused, at most one a minute for each reason), `headroom.running_count_reached`, `headroom.budget_threshold` (burst fees past 80% of the month's budget) and `headroom.budget_reached` (the budget refused a start). Money is in micros of a dollar, memory in MB.
|
|
518
526
|
|
|
519
527
|
Check each post your server receives:
|
|
520
528
|
|
package/dist/client.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Http, type AgentalOptions } from "./http.js";
|
|
2
2
|
import { Email, Sandbox, type CreateOptions } from "./sandbox.js";
|
|
3
3
|
import { Templates } from "./template.js";
|
|
4
|
-
import type { AccountEmail, AccountExport, ApiKey, ApiKeyUsage, Billing, Headroom, HeadroomNow, HeadroomRange, Catalog, HostRoute, Invite, Me, Member, Organization, Region, AutoReload, Checkout, DataRetention, CreateApiKey, CreatedApiKey, MetricsAtMoment, Policy, Prices, RunningOverTime, SandboxSummary, SandboxJob, SandboxJobItem, SandboxJobPreview, Snapshot, Team, TeamRole, Telemetry, TelemetryTest, RunsOnRepository, RunsOnRepositories, Usage, Webhook, EgressAccount } from "./types.js";
|
|
4
|
+
import type { AccountEmail, AccountExport, ApiKey, ApiKeyUsage, Billing, Headroom, HeadroomNow, HeadroomRange, Catalog, HostRoute, Invite, Me, Member, Organization, Region, AutoReload, BillingCard, BillingInvoice, BillingInvoices, Checkout, DataRetention, CreateApiKey, CreatedApiKey, MetricsAtMoment, Policy, Prices, RunningOverTime, SandboxSummary, SandboxJob, SandboxJobItem, SandboxJobPreview, Snapshot, Team, TeamRole, Telemetry, TelemetryTest, ClaudeConnection, ClaudeSession, RunsOnRepository, RunsOnRepositories, Usage, Webhook, EgressAccount } from "./types.js";
|
|
5
5
|
/** What a list of sandboxes is narrowed to. Each field left out narrows nothing; a list of values is any of them. */
|
|
6
6
|
export interface SandboxFilter {
|
|
7
7
|
/** Tags every sandbox has. */
|
|
@@ -310,6 +310,21 @@ export declare class Agental {
|
|
|
310
310
|
* first, by checkout(): billing().canAutoReload says whether it can be set.
|
|
311
311
|
*/
|
|
312
312
|
setAutoReload(dollars: number | null): Promise<AutoReload>;
|
|
313
|
+
/**
|
|
314
|
+
* The account's invoices, newest first, read from the payment provider: a plan's months, top-ups
|
|
315
|
+
* and auto-reloads, drafts left out. 25 unless limit says otherwise, 100 at most; pass a page's
|
|
316
|
+
* next as startingAfter for the page after it. An admin is given no pageUrl or pdfUrl.
|
|
317
|
+
*/
|
|
318
|
+
invoices(options?: {
|
|
319
|
+
limit?: number;
|
|
320
|
+
startingAfter?: string;
|
|
321
|
+
}): Promise<BillingInvoices>;
|
|
322
|
+
/** Every invoice, newest first, read a page at a time as they are asked for. */
|
|
323
|
+
allInvoices(options?: {
|
|
324
|
+
limit?: number;
|
|
325
|
+
}): AsyncGenerator<BillingInvoice, void, void>;
|
|
326
|
+
/** The card the account pays with now, the one an auto-reload charges: its brand, last four, expiry and wallet, or null where none is saved. */
|
|
327
|
+
card(): Promise<BillingCard>;
|
|
313
328
|
/** The account's mail: the handle every address of its sandboxes carries, what its plan allows, and what it has had of that today. */
|
|
314
329
|
email(): Promise<AccountEmail>;
|
|
315
330
|
/**
|
|
@@ -406,6 +421,40 @@ export declare class Agental {
|
|
|
406
421
|
testTelemetry(): Promise<TelemetryTest>;
|
|
407
422
|
/** Removes your collector, with its headers, and nothing more is sent to it. When none is set it throws an ApiError with the status 404. */
|
|
408
423
|
deleteTelemetry(): Promise<void>;
|
|
424
|
+
/**
|
|
425
|
+
* The Claude Managed Agents self-hosted environments connected to your account. Each
|
|
426
|
+
* session of one runs its tool calls in a sandbox of your own. Their keys and signing
|
|
427
|
+
* secrets are never shown. Only where policy() says managedAgents.
|
|
428
|
+
*/
|
|
429
|
+
listClaudeConnections(): Promise<ClaudeConnection[]>;
|
|
430
|
+
/**
|
|
431
|
+
* Connects a self-hosted environment from the Claude Console: its id, its environment key,
|
|
432
|
+
* and, for a turn to start at once, its webhook's signing secret. The key and secret are
|
|
433
|
+
* kept sealed and never shown again, and the key never goes into a sandbox. Each session
|
|
434
|
+
* gets a sandbox on templateId (the account's default when left out), stopped between turns
|
|
435
|
+
* and deleted once it has slept keepDays (7). Set the answer's webhookUrl as the
|
|
436
|
+
* environment's webhook for session.status_run_started in the Claude Console.
|
|
437
|
+
*/
|
|
438
|
+
connectClaude(connection: {
|
|
439
|
+
environmentId: string;
|
|
440
|
+
environmentKey: string;
|
|
441
|
+
webhookSecret?: string;
|
|
442
|
+
templateId?: string | null;
|
|
443
|
+
keepDays?: number;
|
|
444
|
+
}): Promise<ClaudeConnection>;
|
|
445
|
+
/** One connected environment. */
|
|
446
|
+
getClaudeConnection(id: string): Promise<ClaudeConnection>;
|
|
447
|
+
/** The sessions of a connected environment that have run here, the latest active first: each one's sandbox, whether it runs or sleeps, when a sleeping one's sandbox is deleted, and why its last turn was not served. */
|
|
448
|
+
listClaudeSessions(id: string): Promise<ClaudeSession[]>;
|
|
449
|
+
/** Changes a connection: a new key or signing secret (null forgets it), another template (null for the default), or keepDays. What is left out stays as it was. */
|
|
450
|
+
updateClaudeConnection(id: string, change: {
|
|
451
|
+
environmentKey?: string;
|
|
452
|
+
webhookSecret?: string | null;
|
|
453
|
+
templateId?: string | null;
|
|
454
|
+
keepDays?: number;
|
|
455
|
+
}): Promise<ClaudeConnection>;
|
|
456
|
+
/** Disconnects an environment: its key and signing secret are forgotten, and no more of its work is claimed. Its sessions' sandboxes are left as they are. */
|
|
457
|
+
disconnectClaude(id: string): Promise<void>;
|
|
409
458
|
/**
|
|
410
459
|
* GitHub Actions jobs on sandboxes: each repository's pool, how many sandboxes of each size it
|
|
411
460
|
* keeps and the template they are made on. available is false where jobs do not run on
|
|
@@ -440,8 +489,10 @@ export declare class Agental {
|
|
|
440
489
|
listWebhooks(): Promise<Webhook[]>;
|
|
441
490
|
/**
|
|
442
491
|
* Adds a webhook. url is posted each event it takes, and has to be on the public internet.
|
|
443
|
-
* events names the kinds it takes, such as sandbox.stopped
|
|
444
|
-
*
|
|
492
|
+
* events names the kinds it takes, such as sandbox.stopped or headroom.burst_ended, a group
|
|
493
|
+
* of them by its name and .*, such as "headroom.*", which takes the group's kinds added later
|
|
494
|
+
* too, or "*" for every one and any added later, which is what it takes when events is left
|
|
495
|
+
* out. A * anywhere else is refused. The answer holds
|
|
445
496
|
* signingSecret, the one time it is given: each post's X-Agental-Signature is checked
|
|
446
497
|
* against it with verifyWebhook. It is sent once, so a lost answer is not sent again.
|
|
447
498
|
*/
|
package/dist/client.js
CHANGED
|
@@ -426,6 +426,31 @@ export class Agental {
|
|
|
426
426
|
async setAutoReload(dollars) {
|
|
427
427
|
return (await this.http.json({ method: "PUT", path: "/v1/billing/auto-reload", body: { dollars } })).body;
|
|
428
428
|
}
|
|
429
|
+
/**
|
|
430
|
+
* The account's invoices, newest first, read from the payment provider: a plan's months, top-ups
|
|
431
|
+
* and auto-reloads, drafts left out. 25 unless limit says otherwise, 100 at most; pass a page's
|
|
432
|
+
* next as startingAfter for the page after it. An admin is given no pageUrl or pdfUrl.
|
|
433
|
+
*/
|
|
434
|
+
async invoices(options = {}) {
|
|
435
|
+
const query = { limit: options.limit === undefined ? undefined : String(options.limit), startingAfter: options.startingAfter };
|
|
436
|
+
return (await this.http.json({ method: "GET", path: "/v1/billing/invoices", query, replay: true })).body;
|
|
437
|
+
}
|
|
438
|
+
/** Every invoice, newest first, read a page at a time as they are asked for. */
|
|
439
|
+
async *allInvoices(options = {}) {
|
|
440
|
+
let startingAfter;
|
|
441
|
+
for (;;) {
|
|
442
|
+
const page = await this.invoices({ ...options, ...(startingAfter === undefined ? {} : { startingAfter }) });
|
|
443
|
+
yield* page.invoices;
|
|
444
|
+
if (page.next === null) {
|
|
445
|
+
return;
|
|
446
|
+
}
|
|
447
|
+
startingAfter = page.next;
|
|
448
|
+
}
|
|
449
|
+
}
|
|
450
|
+
/** The card the account pays with now, the one an auto-reload charges: its brand, last four, expiry and wallet, or null where none is saved. */
|
|
451
|
+
async card() {
|
|
452
|
+
return (await this.http.json({ method: "GET", path: "/v1/billing/card", replay: true })).body;
|
|
453
|
+
}
|
|
429
454
|
/** The account's mail: the handle every address of its sandboxes carries, what its plan allows, and what it has had of that today. */
|
|
430
455
|
async email() {
|
|
431
456
|
return (await this.http.json({ method: "GET", path: "/v1/email", replay: true })).body;
|
|
@@ -541,6 +566,41 @@ export class Agental {
|
|
|
541
566
|
async deleteTelemetry() {
|
|
542
567
|
await this.http.send({ method: "DELETE", path: "/v1/telemetry" });
|
|
543
568
|
}
|
|
569
|
+
/**
|
|
570
|
+
* The Claude Managed Agents self-hosted environments connected to your account. Each
|
|
571
|
+
* session of one runs its tool calls in a sandbox of your own. Their keys and signing
|
|
572
|
+
* secrets are never shown. Only where policy() says managedAgents.
|
|
573
|
+
*/
|
|
574
|
+
async listClaudeConnections() {
|
|
575
|
+
return (await this.http.json({ method: "GET", path: "/v1/claude/connections", replay: true })).body.data;
|
|
576
|
+
}
|
|
577
|
+
/**
|
|
578
|
+
* Connects a self-hosted environment from the Claude Console: its id, its environment key,
|
|
579
|
+
* and, for a turn to start at once, its webhook's signing secret. The key and secret are
|
|
580
|
+
* kept sealed and never shown again, and the key never goes into a sandbox. Each session
|
|
581
|
+
* gets a sandbox on templateId (the account's default when left out), stopped between turns
|
|
582
|
+
* and deleted once it has slept keepDays (7). Set the answer's webhookUrl as the
|
|
583
|
+
* environment's webhook for session.status_run_started in the Claude Console.
|
|
584
|
+
*/
|
|
585
|
+
async connectClaude(connection) {
|
|
586
|
+
return (await this.http.json({ method: "POST", path: "/v1/claude/connections", body: connection })).body.connection;
|
|
587
|
+
}
|
|
588
|
+
/** One connected environment. */
|
|
589
|
+
async getClaudeConnection(id) {
|
|
590
|
+
return (await this.http.json({ method: "GET", path: `/v1/claude/connections/${encodeURIComponent(id)}`, replay: true })).body.connection;
|
|
591
|
+
}
|
|
592
|
+
/** The sessions of a connected environment that have run here, the latest active first: each one's sandbox, whether it runs or sleeps, when a sleeping one's sandbox is deleted, and why its last turn was not served. */
|
|
593
|
+
async listClaudeSessions(id) {
|
|
594
|
+
return (await this.http.json({ method: "GET", path: `/v1/claude/connections/${encodeURIComponent(id)}/sessions`, replay: true })).body.data;
|
|
595
|
+
}
|
|
596
|
+
/** Changes a connection: a new key or signing secret (null forgets it), another template (null for the default), or keepDays. What is left out stays as it was. */
|
|
597
|
+
async updateClaudeConnection(id, change) {
|
|
598
|
+
return (await this.http.json({ method: "PATCH", path: `/v1/claude/connections/${encodeURIComponent(id)}`, body: change, replay: true })).body.connection;
|
|
599
|
+
}
|
|
600
|
+
/** Disconnects an environment: its key and signing secret are forgotten, and no more of its work is claimed. Its sessions' sandboxes are left as they are. */
|
|
601
|
+
async disconnectClaude(id) {
|
|
602
|
+
await this.http.send({ method: "DELETE", path: `/v1/claude/connections/${encodeURIComponent(id)}` });
|
|
603
|
+
}
|
|
544
604
|
/**
|
|
545
605
|
* GitHub Actions jobs on sandboxes: each repository's pool, how many sandboxes of each size it
|
|
546
606
|
* keeps and the template they are made on. available is false where jobs do not run on
|
|
@@ -584,8 +644,10 @@ export class Agental {
|
|
|
584
644
|
}
|
|
585
645
|
/**
|
|
586
646
|
* Adds a webhook. url is posted each event it takes, and has to be on the public internet.
|
|
587
|
-
* events names the kinds it takes, such as sandbox.stopped
|
|
588
|
-
*
|
|
647
|
+
* events names the kinds it takes, such as sandbox.stopped or headroom.burst_ended, a group
|
|
648
|
+
* of them by its name and .*, such as "headroom.*", which takes the group's kinds added later
|
|
649
|
+
* too, or "*" for every one and any added later, which is what it takes when events is left
|
|
650
|
+
* out. A * anywhere else is refused. The answer holds
|
|
589
651
|
* signingSecret, the one time it is given: each post's X-Agental-Signature is checked
|
|
590
652
|
* against it with verifyWebhook. It is sent once, so a lost answer is not sent again.
|
|
591
653
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -8,5 +8,5 @@ export { Terminal, TERMINAL_CLOSE, TERMINAL_PROTOCOL } from "./terminal.js";
|
|
|
8
8
|
export type { TerminalExit, TerminalOptions, WebSocketConstructor, WebSocketLike } from "./terminal.js";
|
|
9
9
|
export type { TemplateChanges } from "./template.js";
|
|
10
10
|
export type { BurstOptions, CommandLine, CreateOptions, DesktopButton, ExecEvent, ExecOptions, SandboxChanges, ScreenshotOptions, SendEmailOptions, StartOptions, StopOptions, WaitOptions } from "./sandbox.js";
|
|
11
|
-
export type { AccountEmail, ApiKey, ApiKeyAction, ApiKeyPreset, ApiKeyUsage, Billing, BrowserState, BurstFee, BurstQuote, Headroom, HeadroomNow, HeadroomRange, HeadroomStep, Catalog, Region, AutoReload, Checkout, Command, CreateSchedule, CreateApiKey, CreatedApiKey, DesktopLink, DesktopScreenshot, DesktopState, Egress, EgressAccount, EgressInput, EmailMessage, EmailMessageList, EmailMessageSummary, ExecResult, HiddenVariable, HostRoute, Invite, Me, Member, Organization, MetricsAtMoment, MetricsReading, NetworkRule, Operation, PlainVariable, Plan, Policy, Prices, RunningOverTime, SandboxAutoStop, SandboxEmail, SandboxInfo, SandboxSummary, SandboxJob, SandboxJobItem, SandboxJobPreview, SandboxMetrics, SandboxNetwork, SandboxNetworkDetail, SandboxOwnNetwork, SandboxStatus, SandboxTemplate, SandboxUsage, Schedule, ScheduleRun, SecretVariable, SendEmail, SetAutoStop, Size, Snapshot, SshKey, SshState, UpdateSchedule, Team, TeamRole, Telemetry, DataRetention, AccountExport, TelemetryTest, RunsOnRepository, RunsOnRepositories, TemplateApplied, TemplateInfo, TemplateNetwork, TemplateSandbox, TemplateStart, TemplateSsh, Usage, Webhook, WebhookDelivery, } from "./types.js";
|
|
11
|
+
export type { AccountEmail, ApiKey, ApiKeyAction, ApiKeyPreset, ApiKeyUsage, Billing, BrowserState, BurstFee, BurstQuote, Headroom, HeadroomNow, HeadroomRange, HeadroomStep, Catalog, Region, AutoReload, BillingCard, BillingInvoice, BillingInvoices, Checkout, Command, CreateSchedule, CreateApiKey, CreatedApiKey, DesktopLink, DesktopScreenshot, DesktopState, Egress, EgressAccount, EgressInput, EmailMessage, EmailMessageList, EmailMessageSummary, ExecResult, HiddenVariable, HostRoute, Invite, Me, Member, Organization, MetricsAtMoment, MetricsReading, NetworkRule, Operation, PlainVariable, Plan, Policy, Prices, RunningOverTime, SandboxAutoStop, SandboxEmail, SandboxInfo, SandboxSummary, SandboxJob, SandboxJobItem, SandboxJobPreview, SandboxMetrics, SandboxNetwork, SandboxNetworkDetail, SandboxOwnNetwork, SandboxStatus, SandboxTemplate, SandboxUsage, Schedule, ScheduleRun, SecretVariable, SendEmail, SetAutoStop, Size, Snapshot, SshKey, SshState, UpdateSchedule, Team, TeamRole, Telemetry, DataRetention, AccountExport, TelemetryTest, ClaudeConnection, ClaudeSession, RunsOnRepository, RunsOnRepositories, TemplateApplied, TemplateInfo, TemplateNetwork, TemplateSandbox, TemplateStart, TemplateSsh, Usage, Webhook, WebhookDelivery, } from "./types.js";
|
|
12
12
|
export { verifyWebhook } from "./webhooks.js";
|
package/dist/openapi.d.ts
CHANGED
|
@@ -2304,6 +2304,38 @@ export interface paths {
|
|
|
2304
2304
|
patch?: never;
|
|
2305
2305
|
trace?: never;
|
|
2306
2306
|
};
|
|
2307
|
+
"/v1/billing/invoices": {
|
|
2308
|
+
parameters: {
|
|
2309
|
+
query?: never;
|
|
2310
|
+
header?: never;
|
|
2311
|
+
path?: never;
|
|
2312
|
+
cookie?: never;
|
|
2313
|
+
};
|
|
2314
|
+
get: operations["listBillingInvoices"];
|
|
2315
|
+
put?: never;
|
|
2316
|
+
post?: never;
|
|
2317
|
+
delete?: never;
|
|
2318
|
+
options?: never;
|
|
2319
|
+
head?: never;
|
|
2320
|
+
patch?: never;
|
|
2321
|
+
trace?: never;
|
|
2322
|
+
};
|
|
2323
|
+
"/v1/billing/card": {
|
|
2324
|
+
parameters: {
|
|
2325
|
+
query?: never;
|
|
2326
|
+
header?: never;
|
|
2327
|
+
path?: never;
|
|
2328
|
+
cookie?: never;
|
|
2329
|
+
};
|
|
2330
|
+
get: operations["getBillingCard"];
|
|
2331
|
+
put?: never;
|
|
2332
|
+
post?: never;
|
|
2333
|
+
delete?: never;
|
|
2334
|
+
options?: never;
|
|
2335
|
+
head?: never;
|
|
2336
|
+
patch?: never;
|
|
2337
|
+
trace?: never;
|
|
2338
|
+
};
|
|
2307
2339
|
"/v1/cli-sign-ins": {
|
|
2308
2340
|
parameters: {
|
|
2309
2341
|
query?: never;
|
|
@@ -2715,6 +2747,54 @@ export interface paths {
|
|
|
2715
2747
|
patch?: never;
|
|
2716
2748
|
trace?: never;
|
|
2717
2749
|
};
|
|
2750
|
+
"/v1/claude/connections": {
|
|
2751
|
+
parameters: {
|
|
2752
|
+
query?: never;
|
|
2753
|
+
header?: never;
|
|
2754
|
+
path?: never;
|
|
2755
|
+
cookie?: never;
|
|
2756
|
+
};
|
|
2757
|
+
get: operations["listClaudeConnections"];
|
|
2758
|
+
put?: never;
|
|
2759
|
+
post: operations["connectClaude"];
|
|
2760
|
+
delete?: never;
|
|
2761
|
+
options?: never;
|
|
2762
|
+
head?: never;
|
|
2763
|
+
patch?: never;
|
|
2764
|
+
trace?: never;
|
|
2765
|
+
};
|
|
2766
|
+
"/v1/claude/connections/{id}": {
|
|
2767
|
+
parameters: {
|
|
2768
|
+
query?: never;
|
|
2769
|
+
header?: never;
|
|
2770
|
+
path?: never;
|
|
2771
|
+
cookie?: never;
|
|
2772
|
+
};
|
|
2773
|
+
get: operations["getClaudeConnection"];
|
|
2774
|
+
put?: never;
|
|
2775
|
+
post?: never;
|
|
2776
|
+
delete: operations["disconnectClaude"];
|
|
2777
|
+
options?: never;
|
|
2778
|
+
head?: never;
|
|
2779
|
+
patch: operations["updateClaudeConnection"];
|
|
2780
|
+
trace?: never;
|
|
2781
|
+
};
|
|
2782
|
+
"/v1/claude/connections/{id}/sessions": {
|
|
2783
|
+
parameters: {
|
|
2784
|
+
query?: never;
|
|
2785
|
+
header?: never;
|
|
2786
|
+
path?: never;
|
|
2787
|
+
cookie?: never;
|
|
2788
|
+
};
|
|
2789
|
+
get: operations["listClaudeSessions"];
|
|
2790
|
+
put?: never;
|
|
2791
|
+
post?: never;
|
|
2792
|
+
delete?: never;
|
|
2793
|
+
options?: never;
|
|
2794
|
+
head?: never;
|
|
2795
|
+
patch?: never;
|
|
2796
|
+
trace?: never;
|
|
2797
|
+
};
|
|
2718
2798
|
"/v1/burst": {
|
|
2719
2799
|
parameters: {
|
|
2720
2800
|
query?: never;
|
|
@@ -4819,6 +4899,8 @@ export interface components {
|
|
|
4819
4899
|
hiddenVariables: boolean;
|
|
4820
4900
|
/** @description Whether a sandbox's web traffic can leave through a residential address, at $3 a GB: PUT /v1/sandboxes/{id}/egress, and egress on a create or a template. GET /v1/egress says whether the account may. False, asking for it answers 501 residential_egress_unavailable. */
|
|
4821
4901
|
residentialEgress: boolean;
|
|
4902
|
+
/** @description Whether Claude Managed Agents' self-hosted environments can be connected, so that their sessions' tool calls run in this account's sandboxes: /v1/claude/connections. False, those calls answer 501 claude_unavailable. */
|
|
4903
|
+
managedAgents: boolean;
|
|
4822
4904
|
/** @description Whether a sandbox's CPU, memory, disk and network are read and kept: GET /v1/sandboxes/{id}/metrics and GET /v1/metrics. False, both answer 501 metrics_unavailable. GET /v1/metrics/running answers either way. */
|
|
4823
4905
|
metrics: boolean;
|
|
4824
4906
|
/** @description Whether an account can have its sandboxes' metrics and lifecycle events sent to a collector of its own, over OTLP/HTTP: GET, PUT and DELETE /v1/telemetry, and POST /v1/telemetry/test. Metrics are sent only where metrics is true as well. False, those calls answer 501 telemetry_unavailable. */
|
|
@@ -5166,6 +5248,46 @@ export interface components {
|
|
|
5166
5248
|
dollars: number;
|
|
5167
5249
|
} | null;
|
|
5168
5250
|
};
|
|
5251
|
+
BillingInvoices: {
|
|
5252
|
+
invoices: {
|
|
5253
|
+
id: string;
|
|
5254
|
+
/** @description The number on the invoice. Null until it is finalized. */
|
|
5255
|
+
number: string | null;
|
|
5256
|
+
createdAt: string;
|
|
5257
|
+
/**
|
|
5258
|
+
* @description open: not paid yet. void: cancelled, nothing is owed, as a reload whose card declined. uncollectible: written off.
|
|
5259
|
+
* @enum {string}
|
|
5260
|
+
*/
|
|
5261
|
+
status: "open" | "paid" | "void" | "uncollectible";
|
|
5262
|
+
/** @description What it was for, as the invoice says it. */
|
|
5263
|
+
description: string | null;
|
|
5264
|
+
/** @example usd */
|
|
5265
|
+
currency: string;
|
|
5266
|
+
/** @description What it came to, tax included. */
|
|
5267
|
+
totalMicros: number;
|
|
5268
|
+
taxMicros: number;
|
|
5269
|
+
amountPaidMicros: number;
|
|
5270
|
+
/** @description The payment provider's page for it, where an open one is paid. It shows the billing name and address, so it is given to an owner only: null for an admin. */
|
|
5271
|
+
pageUrl: string | null;
|
|
5272
|
+
/** @description Its PDF, an owner's only as pageUrl is. */
|
|
5273
|
+
pdfUrl: string | null;
|
|
5274
|
+
}[];
|
|
5275
|
+
/** @description Pass as startingAfter for the page after this one. Null on the last page. */
|
|
5276
|
+
next: string | null;
|
|
5277
|
+
};
|
|
5278
|
+
BillingCard: {
|
|
5279
|
+
/** @description Null where the account has no card saved. */
|
|
5280
|
+
card: {
|
|
5281
|
+
/** @example visa */
|
|
5282
|
+
brand: string | null;
|
|
5283
|
+
/** @example 4242 */
|
|
5284
|
+
last4: string | null;
|
|
5285
|
+
expMonth: number | null;
|
|
5286
|
+
expYear: number | null;
|
|
5287
|
+
/** @description apple_pay, google_pay or another wallet it is kept in; null for a card typed in. */
|
|
5288
|
+
wallet: string | null;
|
|
5289
|
+
} | null;
|
|
5290
|
+
};
|
|
5169
5291
|
CliSignIn: {
|
|
5170
5292
|
/** @example cli_5d0f3c9a7e214b86a0c1d2e3f4a5b6c7 */
|
|
5171
5293
|
id: string;
|
|
@@ -5469,6 +5591,100 @@ export interface components {
|
|
|
5469
5591
|
/** @description What went wrong, or what the collector said it did not take. */
|
|
5470
5592
|
message: string | null;
|
|
5471
5593
|
};
|
|
5594
|
+
ClaudeConnection: {
|
|
5595
|
+
/** @example ccn_7f3a91c2d04e5b18 */
|
|
5596
|
+
id: string;
|
|
5597
|
+
/**
|
|
5598
|
+
* @description The self-hosted environment at Anthropic whose sessions run in this account's sandboxes.
|
|
5599
|
+
* @example env_01UykHXsjAbCdEfGhIjKlMnO
|
|
5600
|
+
*/
|
|
5601
|
+
environmentId: string;
|
|
5602
|
+
/** @description The template each session's sandbox is made from. Null for the account's default template, and for a template deleted since. */
|
|
5603
|
+
templateId: string | null;
|
|
5604
|
+
/**
|
|
5605
|
+
* @description How many days a sleeping session's stopped sandbox is kept before it is deleted.
|
|
5606
|
+
* @example 7
|
|
5607
|
+
*/
|
|
5608
|
+
keepDays: number;
|
|
5609
|
+
/** @description Whether the webhook's signing secret is kept. Without it no webhook is taken, and sessions are found by a pass every minute alone. */
|
|
5610
|
+
hasWebhookSecret: boolean;
|
|
5611
|
+
/**
|
|
5612
|
+
* @description The address to give the Claude Console as this environment's webhook, for session.status_run_started.
|
|
5613
|
+
* @example https://agental.io/v1/claude/webhook/ccn_7f3a91c2d04e5b18
|
|
5614
|
+
*/
|
|
5615
|
+
webhookUrl: string;
|
|
5616
|
+
createdAt: string;
|
|
5617
|
+
updatedAt: string;
|
|
5618
|
+
};
|
|
5619
|
+
ClaudeConnectInput: {
|
|
5620
|
+
/**
|
|
5621
|
+
* @description A self-hosted environment's id from the Claude Console.
|
|
5622
|
+
* @example env_01UykHXsjAbCdEfGhIjKlMnO
|
|
5623
|
+
*/
|
|
5624
|
+
environmentId: string;
|
|
5625
|
+
/**
|
|
5626
|
+
* @description The environment's key from the Claude Console. It is kept sealed, never shown again, and never put into a sandbox in plain.
|
|
5627
|
+
* @example <ENVIRONMENT_KEY>
|
|
5628
|
+
*/
|
|
5629
|
+
environmentKey: string;
|
|
5630
|
+
/**
|
|
5631
|
+
* @description The webhook's signing secret from the Claude Console. Kept sealed and never shown again.
|
|
5632
|
+
* @example <WEBHOOK_SIGNING_SECRET>
|
|
5633
|
+
*/
|
|
5634
|
+
webhookSecret?: string;
|
|
5635
|
+
/**
|
|
5636
|
+
* @description A template of this account. Left out or null, the account's default template.
|
|
5637
|
+
* @example tpl_97b3405a8aad303a
|
|
5638
|
+
*/
|
|
5639
|
+
templateId?: string | null;
|
|
5640
|
+
/**
|
|
5641
|
+
* @description Days a sleeping session's stopped sandbox is kept: 1 to 90. 7 when left out.
|
|
5642
|
+
* @example 7
|
|
5643
|
+
*/
|
|
5644
|
+
keepDays?: number;
|
|
5645
|
+
};
|
|
5646
|
+
ClaudeSession: {
|
|
5647
|
+
/** @example sesn_015kpQZQkF1Puu8vYEgsmGtY */
|
|
5648
|
+
sessionId: string;
|
|
5649
|
+
/** @description The session's sandbox, or null while one is being made. */
|
|
5650
|
+
sandboxId: string | null;
|
|
5651
|
+
/** @description The sandbox's status now, or null where it was deleted. */
|
|
5652
|
+
sandboxStatus: string | null;
|
|
5653
|
+
/**
|
|
5654
|
+
* @description running while its worker may be up; sleeping once its sandbox is stopped, until its next turn.
|
|
5655
|
+
* @enum {string}
|
|
5656
|
+
*/
|
|
5657
|
+
state: "running" | "sleeping";
|
|
5658
|
+
/** @description When its last turn's worker was started. */
|
|
5659
|
+
lastTurnAt: string | null;
|
|
5660
|
+
lastActiveAt: string;
|
|
5661
|
+
/** @description When its sandbox is deleted, while it sleeps: keepDays after it went to sleep. */
|
|
5662
|
+
deletesAt: string | null;
|
|
5663
|
+
/** @description Why its last turn was not served, such as a sandbox that could not be made. Null when it was. */
|
|
5664
|
+
error: string | null;
|
|
5665
|
+
};
|
|
5666
|
+
ClaudeConnectionChange: {
|
|
5667
|
+
/**
|
|
5668
|
+
* @description The environment's key from the Claude Console. It is kept sealed, never shown again, and never put into a sandbox in plain.
|
|
5669
|
+
* @example <ENVIRONMENT_KEY>
|
|
5670
|
+
*/
|
|
5671
|
+
environmentKey?: string;
|
|
5672
|
+
/**
|
|
5673
|
+
* @description A new signing secret, or null to forget it.
|
|
5674
|
+
* @example <WEBHOOK_SIGNING_SECRET>
|
|
5675
|
+
*/
|
|
5676
|
+
webhookSecret?: string | null;
|
|
5677
|
+
/**
|
|
5678
|
+
* @description A template of this account. Left out or null, the account's default template.
|
|
5679
|
+
* @example tpl_97b3405a8aad303a
|
|
5680
|
+
*/
|
|
5681
|
+
templateId?: string | null;
|
|
5682
|
+
/**
|
|
5683
|
+
* @description Days a sleeping session's stopped sandbox is kept: 1 to 90. 7 when left out.
|
|
5684
|
+
* @example 7
|
|
5685
|
+
*/
|
|
5686
|
+
keepDays?: number;
|
|
5687
|
+
};
|
|
5472
5688
|
Burst: {
|
|
5473
5689
|
/** @description Whether the account is held to its plan: a start past the running count is refused, and a fast one costs a fee. False: what it starts is only measured. */
|
|
5474
5690
|
enforced: boolean;
|
|
@@ -11428,10 +11644,11 @@ export interface operations {
|
|
|
11428
11644
|
*/
|
|
11429
11645
|
url: string;
|
|
11430
11646
|
/**
|
|
11431
|
-
* @description What to send: sandbox.created, sandbox.started, sandbox.stopped, sandbox.archived, sandbox.error, sandbox.moved, sandbox.deleted, sandbox.auto_stop_set, sandbox.labels_changed, prompt.created, template.created, template.updated, template.secrets_changed (named, never with a value), template.labels_changed
|
|
11647
|
+
* @description What to send: sandbox.created, sandbox.started, sandbox.stopped, sandbox.archived, sandbox.error, sandbox.moved, sandbox.deleted, sandbox.auto_stop_set, sandbox.labels_changed, sandbox.scheduled_run, sandbox.schedule_paused, sandbox.low_cpu, prompt.created, email.received, email.delivered, email.bounced, member.invited, member.joined, member.removed, member.role_changed, key.revoked, template.created, template.updated, template.secrets_changed (named, never with a value), template.labels_changed, template.deleted, and Headroom's headroom.burst_started, headroom.burst_ended, headroom.refused, headroom.running_count_reached, headroom.budget_threshold and headroom.budget_reached, which are the organization's and about no sandbox. A group by its name and .*, as headroom.* or sandbox.*, is every event of the group and any added to it later; * alone is every event, which is what is sent when this is left out. A * anywhere else is refused. Each event has the same id in every webhook it is sent to, and a sandbox.* or headroom.* event is sent as a log record to the collector set with PUT /v1/telemetry.
|
|
11432
11648
|
* @example [
|
|
11433
11649
|
* "sandbox.created",
|
|
11434
|
-
* "sandbox.error"
|
|
11650
|
+
* "sandbox.error",
|
|
11651
|
+
* "headroom.*"
|
|
11435
11652
|
* ]
|
|
11436
11653
|
*/
|
|
11437
11654
|
events?: string[];
|
|
@@ -11625,10 +11842,11 @@ export interface operations {
|
|
|
11625
11842
|
*/
|
|
11626
11843
|
url?: string;
|
|
11627
11844
|
/**
|
|
11628
|
-
* @description What to send: sandbox.created, sandbox.started, sandbox.stopped, sandbox.archived, sandbox.error, sandbox.moved, sandbox.deleted, sandbox.auto_stop_set, sandbox.labels_changed, prompt.created, template.created, template.updated, template.secrets_changed (named, never with a value), template.labels_changed
|
|
11845
|
+
* @description What to send: sandbox.created, sandbox.started, sandbox.stopped, sandbox.archived, sandbox.error, sandbox.moved, sandbox.deleted, sandbox.auto_stop_set, sandbox.labels_changed, sandbox.scheduled_run, sandbox.schedule_paused, sandbox.low_cpu, prompt.created, email.received, email.delivered, email.bounced, member.invited, member.joined, member.removed, member.role_changed, key.revoked, template.created, template.updated, template.secrets_changed (named, never with a value), template.labels_changed, template.deleted, and Headroom's headroom.burst_started, headroom.burst_ended, headroom.refused, headroom.running_count_reached, headroom.budget_threshold and headroom.budget_reached, which are the organization's and about no sandbox. A group by its name and .*, as headroom.* or sandbox.*, is every event of the group and any added to it later; * alone is every event, which is what is sent when this is left out. A * anywhere else is refused. Each event has the same id in every webhook it is sent to, and a sandbox.* or headroom.* event is sent as a log record to the collector set with PUT /v1/telemetry.
|
|
11629
11846
|
* @example [
|
|
11630
11847
|
* "sandbox.created",
|
|
11631
|
-
* "sandbox.error"
|
|
11848
|
+
* "sandbox.error",
|
|
11849
|
+
* "headroom.*"
|
|
11632
11850
|
* ]
|
|
11633
11851
|
*/
|
|
11634
11852
|
events?: string[];
|
|
@@ -16326,6 +16544,69 @@ export interface operations {
|
|
|
16326
16544
|
};
|
|
16327
16545
|
};
|
|
16328
16546
|
};
|
|
16547
|
+
listBillingInvoices: {
|
|
16548
|
+
parameters: {
|
|
16549
|
+
query?: {
|
|
16550
|
+
/** @description How many to answer at most, 1 to 100. 25 when left out. */
|
|
16551
|
+
limit?: number;
|
|
16552
|
+
/** @description The next value of the page before, for the page after it. A page may hold fewer than limit, drafts being left out, and still have a next. */
|
|
16553
|
+
startingAfter?: string;
|
|
16554
|
+
};
|
|
16555
|
+
header?: never;
|
|
16556
|
+
path?: never;
|
|
16557
|
+
cookie?: never;
|
|
16558
|
+
};
|
|
16559
|
+
requestBody?: never;
|
|
16560
|
+
responses: {
|
|
16561
|
+
/** @description The account's invoices, newest first, as the payment provider keeps them: a plan's months, top-ups and auto-reloads, drafts left out. Read from it each time; agental keeps none of them. Amounts are millionths of the invoice's currency. */
|
|
16562
|
+
200: {
|
|
16563
|
+
headers: {
|
|
16564
|
+
[name: string]: unknown;
|
|
16565
|
+
};
|
|
16566
|
+
content: {
|
|
16567
|
+
"application/json": components["schemas"]["BillingInvoices"];
|
|
16568
|
+
};
|
|
16569
|
+
};
|
|
16570
|
+
/** @description billing_not_configured: nothing is sold here. */
|
|
16571
|
+
409: {
|
|
16572
|
+
headers: {
|
|
16573
|
+
[name: string]: unknown;
|
|
16574
|
+
};
|
|
16575
|
+
content: {
|
|
16576
|
+
"application/json": components["schemas"]["Error"];
|
|
16577
|
+
};
|
|
16578
|
+
};
|
|
16579
|
+
};
|
|
16580
|
+
};
|
|
16581
|
+
getBillingCard: {
|
|
16582
|
+
parameters: {
|
|
16583
|
+
query?: never;
|
|
16584
|
+
header?: never;
|
|
16585
|
+
path?: never;
|
|
16586
|
+
cookie?: never;
|
|
16587
|
+
};
|
|
16588
|
+
requestBody?: never;
|
|
16589
|
+
responses: {
|
|
16590
|
+
/** @description The card the account pays with now: the one a plan's month, a top-up and an auto-reload charge. Its brand, last four and expiry only, read from the payment provider each time. Changed on the payment provider's page, POST /v1/billing/portal. */
|
|
16591
|
+
200: {
|
|
16592
|
+
headers: {
|
|
16593
|
+
[name: string]: unknown;
|
|
16594
|
+
};
|
|
16595
|
+
content: {
|
|
16596
|
+
"application/json": components["schemas"]["BillingCard"];
|
|
16597
|
+
};
|
|
16598
|
+
};
|
|
16599
|
+
/** @description billing_not_configured: nothing is sold here. */
|
|
16600
|
+
409: {
|
|
16601
|
+
headers: {
|
|
16602
|
+
[name: string]: unknown;
|
|
16603
|
+
};
|
|
16604
|
+
content: {
|
|
16605
|
+
"application/json": components["schemas"]["Error"];
|
|
16606
|
+
};
|
|
16607
|
+
};
|
|
16608
|
+
};
|
|
16609
|
+
};
|
|
16329
16610
|
createCliSignIn: {
|
|
16330
16611
|
parameters: {
|
|
16331
16612
|
query?: never;
|
|
@@ -17982,6 +18263,357 @@ export interface operations {
|
|
|
17982
18263
|
};
|
|
17983
18264
|
};
|
|
17984
18265
|
};
|
|
18266
|
+
listClaudeConnections: {
|
|
18267
|
+
parameters: {
|
|
18268
|
+
query?: never;
|
|
18269
|
+
header?: never;
|
|
18270
|
+
path?: never;
|
|
18271
|
+
cookie?: never;
|
|
18272
|
+
};
|
|
18273
|
+
requestBody?: never;
|
|
18274
|
+
responses: {
|
|
18275
|
+
/** @description The account's connected environments. Their keys and signing secrets are never shown. */
|
|
18276
|
+
200: {
|
|
18277
|
+
headers: {
|
|
18278
|
+
[name: string]: unknown;
|
|
18279
|
+
};
|
|
18280
|
+
content: {
|
|
18281
|
+
"application/json": {
|
|
18282
|
+
data: components["schemas"]["ClaudeConnection"][];
|
|
18283
|
+
};
|
|
18284
|
+
};
|
|
18285
|
+
};
|
|
18286
|
+
/** @description Missing or invalid API key. */
|
|
18287
|
+
401: {
|
|
18288
|
+
headers: {
|
|
18289
|
+
[name: string]: unknown;
|
|
18290
|
+
};
|
|
18291
|
+
content: {
|
|
18292
|
+
"application/json": components["schemas"]["Error"];
|
|
18293
|
+
};
|
|
18294
|
+
};
|
|
18295
|
+
/** @description claude_unavailable: Claude Managed Agents are not served here. GET /v1/policy says so as managedAgents. */
|
|
18296
|
+
501: {
|
|
18297
|
+
headers: {
|
|
18298
|
+
[name: string]: unknown;
|
|
18299
|
+
};
|
|
18300
|
+
content: {
|
|
18301
|
+
"application/json": components["schemas"]["Error"];
|
|
18302
|
+
};
|
|
18303
|
+
};
|
|
18304
|
+
};
|
|
18305
|
+
};
|
|
18306
|
+
connectClaude: {
|
|
18307
|
+
parameters: {
|
|
18308
|
+
query?: never;
|
|
18309
|
+
header?: never;
|
|
18310
|
+
path?: never;
|
|
18311
|
+
cookie?: never;
|
|
18312
|
+
};
|
|
18313
|
+
requestBody: {
|
|
18314
|
+
content: {
|
|
18315
|
+
"application/json": components["schemas"]["ClaudeConnectInput"];
|
|
18316
|
+
};
|
|
18317
|
+
};
|
|
18318
|
+
responses: {
|
|
18319
|
+
/** @description The environment is connected. Set webhookUrl as its webhook in the Claude Console, with session.status_run_started, and give its signing secret here. The key is not tried now: a key Anthropic refuses is said on the connection once its work is claimed. */
|
|
18320
|
+
201: {
|
|
18321
|
+
headers: {
|
|
18322
|
+
[name: string]: unknown;
|
|
18323
|
+
};
|
|
18324
|
+
content: {
|
|
18325
|
+
"application/json": {
|
|
18326
|
+
connection: components["schemas"]["ClaudeConnection"];
|
|
18327
|
+
};
|
|
18328
|
+
};
|
|
18329
|
+
};
|
|
18330
|
+
/** @description invalid_request: the environment's id, its key, the signing secret or keepDays is not of the shape it should be. template_required: the key is limited to templates, the default is not one of them, and no templateId was sent. */
|
|
18331
|
+
400: {
|
|
18332
|
+
headers: {
|
|
18333
|
+
[name: string]: unknown;
|
|
18334
|
+
};
|
|
18335
|
+
content: {
|
|
18336
|
+
"application/json": components["schemas"]["Error"];
|
|
18337
|
+
};
|
|
18338
|
+
};
|
|
18339
|
+
/** @description Missing or invalid API key. */
|
|
18340
|
+
401: {
|
|
18341
|
+
headers: {
|
|
18342
|
+
[name: string]: unknown;
|
|
18343
|
+
};
|
|
18344
|
+
content: {
|
|
18345
|
+
"application/json": components["schemas"]["Error"];
|
|
18346
|
+
};
|
|
18347
|
+
};
|
|
18348
|
+
/** @description role_required: in a team, only an owner or an admin connects an environment. key_action_forbidden: the key may not sandbox.create. */
|
|
18349
|
+
403: {
|
|
18350
|
+
headers: {
|
|
18351
|
+
[name: string]: unknown;
|
|
18352
|
+
};
|
|
18353
|
+
content: {
|
|
18354
|
+
"application/json": components["schemas"]["Error"];
|
|
18355
|
+
};
|
|
18356
|
+
};
|
|
18357
|
+
/** @description template_not_found: no template of this account has that id, or the key does not reach it. */
|
|
18358
|
+
404: {
|
|
18359
|
+
headers: {
|
|
18360
|
+
[name: string]: unknown;
|
|
18361
|
+
};
|
|
18362
|
+
content: {
|
|
18363
|
+
"application/json": components["schemas"]["Error"];
|
|
18364
|
+
};
|
|
18365
|
+
};
|
|
18366
|
+
/** @description environment_connected: this account has connected the environment already. connection_limit_reached: the account has 20 connections. */
|
|
18367
|
+
409: {
|
|
18368
|
+
headers: {
|
|
18369
|
+
[name: string]: unknown;
|
|
18370
|
+
};
|
|
18371
|
+
content: {
|
|
18372
|
+
"application/json": components["schemas"]["Error"];
|
|
18373
|
+
};
|
|
18374
|
+
};
|
|
18375
|
+
/** @description claude_unavailable: Claude Managed Agents are not served here. GET /v1/policy says so as managedAgents. */
|
|
18376
|
+
501: {
|
|
18377
|
+
headers: {
|
|
18378
|
+
[name: string]: unknown;
|
|
18379
|
+
};
|
|
18380
|
+
content: {
|
|
18381
|
+
"application/json": components["schemas"]["Error"];
|
|
18382
|
+
};
|
|
18383
|
+
};
|
|
18384
|
+
};
|
|
18385
|
+
};
|
|
18386
|
+
getClaudeConnection: {
|
|
18387
|
+
parameters: {
|
|
18388
|
+
query?: never;
|
|
18389
|
+
header?: never;
|
|
18390
|
+
path: {
|
|
18391
|
+
id: string;
|
|
18392
|
+
};
|
|
18393
|
+
cookie?: never;
|
|
18394
|
+
};
|
|
18395
|
+
requestBody?: never;
|
|
18396
|
+
responses: {
|
|
18397
|
+
/** @description The connection. */
|
|
18398
|
+
200: {
|
|
18399
|
+
headers: {
|
|
18400
|
+
[name: string]: unknown;
|
|
18401
|
+
};
|
|
18402
|
+
content: {
|
|
18403
|
+
"application/json": {
|
|
18404
|
+
connection: components["schemas"]["ClaudeConnection"];
|
|
18405
|
+
};
|
|
18406
|
+
};
|
|
18407
|
+
};
|
|
18408
|
+
/** @description Missing or invalid API key. */
|
|
18409
|
+
401: {
|
|
18410
|
+
headers: {
|
|
18411
|
+
[name: string]: unknown;
|
|
18412
|
+
};
|
|
18413
|
+
content: {
|
|
18414
|
+
"application/json": components["schemas"]["Error"];
|
|
18415
|
+
};
|
|
18416
|
+
};
|
|
18417
|
+
/** @description not_found: no connection of this account has that id. */
|
|
18418
|
+
404: {
|
|
18419
|
+
headers: {
|
|
18420
|
+
[name: string]: unknown;
|
|
18421
|
+
};
|
|
18422
|
+
content: {
|
|
18423
|
+
"application/json": components["schemas"]["Error"];
|
|
18424
|
+
};
|
|
18425
|
+
};
|
|
18426
|
+
/** @description claude_unavailable: Claude Managed Agents are not served here. GET /v1/policy says so as managedAgents. */
|
|
18427
|
+
501: {
|
|
18428
|
+
headers: {
|
|
18429
|
+
[name: string]: unknown;
|
|
18430
|
+
};
|
|
18431
|
+
content: {
|
|
18432
|
+
"application/json": components["schemas"]["Error"];
|
|
18433
|
+
};
|
|
18434
|
+
};
|
|
18435
|
+
};
|
|
18436
|
+
};
|
|
18437
|
+
disconnectClaude: {
|
|
18438
|
+
parameters: {
|
|
18439
|
+
query?: never;
|
|
18440
|
+
header?: never;
|
|
18441
|
+
path: {
|
|
18442
|
+
id: string;
|
|
18443
|
+
};
|
|
18444
|
+
cookie?: never;
|
|
18445
|
+
};
|
|
18446
|
+
requestBody?: never;
|
|
18447
|
+
responses: {
|
|
18448
|
+
/** @description The environment is disconnected, and its key and signing secret are forgotten. Its sessions' sandboxes are left as they are. */
|
|
18449
|
+
204: {
|
|
18450
|
+
headers: {
|
|
18451
|
+
[name: string]: unknown;
|
|
18452
|
+
};
|
|
18453
|
+
content?: never;
|
|
18454
|
+
};
|
|
18455
|
+
/** @description Missing or invalid API key. */
|
|
18456
|
+
401: {
|
|
18457
|
+
headers: {
|
|
18458
|
+
[name: string]: unknown;
|
|
18459
|
+
};
|
|
18460
|
+
content: {
|
|
18461
|
+
"application/json": components["schemas"]["Error"];
|
|
18462
|
+
};
|
|
18463
|
+
};
|
|
18464
|
+
/** @description role_required: in a team, only an owner or an admin disconnects an environment. */
|
|
18465
|
+
403: {
|
|
18466
|
+
headers: {
|
|
18467
|
+
[name: string]: unknown;
|
|
18468
|
+
};
|
|
18469
|
+
content: {
|
|
18470
|
+
"application/json": components["schemas"]["Error"];
|
|
18471
|
+
};
|
|
18472
|
+
};
|
|
18473
|
+
/** @description not_found: no connection of this account has that id. */
|
|
18474
|
+
404: {
|
|
18475
|
+
headers: {
|
|
18476
|
+
[name: string]: unknown;
|
|
18477
|
+
};
|
|
18478
|
+
content: {
|
|
18479
|
+
"application/json": components["schemas"]["Error"];
|
|
18480
|
+
};
|
|
18481
|
+
};
|
|
18482
|
+
/** @description claude_unavailable: Claude Managed Agents are not served here. GET /v1/policy says so as managedAgents. */
|
|
18483
|
+
501: {
|
|
18484
|
+
headers: {
|
|
18485
|
+
[name: string]: unknown;
|
|
18486
|
+
};
|
|
18487
|
+
content: {
|
|
18488
|
+
"application/json": components["schemas"]["Error"];
|
|
18489
|
+
};
|
|
18490
|
+
};
|
|
18491
|
+
};
|
|
18492
|
+
};
|
|
18493
|
+
updateClaudeConnection: {
|
|
18494
|
+
parameters: {
|
|
18495
|
+
query?: never;
|
|
18496
|
+
header?: never;
|
|
18497
|
+
path: {
|
|
18498
|
+
id: string;
|
|
18499
|
+
};
|
|
18500
|
+
cookie?: never;
|
|
18501
|
+
};
|
|
18502
|
+
requestBody: {
|
|
18503
|
+
content: {
|
|
18504
|
+
"application/json": components["schemas"]["ClaudeConnectionChange"];
|
|
18505
|
+
};
|
|
18506
|
+
};
|
|
18507
|
+
responses: {
|
|
18508
|
+
/** @description The connection, changed: a new key or signing secret, another template, or another keepDays. What is left out stays as it was. */
|
|
18509
|
+
200: {
|
|
18510
|
+
headers: {
|
|
18511
|
+
[name: string]: unknown;
|
|
18512
|
+
};
|
|
18513
|
+
content: {
|
|
18514
|
+
"application/json": {
|
|
18515
|
+
connection: components["schemas"]["ClaudeConnection"];
|
|
18516
|
+
};
|
|
18517
|
+
};
|
|
18518
|
+
};
|
|
18519
|
+
/** @description invalid_request: the key, the signing secret or keepDays is not of the shape it should be. template_required: templateId is null, the key is limited to templates, and the default is not one of them. */
|
|
18520
|
+
400: {
|
|
18521
|
+
headers: {
|
|
18522
|
+
[name: string]: unknown;
|
|
18523
|
+
};
|
|
18524
|
+
content: {
|
|
18525
|
+
"application/json": components["schemas"]["Error"];
|
|
18526
|
+
};
|
|
18527
|
+
};
|
|
18528
|
+
/** @description Missing or invalid API key. */
|
|
18529
|
+
401: {
|
|
18530
|
+
headers: {
|
|
18531
|
+
[name: string]: unknown;
|
|
18532
|
+
};
|
|
18533
|
+
content: {
|
|
18534
|
+
"application/json": components["schemas"]["Error"];
|
|
18535
|
+
};
|
|
18536
|
+
};
|
|
18537
|
+
/** @description role_required: in a team, only an owner or an admin changes a connection. key_action_forbidden: the key may not sandbox.create. */
|
|
18538
|
+
403: {
|
|
18539
|
+
headers: {
|
|
18540
|
+
[name: string]: unknown;
|
|
18541
|
+
};
|
|
18542
|
+
content: {
|
|
18543
|
+
"application/json": components["schemas"]["Error"];
|
|
18544
|
+
};
|
|
18545
|
+
};
|
|
18546
|
+
/** @description not_found: no connection of this account has that id. template_not_found: no template of this account has that id, or the key does not reach it. */
|
|
18547
|
+
404: {
|
|
18548
|
+
headers: {
|
|
18549
|
+
[name: string]: unknown;
|
|
18550
|
+
};
|
|
18551
|
+
content: {
|
|
18552
|
+
"application/json": components["schemas"]["Error"];
|
|
18553
|
+
};
|
|
18554
|
+
};
|
|
18555
|
+
/** @description claude_unavailable: Claude Managed Agents are not served here. GET /v1/policy says so as managedAgents. */
|
|
18556
|
+
501: {
|
|
18557
|
+
headers: {
|
|
18558
|
+
[name: string]: unknown;
|
|
18559
|
+
};
|
|
18560
|
+
content: {
|
|
18561
|
+
"application/json": components["schemas"]["Error"];
|
|
18562
|
+
};
|
|
18563
|
+
};
|
|
18564
|
+
};
|
|
18565
|
+
};
|
|
18566
|
+
listClaudeSessions: {
|
|
18567
|
+
parameters: {
|
|
18568
|
+
query?: never;
|
|
18569
|
+
header?: never;
|
|
18570
|
+
path: {
|
|
18571
|
+
id: string;
|
|
18572
|
+
};
|
|
18573
|
+
cookie?: never;
|
|
18574
|
+
};
|
|
18575
|
+
requestBody?: never;
|
|
18576
|
+
responses: {
|
|
18577
|
+
/** @description The sessions of this environment that have run here, the latest active first, at most 200: each one's sandbox, whether it runs or sleeps, and why its last turn was not served, where it was not. */
|
|
18578
|
+
200: {
|
|
18579
|
+
headers: {
|
|
18580
|
+
[name: string]: unknown;
|
|
18581
|
+
};
|
|
18582
|
+
content: {
|
|
18583
|
+
"application/json": {
|
|
18584
|
+
data: components["schemas"]["ClaudeSession"][];
|
|
18585
|
+
};
|
|
18586
|
+
};
|
|
18587
|
+
};
|
|
18588
|
+
/** @description Missing or invalid API key. */
|
|
18589
|
+
401: {
|
|
18590
|
+
headers: {
|
|
18591
|
+
[name: string]: unknown;
|
|
18592
|
+
};
|
|
18593
|
+
content: {
|
|
18594
|
+
"application/json": components["schemas"]["Error"];
|
|
18595
|
+
};
|
|
18596
|
+
};
|
|
18597
|
+
/** @description not_found: no connection of this account has that id. */
|
|
18598
|
+
404: {
|
|
18599
|
+
headers: {
|
|
18600
|
+
[name: string]: unknown;
|
|
18601
|
+
};
|
|
18602
|
+
content: {
|
|
18603
|
+
"application/json": components["schemas"]["Error"];
|
|
18604
|
+
};
|
|
18605
|
+
};
|
|
18606
|
+
/** @description claude_unavailable: Claude Managed Agents are not served here. GET /v1/policy says so as managedAgents. */
|
|
18607
|
+
501: {
|
|
18608
|
+
headers: {
|
|
18609
|
+
[name: string]: unknown;
|
|
18610
|
+
};
|
|
18611
|
+
content: {
|
|
18612
|
+
"application/json": components["schemas"]["Error"];
|
|
18613
|
+
};
|
|
18614
|
+
};
|
|
18615
|
+
};
|
|
18616
|
+
};
|
|
17985
18617
|
getBurst: {
|
|
17986
18618
|
parameters: {
|
|
17987
18619
|
query?: {
|
package/dist/types.d.ts
CHANGED
|
@@ -149,6 +149,10 @@ export type DataRetention = Schemas["DataRetention"];
|
|
|
149
149
|
export type AccountExport = Schemas["AccountExport"];
|
|
150
150
|
/** What your collector answered one empty export. */
|
|
151
151
|
export type TelemetryTest = Schemas["TelemetryTest"];
|
|
152
|
+
/** A Claude Managed Agents self-hosted environment connected to your account: its sessions' tool calls run in your sandboxes. Its key and signing secret are never shown. */
|
|
153
|
+
export type ClaudeConnection = Schemas["ClaudeConnection"];
|
|
154
|
+
/** A session of a connected environment that has run here: its sandbox, whether it runs or sleeps, and why its last turn was not served. */
|
|
155
|
+
export type ClaudeSession = Schemas["ClaudeSession"];
|
|
152
156
|
/** A repository's runs-on pool: how many sandboxes of each size it keeps, the template they are made on, and the ones it has. */
|
|
153
157
|
export type RunsOnRepository = Schemas["RunsOnRepository"];
|
|
154
158
|
/** Each repository's runs-on pool, and the size a pool keeps where none was set. */
|
|
@@ -166,6 +170,12 @@ export type Billing = Omit<Schemas["Billing"], "plan" | "discount" | "sandboxesA
|
|
|
166
170
|
export type Checkout = Schemas["Checkout"];
|
|
167
171
|
/** The auto-reload as it is now: the top-up the saved card is charged for when the credits run out, or null while it is off. */
|
|
168
172
|
export type AutoReload = Schemas["AutoReload"];
|
|
173
|
+
/** A page of the account's invoices, newest first, and the value to pass as startingAfter for the page after it, null on the last. */
|
|
174
|
+
export type BillingInvoices = Schemas["BillingInvoices"];
|
|
175
|
+
/** An invoice: its number, state, what it was for, what it came to in millionths, and the payment provider's page and PDF for it (an owner's only). */
|
|
176
|
+
export type BillingInvoice = Schemas["BillingInvoices"]["invoices"][number];
|
|
177
|
+
/** The card the account pays with now, or null where it has none: brand, last four, expiry and wallet only. */
|
|
178
|
+
export type BillingCard = Schemas["BillingCard"];
|
|
169
179
|
/** Whether mail is on for a sandbox, and the domain its addresses end in. */
|
|
170
180
|
export type SandboxEmail = Schemas["SandboxEmail"];
|
|
171
181
|
/** A message as a list gives it: who it is from and for, what was made of its sender, and where a sent one has got to. */
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** This package's version, as package.json says it. A test holds the two to the same. */
|
|
2
|
-
export declare const VERSION = "0.
|
|
2
|
+
export declare const VERSION = "0.7.0";
|
package/dist/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** This package's version, as package.json says it. A test holds the two to the same. */
|
|
2
|
-
export const VERSION = "0.
|
|
2
|
+
export const VERSION = "0.7.0";
|
package/package.json
CHANGED