@deepraxis/cli 0.1.1-dev.b176367 → 0.1.1-dev.bdcd5e6
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/COMMANDS.md +12 -17
- package/dist/praxis.js +182 -414
- package/package.json +1 -1
package/COMMANDS.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Generated by `bun run commands`. DO NOT EDIT.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
421 HTTP operations; 423 commands including aliases.
|
|
6
6
|
|
|
7
7
|
Environment: `PRAXIS_ENV=develop|production` (dev package defaults to `develop`; stable package defaults to `production`). No `--env` option.
|
|
8
8
|
|
|
@@ -31,11 +31,18 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
31
31
|
| `praxis agent computer lease renew create` | `agent.computers.leases.renew.create` | POST `/agent/v1/computers/{computer_id}/leases/{lease_id}/renew` | `--computer`, `--lease` |
|
|
32
32
|
| `praxis agent computer list` | `agent.computers.list` | GET `/agent/v1/computers` | `--param-limit`, `--page` |
|
|
33
33
|
| `praxis agent computer update <computer_id>` | `agent.computers.update` | POST `/agent/v1/computers/{computer_id}` | `--name` |
|
|
34
|
-
| `praxis agent create` | `agent.agents.create` | POST `/agent/v1/agents` | `--name`, `--description`, `--system`, `--kind`, `--computer-id`, `--subagent-model`, `--avatar`, `--environment-id`, `--vault-ids`, `--preset` |
|
|
34
|
+
| `praxis agent create` | `agent.agents.create` | POST `/agent/v1/agents` | `--name`, `--description`, `--system`, `--kind`, `--computer-id`, `--subagent-model`, `--image-model`, `--avatar`, `--environment-id`, `--vault-ids`, `--preset` |
|
|
35
35
|
| `praxis agent customer auth access-token create` | `agent.agents.customers.auth.accessTokens.create` | POST `/agent/v1/agents/{agent_id}/customers/auth/access_tokens` | `--agent` |
|
|
36
36
|
| `praxis agent customer auth access-token delete-current` | `agent.agents.customers.auth.accessTokens.deleteCurrent` | DELETE `/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current` | `--agent` |
|
|
37
37
|
| `praxis agent customer auth access-token renew create` | `agent.agents.customers.auth.accessTokens.renew.create` | POST `/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew` | `--agent` |
|
|
38
|
-
| `praxis agent customer auth grant-code create` | `agent.agents.customers.auth.grantCodes.create` | POST `/agent/v1/agents/{agent_id}/customers/auth/grant_codes` | `--agent`, `--customer-id`, `--param-version`, `--
|
|
38
|
+
| `praxis agent customer auth grant-code create` | `agent.agents.customers.auth.grantCodes.create` | POST `/agent/v1/agents/{agent_id}/customers/auth/grant_codes` | `--agent`, `--customer-id`, `--param-version`, `--origin`, `--expires-in`, `--max-session-seconds`, `--anonymous-access-token`, `--hosted` |
|
|
39
|
+
| `praxis agent customer block create` | `agent.agents.customers.block.create` | POST `/agent/v1/agents/{agent_id}/customers/{customer_id}/block` | `--agent`, `--customer` |
|
|
40
|
+
| `praxis agent customer delete <customer_id>` | `agent.agents.customers.delete` | DELETE `/agent/v1/agents/{agent_id}/customers/{customer_id}` | `--agent`, `--confirm` |
|
|
41
|
+
| `praxis agent customer get <customer_id>` | `agent.agents.customers.retrieve` | GET `/agent/v1/agents/{agent_id}/customers/{customer_id}` | `--agent` |
|
|
42
|
+
| `praxis agent customer get-deletion <customer_id>` | `agent.agents.customers.retrieveDeletion` | GET `/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion` | `--agent` |
|
|
43
|
+
| `praxis agent customer list` | `agent.agents.customers.list` | GET `/agent/v1/agents/{agent_id}/customers` | `--agent`, `--param-limit`, `--page`, `--q`, `--type`, `--blocked` |
|
|
44
|
+
| `praxis agent customer revoke-token create` | `agent.agents.customers.revokeTokens.create` | POST `/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens` | `--agent`, `--customer` |
|
|
45
|
+
| `praxis agent customer unblock create` | `agent.agents.customers.unblock.create` | POST `/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock` | `--agent`, `--customer` |
|
|
39
46
|
| `praxis agent deployment archive <deployment_id>` | `agent.deployments.archive` | POST `/agent/v1/deployments/{deployment_id}/archive` | |
|
|
40
47
|
| `praxis agent deployment create` | `agent.deployments.create` | POST `/agent/v1/deployments` | `--environment-id`, `--name`, `--description`, `--vault-ids` |
|
|
41
48
|
| `praxis agent deployment get <deployment_id>` | `agent.deployments.retrieve` | GET `/agent/v1/deployments/{deployment_id}` | |
|
|
@@ -46,25 +53,13 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
46
53
|
| `praxis agent deployment update <deployment_id>` | `agent.deployments.update` | POST `/agent/v1/deployments/{deployment_id}` | `--description`, `--environment-id`, `--name`, `--vault-ids` |
|
|
47
54
|
| `praxis agent deployment-run get <deployment_run_id>` | `agent.deploymentRuns.retrieve` | GET `/agent/v1/deployment_runs/{deployment_run_id}` | |
|
|
48
55
|
| `praxis agent deployment-run list` | `agent.deploymentRuns.list` | GET `/agent/v1/deployment_runs` | `--created-at-gt`, `--created-at-gte`, `--created-at-lt`, `--created-at-lte`, `--deployment-id`, `--has-error`, `--trigger-type`, `--param-limit`, `--page` |
|
|
49
|
-
| `praxis agent embed exchange create` | `agent.embed.exchange.create` | POST `/agent/v1/embed/exchange` | `--code` |
|
|
50
|
-
| `praxis agent embed get-appearance` | `agent.embed.retrieveAppearance` | GET `/agent/v1/embed/appearance` | |
|
|
51
|
-
| `praxis agent embed-token anonymous create` | `agent.embedTokens.anonymous.create` | POST `/agent/v1/embed_tokens/anonymous` | `--publishable-key`, `--visitor-secret` |
|
|
52
|
-
| `praxis agent embed-token create` | `agent.embedTokens.create` | POST `/agent/v1/embed_tokens` | `--hosted`, `--agent`, `--param-version`, `--external-user-id`, `--ttl-seconds`, `--budget-cents`, `--allowed-origins` |
|
|
53
|
-
| `praxis agent embed-token list` | `agent.embedTokens.list` | GET `/agent/v1/embed_tokens` | `--agent-id`, `--external-user-id`, `--param-limit`, `--page` |
|
|
54
|
-
| `praxis agent embed-token revoke create` | `agent.embedTokens.revoke.create` | POST `/agent/v1/embed_tokens/{id}/revoke` | `--embed-token` |
|
|
55
|
-
| `praxis agent end-user block create` | `agent.agents.endUsers.block.create` | POST `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/block` | `--agent`, `--end-user` |
|
|
56
|
-
| `praxis agent end-user delete <external_user_id>` | `agent.agents.endUsers.delete` | DELETE `/agent/v1/agents/{agent_id}/end_users/{external_user_id}` | `--agent`, `--confirm` |
|
|
57
|
-
| `praxis agent end-user get <external_user_id>` | `agent.agents.endUsers.retrieve` | GET `/agent/v1/agents/{agent_id}/end_users/{external_user_id}` | `--agent` |
|
|
58
|
-
| `praxis agent end-user get-deletion <external_user_id>` | `agent.agents.endUsers.retrieveDeletion` | GET `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/deletion` | `--agent` |
|
|
59
|
-
| `praxis agent end-user list` | `agent.agents.endUsers.list` | GET `/agent/v1/agents/{agent_id}/end_users` | `--agent`, `--param-limit`, `--page`, `--q` |
|
|
60
|
-
| `praxis agent end-user revoke-token create` | `agent.agents.endUsers.revokeTokens.create` | POST `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/revoke_tokens` | `--agent`, `--end-user` |
|
|
61
|
-
| `praxis agent end-user unblock create` | `agent.agents.endUsers.unblock.create` | POST `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock` | `--agent`, `--end-user` |
|
|
62
56
|
| `praxis agent environment archive <environment_id>` | `agent.environments.archive` | POST `/agent/v1/environments/{environment_id}/archive` | |
|
|
63
57
|
| `praxis agent environment create` | `agent.environments.create` | POST `/agent/v1/environments` | `--name`, `--description` |
|
|
64
58
|
| `praxis agent environment get <environment_id>` | `agent.environments.retrieve` | GET `/agent/v1/environments/{environment_id}` | |
|
|
65
59
|
| `praxis agent environment list` | `agent.environments.list` | GET `/agent/v1/environments` | `--include-archived`, `--param-limit`, `--page` |
|
|
66
60
|
| `praxis agent environment update <environment_id>` | `agent.environments.update` | POST `/agent/v1/environments/{environment_id}` | `--description`, `--name` |
|
|
67
61
|
| `praxis agent get <agent_id>` | `agent.agents.retrieve` | GET `/agent/v1/agents/{agent_id}` | `--param-version` |
|
|
62
|
+
| `praxis agent get-appearance <agent_id>` | `agent.agents.retrieveAppearance` | GET `/agent/v1/agents/{agent_id}/appearance` | |
|
|
68
63
|
| `praxis agent list` | `agent.agents.list` | GET `/agent/v1/agents` | `--created-at-gte`, `--created-at-lte`, `--include-archived`, `--param-limit`, `--page`, `--kind` |
|
|
69
64
|
| `praxis agent session archive <session_id>` | `agent.sessions.archive` | POST `/agent/v1/sessions/{session_id}/archive` | |
|
|
70
65
|
| `praxis agent session background-task get-output <task_id>` | `agent.sessions.backgroundTasks.retrieveOutput` | GET `/agent/v1/sessions/{session_id}/background_tasks/{task_id}/output` | `--session`, `--offset`, `--max-bytes` |
|
|
@@ -105,7 +100,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
105
100
|
| `praxis agent skill version list` | `agent.skills.versions.list` | GET `/agent/v1/skills/{skill_id}/versions` | `--skill`, `--param-limit`, `--page` |
|
|
106
101
|
| `praxis agent toolset list` | `agent.toolsets.list` | GET `/agent/v1/toolsets` | |
|
|
107
102
|
| `praxis agent unarchive create` | `agent.agents.unarchive.create` | POST `/agent/v1/agents/{agent_id}/unarchive` | `--agent` |
|
|
108
|
-
| `praxis agent update <agent_id>` | `agent.agents.update` | POST `/agent/v1/agents/{agent_id}` | `--description`, `--name`, `--system`, `--param-version`, `--apply`, `--version-note`, `--kind`, `--computer-id`, `--subagent-model`, `--avatar`, `--environment-id`, `--vault-ids`, `--preset` |
|
|
103
|
+
| `praxis agent update <agent_id>` | `agent.agents.update` | POST `/agent/v1/agents/{agent_id}` | `--description`, `--name`, `--system`, `--param-version`, `--apply`, `--version-note`, `--kind`, `--computer-id`, `--subagent-model`, `--image-model`, `--avatar`, `--environment-id`, `--vault-ids`, `--preset` |
|
|
109
104
|
| `praxis agent version apply <version>` | `agent.agents.versions.apply` | POST `/agent/v1/agents/{agent_id}/versions/{version}/apply` | `--agent` |
|
|
110
105
|
| `praxis agent version list` | `agent.agents.versions.list` | GET `/agent/v1/agents/{agent_id}/versions` | `--agent`, `--param-limit`, `--page` |
|
|
111
106
|
| `praxis application asset upload` | `application.assets.upload.create` | POST `/application/v1/assets/upload` | `--jwt` |
|
package/dist/praxis.js
CHANGED
|
@@ -141,7 +141,7 @@ across all toolsets allowed.`
|
|
|
141
141
|
type: "array",
|
|
142
142
|
itemType: "object",
|
|
143
143
|
required: false,
|
|
144
|
-
description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings."
|
|
144
|
+
description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
|
|
145
145
|
},
|
|
146
146
|
{
|
|
147
147
|
name: "kind",
|
|
@@ -165,6 +165,12 @@ across all toolsets allowed.`
|
|
|
165
165
|
required: false,
|
|
166
166
|
description: "Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only."
|
|
167
167
|
},
|
|
168
|
+
{
|
|
169
|
+
name: "image_model",
|
|
170
|
+
type: "string",
|
|
171
|
+
required: false,
|
|
172
|
+
description: "Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only."
|
|
173
|
+
},
|
|
168
174
|
{
|
|
169
175
|
name: "subagents",
|
|
170
176
|
type: "array",
|
|
@@ -380,6 +386,12 @@ current version; omit to apply the update unconditionally.`
|
|
|
380
386
|
required: false,
|
|
381
387
|
description: "Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only."
|
|
382
388
|
},
|
|
389
|
+
{
|
|
390
|
+
name: "image_model",
|
|
391
|
+
type: "string",
|
|
392
|
+
required: false,
|
|
393
|
+
description: "Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only."
|
|
394
|
+
},
|
|
383
395
|
{
|
|
384
396
|
name: "subagents",
|
|
385
397
|
type: "array",
|
|
@@ -439,6 +451,26 @@ current version; omit to apply the update unconditionally.`
|
|
|
439
451
|
]
|
|
440
452
|
}
|
|
441
453
|
},
|
|
454
|
+
{
|
|
455
|
+
resource: "agent.agents",
|
|
456
|
+
method: "retrieveAppearance",
|
|
457
|
+
summary: "Get agent appearance",
|
|
458
|
+
description: `Read the saved chat appearance of a service agent.
|
|
459
|
+
|
|
460
|
+
Agent Kit calls this from the page with a customer access token of this agent; your API key and console members can read it too. A token of another agent returns 404. The body is the same as the embed appearance read; a missing appearance returns the agent's own name and avatar only. Responses are private and cacheable for 60 seconds.`,
|
|
461
|
+
http: "GET",
|
|
462
|
+
path: "/agent/v1/agents/{agent_id}/appearance",
|
|
463
|
+
streaming: "no",
|
|
464
|
+
pagination: false,
|
|
465
|
+
pathParams: [
|
|
466
|
+
{
|
|
467
|
+
name: "agent_id",
|
|
468
|
+
sdkName: "agent_id",
|
|
469
|
+
description: "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for."
|
|
470
|
+
}
|
|
471
|
+
],
|
|
472
|
+
query: []
|
|
473
|
+
},
|
|
442
474
|
{
|
|
443
475
|
resource: "agent.agents",
|
|
444
476
|
method: "archive",
|
|
@@ -457,6 +489,61 @@ current version; omit to apply the update unconditionally.`
|
|
|
457
489
|
],
|
|
458
490
|
query: []
|
|
459
491
|
},
|
|
492
|
+
{
|
|
493
|
+
resource: "agent.agents.customers",
|
|
494
|
+
method: "list",
|
|
495
|
+
summary: "List customers",
|
|
496
|
+
description: `List the customers of a service agent, identified and anonymous, most recently seen first.
|
|
497
|
+
|
|
498
|
+
Call this from your backend with your API key, or from the console. Customers follow Shopify Admin customers (list, retrieve, block, sign-out and data deletion of the people who use your storefront), so that experience applies. The list includes customers who signed in but have not started a session yet, and customers recorded under your own ids by embed tokens before customer sign-in existed; an id first seen that way is identified unless it starts with anon_. Unlike Shopify, a customer can be anonymous: a visitor admitted with the publishable key gets an anon_ id, and when it later signs in with anonymous_access_token it is merged: merged_into names the identified customer, and its sessions count toward that customer. Filter with q (a case-sensitive customer id prefix), type (identified or anonymous) and blocked (true or false). limit is 1 to 100, default 20; reuse next_page with the same filters and limit. A customer access token gets 404. Example: GET /agent/v1/agents/agent_example/customers?type=identified&blocked=false&limit=50.`,
|
|
499
|
+
http: "GET",
|
|
500
|
+
path: "/agent/v1/agents/{agent_id}/customers",
|
|
501
|
+
streaming: "no",
|
|
502
|
+
pagination: false,
|
|
503
|
+
pathParams: [
|
|
504
|
+
{
|
|
505
|
+
name: "agent_id",
|
|
506
|
+
sdkName: "agent_id",
|
|
507
|
+
description: "Active service agent id from agent creation or listing."
|
|
508
|
+
}
|
|
509
|
+
],
|
|
510
|
+
query: [
|
|
511
|
+
{
|
|
512
|
+
name: "limit",
|
|
513
|
+
type: "integer",
|
|
514
|
+
required: false,
|
|
515
|
+
description: "Maximum customers per page, 1 to 100; defaults to 20."
|
|
516
|
+
},
|
|
517
|
+
{
|
|
518
|
+
name: "page",
|
|
519
|
+
type: "string",
|
|
520
|
+
required: false,
|
|
521
|
+
description: "next_page from the previous response with the same q, type, blocked and limit."
|
|
522
|
+
},
|
|
523
|
+
{
|
|
524
|
+
name: "q",
|
|
525
|
+
type: "string",
|
|
526
|
+
required: false,
|
|
527
|
+
description: "Case-sensitive literal prefix of the customer id; omit for all customers."
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
name: "type",
|
|
531
|
+
type: "string",
|
|
532
|
+
enum: [
|
|
533
|
+
"identified",
|
|
534
|
+
"anonymous"
|
|
535
|
+
],
|
|
536
|
+
required: false,
|
|
537
|
+
description: "Only identified or only anonymous customers; omit for both."
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
name: "blocked",
|
|
541
|
+
type: "boolean",
|
|
542
|
+
required: false,
|
|
543
|
+
description: "true for blocked customers only, false for customers who are not blocked; omit for both."
|
|
544
|
+
}
|
|
545
|
+
]
|
|
546
|
+
},
|
|
460
547
|
{
|
|
461
548
|
resource: "agent.agents.customers.auth.accessTokens",
|
|
462
549
|
method: "create",
|
|
@@ -527,7 +614,7 @@ Send the current customer access token as the Bearer credential, with no body, a
|
|
|
527
614
|
summary: "Create customer grant code",
|
|
528
615
|
description: `Sign your logged-in customer in to a service agent from your backend with a one-time grant code that Agent Kit exchanges for a customer access token.
|
|
529
616
|
|
|
530
|
-
Call this from your backend with your API key after your own login succeeds, then pass the returned code to Agent Kit in the browser; never call it from the browser. Customer authorization follows Shopify Storefront customer access tokens (Multipass-style sign-in, a short-lived token, renewal and logout), so that experience applies. customer_id is your own identifier for the customer: use an opaque id such as your database user id, not an email address or phone number. The value auth is reserved, and ids starting with anon_ are reserved for anonymous customers. The code works once and expires after expires_in seconds (default 900). The sign-in it starts lasts max_session_seconds (default 7 days); version,
|
|
617
|
+
Call this from your backend with your API key after your own login succeeds, then pass the returned code to Agent Kit in the browser; never call it from the browser. Customer authorization follows Shopify Storefront customer access tokens (Multipass-style sign-in, a short-lived token, renewal and logout), so that experience applies. customer_id is your own identifier for the customer: use an opaque id such as your database user id, not an email address or phone number. The value auth is reserved, and ids starting with anon_ are reserved for anonymous customers. The code works once and expires after expires_in seconds (default 900). The sign-in it starts lasts max_session_seconds (default 7 days); version, budget (US dollars, at most 2 decimals), system_message, agent_override and metadata apply to every token of the sign-in. Unlike Shopify, origin binds the whole sign-in to one page origin, and anonymous_access_token merges the conversations of the anonymous visitor who chatted before signing in into this customer. Example body: {"customer_id":"cus_8f2a91","origin":"https://shop.example.com"}.`,
|
|
531
618
|
http: "POST",
|
|
532
619
|
path: "/agent/v1/agents/{agent_id}/customers/auth/grant_codes",
|
|
533
620
|
streaming: "no",
|
|
@@ -556,10 +643,10 @@ Call this from your backend with your API key after your own login succeeds, the
|
|
|
556
643
|
description: "Existing agent version that every token of this sign-in pins. Defaults to the agent's active_version when the code is issued."
|
|
557
644
|
},
|
|
558
645
|
{
|
|
559
|
-
name: "
|
|
560
|
-
type: "
|
|
646
|
+
name: "budget",
|
|
647
|
+
type: "object",
|
|
561
648
|
required: false,
|
|
562
|
-
description: "Budget
|
|
649
|
+
description: "Budget for each session the customer starts, in the same shape as a session budget. Defaults to the embed policy session budget and cannot exceed its maximum."
|
|
563
650
|
},
|
|
564
651
|
{
|
|
565
652
|
name: "system_message",
|
|
@@ -614,65 +701,26 @@ Call this from your backend with your API key after your own login succeeds, the
|
|
|
614
701
|
}
|
|
615
702
|
},
|
|
616
703
|
{
|
|
617
|
-
resource: "agent.agents.
|
|
618
|
-
method: "list",
|
|
619
|
-
summary: "List End Users",
|
|
620
|
-
description: `List users who have sessions or token issuance history on a service agent.
|
|
621
|
-
|
|
622
|
-
Ordered by last_active_at and external_user_id descending. q is a case-sensitive literal prefix, including underscores. limit is 1–100, default 20. Reuse next_page with the same organization, agent, q and limit. Preemptively blocked users without history do not appear. End-user credentials and inaccessible or personal agents return 404.`,
|
|
623
|
-
http: "GET",
|
|
624
|
-
path: "/agent/v1/agents/{agent_id}/end_users",
|
|
625
|
-
streaming: "no",
|
|
626
|
-
pagination: false,
|
|
627
|
-
pathParams: [
|
|
628
|
-
{
|
|
629
|
-
name: "agent_id",
|
|
630
|
-
sdkName: "agent_id",
|
|
631
|
-
description: "Active service agent identifier from agent creation or listing."
|
|
632
|
-
}
|
|
633
|
-
],
|
|
634
|
-
query: [
|
|
635
|
-
{
|
|
636
|
-
name: "limit",
|
|
637
|
-
type: "integer",
|
|
638
|
-
required: false,
|
|
639
|
-
description: "Maximum users per page; defaults to 20."
|
|
640
|
-
},
|
|
641
|
-
{
|
|
642
|
-
name: "page",
|
|
643
|
-
type: "string",
|
|
644
|
-
required: false,
|
|
645
|
-
description: "next_page from the previous response with the same agent, q and limit."
|
|
646
|
-
},
|
|
647
|
-
{
|
|
648
|
-
name: "q",
|
|
649
|
-
type: "string",
|
|
650
|
-
required: false,
|
|
651
|
-
description: "Case-sensitive literal prefix of external_user_id; omit or use an empty string for all users."
|
|
652
|
-
}
|
|
653
|
-
]
|
|
654
|
-
},
|
|
655
|
-
{
|
|
656
|
-
resource: "agent.agents.endUsers",
|
|
704
|
+
resource: "agent.agents.customers",
|
|
657
705
|
method: "delete",
|
|
658
|
-
summary: "Delete
|
|
659
|
-
description: `Delete a
|
|
706
|
+
summary: "Delete customer data",
|
|
707
|
+
description: `Delete a customer's data from one service agent after explicit confirmation.
|
|
660
708
|
|
|
661
|
-
Develop only. Set confirm to the exact
|
|
709
|
+
Develop only. Set confirm to the exact customer id; a missing or different confirm returns 400 naming the value to send. Returns 202 with a pending task id; poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the customer is blocked before a seven-day recovery snapshot is verified; sessions including child sessions, conversation data, grants and feedback are then removed. A block that existed before stays; a temporary block is removed on success. File attachments are retained. Example: DELETE /agent/v1/agents/agent_example/customers/cus_8f2a91?confirm=cus_8f2a91.`,
|
|
662
710
|
http: "DELETE",
|
|
663
|
-
path: "/agent/v1/agents/{agent_id}/
|
|
711
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}",
|
|
664
712
|
streaming: "no",
|
|
665
713
|
pagination: false,
|
|
666
714
|
pathParams: [
|
|
667
715
|
{
|
|
668
716
|
name: "agent_id",
|
|
669
717
|
sdkName: "agent_id",
|
|
670
|
-
description: "Active service agent
|
|
718
|
+
description: "Active service agent id from agent creation or listing."
|
|
671
719
|
},
|
|
672
720
|
{
|
|
673
|
-
name: "
|
|
674
|
-
sdkName: "
|
|
675
|
-
description: "
|
|
721
|
+
name: "customer_id",
|
|
722
|
+
sdkName: "customer_id",
|
|
723
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
676
724
|
}
|
|
677
725
|
],
|
|
678
726
|
query: [
|
|
@@ -680,131 +728,131 @@ Develop only. Set confirm to the exact external_user_id; missing or mismatched c
|
|
|
680
728
|
name: "confirm",
|
|
681
729
|
type: "string",
|
|
682
730
|
required: true,
|
|
683
|
-
description: "Must
|
|
731
|
+
description: "Must equal the customer_id path parameter exactly, confirming the destructive deletion."
|
|
684
732
|
}
|
|
685
733
|
]
|
|
686
734
|
},
|
|
687
735
|
{
|
|
688
|
-
resource: "agent.agents.
|
|
736
|
+
resource: "agent.agents.customers",
|
|
689
737
|
method: "retrieve",
|
|
690
|
-
summary: "Get
|
|
691
|
-
description: `
|
|
738
|
+
summary: "Get customer",
|
|
739
|
+
description: `Retrieve one customer of a service agent with its twenty most recently updated sessions.
|
|
692
740
|
|
|
693
|
-
Use
|
|
741
|
+
Use the customer id from the list or your own customer_id. An unknown customer returns 404 CUSTOMER_NOT_FOUND, and so does a customer access token. Unlike Shopify, an identified customer's session_count, cost and recent_sessions include the sessions of anonymous customers merged into it; the merged anonymous customer still shows its own sessions and its merged_into.`,
|
|
694
742
|
http: "GET",
|
|
695
|
-
path: "/agent/v1/agents/{agent_id}/
|
|
743
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}",
|
|
696
744
|
streaming: "no",
|
|
697
745
|
pagination: false,
|
|
698
746
|
pathParams: [
|
|
699
747
|
{
|
|
700
748
|
name: "agent_id",
|
|
701
749
|
sdkName: "agent_id",
|
|
702
|
-
description: "Active service agent
|
|
750
|
+
description: "Active service agent id from agent creation or listing."
|
|
703
751
|
},
|
|
704
752
|
{
|
|
705
|
-
name: "
|
|
706
|
-
sdkName: "
|
|
707
|
-
description: "
|
|
753
|
+
name: "customer_id",
|
|
754
|
+
sdkName: "customer_id",
|
|
755
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
708
756
|
}
|
|
709
757
|
],
|
|
710
758
|
query: []
|
|
711
759
|
},
|
|
712
760
|
{
|
|
713
|
-
resource: "agent.agents.
|
|
761
|
+
resource: "agent.agents.customers.block",
|
|
714
762
|
method: "create",
|
|
715
|
-
summary: "Block
|
|
716
|
-
description: `Block
|
|
763
|
+
summary: "Block customer",
|
|
764
|
+
description: `Block a customer and end every sign-in it has on this agent.
|
|
717
765
|
|
|
718
|
-
|
|
766
|
+
Blocks the customer, then ends every live sign-in the way logout does: each access token is revoked and its open event streams close. From then on grant_codes, access_tokens, renew and new sessions for this customer return CUSTOMER_BLOCKED until you unblock it. Idempotent: a repeat keeps the first block time and revokes whatever is still live. If credential revocation fails the request returns 502 and the customer stays blocked; retry to finish. An unknown customer returns 404 CUSTOMER_NOT_FOUND.`,
|
|
719
767
|
http: "POST",
|
|
720
|
-
path: "/agent/v1/agents/{agent_id}/
|
|
768
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/block",
|
|
721
769
|
streaming: "no",
|
|
722
770
|
pagination: false,
|
|
723
771
|
pathParams: [
|
|
724
772
|
{
|
|
725
773
|
name: "agent_id",
|
|
726
774
|
sdkName: "agent_id",
|
|
727
|
-
description: "Active service agent
|
|
775
|
+
description: "Active service agent id from agent creation or listing."
|
|
728
776
|
},
|
|
729
777
|
{
|
|
730
|
-
name: "
|
|
731
|
-
sdkName: "
|
|
732
|
-
description: "
|
|
778
|
+
name: "customer_id",
|
|
779
|
+
sdkName: "customer_id",
|
|
780
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
733
781
|
}
|
|
734
782
|
],
|
|
735
783
|
query: []
|
|
736
784
|
},
|
|
737
785
|
{
|
|
738
|
-
resource: "agent.agents.
|
|
786
|
+
resource: "agent.agents.customers",
|
|
739
787
|
method: "retrieveDeletion",
|
|
740
|
-
summary: "Get
|
|
741
|
-
description: `Poll the latest deletion task
|
|
788
|
+
summary: "Get customer deletion",
|
|
789
|
+
description: `Poll the latest deletion task of a customer, including after its data has been removed.
|
|
742
790
|
|
|
743
|
-
Use the same agent_id and
|
|
791
|
+
Use the same agent_id and customer id as the confirmed DELETE. Status is pending, snapshotting, deleting, done or failed. Counts are empty until a verified snapshot exists. snapshot_key is an operator recovery reference retained for seven days, not a download URL. A customer access token and a missing task return 404.`,
|
|
744
792
|
http: "GET",
|
|
745
|
-
path: "/agent/v1/agents/{agent_id}/
|
|
793
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion",
|
|
746
794
|
streaming: "no",
|
|
747
795
|
pagination: false,
|
|
748
796
|
pathParams: [
|
|
749
797
|
{
|
|
750
798
|
name: "agent_id",
|
|
751
799
|
sdkName: "agent_id",
|
|
752
|
-
description: "Active service agent
|
|
800
|
+
description: "Active service agent id from agent creation or listing."
|
|
753
801
|
},
|
|
754
802
|
{
|
|
755
|
-
name: "
|
|
756
|
-
sdkName: "
|
|
757
|
-
description: "
|
|
803
|
+
name: "customer_id",
|
|
804
|
+
sdkName: "customer_id",
|
|
805
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
758
806
|
}
|
|
759
807
|
],
|
|
760
808
|
query: []
|
|
761
809
|
},
|
|
762
810
|
{
|
|
763
|
-
resource: "agent.agents.
|
|
811
|
+
resource: "agent.agents.customers.revokeTokens",
|
|
764
812
|
method: "create",
|
|
765
|
-
summary: "Revoke
|
|
766
|
-
description: `
|
|
813
|
+
summary: "Revoke customer tokens",
|
|
814
|
+
description: `Sign a customer out everywhere without blocking it.
|
|
767
815
|
|
|
768
|
-
|
|
816
|
+
Ends every live sign-in of the customer, revoking each access token and closing its open event streams; the customer can sign in again right away. Returns the number of access tokens this request revoked; a repeat returns 0. Credential revocation failure returns 502; retry to finish. An unknown customer returns 404 CUSTOMER_NOT_FOUND.`,
|
|
769
817
|
http: "POST",
|
|
770
|
-
path: "/agent/v1/agents/{agent_id}/
|
|
818
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens",
|
|
771
819
|
streaming: "no",
|
|
772
820
|
pagination: false,
|
|
773
821
|
pathParams: [
|
|
774
822
|
{
|
|
775
823
|
name: "agent_id",
|
|
776
824
|
sdkName: "agent_id",
|
|
777
|
-
description: "Active service agent
|
|
825
|
+
description: "Active service agent id from agent creation or listing."
|
|
778
826
|
},
|
|
779
827
|
{
|
|
780
|
-
name: "
|
|
781
|
-
sdkName: "
|
|
782
|
-
description: "
|
|
828
|
+
name: "customer_id",
|
|
829
|
+
sdkName: "customer_id",
|
|
830
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
783
831
|
}
|
|
784
832
|
],
|
|
785
833
|
query: []
|
|
786
834
|
},
|
|
787
835
|
{
|
|
788
|
-
resource: "agent.agents.
|
|
836
|
+
resource: "agent.agents.customers.unblock",
|
|
789
837
|
method: "create",
|
|
790
|
-
summary: "Unblock
|
|
791
|
-
description: `Allow
|
|
838
|
+
summary: "Unblock customer",
|
|
839
|
+
description: `Allow a blocked customer to sign in and start sessions again.
|
|
792
840
|
|
|
793
|
-
|
|
841
|
+
Idempotent. Access tokens revoked while the customer was blocked stay revoked; sign the customer in again with a new grant code. An unknown customer returns 404 CUSTOMER_NOT_FOUND.`,
|
|
794
842
|
http: "POST",
|
|
795
|
-
path: "/agent/v1/agents/{agent_id}/
|
|
843
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock",
|
|
796
844
|
streaming: "no",
|
|
797
845
|
pagination: false,
|
|
798
846
|
pathParams: [
|
|
799
847
|
{
|
|
800
848
|
name: "agent_id",
|
|
801
849
|
sdkName: "agent_id",
|
|
802
|
-
description: "Active service agent
|
|
850
|
+
description: "Active service agent id from agent creation or listing."
|
|
803
851
|
},
|
|
804
852
|
{
|
|
805
|
-
name: "
|
|
806
|
-
sdkName: "
|
|
807
|
-
description: "
|
|
853
|
+
name: "customer_id",
|
|
854
|
+
sdkName: "customer_id",
|
|
855
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
808
856
|
}
|
|
809
857
|
],
|
|
810
858
|
query: []
|
|
@@ -1639,214 +1687,6 @@ null to clear. Maximum 50.`
|
|
|
1639
1687
|
],
|
|
1640
1688
|
query: []
|
|
1641
1689
|
},
|
|
1642
|
-
{
|
|
1643
|
-
resource: "agent.embed",
|
|
1644
|
-
method: "retrieveAppearance",
|
|
1645
|
-
summary: "Read chat appearance",
|
|
1646
|
-
description: "Load saved appearance for an iframe or Hosted chat page. Supply an end-user embed token as Bearer authorization, or a console-issued publishable key in Praxis-Publishable-Key before anonymous token issuance. The credential selects the agent; identity_number and agent_id query parameters are rejected with 400. Missing appearance returns an empty object. Kit option names retain camelCase. Responses are private and cacheable for 60 seconds. Component hosts configure Kit in their own code instead.",
|
|
1647
|
-
http: "GET",
|
|
1648
|
-
path: "/agent/v1/embed/appearance",
|
|
1649
|
-
streaming: "no",
|
|
1650
|
-
pagination: false,
|
|
1651
|
-
pathParams: [],
|
|
1652
|
-
query: []
|
|
1653
|
-
},
|
|
1654
|
-
{
|
|
1655
|
-
resource: "agent.embed.exchange",
|
|
1656
|
-
method: "create",
|
|
1657
|
-
summary: "Exchange Hosted Code",
|
|
1658
|
-
description: `Redeem a single-use hosted link credential for an end-user token.
|
|
1659
|
-
|
|
1660
|
-
Read code from the c fragment parameter of hosted_url returned by embed token creation with hosted true, then remove the fragment before exchanging. No Authorization header is required; the code authenticates this request. The code expires after 60 seconds and is consumed atomically on exchange, so concurrent attempts have only one winner. Expired, used and unknown codes return the same 404 body. Keep the token in memory and return to the host website for a fresh link when it expires; exchange cannot refresh it. Requests are IP limited per minute using the anonymous entrypoint budget (default 20). Example body is {"code":"<code from hosted_url>"}.`,
|
|
1661
|
-
http: "POST",
|
|
1662
|
-
path: "/agent/v1/embed/exchange",
|
|
1663
|
-
streaming: "no",
|
|
1664
|
-
pagination: false,
|
|
1665
|
-
pathParams: [],
|
|
1666
|
-
query: [],
|
|
1667
|
-
body: {
|
|
1668
|
-
required: true,
|
|
1669
|
-
fields: [
|
|
1670
|
-
{
|
|
1671
|
-
name: "code",
|
|
1672
|
-
type: "string",
|
|
1673
|
-
required: true,
|
|
1674
|
-
description: "Single-use credential from the c fragment parameter of hosted_url returned by embed token creation. Valid for 60 seconds."
|
|
1675
|
-
}
|
|
1676
|
-
]
|
|
1677
|
-
}
|
|
1678
|
-
},
|
|
1679
|
-
{
|
|
1680
|
-
resource: "agent.embedTokens",
|
|
1681
|
-
method: "list",
|
|
1682
|
-
summary: "List Embed Tokens",
|
|
1683
|
-
description: `List embed token issuance records in your organization.
|
|
1684
|
-
|
|
1685
|
-
Includes expired and revoked grants; returns neither token nor token_id. Sorts by created_at, then grant id, both descending. agent_id accepts agent_ or agt_; external_user_id matches exactly. limit is 1–100 (default 20). Reuse next_page as page with the same filters and organization; a mismatch returns 400. End-user credentials return 404.`,
|
|
1686
|
-
http: "GET",
|
|
1687
|
-
path: "/agent/v1/embed_tokens",
|
|
1688
|
-
streaming: "no",
|
|
1689
|
-
pagination: false,
|
|
1690
|
-
pathParams: [],
|
|
1691
|
-
query: [
|
|
1692
|
-
{
|
|
1693
|
-
name: "agent_id",
|
|
1694
|
-
type: "string",
|
|
1695
|
-
required: false,
|
|
1696
|
-
description: "Filter by service agent identifier (agent_ or agt_ prefix)."
|
|
1697
|
-
},
|
|
1698
|
-
{
|
|
1699
|
-
name: "external_user_id",
|
|
1700
|
-
type: "string",
|
|
1701
|
-
required: false,
|
|
1702
|
-
description: "Exact host user identifier supplied at issuance."
|
|
1703
|
-
},
|
|
1704
|
-
{
|
|
1705
|
-
name: "limit",
|
|
1706
|
-
type: "integer",
|
|
1707
|
-
required: false,
|
|
1708
|
-
description: "Maximum records per page; defaults to 20."
|
|
1709
|
-
},
|
|
1710
|
-
{
|
|
1711
|
-
name: "page",
|
|
1712
|
-
type: "string",
|
|
1713
|
-
required: false,
|
|
1714
|
-
description: "next_page from a previous response with the same filters."
|
|
1715
|
-
}
|
|
1716
|
-
]
|
|
1717
|
-
},
|
|
1718
|
-
{
|
|
1719
|
-
resource: "agent.embedTokens",
|
|
1720
|
-
method: "create",
|
|
1721
|
-
summary: "Create Embed Token",
|
|
1722
|
-
description: `Issue a short-lived credential on your backend for an end user of a service agent.
|
|
1723
|
-
|
|
1724
|
-
Requires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent. Set hosted to true to also receive hosted_url; redirect the user there within 60 seconds. The agent must have an identity_number. The URL fragment contains a single-use exchange credential, not the token. Omit hosted or set false for ordinary token issuance.`,
|
|
1725
|
-
http: "POST",
|
|
1726
|
-
path: "/agent/v1/embed_tokens",
|
|
1727
|
-
streaming: "no",
|
|
1728
|
-
pagination: false,
|
|
1729
|
-
pathParams: [],
|
|
1730
|
-
query: [],
|
|
1731
|
-
body: {
|
|
1732
|
-
required: true,
|
|
1733
|
-
fields: [
|
|
1734
|
-
{
|
|
1735
|
-
name: "hosted",
|
|
1736
|
-
type: "boolean",
|
|
1737
|
-
required: false,
|
|
1738
|
-
description: "Set true to also return a hosted chat URL with a single-use credential valid for 60 seconds. Defaults to false; the agent must have an identity_number."
|
|
1739
|
-
},
|
|
1740
|
-
{
|
|
1741
|
-
name: "agent",
|
|
1742
|
-
type: "string",
|
|
1743
|
-
required: true,
|
|
1744
|
-
description: "Service agent ID or identity_number from agent retrieval; it must belong to your organization and be active."
|
|
1745
|
-
},
|
|
1746
|
-
{
|
|
1747
|
-
name: "version",
|
|
1748
|
-
type: "integer",
|
|
1749
|
-
required: false,
|
|
1750
|
-
description: "Existing agent version to pin. Omit to pin the latest version at issuance."
|
|
1751
|
-
},
|
|
1752
|
-
{
|
|
1753
|
-
name: "external_user_id",
|
|
1754
|
-
type: "string",
|
|
1755
|
-
required: true,
|
|
1756
|
-
description: "Your application's stable end-user identifier, scoped to this organization and agent."
|
|
1757
|
-
},
|
|
1758
|
-
{
|
|
1759
|
-
name: "ttl_seconds",
|
|
1760
|
-
type: "integer",
|
|
1761
|
-
required: false,
|
|
1762
|
-
description: "Token lifetime in seconds. Defaults to the embed policy TTL and cannot exceed its maximum or 3600 seconds."
|
|
1763
|
-
},
|
|
1764
|
-
{
|
|
1765
|
-
name: "budget_cents",
|
|
1766
|
-
type: "integer",
|
|
1767
|
-
required: false,
|
|
1768
|
-
description: "Session budget in cents. Defaults to the embed policy session budget and cannot exceed its maximum."
|
|
1769
|
-
},
|
|
1770
|
-
{
|
|
1771
|
-
name: "system_message",
|
|
1772
|
-
type: "array",
|
|
1773
|
-
itemType: "object",
|
|
1774
|
-
required: false,
|
|
1775
|
-
description: "Optional host context as text blocks, limited to 8192 UTF-8 bytes in total."
|
|
1776
|
-
},
|
|
1777
|
-
{
|
|
1778
|
-
name: "agent_override",
|
|
1779
|
-
type: "object",
|
|
1780
|
-
required: false,
|
|
1781
|
-
description: "Optional system prompt override, accepted only when the embed policy allows agent overrides."
|
|
1782
|
-
},
|
|
1783
|
-
{
|
|
1784
|
-
name: "allowed_origins",
|
|
1785
|
-
type: "array",
|
|
1786
|
-
itemType: "string",
|
|
1787
|
-
required: false,
|
|
1788
|
-
description: "Optional subset of the policy origin entries, compared exactly. Omit to snapshot every policy origin."
|
|
1789
|
-
},
|
|
1790
|
-
{
|
|
1791
|
-
name: "metadata",
|
|
1792
|
-
type: "object",
|
|
1793
|
-
required: false,
|
|
1794
|
-
description: "Host metadata preserved verbatim; at most 16 keys of 1–64 characters and string values of at most 512 characters. Defaults to an empty object."
|
|
1795
|
-
}
|
|
1796
|
-
]
|
|
1797
|
-
}
|
|
1798
|
-
},
|
|
1799
|
-
{
|
|
1800
|
-
resource: "agent.embedTokens.anonymous",
|
|
1801
|
-
method: "create",
|
|
1802
|
-
summary: "Issue anonymous visitor token",
|
|
1803
|
-
description: `Obtain a short-lived embedding token for a visitor without an account using the agent owner's publishable key.
|
|
1804
|
-
|
|
1805
|
-
No Authorization header is required. Send the browser Origin allowed by the agent policy. Save a returned visitor_secret and reuse it for refreshes; only new visitors receive one. Unknown secrets create new visitors, and extra fields including visitor_id return 400. Issuance uses the key creator's organization membership, the key session budget and the smaller of the policy TTL maximum and 3600 seconds. IP requests are limited per minute (default 20); UTC daily session and spending caps are checked across the key's primary sessions created that day. Token issuance itself does not create a session or charge usage; subsequent sessions bill the host organization. Example body: {"publishable_key":"pk_praxis_example"}.`,
|
|
1806
|
-
http: "POST",
|
|
1807
|
-
path: "/agent/v1/embed_tokens/anonymous",
|
|
1808
|
-
streaming: "no",
|
|
1809
|
-
pagination: false,
|
|
1810
|
-
pathParams: [],
|
|
1811
|
-
query: [],
|
|
1812
|
-
body: {
|
|
1813
|
-
required: true,
|
|
1814
|
-
fields: [
|
|
1815
|
-
{
|
|
1816
|
-
name: "publishable_key",
|
|
1817
|
-
type: "string",
|
|
1818
|
-
required: true,
|
|
1819
|
-
description: "Public key created by the service agent owner; safe to include in browser code."
|
|
1820
|
-
},
|
|
1821
|
-
{
|
|
1822
|
-
name: "visitor_secret",
|
|
1823
|
-
type: "string",
|
|
1824
|
-
required: false,
|
|
1825
|
-
description: "Secret returned by a previous anonymous issuance for this key. Omit for a new visitor; an unknown secret creates a new visitor."
|
|
1826
|
-
}
|
|
1827
|
-
]
|
|
1828
|
-
}
|
|
1829
|
-
},
|
|
1830
|
-
{
|
|
1831
|
-
resource: "agent.embedTokens.revoke",
|
|
1832
|
-
method: "create",
|
|
1833
|
-
summary: "Revoke Embed Token",
|
|
1834
|
-
description: `Revoke an embed token and close its open event streams.
|
|
1835
|
-
|
|
1836
|
-
Use an id from issuance or listing. Revokes the credential before setting revoked_at; upstream failure leaves it unset. Streams receive session.error (EMBED_TOKEN_REVOKED), then close immediately; other credentials are unaffected. Idempotent; repeats return the original revoked record without another revocation or audit. Missing or foreign grants and end-user credentials return 404.`,
|
|
1837
|
-
http: "POST",
|
|
1838
|
-
path: "/agent/v1/embed_tokens/{id}/revoke",
|
|
1839
|
-
streaming: "no",
|
|
1840
|
-
pagination: false,
|
|
1841
|
-
pathParams: [
|
|
1842
|
-
{
|
|
1843
|
-
name: "id",
|
|
1844
|
-
sdkName: "id",
|
|
1845
|
-
description: "Grant id returned by issuance or listing."
|
|
1846
|
-
}
|
|
1847
|
-
],
|
|
1848
|
-
query: []
|
|
1849
|
-
},
|
|
1850
1690
|
{
|
|
1851
1691
|
resource: "agent.environments",
|
|
1852
1692
|
method: "list",
|
|
@@ -2162,7 +2002,7 @@ clears to null; an empty string is stored as an empty string.`
|
|
|
2162
2002
|
name: "budget",
|
|
2163
2003
|
type: "object",
|
|
2164
2004
|
required: false,
|
|
2165
|
-
description: 'Session spending limit, {type: "limit", max_list_cost: {amount, currency}}; null when unlimited.
|
|
2005
|
+
description: 'Session spending limit, {type: "limit", max_list_cost: {amount, currency}}; null when unlimited. amount is in US dollars: send an integer or up to 2 decimals ("0.50"), and responses carry exactly 2 decimals ("20.00"). Creation defaults to USD 20.00 when omitted. More decimals, zero or a number return 400. Removing the limit with null prevents setting it again for that session.'
|
|
2166
2006
|
},
|
|
2167
2007
|
{
|
|
2168
2008
|
name: "initial_events",
|
|
@@ -18307,7 +18147,7 @@ var setRunFeedback = (options) => (options.client ?? client).post({
|
|
|
18307
18147
|
...options.headers
|
|
18308
18148
|
}
|
|
18309
18149
|
});
|
|
18310
|
-
var
|
|
18150
|
+
var listCustomers = (options) => (options.client ?? client).get({
|
|
18311
18151
|
security: [{
|
|
18312
18152
|
key: "BearerAuth",
|
|
18313
18153
|
scheme: "bearer",
|
|
@@ -18317,10 +18157,10 @@ var listEndUsers = (options) => (options.client ?? client).get({
|
|
|
18317
18157
|
name: "X-API-Key",
|
|
18318
18158
|
type: "apiKey"
|
|
18319
18159
|
}],
|
|
18320
|
-
url: "/agent/v1/agents/{agent_id}/
|
|
18160
|
+
url: "/agent/v1/agents/{agent_id}/customers",
|
|
18321
18161
|
...options
|
|
18322
18162
|
});
|
|
18323
|
-
var
|
|
18163
|
+
var deleteCustomer = (options) => (options.client ?? client).delete({
|
|
18324
18164
|
security: [{
|
|
18325
18165
|
key: "BearerAuth",
|
|
18326
18166
|
scheme: "bearer",
|
|
@@ -18330,10 +18170,10 @@ var deleteEndUser = (options) => (options.client ?? client).delete({
|
|
|
18330
18170
|
name: "X-API-Key",
|
|
18331
18171
|
type: "apiKey"
|
|
18332
18172
|
}],
|
|
18333
|
-
url: "/agent/v1/agents/{agent_id}/
|
|
18173
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}",
|
|
18334
18174
|
...options
|
|
18335
18175
|
});
|
|
18336
|
-
var
|
|
18176
|
+
var getCustomer = (options) => (options.client ?? client).get({
|
|
18337
18177
|
security: [{
|
|
18338
18178
|
key: "BearerAuth",
|
|
18339
18179
|
scheme: "bearer",
|
|
@@ -18343,10 +18183,10 @@ var getEndUser = (options) => (options.client ?? client).get({
|
|
|
18343
18183
|
name: "X-API-Key",
|
|
18344
18184
|
type: "apiKey"
|
|
18345
18185
|
}],
|
|
18346
|
-
url: "/agent/v1/agents/{agent_id}/
|
|
18186
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}",
|
|
18347
18187
|
...options
|
|
18348
18188
|
});
|
|
18349
|
-
var
|
|
18189
|
+
var getCustomerDeletion = (options) => (options.client ?? client).get({
|
|
18350
18190
|
security: [{
|
|
18351
18191
|
key: "BearerAuth",
|
|
18352
18192
|
scheme: "bearer",
|
|
@@ -18356,10 +18196,10 @@ var getEndUserDeletion = (options) => (options.client ?? client).get({
|
|
|
18356
18196
|
name: "X-API-Key",
|
|
18357
18197
|
type: "apiKey"
|
|
18358
18198
|
}],
|
|
18359
|
-
url: "/agent/v1/agents/{agent_id}/
|
|
18199
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion",
|
|
18360
18200
|
...options
|
|
18361
18201
|
});
|
|
18362
|
-
var
|
|
18202
|
+
var blockCustomer = (options) => (options.client ?? client).post({
|
|
18363
18203
|
security: [{
|
|
18364
18204
|
key: "BearerAuth",
|
|
18365
18205
|
scheme: "bearer",
|
|
@@ -18369,10 +18209,10 @@ var revokeEndUserTokens = (options) => (options.client ?? client).post({
|
|
|
18369
18209
|
name: "X-API-Key",
|
|
18370
18210
|
type: "apiKey"
|
|
18371
18211
|
}],
|
|
18372
|
-
url: "/agent/v1/agents/{agent_id}/
|
|
18212
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}/block",
|
|
18373
18213
|
...options
|
|
18374
18214
|
});
|
|
18375
|
-
var
|
|
18215
|
+
var unblockCustomer = (options) => (options.client ?? client).post({
|
|
18376
18216
|
security: [{
|
|
18377
18217
|
key: "BearerAuth",
|
|
18378
18218
|
scheme: "bearer",
|
|
@@ -18382,10 +18222,10 @@ var blockEndUser = (options) => (options.client ?? client).post({
|
|
|
18382
18222
|
name: "X-API-Key",
|
|
18383
18223
|
type: "apiKey"
|
|
18384
18224
|
}],
|
|
18385
|
-
url: "/agent/v1/agents/{agent_id}/
|
|
18225
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock",
|
|
18386
18226
|
...options
|
|
18387
18227
|
});
|
|
18388
|
-
var
|
|
18228
|
+
var revokeCustomerTokens = (options) => (options.client ?? client).post({
|
|
18389
18229
|
security: [{
|
|
18390
18230
|
key: "BearerAuth",
|
|
18391
18231
|
scheme: "bearer",
|
|
@@ -18395,10 +18235,10 @@ var unblockEndUser = (options) => (options.client ?? client).post({
|
|
|
18395
18235
|
name: "X-API-Key",
|
|
18396
18236
|
type: "apiKey"
|
|
18397
18237
|
}],
|
|
18398
|
-
url: "/agent/v1/agents/{agent_id}/
|
|
18238
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens",
|
|
18399
18239
|
...options
|
|
18400
18240
|
});
|
|
18401
|
-
var
|
|
18241
|
+
var getAgentAppearance = (options) => (options.client ?? client).get({
|
|
18402
18242
|
security: [{
|
|
18403
18243
|
key: "BearerAuth",
|
|
18404
18244
|
scheme: "bearer",
|
|
@@ -18408,35 +18248,10 @@ var createCustomerGrantCode = (options) => (options.client ?? client).post({
|
|
|
18408
18248
|
name: "X-API-Key",
|
|
18409
18249
|
type: "apiKey"
|
|
18410
18250
|
}],
|
|
18411
|
-
url: "/agent/v1/agents/{agent_id}/
|
|
18412
|
-
...options,
|
|
18413
|
-
headers: {
|
|
18414
|
-
"Content-Type": "application/json",
|
|
18415
|
-
...options.headers
|
|
18416
|
-
}
|
|
18417
|
-
});
|
|
18418
|
-
var createCustomerAccessToken = (options) => (options.client ?? client).post({
|
|
18419
|
-
url: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens",
|
|
18420
|
-
...options,
|
|
18421
|
-
headers: {
|
|
18422
|
-
"Content-Type": "application/json",
|
|
18423
|
-
...options.headers
|
|
18424
|
-
}
|
|
18425
|
-
});
|
|
18426
|
-
var renewCustomerAccessToken = (options) => (options.client ?? client).post({
|
|
18427
|
-
security: [{
|
|
18428
|
-
key: "BearerAuth",
|
|
18429
|
-
scheme: "bearer",
|
|
18430
|
-
type: "http"
|
|
18431
|
-
}, {
|
|
18432
|
-
key: "ApiKeyAuth",
|
|
18433
|
-
name: "X-API-Key",
|
|
18434
|
-
type: "apiKey"
|
|
18435
|
-
}],
|
|
18436
|
-
url: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew",
|
|
18251
|
+
url: "/agent/v1/agents/{agent_id}/appearance",
|
|
18437
18252
|
...options
|
|
18438
18253
|
});
|
|
18439
|
-
var
|
|
18254
|
+
var createCustomerGrantCode = (options) => (options.client ?? client).post({
|
|
18440
18255
|
security: [{
|
|
18441
18256
|
key: "BearerAuth",
|
|
18442
18257
|
scheme: "bearer",
|
|
@@ -18446,26 +18261,22 @@ var deleteCurrentCustomerAccessToken = (options) => (options.client ?? client).d
|
|
|
18446
18261
|
name: "X-API-Key",
|
|
18447
18262
|
type: "apiKey"
|
|
18448
18263
|
}],
|
|
18449
|
-
url: "/agent/v1/agents/{agent_id}/customers/auth/
|
|
18450
|
-
...options
|
|
18451
|
-
});
|
|
18452
|
-
var exchangeEmbedCode = (options) => (options.client ?? client).post({
|
|
18453
|
-
url: "/agent/v1/embed/exchange",
|
|
18264
|
+
url: "/agent/v1/agents/{agent_id}/customers/auth/grant_codes",
|
|
18454
18265
|
...options,
|
|
18455
18266
|
headers: {
|
|
18456
18267
|
"Content-Type": "application/json",
|
|
18457
18268
|
...options.headers
|
|
18458
18269
|
}
|
|
18459
18270
|
});
|
|
18460
|
-
var
|
|
18461
|
-
url: "/agent/v1/
|
|
18271
|
+
var createCustomerAccessToken = (options) => (options.client ?? client).post({
|
|
18272
|
+
url: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens",
|
|
18462
18273
|
...options,
|
|
18463
18274
|
headers: {
|
|
18464
18275
|
"Content-Type": "application/json",
|
|
18465
18276
|
...options.headers
|
|
18466
18277
|
}
|
|
18467
18278
|
});
|
|
18468
|
-
var
|
|
18279
|
+
var renewCustomerAccessToken = (options) => (options.client ?? client).post({
|
|
18469
18280
|
security: [{
|
|
18470
18281
|
key: "BearerAuth",
|
|
18471
18282
|
scheme: "bearer",
|
|
@@ -18475,27 +18286,10 @@ var listEmbedTokens = (options) => (options?.client ?? client).get({
|
|
|
18475
18286
|
name: "X-API-Key",
|
|
18476
18287
|
type: "apiKey"
|
|
18477
18288
|
}],
|
|
18478
|
-
url: "/agent/v1/
|
|
18289
|
+
url: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew",
|
|
18479
18290
|
...options
|
|
18480
18291
|
});
|
|
18481
|
-
var
|
|
18482
|
-
security: [{
|
|
18483
|
-
key: "BearerAuth",
|
|
18484
|
-
scheme: "bearer",
|
|
18485
|
-
type: "http"
|
|
18486
|
-
}, {
|
|
18487
|
-
key: "ApiKeyAuth",
|
|
18488
|
-
name: "X-API-Key",
|
|
18489
|
-
type: "apiKey"
|
|
18490
|
-
}],
|
|
18491
|
-
url: "/agent/v1/embed_tokens",
|
|
18492
|
-
...options,
|
|
18493
|
-
headers: {
|
|
18494
|
-
"Content-Type": "application/json",
|
|
18495
|
-
...options.headers
|
|
18496
|
-
}
|
|
18497
|
-
});
|
|
18498
|
-
var revokeEmbedToken = (options) => (options.client ?? client).post({
|
|
18292
|
+
var deleteCurrentCustomerAccessToken = (options) => (options.client ?? client).delete({
|
|
18499
18293
|
security: [{
|
|
18500
18294
|
key: "BearerAuth",
|
|
18501
18295
|
scheme: "bearer",
|
|
@@ -18505,7 +18299,7 @@ var revokeEmbedToken = (options) => (options.client ?? client).post({
|
|
|
18505
18299
|
name: "X-API-Key",
|
|
18506
18300
|
type: "apiKey"
|
|
18507
18301
|
}],
|
|
18508
|
-
url: "/agent/v1/
|
|
18302
|
+
url: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current",
|
|
18509
18303
|
...options
|
|
18510
18304
|
});
|
|
18511
18305
|
var computersList = (options) => (options?.client ?? client).get({
|
|
@@ -18806,15 +18600,6 @@ var listSessionCompactions = (options) => (options.client ?? client).get({
|
|
|
18806
18600
|
url: "/agent/v1/sessions/{session_id}/compactions",
|
|
18807
18601
|
...options
|
|
18808
18602
|
});
|
|
18809
|
-
var getEmbedAppearance = (options) => (options?.client ?? client).get({
|
|
18810
|
-
security: [{
|
|
18811
|
-
key: "BearerAuth",
|
|
18812
|
-
scheme: "bearer",
|
|
18813
|
-
type: "http"
|
|
18814
|
-
}, { name: "Praxis-Publishable-Key", type: "apiKey" }],
|
|
18815
|
-
url: "/agent/v1/embed/appearance",
|
|
18816
|
-
...options
|
|
18817
|
-
});
|
|
18818
18603
|
var createAudioSpeech = (options) => (options.client ?? client).post({
|
|
18819
18604
|
security: [{
|
|
18820
18605
|
key: "BearerAuth",
|
|
@@ -24177,25 +23962,24 @@ function createAgent(transport) {
|
|
|
24177
23962
|
grantCodes: {
|
|
24178
23963
|
create: bind(transport, createCustomerGrantCode)
|
|
24179
23964
|
}
|
|
24180
|
-
}
|
|
24181
|
-
},
|
|
24182
|
-
endUsers: {
|
|
23965
|
+
},
|
|
24183
23966
|
block: {
|
|
24184
|
-
create: bind(transport,
|
|
23967
|
+
create: bind(transport, blockCustomer)
|
|
24185
23968
|
},
|
|
24186
|
-
delete: bind(transport,
|
|
24187
|
-
list: bind(transport,
|
|
24188
|
-
retrieve: bind(transport,
|
|
24189
|
-
retrieveDeletion: bind(transport,
|
|
23969
|
+
delete: bind(transport, deleteCustomer),
|
|
23970
|
+
list: bind(transport, listCustomers),
|
|
23971
|
+
retrieve: bind(transport, getCustomer),
|
|
23972
|
+
retrieveDeletion: bind(transport, getCustomerDeletion),
|
|
24190
23973
|
revokeTokens: {
|
|
24191
|
-
create: bind(transport,
|
|
23974
|
+
create: bind(transport, revokeCustomerTokens)
|
|
24192
23975
|
},
|
|
24193
23976
|
unblock: {
|
|
24194
|
-
create: bind(transport,
|
|
23977
|
+
create: bind(transport, unblockCustomer)
|
|
24195
23978
|
}
|
|
24196
23979
|
},
|
|
24197
23980
|
list: bind(transport, agentsList),
|
|
24198
23981
|
retrieve: bind(transport, agentsRetrieve),
|
|
23982
|
+
retrieveAppearance: bind(transport, getAgentAppearance),
|
|
24199
23983
|
unarchive: {
|
|
24200
23984
|
create: bind(transport, unarchiveAgent)
|
|
24201
23985
|
},
|
|
@@ -24245,22 +24029,6 @@ function createAgent(transport) {
|
|
|
24245
24029
|
},
|
|
24246
24030
|
update: bind(transport, deploymentsUpdate)
|
|
24247
24031
|
},
|
|
24248
|
-
embed: {
|
|
24249
|
-
exchange: {
|
|
24250
|
-
create: bind(transport, exchangeEmbedCode)
|
|
24251
|
-
},
|
|
24252
|
-
retrieveAppearance: bind(transport, getEmbedAppearance)
|
|
24253
|
-
},
|
|
24254
|
-
embedTokens: {
|
|
24255
|
-
anonymous: {
|
|
24256
|
-
create: bind(transport, createAnonymousEmbedToken)
|
|
24257
|
-
},
|
|
24258
|
-
create: bind(transport, createEmbedToken),
|
|
24259
|
-
list: bind(transport, listEmbedTokens),
|
|
24260
|
-
revoke: {
|
|
24261
|
-
create: bind(transport, revokeEmbedToken)
|
|
24262
|
-
}
|
|
24263
|
-
},
|
|
24264
24032
|
environments: {
|
|
24265
24033
|
archive: bind(transport, environmentsArchive),
|
|
24266
24034
|
create: bind(transport, environmentsCreate),
|
|
@@ -27029,7 +26797,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
27029
26797
|
}
|
|
27030
26798
|
|
|
27031
26799
|
// src/main.ts
|
|
27032
|
-
var version = "0.1.1-dev.
|
|
26800
|
+
var version = "0.1.1-dev.bdcd5e6";
|
|
27033
26801
|
var commands = commandTree(operations);
|
|
27034
26802
|
var manual = [["login"], ["logout"], ["whoami"], ["org", "list"], ["org", "switch"], ["api"], ["skill"]];
|
|
27035
26803
|
function route(argv) {
|