@reclaimprotocol/client 0.1.18 → 0.1.21
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/lib/routes.gen.d.ts +8 -0
- package/lib/routes.gen.js +2 -0
- package/lib/types/openapi.gen.d.ts +135 -13
- package/package.json +1 -1
- package/src/routes.gen.ts +2 -0
- package/src/types/openapi.gen.ts +135 -13
package/lib/routes.gen.d.ts
CHANGED
|
@@ -95,6 +95,10 @@ export declare const ROUTES: {
|
|
|
95
95
|
readonly method: "post";
|
|
96
96
|
readonly path: "/orgs/{orgId}/convert";
|
|
97
97
|
};
|
|
98
|
+
readonly CreateAgentBrowserSession: {
|
|
99
|
+
readonly method: "post";
|
|
100
|
+
readonly path: "/orgs/{orgId}/agent-browser-sessions";
|
|
101
|
+
};
|
|
98
102
|
readonly CreateBillingCheckoutSession: {
|
|
99
103
|
readonly method: "post";
|
|
100
104
|
readonly path: "/orgs/{orgId}/billing/checkout";
|
|
@@ -199,6 +203,10 @@ export declare const ROUTES: {
|
|
|
199
203
|
readonly method: "get";
|
|
200
204
|
readonly path: "/discover/websites";
|
|
201
205
|
};
|
|
206
|
+
readonly DisposeAgentBrowserSession: {
|
|
207
|
+
readonly method: "delete";
|
|
208
|
+
readonly path: "/orgs/{orgId}/agent-browser-sessions/{browserSessionId}";
|
|
209
|
+
};
|
|
202
210
|
readonly DisposeVerificationSession: {
|
|
203
211
|
readonly method: "post";
|
|
204
212
|
readonly path: "/v/{sessionId}/dispose";
|
package/lib/routes.gen.js
CHANGED
|
@@ -27,6 +27,7 @@ export const ROUTES = {
|
|
|
27
27
|
"ChangeOrgPlan": { "method": "post", "path": "/orgs/{orgId}/billing/change-plan" },
|
|
28
28
|
"ConsentPage": { "method": "get", "path": "/oauth/consent" },
|
|
29
29
|
"ConvertOrgToRegular": { "method": "post", "path": "/orgs/{orgId}/convert" },
|
|
30
|
+
"CreateAgentBrowserSession": { "method": "post", "path": "/orgs/{orgId}/agent-browser-sessions" },
|
|
30
31
|
"CreateBillingCheckoutSession": { "method": "post", "path": "/orgs/{orgId}/billing/checkout" },
|
|
31
32
|
"CreateBillingPortalSession": { "method": "post", "path": "/orgs/{orgId}/billing/portal" },
|
|
32
33
|
"CreateCallbackSubscription": { "method": "post", "path": "/verifications/callback-subscriptions" },
|
|
@@ -53,6 +54,7 @@ export const ROUTES = {
|
|
|
53
54
|
"DiscoverResolve": { "method": "get", "path": "/discover/resolve" },
|
|
54
55
|
"DiscoverTeachAgent": { "method": "get", "path": "/discover/teach" },
|
|
55
56
|
"DiscoverWebsites": { "method": "get", "path": "/discover/websites" },
|
|
57
|
+
"DisposeAgentBrowserSession": { "method": "delete", "path": "/orgs/{orgId}/agent-browser-sessions/{browserSessionId}" },
|
|
56
58
|
"DisposeVerificationSession": { "method": "post", "path": "/v/{sessionId}/dispose" },
|
|
57
59
|
"Docs": { "method": "get", "path": "/docs" },
|
|
58
60
|
"ExplorePreviewImage": { "method": "get", "path": "/og/explore.png" },
|
|
@@ -476,7 +476,7 @@ export interface paths {
|
|
|
476
476
|
};
|
|
477
477
|
/**
|
|
478
478
|
* Explore verification sessions (admin-only)
|
|
479
|
-
* @description Admin only. Search verification sessions across all organizations —
|
|
479
|
+
* @description Admin only. Search verification sessions across all organizations — filter by `sessionId` (prefix match, at least 5 characters), `providerId`, `claimantClientId`, `orgId` (all exact match), `status`, and a `createdAfter`/`createdBefore` time range. Rows link to the org-scoped session detail page (admins can open any org's pages). Capped at 100, newest first.
|
|
480
480
|
*/
|
|
481
481
|
get: operations["AdminSessions"];
|
|
482
482
|
put?: never;
|
|
@@ -1002,7 +1002,7 @@ export interface paths {
|
|
|
1002
1002
|
};
|
|
1003
1003
|
/**
|
|
1004
1004
|
* Verification page for an end-user
|
|
1005
|
-
* @description Opens a
|
|
1005
|
+
* @description Opens a Builder-hosted remote-browser session, embeds its live view in an iframe, and kicks off the capture → prove → submit run for this verification session.
|
|
1006
1006
|
*/
|
|
1007
1007
|
get: operations["VerificationPage"];
|
|
1008
1008
|
put?: never;
|
|
@@ -1122,7 +1122,7 @@ export interface paths {
|
|
|
1122
1122
|
};
|
|
1123
1123
|
/**
|
|
1124
1124
|
* Get the OpenAPI specification (YAML)
|
|
1125
|
-
* @description
|
|
1125
|
+
* @description The OpenAPI 3.1 document for this API, self-contained (every `$ref` is internal). Feed it to API tooling and SDK generators. Reclaim staff additionally see the internal tag groups; everyone else gets the integration surface only.
|
|
1126
1126
|
*/
|
|
1127
1127
|
get: operations["OpenApiSpec"];
|
|
1128
1128
|
put?: never;
|
|
@@ -1142,7 +1142,7 @@ export interface paths {
|
|
|
1142
1142
|
};
|
|
1143
1143
|
/**
|
|
1144
1144
|
* View the API reference (Scalar UI)
|
|
1145
|
-
* @description
|
|
1145
|
+
* @description Interactive API reference rendered by Scalar from `GET /openapi.yaml`, so it shows whichever document the viewer is served.
|
|
1146
1146
|
*/
|
|
1147
1147
|
get: operations["Docs"];
|
|
1148
1148
|
put?: never;
|
|
@@ -1352,6 +1352,46 @@ export interface paths {
|
|
|
1352
1352
|
patch?: never;
|
|
1353
1353
|
trace?: never;
|
|
1354
1354
|
};
|
|
1355
|
+
"/orgs/{orgId}/agent-browser-sessions": {
|
|
1356
|
+
parameters: {
|
|
1357
|
+
query?: never;
|
|
1358
|
+
header?: never;
|
|
1359
|
+
path?: never;
|
|
1360
|
+
cookie?: never;
|
|
1361
|
+
};
|
|
1362
|
+
get?: never;
|
|
1363
|
+
put?: never;
|
|
1364
|
+
/**
|
|
1365
|
+
* Create a remote browser session for provider authoring
|
|
1366
|
+
* @description Allocates a Builder-managed Popcorn browser for an authenticated agent. The caller must be an active editor of the organization. Creating the browser consumes one use from the seeded Builder verification client's VERIFICATION quota pool, so the organization's normal sandbox, plan, overage, and credit restrictions apply. The live-view URL may be shared with a volunteer; the unrestricted CDP URL is a secret intended only for the authenticated local agent process.
|
|
1367
|
+
*/
|
|
1368
|
+
post: operations["CreateAgentBrowserSession"];
|
|
1369
|
+
delete?: never;
|
|
1370
|
+
options?: never;
|
|
1371
|
+
head?: never;
|
|
1372
|
+
patch?: never;
|
|
1373
|
+
trace?: never;
|
|
1374
|
+
};
|
|
1375
|
+
"/orgs/{orgId}/agent-browser-sessions/{browserSessionId}": {
|
|
1376
|
+
parameters: {
|
|
1377
|
+
query?: never;
|
|
1378
|
+
header?: never;
|
|
1379
|
+
path?: never;
|
|
1380
|
+
cookie?: never;
|
|
1381
|
+
};
|
|
1382
|
+
get?: never;
|
|
1383
|
+
put?: never;
|
|
1384
|
+
post?: never;
|
|
1385
|
+
/**
|
|
1386
|
+
* Dispose a remote provider-authoring browser
|
|
1387
|
+
* @description Tears down an agent-owned Popcorn browser immediately. Idempotent for a session that was already disposed. The caller must still be an active editor of the owning organization.
|
|
1388
|
+
*/
|
|
1389
|
+
delete: operations["DisposeAgentBrowserSession"];
|
|
1390
|
+
options?: never;
|
|
1391
|
+
head?: never;
|
|
1392
|
+
patch?: never;
|
|
1393
|
+
trace?: never;
|
|
1394
|
+
};
|
|
1355
1395
|
"/orgs/{orgId}": {
|
|
1356
1396
|
parameters: {
|
|
1357
1397
|
query?: never;
|
|
@@ -2206,7 +2246,7 @@ export interface paths {
|
|
|
2206
2246
|
};
|
|
2207
2247
|
/**
|
|
2208
2248
|
* List an organization's verification sessions
|
|
2209
|
-
* @description Returns verification sessions created under the organization, newest first. Optionally filter by `providerId`, `status`, `resolvedVersion`, `claimantClientId`, and a `createdAfter`/`createdBefore` time range. Caller must be an active member of the org. Opaque cursor pagination.
|
|
2249
|
+
* @description Returns verification sessions created under the organization, newest first. Optionally filter by `sessionId` (prefix match, at least 5 characters), `providerId`, `status`, `resolvedVersion`, `claimantClientId`, and a `createdAfter`/`createdBefore` time range. Caller must be an active member of the org. Opaque cursor pagination.
|
|
2210
2250
|
*
|
|
2211
2251
|
* Note: `status` filters on the stored column. A session that has passed `expiresAt` but has not yet been swept is reported as `expired` in its body while still stored as `pending`, so `status=expired` may not match such sessions until the sweep runs.
|
|
2212
2252
|
*/
|
|
@@ -2622,6 +2662,23 @@ export interface components {
|
|
|
2622
2662
|
* @description Verification session id (UUID v7 when supported). Also echoed in the result payload as `reclaimSessionId`.
|
|
2623
2663
|
*/
|
|
2624
2664
|
SessionID: string;
|
|
2665
|
+
/**
|
|
2666
|
+
* Format: uuid
|
|
2667
|
+
* @description Builder-managed remote browser session id.
|
|
2668
|
+
*/
|
|
2669
|
+
AgentBrowserSessionID: string;
|
|
2670
|
+
/** @description A short-lived Popcorn browser allocated for provider authoring. Treat `cdpUrl` and `apiUrl` as credentials: the local agent consumes them and must not display, persist, or share them. `liveViewUrl` is intentionally shareable with the volunteer operating the browser. */
|
|
2671
|
+
AgentBrowserSession: {
|
|
2672
|
+
id: components["schemas"]["AgentBrowserSessionID"];
|
|
2673
|
+
orgId: components["schemas"]["OrgID"];
|
|
2674
|
+
/** Format: uri */
|
|
2675
|
+
liveViewUrl: string;
|
|
2676
|
+
/** Format: uri */
|
|
2677
|
+
readonly cdpUrl: string;
|
|
2678
|
+
/** Format: uri */
|
|
2679
|
+
readonly apiUrl?: string;
|
|
2680
|
+
expiresAt: components["schemas"]["Timestamp"];
|
|
2681
|
+
};
|
|
2625
2682
|
/**
|
|
2626
2683
|
* Format: uuid
|
|
2627
2684
|
* @description Stable id for a callback subscription.
|
|
@@ -3804,9 +3861,11 @@ export interface components {
|
|
|
3804
3861
|
};
|
|
3805
3862
|
orgId?: components["schemas"]["OrgID"];
|
|
3806
3863
|
};
|
|
3807
|
-
/** @description Body for `POST /site/{domain}/ai-provider`.
|
|
3864
|
+
/** @description Body for `POST /site/{domain}/ai-provider`. `orgId` is optional: which owned organization the AI provider is authored under (defaults to the member's personal organization, or their first owned org). `url` is required only when `domain` has no existing catalog data — the build page's confirm-URL step supplies it, and the draft is scaffolded under whatever domain that URL actually resolves to (which may differ from `domain`), not the unconfirmed search text the build page was first opened with. */
|
|
3808
3865
|
SiteAiProviderBody: {
|
|
3809
3866
|
orgId?: components["schemas"]["OrgID"];
|
|
3867
|
+
/** @description Confirmed website URL, for a domain with no existing catalog data. Verified reachable before anything is created. */
|
|
3868
|
+
url?: string;
|
|
3810
3869
|
};
|
|
3811
3870
|
/** @description Body for `PUT /users/{userId}/org-limit`. An integer sets the limit; `null` (JSON) or an empty string (form) restores the default (3). */
|
|
3812
3871
|
AdminSetUserOrgLimitBody: {
|
|
@@ -3814,7 +3873,7 @@ export interface components {
|
|
|
3814
3873
|
};
|
|
3815
3874
|
/** @description Body for `POST /site/{domain}/try-ai`. An optional edited extraction prompt, saved as a new draft build before the sandbox session is minted. */
|
|
3816
3875
|
SiteTryAiBody: {
|
|
3817
|
-
/** @description The edited extraction prompt for the AI provider. */
|
|
3876
|
+
/** @description The edited extraction prompt for the AI provider. Gated by the prompt guard before it is stored (see docs/prompt-guard.md); the length here documents the same ceiling the guard enforces. */
|
|
3818
3877
|
prompt?: string;
|
|
3819
3878
|
};
|
|
3820
3879
|
/** @description A single data point selectable on the `/site/{domain}` page, with how many visible providers expose it, one example provider slug, and one `references` entry per provider describing how that provider proves it (what the site page's source picker offers as selectable options). */
|
|
@@ -4159,7 +4218,7 @@ export interface components {
|
|
|
4159
4218
|
CreateProviderVersionRequest: {
|
|
4160
4219
|
/** @description Defaults to `structured` server-side when omitted; pass `llm` (with a `prompt`) to author an AI-verification provider. */
|
|
4161
4220
|
verificationType?: components["schemas"]["VerificationType"];
|
|
4162
|
-
/** @description Extraction prompt, used (and required) when `verificationType` is `llm`. */
|
|
4221
|
+
/** @description Extraction prompt, used (and required) when `verificationType` is `llm`. Gated by the prompt guard before it is stored (docs/prompt-guard.md). */
|
|
4163
4222
|
prompt?: string;
|
|
4164
4223
|
/**
|
|
4165
4224
|
* @description The version of this Provider upon creation. Clients typically omit this and let the dashboard's bump-suggestion compute it. When omitted, defaults to `0.1.0` for the very first version; otherwise the caller is expected to pass a value higher than the latest existing version.
|
|
@@ -4186,7 +4245,7 @@ export interface components {
|
|
|
4186
4245
|
/** Format: uri */
|
|
4187
4246
|
initialUrl?: string;
|
|
4188
4247
|
verificationType?: components["schemas"]["VerificationType"];
|
|
4189
|
-
/** @description Extraction prompt, used when `verificationType` is `llm`. */
|
|
4248
|
+
/** @description Extraction prompt, used when `verificationType` is `llm`. Gated by the prompt guard before it is stored (docs/prompt-guard.md). */
|
|
4190
4249
|
prompt?: string;
|
|
4191
4250
|
requests?: components["schemas"]["RequestSelection"][];
|
|
4192
4251
|
allowedJsRequests?: components["schemas"]["RequestSelectionTemplate"][];
|
|
@@ -5430,9 +5489,19 @@ export interface operations {
|
|
|
5430
5489
|
AdminSessions: {
|
|
5431
5490
|
parameters: {
|
|
5432
5491
|
query?: {
|
|
5433
|
-
/** @description
|
|
5434
|
-
|
|
5492
|
+
/** @description Only return sessions whose id starts with this value (matched at least 5 characters). */
|
|
5493
|
+
sessionId?: string;
|
|
5494
|
+
/** @description Only return sessions for this exact provider id. */
|
|
5495
|
+
providerId?: string;
|
|
5496
|
+
/** @description Only return the session matching this claimant client id. */
|
|
5497
|
+
claimantClientId?: string;
|
|
5498
|
+
/** @description Only return sessions belonging to this exact organization id. */
|
|
5499
|
+
orgId?: string;
|
|
5435
5500
|
status?: components["schemas"]["VerificationStatus"];
|
|
5501
|
+
/** @description Only return sessions created at or after this time (inclusive). */
|
|
5502
|
+
createdAfter?: string;
|
|
5503
|
+
/** @description Only return sessions created at or before this time (inclusive). */
|
|
5504
|
+
createdBefore?: string;
|
|
5436
5505
|
};
|
|
5437
5506
|
header?: never;
|
|
5438
5507
|
path?: never;
|
|
@@ -6676,6 +6745,57 @@ export interface operations {
|
|
|
6676
6745
|
default: components["responses"]["ProblemResponse"];
|
|
6677
6746
|
};
|
|
6678
6747
|
};
|
|
6748
|
+
CreateAgentBrowserSession: {
|
|
6749
|
+
parameters: {
|
|
6750
|
+
query?: never;
|
|
6751
|
+
header?: never;
|
|
6752
|
+
path: {
|
|
6753
|
+
orgId: components["schemas"]["OrgID"];
|
|
6754
|
+
};
|
|
6755
|
+
cookie?: never;
|
|
6756
|
+
};
|
|
6757
|
+
requestBody?: never;
|
|
6758
|
+
responses: {
|
|
6759
|
+
/** @description Remote authoring browser created. */
|
|
6760
|
+
201: {
|
|
6761
|
+
headers: {
|
|
6762
|
+
"Cache-Control"?: string;
|
|
6763
|
+
[name: string]: unknown;
|
|
6764
|
+
};
|
|
6765
|
+
content: {
|
|
6766
|
+
"application/json": components["schemas"]["AgentBrowserSession"];
|
|
6767
|
+
};
|
|
6768
|
+
};
|
|
6769
|
+
402: components["responses"]["ProblemResponse"];
|
|
6770
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6771
|
+
429: components["responses"]["ProblemResponse"];
|
|
6772
|
+
default: components["responses"]["ProblemResponse"];
|
|
6773
|
+
};
|
|
6774
|
+
};
|
|
6775
|
+
DisposeAgentBrowserSession: {
|
|
6776
|
+
parameters: {
|
|
6777
|
+
query?: never;
|
|
6778
|
+
header?: never;
|
|
6779
|
+
path: {
|
|
6780
|
+
orgId: components["schemas"]["OrgID"];
|
|
6781
|
+
browserSessionId: components["schemas"]["AgentBrowserSessionID"];
|
|
6782
|
+
};
|
|
6783
|
+
cookie?: never;
|
|
6784
|
+
};
|
|
6785
|
+
requestBody?: never;
|
|
6786
|
+
responses: {
|
|
6787
|
+
/** @description Browser disposed or already absent. */
|
|
6788
|
+
204: {
|
|
6789
|
+
headers: {
|
|
6790
|
+
[name: string]: unknown;
|
|
6791
|
+
};
|
|
6792
|
+
content?: never;
|
|
6793
|
+
};
|
|
6794
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6795
|
+
404: components["responses"]["ProblemResponse"];
|
|
6796
|
+
default: components["responses"]["ProblemResponse"];
|
|
6797
|
+
};
|
|
6798
|
+
};
|
|
6679
6799
|
GetOrg: {
|
|
6680
6800
|
parameters: {
|
|
6681
6801
|
query?: {
|
|
@@ -8297,8 +8417,10 @@ export interface operations {
|
|
|
8297
8417
|
ListOrgVerificationSessions: {
|
|
8298
8418
|
parameters: {
|
|
8299
8419
|
query?: {
|
|
8300
|
-
/** @description Only return sessions
|
|
8301
|
-
|
|
8420
|
+
/** @description Only return sessions whose id starts with this value (matched at least 5 characters). */
|
|
8421
|
+
sessionId?: string;
|
|
8422
|
+
/** @description Only return sessions for this exact provider id. */
|
|
8423
|
+
providerId?: string;
|
|
8302
8424
|
/** @description Only return sessions in this status. */
|
|
8303
8425
|
status?: components["schemas"]["VerificationStatus"];
|
|
8304
8426
|
/** @description Only return sessions resolved to this exact provider version. */
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@reclaimprotocol/client",
|
|
3
3
|
"title": "Reclaim Client",
|
|
4
|
-
"version": "0.1.
|
|
4
|
+
"version": "0.1.21",
|
|
5
5
|
"description": "Typed SDK/HTTP client SDK for the Reclaim Protocol — the programmatic way to use Reclaim Protocol to verify **data points** about your users (a follower count, an account balance, an order). Can be directly integrated by apps to request verification for their users using Reclaim Protocol and verify the results.",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"sideEffects": false,
|
package/src/routes.gen.ts
CHANGED
|
@@ -28,6 +28,7 @@ export const ROUTES = {
|
|
|
28
28
|
"ChangeOrgPlan": {"method":"post","path":"/orgs/{orgId}/billing/change-plan"},
|
|
29
29
|
"ConsentPage": {"method":"get","path":"/oauth/consent"},
|
|
30
30
|
"ConvertOrgToRegular": {"method":"post","path":"/orgs/{orgId}/convert"},
|
|
31
|
+
"CreateAgentBrowserSession": {"method":"post","path":"/orgs/{orgId}/agent-browser-sessions"},
|
|
31
32
|
"CreateBillingCheckoutSession": {"method":"post","path":"/orgs/{orgId}/billing/checkout"},
|
|
32
33
|
"CreateBillingPortalSession": {"method":"post","path":"/orgs/{orgId}/billing/portal"},
|
|
33
34
|
"CreateCallbackSubscription": {"method":"post","path":"/verifications/callback-subscriptions"},
|
|
@@ -54,6 +55,7 @@ export const ROUTES = {
|
|
|
54
55
|
"DiscoverResolve": {"method":"get","path":"/discover/resolve"},
|
|
55
56
|
"DiscoverTeachAgent": {"method":"get","path":"/discover/teach"},
|
|
56
57
|
"DiscoverWebsites": {"method":"get","path":"/discover/websites"},
|
|
58
|
+
"DisposeAgentBrowserSession": {"method":"delete","path":"/orgs/{orgId}/agent-browser-sessions/{browserSessionId}"},
|
|
57
59
|
"DisposeVerificationSession": {"method":"post","path":"/v/{sessionId}/dispose"},
|
|
58
60
|
"Docs": {"method":"get","path":"/docs"},
|
|
59
61
|
"ExplorePreviewImage": {"method":"get","path":"/og/explore.png"},
|
package/src/types/openapi.gen.ts
CHANGED
|
@@ -477,7 +477,7 @@ export interface paths {
|
|
|
477
477
|
};
|
|
478
478
|
/**
|
|
479
479
|
* Explore verification sessions (admin-only)
|
|
480
|
-
* @description Admin only. Search verification sessions across all organizations —
|
|
480
|
+
* @description Admin only. Search verification sessions across all organizations — filter by `sessionId` (prefix match, at least 5 characters), `providerId`, `claimantClientId`, `orgId` (all exact match), `status`, and a `createdAfter`/`createdBefore` time range. Rows link to the org-scoped session detail page (admins can open any org's pages). Capped at 100, newest first.
|
|
481
481
|
*/
|
|
482
482
|
get: operations["AdminSessions"];
|
|
483
483
|
put?: never;
|
|
@@ -1003,7 +1003,7 @@ export interface paths {
|
|
|
1003
1003
|
};
|
|
1004
1004
|
/**
|
|
1005
1005
|
* Verification page for an end-user
|
|
1006
|
-
* @description Opens a
|
|
1006
|
+
* @description Opens a Builder-hosted remote-browser session, embeds its live view in an iframe, and kicks off the capture → prove → submit run for this verification session.
|
|
1007
1007
|
*/
|
|
1008
1008
|
get: operations["VerificationPage"];
|
|
1009
1009
|
put?: never;
|
|
@@ -1123,7 +1123,7 @@ export interface paths {
|
|
|
1123
1123
|
};
|
|
1124
1124
|
/**
|
|
1125
1125
|
* Get the OpenAPI specification (YAML)
|
|
1126
|
-
* @description
|
|
1126
|
+
* @description The OpenAPI 3.1 document for this API, self-contained (every `$ref` is internal). Feed it to API tooling and SDK generators. Reclaim staff additionally see the internal tag groups; everyone else gets the integration surface only.
|
|
1127
1127
|
*/
|
|
1128
1128
|
get: operations["OpenApiSpec"];
|
|
1129
1129
|
put?: never;
|
|
@@ -1143,7 +1143,7 @@ export interface paths {
|
|
|
1143
1143
|
};
|
|
1144
1144
|
/**
|
|
1145
1145
|
* View the API reference (Scalar UI)
|
|
1146
|
-
* @description
|
|
1146
|
+
* @description Interactive API reference rendered by Scalar from `GET /openapi.yaml`, so it shows whichever document the viewer is served.
|
|
1147
1147
|
*/
|
|
1148
1148
|
get: operations["Docs"];
|
|
1149
1149
|
put?: never;
|
|
@@ -1353,6 +1353,46 @@ export interface paths {
|
|
|
1353
1353
|
patch?: never;
|
|
1354
1354
|
trace?: never;
|
|
1355
1355
|
};
|
|
1356
|
+
"/orgs/{orgId}/agent-browser-sessions": {
|
|
1357
|
+
parameters: {
|
|
1358
|
+
query?: never;
|
|
1359
|
+
header?: never;
|
|
1360
|
+
path?: never;
|
|
1361
|
+
cookie?: never;
|
|
1362
|
+
};
|
|
1363
|
+
get?: never;
|
|
1364
|
+
put?: never;
|
|
1365
|
+
/**
|
|
1366
|
+
* Create a remote browser session for provider authoring
|
|
1367
|
+
* @description Allocates a Builder-managed Popcorn browser for an authenticated agent. The caller must be an active editor of the organization. Creating the browser consumes one use from the seeded Builder verification client's VERIFICATION quota pool, so the organization's normal sandbox, plan, overage, and credit restrictions apply. The live-view URL may be shared with a volunteer; the unrestricted CDP URL is a secret intended only for the authenticated local agent process.
|
|
1368
|
+
*/
|
|
1369
|
+
post: operations["CreateAgentBrowserSession"];
|
|
1370
|
+
delete?: never;
|
|
1371
|
+
options?: never;
|
|
1372
|
+
head?: never;
|
|
1373
|
+
patch?: never;
|
|
1374
|
+
trace?: never;
|
|
1375
|
+
};
|
|
1376
|
+
"/orgs/{orgId}/agent-browser-sessions/{browserSessionId}": {
|
|
1377
|
+
parameters: {
|
|
1378
|
+
query?: never;
|
|
1379
|
+
header?: never;
|
|
1380
|
+
path?: never;
|
|
1381
|
+
cookie?: never;
|
|
1382
|
+
};
|
|
1383
|
+
get?: never;
|
|
1384
|
+
put?: never;
|
|
1385
|
+
post?: never;
|
|
1386
|
+
/**
|
|
1387
|
+
* Dispose a remote provider-authoring browser
|
|
1388
|
+
* @description Tears down an agent-owned Popcorn browser immediately. Idempotent for a session that was already disposed. The caller must still be an active editor of the owning organization.
|
|
1389
|
+
*/
|
|
1390
|
+
delete: operations["DisposeAgentBrowserSession"];
|
|
1391
|
+
options?: never;
|
|
1392
|
+
head?: never;
|
|
1393
|
+
patch?: never;
|
|
1394
|
+
trace?: never;
|
|
1395
|
+
};
|
|
1356
1396
|
"/orgs/{orgId}": {
|
|
1357
1397
|
parameters: {
|
|
1358
1398
|
query?: never;
|
|
@@ -2207,7 +2247,7 @@ export interface paths {
|
|
|
2207
2247
|
};
|
|
2208
2248
|
/**
|
|
2209
2249
|
* List an organization's verification sessions
|
|
2210
|
-
* @description Returns verification sessions created under the organization, newest first. Optionally filter by `providerId`, `status`, `resolvedVersion`, `claimantClientId`, and a `createdAfter`/`createdBefore` time range. Caller must be an active member of the org. Opaque cursor pagination.
|
|
2250
|
+
* @description Returns verification sessions created under the organization, newest first. Optionally filter by `sessionId` (prefix match, at least 5 characters), `providerId`, `status`, `resolvedVersion`, `claimantClientId`, and a `createdAfter`/`createdBefore` time range. Caller must be an active member of the org. Opaque cursor pagination.
|
|
2211
2251
|
*
|
|
2212
2252
|
* Note: `status` filters on the stored column. A session that has passed `expiresAt` but has not yet been swept is reported as `expired` in its body while still stored as `pending`, so `status=expired` may not match such sessions until the sweep runs.
|
|
2213
2253
|
*/
|
|
@@ -2623,6 +2663,23 @@ export interface components {
|
|
|
2623
2663
|
* @description Verification session id (UUID v7 when supported). Also echoed in the result payload as `reclaimSessionId`.
|
|
2624
2664
|
*/
|
|
2625
2665
|
SessionID: string;
|
|
2666
|
+
/**
|
|
2667
|
+
* Format: uuid
|
|
2668
|
+
* @description Builder-managed remote browser session id.
|
|
2669
|
+
*/
|
|
2670
|
+
AgentBrowserSessionID: string;
|
|
2671
|
+
/** @description A short-lived Popcorn browser allocated for provider authoring. Treat `cdpUrl` and `apiUrl` as credentials: the local agent consumes them and must not display, persist, or share them. `liveViewUrl` is intentionally shareable with the volunteer operating the browser. */
|
|
2672
|
+
AgentBrowserSession: {
|
|
2673
|
+
id: components["schemas"]["AgentBrowserSessionID"];
|
|
2674
|
+
orgId: components["schemas"]["OrgID"];
|
|
2675
|
+
/** Format: uri */
|
|
2676
|
+
liveViewUrl: string;
|
|
2677
|
+
/** Format: uri */
|
|
2678
|
+
readonly cdpUrl: string;
|
|
2679
|
+
/** Format: uri */
|
|
2680
|
+
readonly apiUrl?: string;
|
|
2681
|
+
expiresAt: components["schemas"]["Timestamp"];
|
|
2682
|
+
};
|
|
2626
2683
|
/**
|
|
2627
2684
|
* Format: uuid
|
|
2628
2685
|
* @description Stable id for a callback subscription.
|
|
@@ -3805,9 +3862,11 @@ export interface components {
|
|
|
3805
3862
|
};
|
|
3806
3863
|
orgId?: components["schemas"]["OrgID"];
|
|
3807
3864
|
};
|
|
3808
|
-
/** @description Body for `POST /site/{domain}/ai-provider`.
|
|
3865
|
+
/** @description Body for `POST /site/{domain}/ai-provider`. `orgId` is optional: which owned organization the AI provider is authored under (defaults to the member's personal organization, or their first owned org). `url` is required only when `domain` has no existing catalog data — the build page's confirm-URL step supplies it, and the draft is scaffolded under whatever domain that URL actually resolves to (which may differ from `domain`), not the unconfirmed search text the build page was first opened with. */
|
|
3809
3866
|
SiteAiProviderBody: {
|
|
3810
3867
|
orgId?: components["schemas"]["OrgID"];
|
|
3868
|
+
/** @description Confirmed website URL, for a domain with no existing catalog data. Verified reachable before anything is created. */
|
|
3869
|
+
url?: string;
|
|
3811
3870
|
};
|
|
3812
3871
|
/** @description Body for `PUT /users/{userId}/org-limit`. An integer sets the limit; `null` (JSON) or an empty string (form) restores the default (3). */
|
|
3813
3872
|
AdminSetUserOrgLimitBody: {
|
|
@@ -3815,7 +3874,7 @@ export interface components {
|
|
|
3815
3874
|
};
|
|
3816
3875
|
/** @description Body for `POST /site/{domain}/try-ai`. An optional edited extraction prompt, saved as a new draft build before the sandbox session is minted. */
|
|
3817
3876
|
SiteTryAiBody: {
|
|
3818
|
-
/** @description The edited extraction prompt for the AI provider. */
|
|
3877
|
+
/** @description The edited extraction prompt for the AI provider. Gated by the prompt guard before it is stored (see docs/prompt-guard.md); the length here documents the same ceiling the guard enforces. */
|
|
3819
3878
|
prompt?: string;
|
|
3820
3879
|
};
|
|
3821
3880
|
/** @description A single data point selectable on the `/site/{domain}` page, with how many visible providers expose it, one example provider slug, and one `references` entry per provider describing how that provider proves it (what the site page's source picker offers as selectable options). */
|
|
@@ -4160,7 +4219,7 @@ export interface components {
|
|
|
4160
4219
|
CreateProviderVersionRequest: {
|
|
4161
4220
|
/** @description Defaults to `structured` server-side when omitted; pass `llm` (with a `prompt`) to author an AI-verification provider. */
|
|
4162
4221
|
verificationType?: components["schemas"]["VerificationType"];
|
|
4163
|
-
/** @description Extraction prompt, used (and required) when `verificationType` is `llm`. */
|
|
4222
|
+
/** @description Extraction prompt, used (and required) when `verificationType` is `llm`. Gated by the prompt guard before it is stored (docs/prompt-guard.md). */
|
|
4164
4223
|
prompt?: string;
|
|
4165
4224
|
/**
|
|
4166
4225
|
* @description The version of this Provider upon creation. Clients typically omit this and let the dashboard's bump-suggestion compute it. When omitted, defaults to `0.1.0` for the very first version; otherwise the caller is expected to pass a value higher than the latest existing version.
|
|
@@ -4187,7 +4246,7 @@ export interface components {
|
|
|
4187
4246
|
/** Format: uri */
|
|
4188
4247
|
initialUrl?: string;
|
|
4189
4248
|
verificationType?: components["schemas"]["VerificationType"];
|
|
4190
|
-
/** @description Extraction prompt, used when `verificationType` is `llm`. */
|
|
4249
|
+
/** @description Extraction prompt, used when `verificationType` is `llm`. Gated by the prompt guard before it is stored (docs/prompt-guard.md). */
|
|
4191
4250
|
prompt?: string;
|
|
4192
4251
|
requests?: components["schemas"]["RequestSelection"][];
|
|
4193
4252
|
allowedJsRequests?: components["schemas"]["RequestSelectionTemplate"][];
|
|
@@ -5431,9 +5490,19 @@ export interface operations {
|
|
|
5431
5490
|
AdminSessions: {
|
|
5432
5491
|
parameters: {
|
|
5433
5492
|
query?: {
|
|
5434
|
-
/** @description
|
|
5435
|
-
|
|
5493
|
+
/** @description Only return sessions whose id starts with this value (matched at least 5 characters). */
|
|
5494
|
+
sessionId?: string;
|
|
5495
|
+
/** @description Only return sessions for this exact provider id. */
|
|
5496
|
+
providerId?: string;
|
|
5497
|
+
/** @description Only return the session matching this claimant client id. */
|
|
5498
|
+
claimantClientId?: string;
|
|
5499
|
+
/** @description Only return sessions belonging to this exact organization id. */
|
|
5500
|
+
orgId?: string;
|
|
5436
5501
|
status?: components["schemas"]["VerificationStatus"];
|
|
5502
|
+
/** @description Only return sessions created at or after this time (inclusive). */
|
|
5503
|
+
createdAfter?: string;
|
|
5504
|
+
/** @description Only return sessions created at or before this time (inclusive). */
|
|
5505
|
+
createdBefore?: string;
|
|
5437
5506
|
};
|
|
5438
5507
|
header?: never;
|
|
5439
5508
|
path?: never;
|
|
@@ -6677,6 +6746,57 @@ export interface operations {
|
|
|
6677
6746
|
default: components["responses"]["ProblemResponse"];
|
|
6678
6747
|
};
|
|
6679
6748
|
};
|
|
6749
|
+
CreateAgentBrowserSession: {
|
|
6750
|
+
parameters: {
|
|
6751
|
+
query?: never;
|
|
6752
|
+
header?: never;
|
|
6753
|
+
path: {
|
|
6754
|
+
orgId: components["schemas"]["OrgID"];
|
|
6755
|
+
};
|
|
6756
|
+
cookie?: never;
|
|
6757
|
+
};
|
|
6758
|
+
requestBody?: never;
|
|
6759
|
+
responses: {
|
|
6760
|
+
/** @description Remote authoring browser created. */
|
|
6761
|
+
201: {
|
|
6762
|
+
headers: {
|
|
6763
|
+
"Cache-Control"?: string;
|
|
6764
|
+
[name: string]: unknown;
|
|
6765
|
+
};
|
|
6766
|
+
content: {
|
|
6767
|
+
"application/json": components["schemas"]["AgentBrowserSession"];
|
|
6768
|
+
};
|
|
6769
|
+
};
|
|
6770
|
+
402: components["responses"]["ProblemResponse"];
|
|
6771
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6772
|
+
429: components["responses"]["ProblemResponse"];
|
|
6773
|
+
default: components["responses"]["ProblemResponse"];
|
|
6774
|
+
};
|
|
6775
|
+
};
|
|
6776
|
+
DisposeAgentBrowserSession: {
|
|
6777
|
+
parameters: {
|
|
6778
|
+
query?: never;
|
|
6779
|
+
header?: never;
|
|
6780
|
+
path: {
|
|
6781
|
+
orgId: components["schemas"]["OrgID"];
|
|
6782
|
+
browserSessionId: components["schemas"]["AgentBrowserSessionID"];
|
|
6783
|
+
};
|
|
6784
|
+
cookie?: never;
|
|
6785
|
+
};
|
|
6786
|
+
requestBody?: never;
|
|
6787
|
+
responses: {
|
|
6788
|
+
/** @description Browser disposed or already absent. */
|
|
6789
|
+
204: {
|
|
6790
|
+
headers: {
|
|
6791
|
+
[name: string]: unknown;
|
|
6792
|
+
};
|
|
6793
|
+
content?: never;
|
|
6794
|
+
};
|
|
6795
|
+
403: components["responses"]["ForbiddenResponse"];
|
|
6796
|
+
404: components["responses"]["ProblemResponse"];
|
|
6797
|
+
default: components["responses"]["ProblemResponse"];
|
|
6798
|
+
};
|
|
6799
|
+
};
|
|
6680
6800
|
GetOrg: {
|
|
6681
6801
|
parameters: {
|
|
6682
6802
|
query?: {
|
|
@@ -8298,8 +8418,10 @@ export interface operations {
|
|
|
8298
8418
|
ListOrgVerificationSessions: {
|
|
8299
8419
|
parameters: {
|
|
8300
8420
|
query?: {
|
|
8301
|
-
/** @description Only return sessions
|
|
8302
|
-
|
|
8421
|
+
/** @description Only return sessions whose id starts with this value (matched at least 5 characters). */
|
|
8422
|
+
sessionId?: string;
|
|
8423
|
+
/** @description Only return sessions for this exact provider id. */
|
|
8424
|
+
providerId?: string;
|
|
8303
8425
|
/** @description Only return sessions in this status. */
|
|
8304
8426
|
status?: components["schemas"]["VerificationStatus"];
|
|
8305
8427
|
/** @description Only return sessions resolved to this exact provider version. */
|