@alpic-ai/api 0.0.0-dev.gf73de62 → 0.0.0-dev.gf73e9fe
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/dist/index.d.mts +647 -85
- package/dist/index.mjs +519 -95
- package/package.json +5 -5
package/dist/index.mjs
CHANGED
|
@@ -179,6 +179,7 @@ const PLATFORM_LABELS = {
|
|
|
179
179
|
};
|
|
180
180
|
const WAF_PLATFORMS = [
|
|
181
181
|
"akamai",
|
|
182
|
+
"cato",
|
|
182
183
|
"cloudflare",
|
|
183
184
|
"fastly"
|
|
184
185
|
];
|
|
@@ -256,6 +257,25 @@ z.object({
|
|
|
256
257
|
clientSecret: z.string(),
|
|
257
258
|
clientScopes: z.array(z.string())
|
|
258
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
259
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
280
|
"ongoing",
|
|
261
281
|
"deployed",
|
|
@@ -402,12 +422,13 @@ z.object({
|
|
|
402
422
|
collectUserData: z.boolean(),
|
|
403
423
|
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
404
424
|
});
|
|
405
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
406
426
|
id: z.string(),
|
|
407
427
|
createdAt: z.coerce.date(),
|
|
408
428
|
environmentId: z.string(),
|
|
409
429
|
content: z.string(),
|
|
410
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
411
432
|
});
|
|
412
433
|
z.object({
|
|
413
434
|
content: z.string(),
|
|
@@ -423,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
423
444
|
"pink",
|
|
424
445
|
"gray"
|
|
425
446
|
]);
|
|
426
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
427
448
|
const intentCategorySchema = z.object({
|
|
428
449
|
id: z.string(),
|
|
429
450
|
createdAt: z.coerce.date(),
|
|
@@ -431,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
431
452
|
name: z.string(),
|
|
432
453
|
color: intentCategoryColorSchema
|
|
433
454
|
});
|
|
434
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
435
456
|
id: z.string(),
|
|
436
457
|
name: z.string(),
|
|
437
458
|
color: intentCategoryColorSchema,
|
|
@@ -443,6 +464,7 @@ z.object({
|
|
|
443
464
|
environmentId: z.string(),
|
|
444
465
|
toolName: z.string(),
|
|
445
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
446
468
|
categories: z.array(intentCategorySchema)
|
|
447
469
|
});
|
|
448
470
|
const signalCategorySchema = z.object({
|
|
@@ -501,12 +523,262 @@ z.object({
|
|
|
501
523
|
createdAt: z.coerce.date(),
|
|
502
524
|
updatedAt: z.coerce.date()
|
|
503
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
504
536
|
z.enum([
|
|
505
537
|
"INFO",
|
|
506
538
|
"WARNING",
|
|
507
539
|
"DEBUG",
|
|
508
540
|
"ERROR"
|
|
509
541
|
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
510
782
|
const runtimeSchema = z.enum([
|
|
511
783
|
"python3.13",
|
|
512
784
|
"python3.14",
|
|
@@ -1156,6 +1428,11 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1156
1428
|
});
|
|
1157
1429
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1158
1430
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1431
|
+
z.literal([
|
|
1432
|
+
100,
|
|
1433
|
+
75,
|
|
1434
|
+
50
|
|
1435
|
+
]);
|
|
1159
1436
|
const subscriptionPlanSchema = z.enum([
|
|
1160
1437
|
"pro",
|
|
1161
1438
|
"business",
|
|
@@ -1167,17 +1444,49 @@ const customerCreditsSchema = z.object({
|
|
|
1167
1444
|
expiresAt: z.number().nullable(),
|
|
1168
1445
|
currency: z.string()
|
|
1169
1446
|
});
|
|
1170
|
-
const customerUsageSchema = z.object({
|
|
1171
|
-
amountInCents: z.number(),
|
|
1172
|
-
currency: z.string(),
|
|
1173
|
-
periodEnd: z.number()
|
|
1174
|
-
});
|
|
1175
1447
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1176
1448
|
z.object({
|
|
1177
1449
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1178
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1179
1450
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1180
1451
|
});
|
|
1452
|
+
const telemetrySignalSchema = z.enum([
|
|
1453
|
+
"logs",
|
|
1454
|
+
"metrics",
|
|
1455
|
+
"traces"
|
|
1456
|
+
]);
|
|
1457
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1458
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1459
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1460
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1461
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1462
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1463
|
+
id: z.string(),
|
|
1464
|
+
name: otlpHeaderNameSchema,
|
|
1465
|
+
value: otlpHeaderValueSchema,
|
|
1466
|
+
isSecret: z.boolean()
|
|
1467
|
+
});
|
|
1468
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1469
|
+
"credentials",
|
|
1470
|
+
"wrong-path",
|
|
1471
|
+
"wrong-protocol",
|
|
1472
|
+
"invalid-payload",
|
|
1473
|
+
"partial-rejection",
|
|
1474
|
+
"blocked-target",
|
|
1475
|
+
"timeout",
|
|
1476
|
+
"unreachable",
|
|
1477
|
+
"receiver-error",
|
|
1478
|
+
"unexpected-status"
|
|
1479
|
+
]);
|
|
1480
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1481
|
+
z.object({
|
|
1482
|
+
id: z.string(),
|
|
1483
|
+
signal: telemetrySignalSchema,
|
|
1484
|
+
endpoint: otlpEndpointSchema,
|
|
1485
|
+
protocol: otlpProtocolSchema,
|
|
1486
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1487
|
+
status: telemetryDestinationStatusSchema,
|
|
1488
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1489
|
+
});
|
|
1181
1490
|
//#endregion
|
|
1182
1491
|
//#region src/auth-scope.ts
|
|
1183
1492
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1304,21 +1613,20 @@ const deploymentSchema = z.object({
|
|
|
1304
1613
|
isCurrent: z.boolean(),
|
|
1305
1614
|
deploymentPageUrl: z.url().nullable()
|
|
1306
1615
|
});
|
|
1307
|
-
const
|
|
1616
|
+
const isValidTimeInput = (value) => {
|
|
1308
1617
|
if (ms(value) !== void 0) return true;
|
|
1309
1618
|
return !Number.isNaN(new Date(value).getTime());
|
|
1310
1619
|
};
|
|
1311
|
-
const
|
|
1620
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1621
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1622
|
+
const createEnvironmentContractV1 = base.route({
|
|
1312
1623
|
path: "/v1/environments",
|
|
1313
1624
|
method: "POST",
|
|
1314
1625
|
summary: "Create an environment",
|
|
1315
1626
|
description: "Create an environment for a project",
|
|
1316
1627
|
tags: ["environments"],
|
|
1317
1628
|
successDescription: "The environment has been created successfully"
|
|
1318
|
-
}).errors({
|
|
1319
|
-
NOT_FOUND: {},
|
|
1320
|
-
BAD_REQUEST: {}
|
|
1321
|
-
}).input(z.object({
|
|
1629
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1322
1630
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1323
1631
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1324
1632
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1331,7 +1639,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1331
1639
|
createdAt: z.coerce.date(),
|
|
1332
1640
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1333
1641
|
}));
|
|
1334
|
-
const getEnvironmentContractV1 =
|
|
1642
|
+
const getEnvironmentContractV1 = base.route({
|
|
1335
1643
|
path: "/v1/environments/{environmentId}",
|
|
1336
1644
|
method: "GET",
|
|
1337
1645
|
summary: "Get an environment",
|
|
@@ -1388,7 +1696,7 @@ const projectOutputSchema = z.object({
|
|
|
1388
1696
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1389
1697
|
environments: z.array(environmentSchema)
|
|
1390
1698
|
});
|
|
1391
|
-
const getProjectContractV1 =
|
|
1699
|
+
const getProjectContractV1 = base.route({
|
|
1392
1700
|
path: "/v1/projects/{projectId}",
|
|
1393
1701
|
method: "GET",
|
|
1394
1702
|
summary: "Get a project",
|
|
@@ -1396,18 +1704,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1396
1704
|
tags: ["projects"],
|
|
1397
1705
|
successDescription: "The project details"
|
|
1398
1706
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1399
|
-
const listProjectsContractV1 =
|
|
1707
|
+
const listProjectsContractV1 = base.route({
|
|
1400
1708
|
path: "/v1/projects",
|
|
1401
1709
|
method: "GET",
|
|
1402
1710
|
summary: "List projects",
|
|
1403
1711
|
description: "List all projects for a team",
|
|
1404
1712
|
tags: ["projects"],
|
|
1405
1713
|
successDescription: "The list of projects"
|
|
1406
|
-
}).errors({
|
|
1407
|
-
|
|
1408
|
-
BAD_REQUEST: {}
|
|
1409
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1410
|
-
const createProjectContractV1 = oc.route({
|
|
1714
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1715
|
+
const createProjectContractV1 = base.route({
|
|
1411
1716
|
path: "/v1/projects",
|
|
1412
1717
|
method: "POST",
|
|
1413
1718
|
summary: "Create a project",
|
|
@@ -1416,7 +1721,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1416
1721
|
successDescription: "The project has been created successfully"
|
|
1417
1722
|
}).errors({
|
|
1418
1723
|
NOT_FOUND: {},
|
|
1419
|
-
BAD_REQUEST: {},
|
|
1420
1724
|
FORBIDDEN: {}
|
|
1421
1725
|
}).input(z.object({
|
|
1422
1726
|
teamId: z.string().optional(),
|
|
@@ -1457,7 +1761,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1457
1761
|
isSecret: z.boolean(),
|
|
1458
1762
|
createdAt: z.coerce.date()
|
|
1459
1763
|
});
|
|
1460
|
-
const listEnvironmentVariablesContractV1 =
|
|
1764
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1461
1765
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1462
1766
|
method: "GET",
|
|
1463
1767
|
summary: "List environment variables",
|
|
@@ -1465,48 +1769,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1465
1769
|
tags: ["environments"],
|
|
1466
1770
|
successDescription: "The list of environment variables"
|
|
1467
1771
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1468
|
-
const createEnvironmentVariablesContractV1 =
|
|
1772
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1469
1773
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1470
1774
|
method: "POST",
|
|
1471
1775
|
summary: "Add environment variables",
|
|
1472
1776
|
description: "Add one or more environment variables to an environment",
|
|
1473
1777
|
tags: ["environments"],
|
|
1474
1778
|
successDescription: "The environment variables have been added successfully"
|
|
1475
|
-
}).errors({
|
|
1476
|
-
NOT_FOUND: {},
|
|
1477
|
-
BAD_REQUEST: {}
|
|
1478
|
-
}).input(z.object({
|
|
1779
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1479
1780
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1480
1781
|
environmentVariables: environmentVariablesSchema
|
|
1481
1782
|
})).output(z.object({ success: z.literal(true) }));
|
|
1482
|
-
const updateEnvironmentVariableContractV1 =
|
|
1783
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1483
1784
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1484
1785
|
method: "PATCH",
|
|
1485
1786
|
summary: "Update an environment variable",
|
|
1486
1787
|
description: "Update an environment variable by ID",
|
|
1487
1788
|
tags: ["environments"],
|
|
1488
1789
|
successDescription: "The environment variable has been updated successfully"
|
|
1489
|
-
}).errors({
|
|
1490
|
-
NOT_FOUND: {},
|
|
1491
|
-
BAD_REQUEST: {}
|
|
1492
|
-
}).input(z.object({
|
|
1790
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1493
1791
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1494
1792
|
key: environmentVariableSchema.shape.key,
|
|
1495
1793
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1496
1794
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1497
1795
|
})).output(z.object({ success: z.literal(true) }));
|
|
1498
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1796
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1499
1797
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1500
1798
|
method: "DELETE",
|
|
1501
1799
|
summary: "Delete an environment variable",
|
|
1502
1800
|
description: "Delete an environment variable by ID",
|
|
1503
1801
|
tags: ["environments"],
|
|
1504
1802
|
successDescription: "The environment variable has been deleted successfully"
|
|
1505
|
-
}).errors({
|
|
1506
|
-
|
|
1507
|
-
BAD_REQUEST: {}
|
|
1508
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1509
|
-
const deleteProjectContractV1 = oc.route({
|
|
1803
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1804
|
+
const deleteProjectContractV1 = base.route({
|
|
1510
1805
|
path: "/v1/projects/{projectId}",
|
|
1511
1806
|
method: "DELETE",
|
|
1512
1807
|
summary: "Delete a project",
|
|
@@ -1514,7 +1809,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1514
1809
|
tags: ["projects"],
|
|
1515
1810
|
successDescription: "The project has been deleted successfully"
|
|
1516
1811
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1517
|
-
const updateProjectContractV1 =
|
|
1812
|
+
const updateProjectContractV1 = base.route({
|
|
1518
1813
|
path: "/v1/projects/{projectId}",
|
|
1519
1814
|
method: "PATCH",
|
|
1520
1815
|
summary: "Update a project",
|
|
@@ -1523,14 +1818,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1523
1818
|
successDescription: "The project has been updated successfully"
|
|
1524
1819
|
}).errors({
|
|
1525
1820
|
NOT_FOUND: {},
|
|
1526
|
-
BAD_REQUEST: {},
|
|
1527
1821
|
FORBIDDEN: {}
|
|
1528
1822
|
}).input(z.object({
|
|
1529
1823
|
projectId: z.string().describe("The ID of the project"),
|
|
1530
1824
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1531
1825
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1532
1826
|
})).output(projectOutputSchema);
|
|
1533
|
-
const deployEnvironmentContractV1 =
|
|
1827
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1534
1828
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1535
1829
|
method: "POST",
|
|
1536
1830
|
summary: "Deploy an environment",
|
|
@@ -1539,29 +1833,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1539
1833
|
successDescription: "The environment has been deployed successfully"
|
|
1540
1834
|
}).errors({
|
|
1541
1835
|
NOT_FOUND: {},
|
|
1542
|
-
BAD_REQUEST: {},
|
|
1543
1836
|
CONFLICT: {}
|
|
1544
1837
|
}).input(z.object({
|
|
1545
1838
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1546
1839
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1547
1840
|
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1548
1841
|
})).output(deploymentSchema);
|
|
1549
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1842
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1550
1843
|
path: "/v1/deployments/upload",
|
|
1551
1844
|
method: "POST",
|
|
1552
1845
|
summary: "Upload deployment artifacts",
|
|
1553
1846
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1554
1847
|
tags: ["deployments"],
|
|
1555
1848
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1556
|
-
}).errors({
|
|
1557
|
-
NOT_FOUND: {},
|
|
1558
|
-
BAD_REQUEST: {}
|
|
1559
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1849
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1560
1850
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1561
1851
|
token: z.string().describe("Token to identify the source archive"),
|
|
1562
1852
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1563
1853
|
}));
|
|
1564
|
-
const listDeploymentsContractV1 =
|
|
1854
|
+
const listDeploymentsContractV1 = base.route({
|
|
1565
1855
|
path: "/v1/projects/{projectId}/deployments",
|
|
1566
1856
|
method: "GET",
|
|
1567
1857
|
summary: "List project deployments",
|
|
@@ -1573,7 +1863,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1573
1863
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1574
1864
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1575
1865
|
})).output(z.array(deploymentSchema));
|
|
1576
|
-
const getDeploymentContractV1 =
|
|
1866
|
+
const getDeploymentContractV1 = base.route({
|
|
1577
1867
|
path: "/v1/deployments/{deploymentId}",
|
|
1578
1868
|
method: "GET",
|
|
1579
1869
|
summary: "Get a deployment",
|
|
@@ -1596,20 +1886,17 @@ const logEntrySchema = z.object({
|
|
|
1596
1886
|
method: z.string().optional(),
|
|
1597
1887
|
durationInMs: z.number().optional()
|
|
1598
1888
|
});
|
|
1599
|
-
const getLogsContractV1 =
|
|
1889
|
+
const getLogsContractV1 = base.route({
|
|
1600
1890
|
path: "/v1/environments/{environmentId}/logs",
|
|
1601
1891
|
method: "GET",
|
|
1602
1892
|
summary: "Get logs",
|
|
1603
1893
|
description: "Get logs for an environment",
|
|
1604
1894
|
tags: ["environments"],
|
|
1605
1895
|
successDescription: "The logs"
|
|
1606
|
-
}).errors({
|
|
1607
|
-
NOT_FOUND: {},
|
|
1608
|
-
BAD_REQUEST: {}
|
|
1609
|
-
}).input(z.object({
|
|
1896
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1610
1897
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1611
|
-
since:
|
|
1612
|
-
until:
|
|
1898
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1899
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1613
1900
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1614
1901
|
level: z.array(z.enum([
|
|
1615
1902
|
"INFO",
|
|
@@ -1623,17 +1910,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1623
1910
|
logs: z.array(logEntrySchema),
|
|
1624
1911
|
nextToken: z.string().nullable()
|
|
1625
1912
|
}));
|
|
1626
|
-
const getLatestLogsContractV1 =
|
|
1913
|
+
const getLatestLogsContractV1 = base.route({
|
|
1627
1914
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1628
1915
|
method: "GET",
|
|
1629
1916
|
summary: "Get latest logs",
|
|
1630
1917
|
description: "Get the N most recent logs for an environment",
|
|
1631
1918
|
tags: ["environments"],
|
|
1632
1919
|
successDescription: "The latest logs"
|
|
1633
|
-
}).errors({
|
|
1634
|
-
NOT_FOUND: {},
|
|
1635
|
-
BAD_REQUEST: {}
|
|
1636
|
-
}).input(z.object({
|
|
1920
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1637
1921
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1638
1922
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1639
1923
|
level: z.array(z.enum([
|
|
@@ -1644,7 +1928,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1644
1928
|
])).optional().describe("Filter by log level"),
|
|
1645
1929
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1646
1930
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1647
|
-
const getDeploymentLogsContractV1 =
|
|
1931
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1648
1932
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1649
1933
|
method: "GET",
|
|
1650
1934
|
summary: "Get deployment logs",
|
|
@@ -1671,22 +1955,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1671
1955
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1672
1956
|
task_count: z.array(analyticsDataPointSchema)
|
|
1673
1957
|
});
|
|
1674
|
-
const getProjectAnalyticsContractV1 =
|
|
1958
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1675
1959
|
path: "/v1/analytics/{projectId}",
|
|
1676
1960
|
method: "GET",
|
|
1677
1961
|
summary: "Get project analytics",
|
|
1678
1962
|
description: "Get analytics data for a project over a time range",
|
|
1679
1963
|
tags: ["analytics"],
|
|
1680
1964
|
successDescription: "The project analytics data"
|
|
1681
|
-
}).errors({
|
|
1682
|
-
NOT_FOUND: {},
|
|
1683
|
-
BAD_REQUEST: {}
|
|
1684
|
-
}).input(z.object({
|
|
1965
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1685
1966
|
projectId: z.string().describe("The ID of the project"),
|
|
1686
1967
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1687
1968
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1688
1969
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1689
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
1970
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => Intl.supportedValuesOf("timeZone").includes(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1690
1971
|
metadata: z.object({
|
|
1691
1972
|
startTimestamp: z.number(),
|
|
1692
1973
|
endTimestamp: z.number(),
|
|
@@ -1696,7 +1977,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1696
1977
|
}),
|
|
1697
1978
|
timeSeries: analyticsTimeSeriesSchema
|
|
1698
1979
|
}));
|
|
1699
|
-
const
|
|
1980
|
+
const paginatedInsightsInputShape = {
|
|
1981
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1982
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1983
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1984
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1985
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1986
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1987
|
+
};
|
|
1988
|
+
const listIntentsContractV1 = base.route({
|
|
1989
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1990
|
+
method: "GET",
|
|
1991
|
+
summary: "List intents",
|
|
1992
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1993
|
+
tags: ["insights"],
|
|
1994
|
+
successDescription: "The grouped user intents"
|
|
1995
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1996
|
+
...paginatedInsightsInputShape,
|
|
1997
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1998
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
1999
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2000
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2001
|
+
})).output(z.object({
|
|
2002
|
+
intents: z.array(z.object({
|
|
2003
|
+
id: z.string(),
|
|
2004
|
+
intentIds: z.array(z.string()).min(1),
|
|
2005
|
+
environmentId: z.string(),
|
|
2006
|
+
message: z.string(),
|
|
2007
|
+
toolName: z.string(),
|
|
2008
|
+
createdAt: z.coerce.date(),
|
|
2009
|
+
occurrenceCount: z.number().int().positive(),
|
|
2010
|
+
clientName: z.string().nullable(),
|
|
2011
|
+
clientId: z.string().nullable(),
|
|
2012
|
+
categories: z.array(z.object({
|
|
2013
|
+
id: z.string(),
|
|
2014
|
+
name: z.string(),
|
|
2015
|
+
color: intentCategoryColorSchema
|
|
2016
|
+
}))
|
|
2017
|
+
})),
|
|
2018
|
+
totalCount: z.number().int().nonnegative()
|
|
2019
|
+
}));
|
|
2020
|
+
const listFeedbacksContractV1 = base.route({
|
|
2021
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2022
|
+
method: "GET",
|
|
2023
|
+
summary: "List feedbacks",
|
|
2024
|
+
description: "List user feedback for an environment over a time range",
|
|
2025
|
+
tags: ["insights"],
|
|
2026
|
+
successDescription: "The user feedback"
|
|
2027
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2028
|
+
...paginatedInsightsInputShape,
|
|
2029
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2030
|
+
})).output(z.object({
|
|
2031
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2032
|
+
totalCount: z.number().int().nonnegative()
|
|
2033
|
+
}));
|
|
2034
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2035
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2036
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2037
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2038
|
+
method: "GET",
|
|
2039
|
+
summary: "List intent categories",
|
|
2040
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2041
|
+
tags: ["insights"],
|
|
2042
|
+
successDescription: "The intent categories"
|
|
2043
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2044
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2045
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2046
|
+
method: "POST",
|
|
2047
|
+
summary: "Create an intent category",
|
|
2048
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2049
|
+
tags: ["insights"],
|
|
2050
|
+
successDescription: "The created intent category"
|
|
2051
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2052
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2053
|
+
name: intentCategoryNameSchema,
|
|
2054
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2055
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2056
|
+
})).output(intentCategorySchema);
|
|
2057
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2058
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2059
|
+
method: "PATCH",
|
|
2060
|
+
summary: "Update an intent category",
|
|
2061
|
+
description: "Rename or recolor an intent category",
|
|
2062
|
+
tags: ["insights"],
|
|
2063
|
+
successDescription: "The updated intent category"
|
|
2064
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2065
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2066
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2067
|
+
name: intentCategoryNameSchema.optional(),
|
|
2068
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2069
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2070
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2071
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2072
|
+
method: "DELETE",
|
|
2073
|
+
summary: "Delete an intent category",
|
|
2074
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2075
|
+
tags: ["insights"],
|
|
2076
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2077
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2078
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2079
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2080
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2081
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2082
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2083
|
+
method: "POST",
|
|
2084
|
+
summary: "Link an intent category",
|
|
2085
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2086
|
+
tags: ["insights"],
|
|
2087
|
+
successDescription: "The intents have been linked successfully"
|
|
2088
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2089
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2090
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2091
|
+
intentIds: categorizableIntentIdsSchema
|
|
2092
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2093
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2094
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2095
|
+
method: "POST",
|
|
2096
|
+
summary: "Unlink an intent category",
|
|
2097
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2098
|
+
tags: ["insights"],
|
|
2099
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2100
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2101
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2102
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2103
|
+
intentIds: categorizableIntentIdsSchema
|
|
2104
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2105
|
+
const listTeamsContractV1 = base.route({
|
|
1700
2106
|
path: "/v1/teams",
|
|
1701
2107
|
method: "GET",
|
|
1702
2108
|
summary: "List teams",
|
|
@@ -1709,7 +2115,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1709
2115
|
createdAt: z.coerce.date(),
|
|
1710
2116
|
hasStripeAccount: z.boolean()
|
|
1711
2117
|
})));
|
|
1712
|
-
const
|
|
2118
|
+
const getTeamUsageContractV1 = base.route({
|
|
2119
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2120
|
+
method: "GET",
|
|
2121
|
+
summary: "Get team usage",
|
|
2122
|
+
description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
|
|
2123
|
+
tags: ["teams"],
|
|
2124
|
+
successDescription: "The current billing window usage"
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2126
|
+
teamId: z.string(),
|
|
2127
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2128
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2129
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2130
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2131
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2132
|
+
}));
|
|
2133
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1713
2134
|
path: "/v1/tunnels/ticket",
|
|
1714
2135
|
method: "GET",
|
|
1715
2136
|
summary: "Get a tunnel ticket",
|
|
@@ -1721,16 +2142,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1721
2142
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1722
2143
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1723
2144
|
}));
|
|
1724
|
-
const publishServerContractV1 =
|
|
2145
|
+
const publishServerContractV1 = base.route({
|
|
1725
2146
|
path: "/v1/distribution/publish",
|
|
1726
2147
|
method: "POST",
|
|
1727
2148
|
summary: "Publish a server to the MCP registry",
|
|
1728
2149
|
tags: ["distribution"],
|
|
1729
2150
|
successDescription: "The server has been published successfully"
|
|
1730
|
-
}).errors({
|
|
1731
|
-
NOT_FOUND: {},
|
|
1732
|
-
BAD_REQUEST: {}
|
|
1733
|
-
}).input(z.object({
|
|
2151
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1734
2152
|
projectId: z.string(),
|
|
1735
2153
|
domain: z.string(),
|
|
1736
2154
|
title: z.string().min(1).max(100),
|
|
@@ -1739,17 +2157,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1739
2157
|
iconSrc: z.url().max(255).optional(),
|
|
1740
2158
|
dryRun: z.boolean().optional()
|
|
1741
2159
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1742
|
-
const getServerInfoContractV1 =
|
|
2160
|
+
const getServerInfoContractV1 = base.route({
|
|
1743
2161
|
path: "/v1/distribution/get",
|
|
1744
2162
|
method: "GET",
|
|
1745
2163
|
summary: "Get server info",
|
|
1746
2164
|
description: "Get info about a server",
|
|
1747
2165
|
tags: ["distribution"],
|
|
1748
2166
|
successDescription: "The server info"
|
|
1749
|
-
}).errors({
|
|
1750
|
-
NOT_FOUND: {},
|
|
1751
|
-
BAD_REQUEST: {}
|
|
1752
|
-
}).input(z.object({
|
|
2167
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1753
2168
|
projectId: z.string(),
|
|
1754
2169
|
domain: z.string()
|
|
1755
2170
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1768,7 +2183,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1768
2183
|
isPlaygroundEnabled: z.boolean(),
|
|
1769
2184
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1770
2185
|
});
|
|
1771
|
-
const getPlaygroundContractV1 =
|
|
2186
|
+
const getPlaygroundContractV1 = base.route({
|
|
1772
2187
|
path: "/v1/environments/{environmentId}/playground",
|
|
1773
2188
|
method: "GET",
|
|
1774
2189
|
summary: "Get playground configuration",
|
|
@@ -1776,17 +2191,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1776
2191
|
tags: ["environments"],
|
|
1777
2192
|
successDescription: "The playground configuration"
|
|
1778
2193
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1779
|
-
const upsertPlaygroundContractV1 =
|
|
2194
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1780
2195
|
path: "/v1/environments/{environmentId}/playground",
|
|
1781
2196
|
method: "PUT",
|
|
1782
2197
|
summary: "Update playground configuration",
|
|
1783
2198
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1784
2199
|
tags: ["environments"],
|
|
1785
2200
|
successDescription: "The updated playground configuration"
|
|
1786
|
-
}).errors({
|
|
1787
|
-
NOT_FOUND: {},
|
|
1788
|
-
BAD_REQUEST: {}
|
|
1789
|
-
}).input(z.object({
|
|
2201
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1790
2202
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1791
2203
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1792
2204
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1794,7 +2206,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1794
2206
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1795
2207
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1796
2208
|
})).output(playgroundOutputSchema);
|
|
1797
|
-
const createBeaconContractV1 =
|
|
2209
|
+
const createBeaconContractV1 = base.route({
|
|
1798
2210
|
path: "/v1/beacon/audits",
|
|
1799
2211
|
method: "POST",
|
|
1800
2212
|
summary: "Create a beacon audit",
|
|
@@ -1803,7 +2215,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1803
2215
|
successDescription: "The audit has been created"
|
|
1804
2216
|
}).errors({
|
|
1805
2217
|
NOT_FOUND: {},
|
|
1806
|
-
BAD_REQUEST: {},
|
|
1807
2218
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1808
2219
|
}).input(z.object({
|
|
1809
2220
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1811,7 +2222,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1811
2222
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1812
2223
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1813
2224
|
})).output(z.object({ id: z.string() }));
|
|
1814
|
-
const getBeaconContractV1 =
|
|
2225
|
+
const getBeaconContractV1 = base.route({
|
|
1815
2226
|
path: "/v1/beacon/audits/{auditId}",
|
|
1816
2227
|
method: "GET",
|
|
1817
2228
|
summary: "Get a beacon audit",
|
|
@@ -1827,8 +2238,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1827
2238
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1828
2239
|
}));
|
|
1829
2240
|
const contract = {
|
|
1830
|
-
teams: {
|
|
2241
|
+
teams: {
|
|
2242
|
+
list: { v1: listTeamsContractV1 },
|
|
2243
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2244
|
+
},
|
|
1831
2245
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2246
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2247
|
+
intentCategories: {
|
|
2248
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2249
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2250
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2251
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2252
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2253
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2254
|
+
},
|
|
2255
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1832
2256
|
deployments: {
|
|
1833
2257
|
list: { v1: listDeploymentsContractV1 },
|
|
1834
2258
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1875,4 +2299,4 @@ const contractForDocs = {
|
|
|
1875
2299
|
deployments: deploymentsForDocs
|
|
1876
2300
|
};
|
|
1877
2301
|
//#endregion
|
|
1878
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2302
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|