@deepraxis/sdk 0.1.0-dev.331f4e7 → 0.1.0-dev.3a7324b
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/METHODS.md +39 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +145 -59
- package/dist/generated/sdk.gen.js +272 -21
- package/dist/generated/types.gen.d.ts +2011 -637
- package/dist/operations.generated.d.ts +365 -78
- package/dist/operations.generated.js +432 -91
- package/dist/resources.generated.d.ts +165 -119
- package/dist/resources.generated.js +27 -0
- package/package.json +1 -1
|
@@ -4186,7 +4186,7 @@ export type AgentManaged57 = {
|
|
|
4186
4186
|
type: 'custom';
|
|
4187
4187
|
};
|
|
4188
4188
|
/**
|
|
4189
|
-
* Session spending limit
|
|
4189
|
+
* Session spending limit, {type: "limit", max_list_cost: {amount, currency}}; null when unlimited. Creation defaults to a limit of 2000 US cents (USD 20.00) when omitted. amount is a positive integer string of US cents; removing the limit with null prevents setting it again for that session.
|
|
4190
4190
|
*/
|
|
4191
4191
|
export type AgentManaged76 = {
|
|
4192
4192
|
/**
|
|
@@ -4194,7 +4194,7 @@ export type AgentManaged76 = {
|
|
|
4194
4194
|
*/
|
|
4195
4195
|
max_list_cost: AgentManaged77;
|
|
4196
4196
|
/**
|
|
4197
|
-
*
|
|
4197
|
+
* Budget kind; always limit. Any other value, including max_list_cost, returns 400 budget.type must be "limit".
|
|
4198
4198
|
*/
|
|
4199
4199
|
type: 'limit';
|
|
4200
4200
|
};
|
|
@@ -4380,20 +4380,6 @@ export type AgentManaged179 = {
|
|
|
4380
4380
|
*/
|
|
4381
4381
|
server_tool_use?: null | AgentManaged181;
|
|
4382
4382
|
};
|
|
4383
|
-
/**
|
|
4384
|
-
* Agent definition the session uses after the change; null when unchanged.
|
|
4385
|
-
*/
|
|
4386
|
-
export type AgentManaged182 = {
|
|
4387
|
-
/**
|
|
4388
|
-
* Praxis extension: HTTP, SSE or trusted stdio MCP servers paired with mcp_toolset entries and saved with the agent version.
|
|
4389
|
-
*/
|
|
4390
|
-
mcp_servers?: Array<AgentManaged7>;
|
|
4391
|
-
/**
|
|
4392
|
-
* Replacement tool list. Full replacement: the provided array becomes the new
|
|
4393
|
-
* value. Send an empty array to clear; omit to preserve.
|
|
4394
|
-
*/
|
|
4395
|
-
tools?: Array<AgentManaged15 | AgentManaged29 | AgentManaged32>;
|
|
4396
|
-
};
|
|
4397
4383
|
export type AgentManaged183 = {
|
|
4398
4384
|
[key: string]: null | string;
|
|
4399
4385
|
};
|
|
@@ -4658,8 +4644,7 @@ export type AgentManaged10 = {
|
|
|
4658
4644
|
*/
|
|
4659
4645
|
type: 'agent';
|
|
4660
4646
|
/**
|
|
4661
|
-
*
|
|
4662
|
-
* least 1 if specified.
|
|
4647
|
+
* Agent version to pin. Omit to use the agent's active_version.
|
|
4663
4648
|
*/
|
|
4664
4649
|
version?: number;
|
|
4665
4650
|
};
|
|
@@ -4669,34 +4654,16 @@ export type AgentManaged167 = {
|
|
|
4669
4654
|
*/
|
|
4670
4655
|
id: string;
|
|
4671
4656
|
/**
|
|
4672
|
-
* Always `agent_with_overrides`. An agent reference with inline
|
|
4657
|
+
* Always `agent_with_overrides`. An agent reference with an inline system prompt. For session creation, system is the only override: omit it to inherit the agent system prompt, pass a string of at most 100,000 characters to replace it, or null to clear it. Any other field beyond type, id, version and system returns 400. Deployment overrides follow the deployment operation description.
|
|
4673
4658
|
*/
|
|
4674
4659
|
type: 'agent_with_overrides';
|
|
4675
|
-
/**
|
|
4676
|
-
* Praxis extension: HTTP, SSE or trusted stdio MCP servers paired with mcp_toolset entries and saved with the agent version.
|
|
4677
|
-
*/
|
|
4678
|
-
mcp_servers?: Array<AgentManaged7>;
|
|
4679
|
-
/**
|
|
4680
|
-
* Replacement model. Accepts the model string, e.g. `claude-opus-5`, or a
|
|
4681
|
-
* `model_config` object. Omit to use the agent's model.
|
|
4682
|
-
*/
|
|
4683
|
-
model?: 'claude-opus-5-5' | 'claude-fable-5-1' | 'claude-sonnet-5' | 'claude-fable-5' | 'claude-opus-5' | 'claude-opus-4-8' | 'claude-opus-4-7' | 'claude-opus-4-6' | 'claude-sonnet-4-6' | 'claude-haiku-4-5' | 'claude-haiku-4-5-20251001' | 'claude-opus-4-5' | 'claude-opus-4-5-20251101' | 'claude-sonnet-4-5' | 'claude-sonnet-4-5-20250929' | string | AgentManaged1;
|
|
4684
|
-
/**
|
|
4685
|
-
* Replacement skill attachment references stored and echoed unchanged. Not loaded by deployment resource operations.
|
|
4686
|
-
*/
|
|
4687
|
-
skills?: Array<AgentManaged13 | AgentManaged14>;
|
|
4688
4660
|
/**
|
|
4689
4661
|
* Replacement system prompt. Up to 100,000 characters. Set to null to clear the
|
|
4690
4662
|
* agent's system prompt; omit to preserve it.
|
|
4691
4663
|
*/
|
|
4692
4664
|
system?: null | string;
|
|
4693
4665
|
/**
|
|
4694
|
-
*
|
|
4695
|
-
* configuration. Send an empty array to clear; omit to preserve the agent's tools.
|
|
4696
|
-
*/
|
|
4697
|
-
tools?: Array<AgentManaged15 | AgentManaged29 | AgentManaged32>;
|
|
4698
|
-
/**
|
|
4699
|
-
* The specific `agent` version to use. Omit to use the latest version.
|
|
4666
|
+
* Agent version to pin. Omit to use the agent's active_version.
|
|
4700
4667
|
*/
|
|
4701
4668
|
version?: number;
|
|
4702
4669
|
};
|
|
@@ -5516,7 +5483,7 @@ export type AgentManaged170 = {
|
|
|
5516
5483
|
*/
|
|
5517
5484
|
name: string;
|
|
5518
5485
|
/**
|
|
5519
|
-
*
|
|
5486
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
5520
5487
|
*/
|
|
5521
5488
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
5522
5489
|
/**
|
|
@@ -7366,6 +7333,10 @@ export type AgentManaged132 = {
|
|
|
7366
7333
|
* `true`.
|
|
7367
7334
|
*/
|
|
7368
7335
|
packages?: null | AgentManaged135;
|
|
7336
|
+
/**
|
|
7337
|
+
* Sandbox template the environment's machines are created from: the name of a public Base from sandbox.bases.list (for example base, base-large, media) or the name or sbe_ id of one of your own ready sandbox Environments. Size is expressed by the template name, for example base-large; there is no separate size field. 1 to 128 characters of letters, digits, underscore, dot and hyphen; any other value returns 400 config.template must be a sandbox template name. The name is not checked when you save; a template the sandbox does not know fails the machine with Environment template <name> is not available. Omit on create, or send null, for the default node22; omit on update to keep it. /agent/v1 only.
|
|
7338
|
+
*/
|
|
7339
|
+
template?: string | null;
|
|
7369
7340
|
};
|
|
7370
7341
|
export type AgentManaged136 = {
|
|
7371
7342
|
/**
|
|
@@ -7644,6 +7615,113 @@ export type AgentManaged113 = {
|
|
|
7644
7615
|
*/
|
|
7645
7616
|
type: 'deployment_run';
|
|
7646
7617
|
};
|
|
7618
|
+
export type AgentManaged308 = {
|
|
7619
|
+
/**
|
|
7620
|
+
* Unique identifier for the skill.
|
|
7621
|
+
*
|
|
7622
|
+
* The format and length of IDs may change over time.
|
|
7623
|
+
*/
|
|
7624
|
+
id: string;
|
|
7625
|
+
/**
|
|
7626
|
+
* ISO 8601 timestamp of when the skill was created.
|
|
7627
|
+
*/
|
|
7628
|
+
created_at: string;
|
|
7629
|
+
/**
|
|
7630
|
+
* Human-readable, single-line label for the Skill. Maximum 255 characters. Always
|
|
7631
|
+
* set: derived from the SKILL.md frontmatter `name` when omitted at creation. Not
|
|
7632
|
+
* unique.
|
|
7633
|
+
*/
|
|
7634
|
+
display_name: string;
|
|
7635
|
+
/**
|
|
7636
|
+
* ID of the newest Skill Version — what `latest` references resolve to. Always
|
|
7637
|
+
* set: a Skill holds at least one version.
|
|
7638
|
+
*/
|
|
7639
|
+
latest_version_id: string;
|
|
7640
|
+
/**
|
|
7641
|
+
* Where the Skill comes from.
|
|
7642
|
+
*
|
|
7643
|
+
* Possible values:
|
|
7644
|
+
*
|
|
7645
|
+
* - `"custom"`: authored by the platform user; private to their workspace
|
|
7646
|
+
* - `"anthropic"`: published by Anthropic; shared and read-only
|
|
7647
|
+
* - `"anthropic_example"`: Anthropic-published sample Skill
|
|
7648
|
+
* - `"plugin"`: resolved from an installed plugin
|
|
7649
|
+
*/
|
|
7650
|
+
source: AgentManaged309;
|
|
7651
|
+
/**
|
|
7652
|
+
* Object type.
|
|
7653
|
+
*
|
|
7654
|
+
* For Skills, this is always `"skill"`.
|
|
7655
|
+
*/
|
|
7656
|
+
type: 'skill';
|
|
7657
|
+
/**
|
|
7658
|
+
* ISO 8601 timestamp of when the skill was last updated.
|
|
7659
|
+
*/
|
|
7660
|
+
updated_at: string;
|
|
7661
|
+
};
|
|
7662
|
+
export type AgentManaged310 = {
|
|
7663
|
+
/**
|
|
7664
|
+
* Unique identifier for the skill.
|
|
7665
|
+
*
|
|
7666
|
+
* The format and length of IDs may change over time.
|
|
7667
|
+
*/
|
|
7668
|
+
id: string;
|
|
7669
|
+
/**
|
|
7670
|
+
* Deleted object type.
|
|
7671
|
+
*
|
|
7672
|
+
* For Skills, this is always `"skill_deleted"`.
|
|
7673
|
+
*/
|
|
7674
|
+
type: 'skill_deleted';
|
|
7675
|
+
};
|
|
7676
|
+
export type AgentManaged311 = {
|
|
7677
|
+
/**
|
|
7678
|
+
* Unique identifier for this Skill Version. The id addresses the version in paths
|
|
7679
|
+
* and pins it in references.
|
|
7680
|
+
*/
|
|
7681
|
+
id: string;
|
|
7682
|
+
/**
|
|
7683
|
+
* ISO 8601 timestamp of when the skill was created.
|
|
7684
|
+
*/
|
|
7685
|
+
created_at: string;
|
|
7686
|
+
/**
|
|
7687
|
+
* Description of the skill version.
|
|
7688
|
+
*
|
|
7689
|
+
* This is extracted from the SKILL.md file in the skill upload.
|
|
7690
|
+
*/
|
|
7691
|
+
description: string;
|
|
7692
|
+
/**
|
|
7693
|
+
* The Skill's immutable kebab-case slug, set at creation from the first upload's
|
|
7694
|
+
* SKILL.md frontmatter `name` (or its enclosing directory). Every later upload
|
|
7695
|
+
* must resolve to the same value. Also the top-level directory of the Skill's
|
|
7696
|
+
* mounted files and the base name of a downloaded archive.
|
|
7697
|
+
*/
|
|
7698
|
+
name: string;
|
|
7699
|
+
/**
|
|
7700
|
+
* Unique identifier for the skill.
|
|
7701
|
+
*
|
|
7702
|
+
* The format and length of IDs may change over time.
|
|
7703
|
+
*/
|
|
7704
|
+
skill_id: string;
|
|
7705
|
+
/**
|
|
7706
|
+
* Object type.
|
|
7707
|
+
*
|
|
7708
|
+
* For Skill Versions, this is always `"skill_version"`.
|
|
7709
|
+
*/
|
|
7710
|
+
type: 'skill_version';
|
|
7711
|
+
};
|
|
7712
|
+
export type AgentManaged312 = {
|
|
7713
|
+
/**
|
|
7714
|
+
* Unique identifier for this Skill Version. The id addresses the version in paths
|
|
7715
|
+
* and pins it in references.
|
|
7716
|
+
*/
|
|
7717
|
+
id: string;
|
|
7718
|
+
/**
|
|
7719
|
+
* Deleted object type.
|
|
7720
|
+
*
|
|
7721
|
+
* For Skill Versions, this is always `"skill_version_deleted"`.
|
|
7722
|
+
*/
|
|
7723
|
+
type: 'skill_version_deleted';
|
|
7724
|
+
};
|
|
7647
7725
|
export type ApplicationAccountSubdomain = {
|
|
7648
7726
|
/**
|
|
7649
7727
|
* Account subdomain, 8–32 lowercase letters and digits; part of every Worker URL.
|
|
@@ -10533,7 +10611,7 @@ export type DatabaseDatabase = {
|
|
|
10533
10611
|
purge_at: string | null;
|
|
10534
10612
|
};
|
|
10535
10613
|
export type DatabaseDatabaseError = {
|
|
10536
|
-
code: 'SINGULAR_MISMATCH' | 'AMBIGUOUS_EMBED' | 'EMBED_NOT_FOUND' | 'INVALID_PREFERENCE' | 'QUERY_CANCELED' | 'RANGE_NOT_SATISFIABLE' | 'NOT_ACCEPTABLE' | 'OPERATOR_TYPE_MISMATCH' | 'DATABASE_NOT_FOUND' | 'TABLE_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'VALIDATION_FAILED' | 'UNIQUE_VIOLATION' | 'REFERENCE_RESTRICT' | 'FIELD_TYPE_IMMUTABLE' | 'LIMIT_EXCEEDED' | 'UNSUPPORTED' | 'INVALID_PARAMS' | 'DATABASE_INVALID_STATE' | 'CAPACITY' | 'NOT_IMPLEMENTED';
|
|
10614
|
+
code: 'SINGULAR_MISMATCH' | 'AMBIGUOUS_EMBED' | 'EMBED_NOT_FOUND' | 'INVALID_PREFERENCE' | 'QUERY_CANCELED' | 'RANGE_NOT_SATISFIABLE' | 'NOT_ACCEPTABLE' | 'OPERATOR_TYPE_MISMATCH' | 'DATABASE_NOT_FOUND' | 'TABLE_NOT_FOUND' | 'FIELD_NOT_FOUND' | 'VALIDATION_FAILED' | 'UNIQUE_VIOLATION' | 'REFERENCE_RESTRICT' | 'FIELD_TYPE_IMMUTABLE' | 'LIMIT_EXCEEDED' | 'UNSUPPORTED' | 'INVALID_PARAMS' | 'DATABASE_INVALID_STATE' | 'CAPACITY' | 'NOT_IMPLEMENTED' | 'BINDING_READ_ONLY';
|
|
10537
10615
|
message: string;
|
|
10538
10616
|
details: string | null;
|
|
10539
10617
|
hint: string | null;
|
|
@@ -17775,7 +17853,7 @@ export type AgentManaged172 = {
|
|
|
17775
17853
|
*/
|
|
17776
17854
|
name: string;
|
|
17777
17855
|
/**
|
|
17778
|
-
*
|
|
17856
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
17779
17857
|
*/
|
|
17780
17858
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
17781
17859
|
/**
|
|
@@ -17995,19 +18073,15 @@ export type AgentManaged33 = {
|
|
|
17995
18073
|
[key: string]: unknown;
|
|
17996
18074
|
};
|
|
17997
18075
|
/**
|
|
17998
|
-
* Largest list-price cost the session may reach.
|
|
18076
|
+
* Largest list-price cost the session may reach, as {amount, currency}. amount is a string of US cents, not dollars.
|
|
17999
18077
|
*/
|
|
18000
18078
|
export type AgentManaged77 = {
|
|
18001
18079
|
/**
|
|
18002
|
-
*
|
|
18003
|
-
* leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a
|
|
18004
|
-
* number so no float rounding is ever applied.
|
|
18080
|
+
* Cost ceiling in US cents, as a positive integer string with no leading zeros: "2000" is USD 20.00 and "50" is fifty cents. Decimals and JSON numbers return 400.
|
|
18005
18081
|
*/
|
|
18006
18082
|
amount: string;
|
|
18007
18083
|
/**
|
|
18008
|
-
*
|
|
18009
|
-
* supported; the accepted set is closed and grows only when a new currency is
|
|
18010
|
-
* priced.
|
|
18084
|
+
* Currency of amount; always USD.
|
|
18011
18085
|
*/
|
|
18012
18086
|
currency: 'USD';
|
|
18013
18087
|
};
|
|
@@ -18291,33 +18365,6 @@ export type AgentManaged28 = {
|
|
|
18291
18365
|
*/
|
|
18292
18366
|
permission_policy?: null | AgentManaged17 | AgentManaged18 | AgentManaged19;
|
|
18293
18367
|
};
|
|
18294
|
-
export type AgentManaged1 = {
|
|
18295
|
-
/**
|
|
18296
|
-
* The model that will power your agent.
|
|
18297
|
-
*
|
|
18298
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
18299
|
-
* details and options.
|
|
18300
|
-
*/
|
|
18301
|
-
id: 'claude-opus-5-5' | 'claude-fable-5-1' | 'claude-sonnet-5' | 'claude-fable-5' | 'claude-opus-5' | 'claude-opus-4-8' | 'claude-opus-4-7' | 'claude-opus-4-6' | 'claude-sonnet-4-6' | 'claude-haiku-4-5' | 'claude-haiku-4-5-20251001' | 'claude-opus-4-5' | 'claude-opus-4-5-20251101' | 'claude-sonnet-4-5' | 'claude-sonnet-4-5-20250929' | string;
|
|
18302
|
-
/**
|
|
18303
|
-
* How hard Claude works on each inference call. Accepts a bare level string
|
|
18304
|
-
* (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model
|
|
18305
|
-
* default; on update, omitting it leaves the stored value unchanged.
|
|
18306
|
-
*/
|
|
18307
|
-
effort?: null | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | AgentManaged2 | AgentManaged3 | AgentManaged4 | AgentManaged5 | AgentManaged6;
|
|
18308
|
-
/**
|
|
18309
|
-
* Geographic region for model inference. When unset, requests fall through to the
|
|
18310
|
-
* workspace's default_inference_geo. On update, `model` is whole-object
|
|
18311
|
-
* replacement — omitting inference_geo clears it.
|
|
18312
|
-
*/
|
|
18313
|
-
inference_geo?: null | string;
|
|
18314
|
-
/**
|
|
18315
|
-
* Inference speed mode. `fast` provides significantly faster output token
|
|
18316
|
-
* generation at premium pricing. Not all models support `fast`; invalid
|
|
18317
|
-
* combinations are rejected at create time.
|
|
18318
|
-
*/
|
|
18319
|
-
speed?: null | 'standard' | 'fast';
|
|
18320
|
-
};
|
|
18321
18368
|
export type AgentManaged72 = {
|
|
18322
18369
|
/**
|
|
18323
18370
|
* ID of the rubric file.
|
|
@@ -18657,12 +18704,9 @@ export type AgentManaged89 = {
|
|
|
18657
18704
|
*/
|
|
18658
18705
|
export type AgentManaged38 = {
|
|
18659
18706
|
/**
|
|
18660
|
-
*
|
|
18661
|
-
*
|
|
18662
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
18663
|
-
* details and options.
|
|
18707
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
18664
18708
|
*/
|
|
18665
|
-
id:
|
|
18709
|
+
id: string;
|
|
18666
18710
|
/**
|
|
18667
18711
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
18668
18712
|
* Messages call the session makes.
|
|
@@ -20108,6 +20152,10 @@ export type AgentManaged139 = {
|
|
|
20108
20152
|
* Environment type
|
|
20109
20153
|
*/
|
|
20110
20154
|
type: 'cloud';
|
|
20155
|
+
/**
|
|
20156
|
+
* Sandbox template machines of this environment are created from: a public Base name or one of your own sandbox Environments (name or sbe_ id); size is expressed by the template name. The built-in node22 shows node22; null or absent means the default node22. /agent/v1 only.
|
|
20157
|
+
*/
|
|
20158
|
+
template?: string | null;
|
|
20111
20159
|
};
|
|
20112
20160
|
export type AgentManaged142 = {
|
|
20113
20161
|
/**
|
|
@@ -20381,6 +20429,22 @@ export type AgentManaged131 = {
|
|
|
20381
20429
|
*/
|
|
20382
20430
|
type: 'manual';
|
|
20383
20431
|
};
|
|
20432
|
+
/**
|
|
20433
|
+
* Source of the content.
|
|
20434
|
+
*/
|
|
20435
|
+
export type AgentManaged309 = {
|
|
20436
|
+
/**
|
|
20437
|
+
* Where the Skill comes from.
|
|
20438
|
+
*
|
|
20439
|
+
* Possible values:
|
|
20440
|
+
*
|
|
20441
|
+
* - `"custom"`: authored by the platform user; private to their workspace
|
|
20442
|
+
* - `"anthropic"`: published by Anthropic; shared and read-only
|
|
20443
|
+
* - `"anthropic_example"`: Anthropic-published sample Skill
|
|
20444
|
+
* - `"plugin"`: resolved from an installed plugin
|
|
20445
|
+
*/
|
|
20446
|
+
type: 'anthropic' | 'custom' | 'anthropic_example' | 'plugin';
|
|
20447
|
+
};
|
|
20384
20448
|
export type ApplicationModule = {
|
|
20385
20449
|
/**
|
|
20386
20450
|
* Module file name.
|
|
@@ -27199,6 +27263,14 @@ export type ApplyAgentVersionErrors = {
|
|
|
27199
27263
|
* Version must be a positive integer; select a version from agents.versions.list.
|
|
27200
27264
|
*/
|
|
27201
27265
|
400: unknown;
|
|
27266
|
+
/**
|
|
27267
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
27268
|
+
*/
|
|
27269
|
+
401: unknown;
|
|
27270
|
+
/**
|
|
27271
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
27272
|
+
*/
|
|
27273
|
+
403: unknown;
|
|
27202
27274
|
/**
|
|
27203
27275
|
* Agent or version is unavailable. A missing version returns Agent version not found; check the version list.
|
|
27204
27276
|
*/
|
|
@@ -27317,12 +27389,9 @@ export type ApplyAgentVersionResponses = {
|
|
|
27317
27389
|
*/
|
|
27318
27390
|
model: {
|
|
27319
27391
|
/**
|
|
27320
|
-
*
|
|
27321
|
-
*
|
|
27322
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
27323
|
-
* details and options.
|
|
27392
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
27324
27393
|
*/
|
|
27325
|
-
id:
|
|
27394
|
+
id: string;
|
|
27326
27395
|
/**
|
|
27327
27396
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
27328
27397
|
* Messages call the session makes.
|
|
@@ -27415,7 +27484,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
27415
27484
|
*/
|
|
27416
27485
|
name: string;
|
|
27417
27486
|
/**
|
|
27418
|
-
*
|
|
27487
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
27419
27488
|
*/
|
|
27420
27489
|
skills: Array<{
|
|
27421
27490
|
/**
|
|
@@ -27938,38 +28007,21 @@ export type ApplyAgentVersionResponses = {
|
|
|
27938
28007
|
*/
|
|
27939
28008
|
note: string | null;
|
|
27940
28009
|
/**
|
|
27941
|
-
*
|
|
28010
|
+
* 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.
|
|
27942
28011
|
*/
|
|
27943
|
-
|
|
27944
|
-
/**
|
|
27945
|
-
* Resource id from database.databases.list or database.databases.create; use the returned id, not its name. Must start with db_ and be unique within this binding array.
|
|
27946
|
-
*/
|
|
27947
|
-
id: string;
|
|
28012
|
+
bindings: Array<{
|
|
27948
28013
|
/**
|
|
27949
|
-
*
|
|
28014
|
+
* Resource type. Decides the id format and the allowed access.
|
|
27950
28015
|
*/
|
|
27951
|
-
|
|
28016
|
+
type: 'database' | 'vector_store' | 'file' | 'media_library' | 'model' | 'workflow' | 'script';
|
|
27952
28017
|
/**
|
|
27953
|
-
*
|
|
27954
|
-
*/
|
|
27955
|
-
instructions?: string;
|
|
27956
|
-
/**
|
|
27957
|
-
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
27958
|
-
*/
|
|
27959
|
-
enabled?: boolean;
|
|
27960
|
-
}>;
|
|
27961
|
-
/**
|
|
27962
|
-
* Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
27963
|
-
*/
|
|
27964
|
-
vector_stores: Array<{
|
|
27965
|
-
/**
|
|
27966
|
-
* Resource id from knowledge.vectorStores.list or knowledge.vectorStores.create; use the returned id, not its name. Must start with vs_ and be unique within this binding array.
|
|
28018
|
+
* Resource id, never its name. database db_..., vector_store vs_..., file file- plus 24 letters or digits; media_library and model ids must not contain ':' or whitespace; workflow and script use <namespace>/<name> with no '/', '@', ':' or whitespace inside a part.
|
|
27967
28019
|
*/
|
|
27968
28020
|
id: string;
|
|
27969
28021
|
/**
|
|
27970
|
-
*
|
|
28022
|
+
* database, vector_store and media_library accept read_only or read_write; file accepts read_only; model, workflow and script accept invoke. Any other combination returns 400.
|
|
27971
28023
|
*/
|
|
27972
|
-
access: 'read_only' | 'read_write';
|
|
28024
|
+
access: 'read_only' | 'read_write' | 'invoke';
|
|
27973
28025
|
/**
|
|
27974
28026
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
27975
28027
|
*/
|
|
@@ -27978,25 +28030,13 @@ export type ApplyAgentVersionResponses = {
|
|
|
27978
28030
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
27979
28031
|
*/
|
|
27980
28032
|
enabled?: boolean;
|
|
27981
|
-
}
|
|
27982
|
-
/**
|
|
27983
|
-
* File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
27984
|
-
*/
|
|
27985
|
-
files: Array<{
|
|
27986
|
-
/**
|
|
27987
|
-
* Resource id from file.files.list or file.files.create (upload); use the returned id, not its name. Must start with file_ and be unique within this binding array.
|
|
27988
|
-
*/
|
|
27989
|
-
id: string;
|
|
27990
|
-
/**
|
|
27991
|
-
* read_only permits reading the bound file; files do not accept read_write.
|
|
27992
|
-
*/
|
|
27993
|
-
access: 'read_only';
|
|
28033
|
+
} | {
|
|
27994
28034
|
/**
|
|
27995
|
-
*
|
|
28035
|
+
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
27996
28036
|
*/
|
|
27997
|
-
|
|
28037
|
+
type: 'search' | 'browser';
|
|
27998
28038
|
/**
|
|
27999
|
-
* Whether
|
|
28039
|
+
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
28000
28040
|
*/
|
|
28001
28041
|
enabled?: boolean;
|
|
28002
28042
|
}>;
|
|
@@ -28338,7 +28378,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
28338
28378
|
*/
|
|
28339
28379
|
commands?: Array<string>;
|
|
28340
28380
|
/**
|
|
28341
|
-
*
|
|
28381
|
+
* Names of disabled skills declarations.
|
|
28342
28382
|
*/
|
|
28343
28383
|
skills?: Array<string>;
|
|
28344
28384
|
/**
|
|
@@ -28360,6 +28400,26 @@ export type ApplyAgentVersionResponses = {
|
|
|
28360
28400
|
*/
|
|
28361
28401
|
allowed: Array<string>;
|
|
28362
28402
|
};
|
|
28403
|
+
/**
|
|
28404
|
+
* Avatar image URL of this agent version (absolute https), shown in agent lists, the agent detail, the chat header and as the default avatar of embedded chat; null when none is set. Follows the version like other configuration: a version saved with apply=false does not change the avatar in effect. /agent/v1 only.
|
|
28405
|
+
*/
|
|
28406
|
+
avatar: string | null;
|
|
28407
|
+
/**
|
|
28408
|
+
* Channel the agent was created through (for example api or console); null for historical agents whose channel is unknown. Display only. /agent/v1 only; /anthropic neither returns it.
|
|
28409
|
+
*/
|
|
28410
|
+
creation_source: string | null;
|
|
28411
|
+
/**
|
|
28412
|
+
* Platform-wide identity number of the agent (8 characters), usable wherever an agent is addressed by identity_number; null when the agent has none. /agent/v1 only; /anthropic neither returns it.
|
|
28413
|
+
*/
|
|
28414
|
+
identity_number: string | null;
|
|
28415
|
+
/**
|
|
28416
|
+
* Default environment of this service agent version: the environment_id new sessions get when they name none; null means no environment. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the environment in effect. Versions saved before this field existed read as light. /agent/v1 only.
|
|
28417
|
+
*/
|
|
28418
|
+
environment_id?: string | null;
|
|
28419
|
+
/**
|
|
28420
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
28421
|
+
*/
|
|
28422
|
+
vault_ids?: Array<string>;
|
|
28363
28423
|
/**
|
|
28364
28424
|
* Current agent lifecycle status; unarchive restores an archived agent to active.
|
|
28365
28425
|
*/
|
|
@@ -28379,6 +28439,14 @@ export type UnarchiveAgentData = {
|
|
|
28379
28439
|
url: '/agent/v1/agents/{agent_id}/unarchive';
|
|
28380
28440
|
};
|
|
28381
28441
|
export type UnarchiveAgentErrors = {
|
|
28442
|
+
/**
|
|
28443
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
28444
|
+
*/
|
|
28445
|
+
401: unknown;
|
|
28446
|
+
/**
|
|
28447
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
28448
|
+
*/
|
|
28449
|
+
403: unknown;
|
|
28382
28450
|
/**
|
|
28383
28451
|
* Agent does not exist or is inaccessible to this caller.
|
|
28384
28452
|
*/
|
|
@@ -28493,12 +28561,9 @@ export type UnarchiveAgentResponses = {
|
|
|
28493
28561
|
*/
|
|
28494
28562
|
model: {
|
|
28495
28563
|
/**
|
|
28496
|
-
*
|
|
28497
|
-
*
|
|
28498
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
28499
|
-
* details and options.
|
|
28564
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
28500
28565
|
*/
|
|
28501
|
-
id:
|
|
28566
|
+
id: string;
|
|
28502
28567
|
/**
|
|
28503
28568
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
28504
28569
|
* Messages call the session makes.
|
|
@@ -28591,7 +28656,7 @@ export type UnarchiveAgentResponses = {
|
|
|
28591
28656
|
*/
|
|
28592
28657
|
name: string;
|
|
28593
28658
|
/**
|
|
28594
|
-
*
|
|
28659
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
28595
28660
|
*/
|
|
28596
28661
|
skills: Array<{
|
|
28597
28662
|
/**
|
|
@@ -29114,38 +29179,21 @@ export type UnarchiveAgentResponses = {
|
|
|
29114
29179
|
*/
|
|
29115
29180
|
note: string | null;
|
|
29116
29181
|
/**
|
|
29117
|
-
*
|
|
29182
|
+
* 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.
|
|
29118
29183
|
*/
|
|
29119
|
-
|
|
29120
|
-
/**
|
|
29121
|
-
* Resource id from database.databases.list or database.databases.create; use the returned id, not its name. Must start with db_ and be unique within this binding array.
|
|
29122
|
-
*/
|
|
29123
|
-
id: string;
|
|
29124
|
-
/**
|
|
29125
|
-
* read_only permits reads of the bound resource; read_write permits reads and writes.
|
|
29126
|
-
*/
|
|
29127
|
-
access: 'read_only' | 'read_write';
|
|
29128
|
-
/**
|
|
29129
|
-
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
29130
|
-
*/
|
|
29131
|
-
instructions?: string;
|
|
29184
|
+
bindings: Array<{
|
|
29132
29185
|
/**
|
|
29133
|
-
*
|
|
29186
|
+
* Resource type. Decides the id format and the allowed access.
|
|
29134
29187
|
*/
|
|
29135
|
-
|
|
29136
|
-
}>;
|
|
29137
|
-
/**
|
|
29138
|
-
* Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
29139
|
-
*/
|
|
29140
|
-
vector_stores: Array<{
|
|
29188
|
+
type: 'database' | 'vector_store' | 'file' | 'media_library' | 'model' | 'workflow' | 'script';
|
|
29141
29189
|
/**
|
|
29142
|
-
* Resource id
|
|
29190
|
+
* Resource id, never its name. database db_..., vector_store vs_..., file file- plus 24 letters or digits; media_library and model ids must not contain ':' or whitespace; workflow and script use <namespace>/<name> with no '/', '@', ':' or whitespace inside a part.
|
|
29143
29191
|
*/
|
|
29144
29192
|
id: string;
|
|
29145
29193
|
/**
|
|
29146
|
-
*
|
|
29194
|
+
* database, vector_store and media_library accept read_only or read_write; file accepts read_only; model, workflow and script accept invoke. Any other combination returns 400.
|
|
29147
29195
|
*/
|
|
29148
|
-
access: 'read_only' | 'read_write';
|
|
29196
|
+
access: 'read_only' | 'read_write' | 'invoke';
|
|
29149
29197
|
/**
|
|
29150
29198
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
29151
29199
|
*/
|
|
@@ -29154,25 +29202,13 @@ export type UnarchiveAgentResponses = {
|
|
|
29154
29202
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
29155
29203
|
*/
|
|
29156
29204
|
enabled?: boolean;
|
|
29157
|
-
}
|
|
29158
|
-
/**
|
|
29159
|
-
* File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
29160
|
-
*/
|
|
29161
|
-
files: Array<{
|
|
29162
|
-
/**
|
|
29163
|
-
* Resource id from file.files.list or file.files.create (upload); use the returned id, not its name. Must start with file_ and be unique within this binding array.
|
|
29164
|
-
*/
|
|
29165
|
-
id: string;
|
|
29205
|
+
} | {
|
|
29166
29206
|
/**
|
|
29167
|
-
*
|
|
29207
|
+
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
29168
29208
|
*/
|
|
29169
|
-
|
|
29209
|
+
type: 'search' | 'browser';
|
|
29170
29210
|
/**
|
|
29171
|
-
*
|
|
29172
|
-
*/
|
|
29173
|
-
instructions?: string;
|
|
29174
|
-
/**
|
|
29175
|
-
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
29211
|
+
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
29176
29212
|
*/
|
|
29177
29213
|
enabled?: boolean;
|
|
29178
29214
|
}>;
|
|
@@ -29514,7 +29550,7 @@ export type UnarchiveAgentResponses = {
|
|
|
29514
29550
|
*/
|
|
29515
29551
|
commands?: Array<string>;
|
|
29516
29552
|
/**
|
|
29517
|
-
*
|
|
29553
|
+
* Names of disabled skills declarations.
|
|
29518
29554
|
*/
|
|
29519
29555
|
skills?: Array<string>;
|
|
29520
29556
|
/**
|
|
@@ -29536,6 +29572,26 @@ export type UnarchiveAgentResponses = {
|
|
|
29536
29572
|
*/
|
|
29537
29573
|
allowed: Array<string>;
|
|
29538
29574
|
};
|
|
29575
|
+
/**
|
|
29576
|
+
* Avatar image URL of this agent version (absolute https), shown in agent lists, the agent detail, the chat header and as the default avatar of embedded chat; null when none is set. Follows the version like other configuration: a version saved with apply=false does not change the avatar in effect. /agent/v1 only.
|
|
29577
|
+
*/
|
|
29578
|
+
avatar: string | null;
|
|
29579
|
+
/**
|
|
29580
|
+
* Channel the agent was created through (for example api or console); null for historical agents whose channel is unknown. Display only. /agent/v1 only; /anthropic neither returns it.
|
|
29581
|
+
*/
|
|
29582
|
+
creation_source: string | null;
|
|
29583
|
+
/**
|
|
29584
|
+
* Platform-wide identity number of the agent (8 characters), usable wherever an agent is addressed by identity_number; null when the agent has none. /agent/v1 only; /anthropic neither returns it.
|
|
29585
|
+
*/
|
|
29586
|
+
identity_number: string | null;
|
|
29587
|
+
/**
|
|
29588
|
+
* Default environment of this service agent version: the environment_id new sessions get when they name none; null means no environment. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the environment in effect. Versions saved before this field existed read as light. /agent/v1 only.
|
|
29589
|
+
*/
|
|
29590
|
+
environment_id?: string | null;
|
|
29591
|
+
/**
|
|
29592
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
29593
|
+
*/
|
|
29594
|
+
vault_ids?: Array<string>;
|
|
29539
29595
|
/**
|
|
29540
29596
|
* Current agent lifecycle status; unarchive restores an archived agent to active.
|
|
29541
29597
|
*/
|
|
@@ -29567,6 +29623,10 @@ export type DeleteRunFeedbackErrors = {
|
|
|
29567
29623
|
* Authenticate with a valid organization or end-user credential.
|
|
29568
29624
|
*/
|
|
29569
29625
|
401: unknown;
|
|
29626
|
+
/**
|
|
29627
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
29628
|
+
*/
|
|
29629
|
+
403: unknown;
|
|
29570
29630
|
/**
|
|
29571
29631
|
* Session is inaccessible or the run does not belong to it; verify both identifiers.
|
|
29572
29632
|
*/
|
|
@@ -29612,6 +29672,10 @@ export type SetRunFeedbackErrors = {
|
|
|
29612
29672
|
* Authenticate with a valid organization or end-user credential.
|
|
29613
29673
|
*/
|
|
29614
29674
|
401: unknown;
|
|
29675
|
+
/**
|
|
29676
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
29677
|
+
*/
|
|
29678
|
+
403: unknown;
|
|
29615
29679
|
/**
|
|
29616
29680
|
* Session is inaccessible or the run does not belong to it; verify both identifiers.
|
|
29617
29681
|
*/
|
|
@@ -29686,6 +29750,10 @@ export type ListEndUsersErrors = {
|
|
|
29686
29750
|
* Authenticate with a host credential.
|
|
29687
29751
|
*/
|
|
29688
29752
|
401: unknown;
|
|
29753
|
+
/**
|
|
29754
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
29755
|
+
*/
|
|
29756
|
+
403: unknown;
|
|
29689
29757
|
/**
|
|
29690
29758
|
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
29691
29759
|
*/
|
|
@@ -29761,6 +29829,10 @@ export type DeleteEndUserErrors = {
|
|
|
29761
29829
|
* Authenticate with a host credential.
|
|
29762
29830
|
*/
|
|
29763
29831
|
401: unknown;
|
|
29832
|
+
/**
|
|
29833
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
29834
|
+
*/
|
|
29835
|
+
403: unknown;
|
|
29764
29836
|
/**
|
|
29765
29837
|
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
29766
29838
|
*/
|
|
@@ -29806,6 +29878,10 @@ export type GetEndUserErrors = {
|
|
|
29806
29878
|
* Authenticate with a host credential.
|
|
29807
29879
|
*/
|
|
29808
29880
|
401: unknown;
|
|
29881
|
+
/**
|
|
29882
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
29883
|
+
*/
|
|
29884
|
+
403: unknown;
|
|
29809
29885
|
/**
|
|
29810
29886
|
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
29811
29887
|
*/
|
|
@@ -29892,6 +29968,10 @@ export type GetEndUserDeletionErrors = {
|
|
|
29892
29968
|
* Authenticate with a host credential.
|
|
29893
29969
|
*/
|
|
29894
29970
|
401: unknown;
|
|
29971
|
+
/**
|
|
29972
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
29973
|
+
*/
|
|
29974
|
+
403: unknown;
|
|
29895
29975
|
/**
|
|
29896
29976
|
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
29897
29977
|
*/
|
|
@@ -29978,6 +30058,10 @@ export type RevokeEndUserTokensErrors = {
|
|
|
29978
30058
|
* Authenticate with a host credential.
|
|
29979
30059
|
*/
|
|
29980
30060
|
401: unknown;
|
|
30061
|
+
/**
|
|
30062
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30063
|
+
*/
|
|
30064
|
+
403: unknown;
|
|
29981
30065
|
/**
|
|
29982
30066
|
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
29983
30067
|
*/
|
|
@@ -30023,6 +30107,10 @@ export type BlockEndUserErrors = {
|
|
|
30023
30107
|
* Authenticate with a host credential.
|
|
30024
30108
|
*/
|
|
30025
30109
|
401: unknown;
|
|
30110
|
+
/**
|
|
30111
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30112
|
+
*/
|
|
30113
|
+
403: unknown;
|
|
30026
30114
|
/**
|
|
30027
30115
|
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
30028
30116
|
*/
|
|
@@ -30092,6 +30180,10 @@ export type UnblockEndUserErrors = {
|
|
|
30092
30180
|
* Authenticate with a host credential.
|
|
30093
30181
|
*/
|
|
30094
30182
|
401: unknown;
|
|
30183
|
+
/**
|
|
30184
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30185
|
+
*/
|
|
30186
|
+
403: unknown;
|
|
30095
30187
|
/**
|
|
30096
30188
|
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
30097
30189
|
*/
|
|
@@ -30133,6 +30225,303 @@ export type UnblockEndUserResponses = {
|
|
|
30133
30225
|
};
|
|
30134
30226
|
};
|
|
30135
30227
|
export type UnblockEndUserResponse = UnblockEndUserResponses[keyof UnblockEndUserResponses];
|
|
30228
|
+
export type CreateCustomerGrantCodeData = {
|
|
30229
|
+
body: {
|
|
30230
|
+
/**
|
|
30231
|
+
* Your stable, opaque identifier for the signed-in customer, such as your database user id. Do not use an email address or phone number. "auth" is reserved, and ids starting with anon_ are reserved for anonymous customers.
|
|
30232
|
+
*/
|
|
30233
|
+
customer_id: string;
|
|
30234
|
+
/**
|
|
30235
|
+
* Existing agent version that every token of this sign-in pins. Defaults to the agent's active_version when the code is issued.
|
|
30236
|
+
*/
|
|
30237
|
+
version?: number;
|
|
30238
|
+
/**
|
|
30239
|
+
* Budget in cents for each session the customer starts. Defaults to the embed policy session budget and cannot exceed its maximum.
|
|
30240
|
+
*/
|
|
30241
|
+
budget_cents?: number;
|
|
30242
|
+
/**
|
|
30243
|
+
* Optional context the agent receives at the start of each session, as text blocks, limited to 8192 UTF-8 bytes in total.
|
|
30244
|
+
*/
|
|
30245
|
+
system_message?: Array<{
|
|
30246
|
+
/**
|
|
30247
|
+
* The text block kind; text is the only supported kind.
|
|
30248
|
+
*/
|
|
30249
|
+
type: 'text';
|
|
30250
|
+
/**
|
|
30251
|
+
* Context text about this customer. All blocks together must fit within 8192 UTF-8 bytes.
|
|
30252
|
+
*/
|
|
30253
|
+
text: string;
|
|
30254
|
+
}>;
|
|
30255
|
+
/**
|
|
30256
|
+
* Optional system prompt override, accepted only when the embed policy allows agent overrides.
|
|
30257
|
+
*/
|
|
30258
|
+
agent_override?: {
|
|
30259
|
+
/**
|
|
30260
|
+
* Replacement system prompt, or null to clear it for this sign-in.
|
|
30261
|
+
*/
|
|
30262
|
+
system: string | null;
|
|
30263
|
+
};
|
|
30264
|
+
/**
|
|
30265
|
+
* Up to 16 string pairs copied onto every session the customer starts. The playground key is reserved.
|
|
30266
|
+
*/
|
|
30267
|
+
metadata?: {
|
|
30268
|
+
[key: string]: string;
|
|
30269
|
+
};
|
|
30270
|
+
/**
|
|
30271
|
+
* Page origin, such as https://shop.example.com, that must be one of the agent policy's allowed_origins (or localhost when the policy allows it). When set, every token of this sign-in works only from exactly this origin. Omit to accept any policy origin.
|
|
30272
|
+
*/
|
|
30273
|
+
origin?: string;
|
|
30274
|
+
/**
|
|
30275
|
+
* Seconds the code stays redeemable, from 60 to 86400. Defaults to 900.
|
|
30276
|
+
*/
|
|
30277
|
+
expires_in?: number;
|
|
30278
|
+
/**
|
|
30279
|
+
* Total lifetime of the sign-in in seconds, from 3600 to 604800 (7 days). Tokens renew within it; after it the customer signs in again. Defaults to 604800.
|
|
30280
|
+
*/
|
|
30281
|
+
max_session_seconds?: number;
|
|
30282
|
+
/**
|
|
30283
|
+
* The current access token of the anonymous customer who used this agent before signing in. Their conversations become visible to the identified customer, and the anonymous sign-in ends at exchange.
|
|
30284
|
+
*/
|
|
30285
|
+
anonymous_access_token?: string;
|
|
30286
|
+
};
|
|
30287
|
+
path: {
|
|
30288
|
+
/**
|
|
30289
|
+
* Service agent id (agent_…) or its short identity number, from agent creation or listing.
|
|
30290
|
+
*/
|
|
30291
|
+
agent_id: string;
|
|
30292
|
+
};
|
|
30293
|
+
query?: never;
|
|
30294
|
+
url: '/agent/v1/agents/{agent_id}/customers/auth/grant_codes';
|
|
30295
|
+
};
|
|
30296
|
+
export type CreateCustomerGrantCodeErrors = {
|
|
30297
|
+
/**
|
|
30298
|
+
* INVALID_PARAMS: an unknown field, a reserved or malformed customer_id, an origin outside the policy, a value outside its range, or an anonymous_access_token that is not a live anonymous token of this agent. The message names the field to correct.
|
|
30299
|
+
*/
|
|
30300
|
+
400: unknown;
|
|
30301
|
+
/**
|
|
30302
|
+
* Authenticate with your backend API key or a console session.
|
|
30303
|
+
*/
|
|
30304
|
+
401: unknown;
|
|
30305
|
+
/**
|
|
30306
|
+
* CUSTOMER_BLOCKED: the customer is on the agent's blocked list; unblock them in the console first.
|
|
30307
|
+
*/
|
|
30308
|
+
403: unknown;
|
|
30309
|
+
/**
|
|
30310
|
+
* The agent is not an active service agent of your organization, or the caller is a customer access token.
|
|
30311
|
+
*/
|
|
30312
|
+
404: unknown;
|
|
30313
|
+
};
|
|
30314
|
+
export type CreateCustomerGrantCodeResponses = {
|
|
30315
|
+
/**
|
|
30316
|
+
* The one-time grant code and its expiry. Only its hash is stored; it cannot be read again.
|
|
30317
|
+
*/
|
|
30318
|
+
201: {
|
|
30319
|
+
/**
|
|
30320
|
+
* Object type, always customer_grant_code.
|
|
30321
|
+
*/
|
|
30322
|
+
type: 'customer_grant_code';
|
|
30323
|
+
/**
|
|
30324
|
+
* One-time grant code (cgc_…). Hand it to Agent Kit in the browser, which exchanges it for an access token; it is never shown again.
|
|
30325
|
+
*/
|
|
30326
|
+
code: string;
|
|
30327
|
+
/**
|
|
30328
|
+
* The customer_id that the code signs in.
|
|
30329
|
+
*/
|
|
30330
|
+
customer_id: string;
|
|
30331
|
+
/**
|
|
30332
|
+
* RFC 3339 time after which the code can no longer be exchanged.
|
|
30333
|
+
*/
|
|
30334
|
+
expires_at: string;
|
|
30335
|
+
};
|
|
30336
|
+
};
|
|
30337
|
+
export type CreateCustomerGrantCodeResponse = CreateCustomerGrantCodeResponses[keyof CreateCustomerGrantCodeResponses];
|
|
30338
|
+
export type CreateCustomerAccessTokenData = {
|
|
30339
|
+
/**
|
|
30340
|
+
* Exactly one of grant_code (a signed-in customer) or publishable_key (an anonymous visitor).
|
|
30341
|
+
*/
|
|
30342
|
+
body: {
|
|
30343
|
+
/**
|
|
30344
|
+
* The grant code your backend received from grant_codes. It works once.
|
|
30345
|
+
*/
|
|
30346
|
+
grant_code: string;
|
|
30347
|
+
} | {
|
|
30348
|
+
/**
|
|
30349
|
+
* The agent's publishable key, for a visitor who has not signed in. Creates a new anonymous customer.
|
|
30350
|
+
*/
|
|
30351
|
+
publishable_key: string;
|
|
30352
|
+
};
|
|
30353
|
+
headers?: {
|
|
30354
|
+
/**
|
|
30355
|
+
* Browser page origin. Required for publishable_key and for a grant code bound to an origin; it must be in the agent's allowed_origins.
|
|
30356
|
+
*/
|
|
30357
|
+
Origin?: string;
|
|
30358
|
+
};
|
|
30359
|
+
path: {
|
|
30360
|
+
/**
|
|
30361
|
+
* Service agent id (agent_…) or its short identity number, from agent creation or listing.
|
|
30362
|
+
*/
|
|
30363
|
+
agent_id: string;
|
|
30364
|
+
};
|
|
30365
|
+
query?: never;
|
|
30366
|
+
url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens';
|
|
30367
|
+
};
|
|
30368
|
+
export type CreateCustomerAccessTokenErrors = {
|
|
30369
|
+
/**
|
|
30370
|
+
* INVALID_PARAMS: send exactly one of grant_code or publishable_key, nothing else.
|
|
30371
|
+
*/
|
|
30372
|
+
400: unknown;
|
|
30373
|
+
/**
|
|
30374
|
+
* GRANT_CODE_INVALID: the code is unknown, already used, expired or for another agent (one answer for all four); request a new grant code from your backend. UNAUTHENTICATED: the publishable key is unknown, disabled or for another agent.
|
|
30375
|
+
*/
|
|
30376
|
+
401: unknown;
|
|
30377
|
+
/**
|
|
30378
|
+
* EMBED_BUDGET_EXHAUSTED: the publishable key's daily spending cap is reached; wait for the UTC reset or ask the owner to raise it.
|
|
30379
|
+
*/
|
|
30380
|
+
402: unknown;
|
|
30381
|
+
/**
|
|
30382
|
+
* ORIGIN_NOT_ALLOWED or EMBED_ORIGIN_NOT_ALLOWED: call from the origin the code was issued for, or from one in the agent's allowed_origins. CUSTOMER_BLOCKED: the merchant blocked this customer.
|
|
30383
|
+
*/
|
|
30384
|
+
403: unknown;
|
|
30385
|
+
/**
|
|
30386
|
+
* EMBED_RATE_LIMITED: the per-IP minute limit or the key's daily session cap is reached; wait for Retry-After or the UTC reset.
|
|
30387
|
+
*/
|
|
30388
|
+
429: unknown;
|
|
30389
|
+
/**
|
|
30390
|
+
* Issuance or rate limiting is unavailable; retry later with a new grant code if this one expires.
|
|
30391
|
+
*/
|
|
30392
|
+
503: unknown;
|
|
30393
|
+
};
|
|
30394
|
+
export type CreateCustomerAccessTokenResponses = {
|
|
30395
|
+
/**
|
|
30396
|
+
* A customer access token, its expiry and the end of the sign-in.
|
|
30397
|
+
*/
|
|
30398
|
+
201: {
|
|
30399
|
+
/**
|
|
30400
|
+
* Object type, always customer_access_token.
|
|
30401
|
+
*/
|
|
30402
|
+
type: 'customer_access_token';
|
|
30403
|
+
/**
|
|
30404
|
+
* Bearer credential for this agent's sessions on behalf of the customer. Renew it before expires_at.
|
|
30405
|
+
*/
|
|
30406
|
+
access_token: string;
|
|
30407
|
+
/**
|
|
30408
|
+
* RFC 3339 expiry of this access token: at most two hours after issue and never after session_expires_at.
|
|
30409
|
+
*/
|
|
30410
|
+
expires_at: string;
|
|
30411
|
+
/**
|
|
30412
|
+
* RFC 3339 end of the sign-in. Renewal stops working here; the customer signs in again with a new grant code.
|
|
30413
|
+
*/
|
|
30414
|
+
session_expires_at: string;
|
|
30415
|
+
/**
|
|
30416
|
+
* The customer this token acts for.
|
|
30417
|
+
*/
|
|
30418
|
+
customer: {
|
|
30419
|
+
/**
|
|
30420
|
+
* The customer id: your customer_id, or anon_ followed by 16 characters for an anonymous customer.
|
|
30421
|
+
*/
|
|
30422
|
+
id: string;
|
|
30423
|
+
/**
|
|
30424
|
+
* identified: signed in through a grant code from your backend. anonymous: a visitor admitted with the publishable key.
|
|
30425
|
+
*/
|
|
30426
|
+
type: 'identified' | 'anonymous';
|
|
30427
|
+
};
|
|
30428
|
+
};
|
|
30429
|
+
};
|
|
30430
|
+
export type CreateCustomerAccessTokenResponse = CreateCustomerAccessTokenResponses[keyof CreateCustomerAccessTokenResponses];
|
|
30431
|
+
export type RenewCustomerAccessTokenData = {
|
|
30432
|
+
body?: never;
|
|
30433
|
+
path: {
|
|
30434
|
+
/**
|
|
30435
|
+
* Service agent id (agent_…) or its short identity number, from agent creation or listing.
|
|
30436
|
+
*/
|
|
30437
|
+
agent_id: string;
|
|
30438
|
+
};
|
|
30439
|
+
query?: never;
|
|
30440
|
+
url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew';
|
|
30441
|
+
};
|
|
30442
|
+
export type RenewCustomerAccessTokenErrors = {
|
|
30443
|
+
/**
|
|
30444
|
+
* ACCESS_TOKEN_REVOKED: the token or its sign-in was revoked (logout, merge, or revocation by the merchant); sign the customer in again with a new grant code. Other 401 responses mean the Bearer token is missing, invalid or expired; renew before expires_at. CUSTOMER_SESSION_EXPIRED: less than 60 seconds of the sign-in remain; sign in again: request a new grant code from your backend.
|
|
30445
|
+
*/
|
|
30446
|
+
401: unknown;
|
|
30447
|
+
/**
|
|
30448
|
+
* CUSTOMER_BLOCKED: the merchant blocked this customer; unblock them before signing them in. ORIGIN_NOT_ALLOWED: the request Origin is not the origin this sign-in is bound to, or is not in the agent's allowed_origins; call from the page that signed in.
|
|
30449
|
+
*/
|
|
30450
|
+
403: unknown;
|
|
30451
|
+
/**
|
|
30452
|
+
* The token belongs to another agent, is not a customer access token, or the agent is archived or absent; use the agent_id the token was issued for.
|
|
30453
|
+
*/
|
|
30454
|
+
404: unknown;
|
|
30455
|
+
};
|
|
30456
|
+
export type RenewCustomerAccessTokenResponses = {
|
|
30457
|
+
/**
|
|
30458
|
+
* A new access token in the same sign-in. The presented token stays valid until its own expiry.
|
|
30459
|
+
*/
|
|
30460
|
+
201: {
|
|
30461
|
+
/**
|
|
30462
|
+
* Object type, always customer_access_token.
|
|
30463
|
+
*/
|
|
30464
|
+
type: 'customer_access_token';
|
|
30465
|
+
/**
|
|
30466
|
+
* Bearer credential for this agent's sessions on behalf of the customer. Renew it before expires_at.
|
|
30467
|
+
*/
|
|
30468
|
+
access_token: string;
|
|
30469
|
+
/**
|
|
30470
|
+
* RFC 3339 expiry of this access token: at most two hours after issue and never after session_expires_at.
|
|
30471
|
+
*/
|
|
30472
|
+
expires_at: string;
|
|
30473
|
+
/**
|
|
30474
|
+
* RFC 3339 end of the sign-in. Renewal stops working here; the customer signs in again with a new grant code.
|
|
30475
|
+
*/
|
|
30476
|
+
session_expires_at: string;
|
|
30477
|
+
/**
|
|
30478
|
+
* The customer this token acts for.
|
|
30479
|
+
*/
|
|
30480
|
+
customer: {
|
|
30481
|
+
/**
|
|
30482
|
+
* The customer id: your customer_id, or anon_ followed by 16 characters for an anonymous customer.
|
|
30483
|
+
*/
|
|
30484
|
+
id: string;
|
|
30485
|
+
/**
|
|
30486
|
+
* identified: signed in through a grant code from your backend. anonymous: a visitor admitted with the publishable key.
|
|
30487
|
+
*/
|
|
30488
|
+
type: 'identified' | 'anonymous';
|
|
30489
|
+
};
|
|
30490
|
+
};
|
|
30491
|
+
};
|
|
30492
|
+
export type RenewCustomerAccessTokenResponse = RenewCustomerAccessTokenResponses[keyof RenewCustomerAccessTokenResponses];
|
|
30493
|
+
export type DeleteCurrentCustomerAccessTokenData = {
|
|
30494
|
+
body?: never;
|
|
30495
|
+
path: {
|
|
30496
|
+
/**
|
|
30497
|
+
* Service agent id (agent_…) or its short identity number, from agent creation or listing.
|
|
30498
|
+
*/
|
|
30499
|
+
agent_id: string;
|
|
30500
|
+
};
|
|
30501
|
+
query?: never;
|
|
30502
|
+
url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current';
|
|
30503
|
+
};
|
|
30504
|
+
export type DeleteCurrentCustomerAccessTokenErrors = {
|
|
30505
|
+
/**
|
|
30506
|
+
* ACCESS_TOKEN_REVOKED: the token or its sign-in was revoked (logout, merge, or revocation by the merchant); sign the customer in again with a new grant code. Other 401 responses mean the Bearer token is missing, invalid or expired; renew before expires_at.
|
|
30507
|
+
*/
|
|
30508
|
+
401: unknown;
|
|
30509
|
+
/**
|
|
30510
|
+
* CUSTOMER_BLOCKED: the merchant blocked this customer; unblock them before signing them in. ORIGIN_NOT_ALLOWED: the request Origin is not the origin this sign-in is bound to, or is not in the agent's allowed_origins; call from the page that signed in.
|
|
30511
|
+
*/
|
|
30512
|
+
403: unknown;
|
|
30513
|
+
/**
|
|
30514
|
+
* The token belongs to another agent, is not a customer access token, or the agent is archived or absent; use the agent_id the token was issued for.
|
|
30515
|
+
*/
|
|
30516
|
+
404: unknown;
|
|
30517
|
+
};
|
|
30518
|
+
export type DeleteCurrentCustomerAccessTokenResponses = {
|
|
30519
|
+
/**
|
|
30520
|
+
* Logged out: the sign-in and every access token in it are revoked, and their live event streams close.
|
|
30521
|
+
*/
|
|
30522
|
+
204: void;
|
|
30523
|
+
};
|
|
30524
|
+
export type DeleteCurrentCustomerAccessTokenResponse = DeleteCurrentCustomerAccessTokenResponses[keyof DeleteCurrentCustomerAccessTokenResponses];
|
|
30136
30525
|
export type ExchangeEmbedCodeData = {
|
|
30137
30526
|
body: {
|
|
30138
30527
|
/**
|
|
@@ -30149,6 +30538,14 @@ export type ExchangeEmbedCodeErrors = {
|
|
|
30149
30538
|
* Expected a JSON object containing only code. Correct the request body.
|
|
30150
30539
|
*/
|
|
30151
30540
|
400: unknown;
|
|
30541
|
+
/**
|
|
30542
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
30543
|
+
*/
|
|
30544
|
+
401: unknown;
|
|
30545
|
+
/**
|
|
30546
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30547
|
+
*/
|
|
30548
|
+
403: unknown;
|
|
30152
30549
|
/**
|
|
30153
30550
|
* The code is expired, already used or unknown. Return to the host website for a new link; all three cases have the same response body.
|
|
30154
30551
|
*/
|
|
@@ -30277,6 +30674,10 @@ export type ListEmbedTokensErrors = {
|
|
|
30277
30674
|
* Authenticate with a host credential.
|
|
30278
30675
|
*/
|
|
30279
30676
|
401: unknown;
|
|
30677
|
+
/**
|
|
30678
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30679
|
+
*/
|
|
30680
|
+
403: unknown;
|
|
30280
30681
|
/**
|
|
30281
30682
|
* The grant is missing or belongs to another organization, or the caller is an end user.
|
|
30282
30683
|
*/
|
|
@@ -30481,6 +30882,10 @@ export type RevokeEmbedTokenErrors = {
|
|
|
30481
30882
|
* Authenticate with a host credential.
|
|
30482
30883
|
*/
|
|
30483
30884
|
401: unknown;
|
|
30885
|
+
/**
|
|
30886
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30887
|
+
*/
|
|
30888
|
+
403: unknown;
|
|
30484
30889
|
/**
|
|
30485
30890
|
* The grant is missing or belongs to another organization, or the caller is an end user.
|
|
30486
30891
|
*/
|
|
@@ -32323,6 +32728,10 @@ export type ListToolsetsErrors = {
|
|
|
32323
32728
|
* Authentication required
|
|
32324
32729
|
*/
|
|
32325
32730
|
401: unknown;
|
|
32731
|
+
/**
|
|
32732
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
32733
|
+
*/
|
|
32734
|
+
403: unknown;
|
|
32326
32735
|
/**
|
|
32327
32736
|
* Toolset catalog unavailable
|
|
32328
32737
|
*/
|
|
@@ -32425,6 +32834,10 @@ export type GetSessionContextErrors = {
|
|
|
32425
32834
|
* Authentication required
|
|
32426
32835
|
*/
|
|
32427
32836
|
401: unknown;
|
|
32837
|
+
/**
|
|
32838
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
32839
|
+
*/
|
|
32840
|
+
403: unknown;
|
|
32428
32841
|
/**
|
|
32429
32842
|
* Session not found
|
|
32430
32843
|
*/
|
|
@@ -32664,6 +33077,10 @@ export type ForkSessionErrors = {
|
|
|
32664
33077
|
* Authentication required
|
|
32665
33078
|
*/
|
|
32666
33079
|
401: unknown;
|
|
33080
|
+
/**
|
|
33081
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
33082
|
+
*/
|
|
33083
|
+
403: unknown;
|
|
32667
33084
|
/**
|
|
32668
33085
|
* Session not found
|
|
32669
33086
|
*/
|
|
@@ -32785,12 +33202,9 @@ export type ForkSessionResponses = {
|
|
|
32785
33202
|
*/
|
|
32786
33203
|
model: {
|
|
32787
33204
|
/**
|
|
32788
|
-
*
|
|
32789
|
-
*
|
|
32790
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
32791
|
-
* details and options.
|
|
33205
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
32792
33206
|
*/
|
|
32793
|
-
id:
|
|
33207
|
+
id: string;
|
|
32794
33208
|
/**
|
|
32795
33209
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
32796
33210
|
* Messages call the session makes.
|
|
@@ -32950,12 +33364,9 @@ export type ForkSessionResponses = {
|
|
|
32950
33364
|
*/
|
|
32951
33365
|
model: {
|
|
32952
33366
|
/**
|
|
32953
|
-
*
|
|
32954
|
-
*
|
|
32955
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
32956
|
-
* details and options.
|
|
33367
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
32957
33368
|
*/
|
|
32958
|
-
id:
|
|
33369
|
+
id: string;
|
|
32959
33370
|
/**
|
|
32960
33371
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
32961
33372
|
* Messages call the session makes.
|
|
@@ -33003,7 +33414,7 @@ export type ForkSessionResponses = {
|
|
|
33003
33414
|
*/
|
|
33004
33415
|
name: string;
|
|
33005
33416
|
/**
|
|
33006
|
-
*
|
|
33417
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
33007
33418
|
*/
|
|
33008
33419
|
skills: Array<{
|
|
33009
33420
|
/**
|
|
@@ -33497,7 +33908,7 @@ export type ForkSessionResponses = {
|
|
|
33497
33908
|
*/
|
|
33498
33909
|
name: string;
|
|
33499
33910
|
/**
|
|
33500
|
-
*
|
|
33911
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
33501
33912
|
*/
|
|
33502
33913
|
skills: Array<{
|
|
33503
33914
|
/**
|
|
@@ -34017,7 +34428,7 @@ export type ForkSessionResponses = {
|
|
|
34017
34428
|
*/
|
|
34018
34429
|
created_at: string;
|
|
34019
34430
|
/**
|
|
34020
|
-
* Execution environment
|
|
34431
|
+
* Execution environment of this session. A service session created without environment_id uses the default environment saved in the agent version (light for a new agent); null means it was created without a machine; Computer sessions may omit this field.
|
|
34021
34432
|
*/
|
|
34022
34433
|
environment_id?: string;
|
|
34023
34434
|
/**
|
|
@@ -34375,6 +34786,10 @@ export type ListSessionBackgroundTasksErrors = {
|
|
|
34375
34786
|
* Authentication required
|
|
34376
34787
|
*/
|
|
34377
34788
|
401: unknown;
|
|
34789
|
+
/**
|
|
34790
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
34791
|
+
*/
|
|
34792
|
+
403: unknown;
|
|
34378
34793
|
/**
|
|
34379
34794
|
* Session not found
|
|
34380
34795
|
*/
|
|
@@ -34474,6 +34889,10 @@ export type GetSessionBackgroundTaskOutputErrors = {
|
|
|
34474
34889
|
* Authentication required
|
|
34475
34890
|
*/
|
|
34476
34891
|
401: unknown;
|
|
34892
|
+
/**
|
|
34893
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
34894
|
+
*/
|
|
34895
|
+
403: unknown;
|
|
34477
34896
|
/**
|
|
34478
34897
|
* Session not found
|
|
34479
34898
|
*/
|
|
@@ -34535,6 +34954,10 @@ export type StopSessionBackgroundTaskErrors = {
|
|
|
34535
34954
|
* Authentication required
|
|
34536
34955
|
*/
|
|
34537
34956
|
401: unknown;
|
|
34957
|
+
/**
|
|
34958
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
34959
|
+
*/
|
|
34960
|
+
403: unknown;
|
|
34538
34961
|
/**
|
|
34539
34962
|
* Session not found
|
|
34540
34963
|
*/
|
|
@@ -34631,6 +35054,10 @@ export type CompactSessionErrors = {
|
|
|
34631
35054
|
* Authentication required
|
|
34632
35055
|
*/
|
|
34633
35056
|
401: unknown;
|
|
35057
|
+
/**
|
|
35058
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
35059
|
+
*/
|
|
35060
|
+
403: unknown;
|
|
34634
35061
|
/**
|
|
34635
35062
|
* Session not found
|
|
34636
35063
|
*/
|
|
@@ -34709,6 +35136,10 @@ export type GetSessionCompactionErrors = {
|
|
|
34709
35136
|
* Authentication required
|
|
34710
35137
|
*/
|
|
34711
35138
|
401: unknown;
|
|
35139
|
+
/**
|
|
35140
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
35141
|
+
*/
|
|
35142
|
+
403: unknown;
|
|
34712
35143
|
/**
|
|
34713
35144
|
* Session or compaction operation not found
|
|
34714
35145
|
*/
|
|
@@ -34762,6 +35193,10 @@ export type ListSessionCompactionsErrors = {
|
|
|
34762
35193
|
* Authentication required
|
|
34763
35194
|
*/
|
|
34764
35195
|
401: unknown;
|
|
35196
|
+
/**
|
|
35197
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
35198
|
+
*/
|
|
35199
|
+
403: unknown;
|
|
34765
35200
|
/**
|
|
34766
35201
|
* Session not found
|
|
34767
35202
|
*/
|
|
@@ -34857,6 +35292,10 @@ export type GetEmbedAppearanceErrors = {
|
|
|
34857
35292
|
* Supply a valid embed token or an active publishable key; organization member credentials cannot read this surface.
|
|
34858
35293
|
*/
|
|
34859
35294
|
401: unknown;
|
|
35295
|
+
/**
|
|
35296
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
35297
|
+
*/
|
|
35298
|
+
403: unknown;
|
|
34860
35299
|
/**
|
|
34861
35300
|
* The credential's service agent is absent or archived; obtain credentials for an active service agent.
|
|
34862
35301
|
*/
|
|
@@ -34893,13 +35332,63 @@ export type GetEmbedAppearanceResponses = {
|
|
|
34893
35332
|
*/
|
|
34894
35333
|
launcher?: {
|
|
34895
35334
|
/**
|
|
34896
|
-
* Entry control: none hides the launcher, bubble shows a button, mascot shows the
|
|
35335
|
+
* Entry control: none hides the launcher, bubble shows a button, mascot shows a character that reacts while the visitor types and the agent thinks and answers. A mascot needs pack.
|
|
34897
35336
|
*/
|
|
34898
35337
|
type: 'none' | 'bubble' | 'mascot';
|
|
34899
35338
|
/**
|
|
34900
|
-
*
|
|
35339
|
+
* Mascot images: exactly one of preset or images. Send pack, not image.
|
|
35340
|
+
*/
|
|
35341
|
+
pack?: {
|
|
35342
|
+
/**
|
|
35343
|
+
* Built-in character: mint (mint support girl), cat (cat-eared girl) or bot (small robot).
|
|
35344
|
+
*/
|
|
35345
|
+
preset?: 'mint' | 'cat' | 'bot';
|
|
35346
|
+
/**
|
|
35347
|
+
* One HTTPS image per slot; only idle is required and a missing slot shows idle. Use 2:3 canvases with the feet bottom-centered on a transparent background; PNG or WebP stay still, GIF, WebP and APNG play as they are.
|
|
35348
|
+
*/
|
|
35349
|
+
images?: {
|
|
35350
|
+
/**
|
|
35351
|
+
* Resting state.
|
|
35352
|
+
*/
|
|
35353
|
+
idle: string;
|
|
35354
|
+
/**
|
|
35355
|
+
* Page open and while the greeting bubble shows.
|
|
35356
|
+
*/
|
|
35357
|
+
greet?: string;
|
|
35358
|
+
/**
|
|
35359
|
+
* The visitor is typing in the composer.
|
|
35360
|
+
*/
|
|
35361
|
+
listening?: string;
|
|
35362
|
+
/**
|
|
35363
|
+
* After the visitor sends, before the first reply text.
|
|
35364
|
+
*/
|
|
35365
|
+
thinking?: string;
|
|
35366
|
+
/**
|
|
35367
|
+
* While the reply streams; alternates with talking-2 every 220 ms.
|
|
35368
|
+
*/
|
|
35369
|
+
talking?: string;
|
|
35370
|
+
/**
|
|
35371
|
+
* Second mouth frame of talking, mouth closed; without it talking alternates with idle.
|
|
35372
|
+
*/
|
|
35373
|
+
'talking-2'?: string;
|
|
35374
|
+
/**
|
|
35375
|
+
* The last turn failed or was refused.
|
|
35376
|
+
*/
|
|
35377
|
+
sorry?: string;
|
|
35378
|
+
/**
|
|
35379
|
+
* No interaction for 60 seconds; hover or click wakes the mascot.
|
|
35380
|
+
*/
|
|
35381
|
+
sleep?: string;
|
|
35382
|
+
};
|
|
35383
|
+
};
|
|
35384
|
+
/**
|
|
35385
|
+
* Legacy single mascot image, read as pack.images.idle. When pack is present, pack wins.
|
|
34901
35386
|
*/
|
|
34902
35387
|
image?: string;
|
|
35388
|
+
/**
|
|
35389
|
+
* float (default) gently floats the mascot, bounces on hover and waves with the greeting; none keeps it still. Reduced-motion settings always win.
|
|
35390
|
+
*/
|
|
35391
|
+
motion?: 'float' | 'none';
|
|
34903
35392
|
/**
|
|
34904
35393
|
* Launcher corner: bottom-right is the default; bottom-left uses the opposite corner.
|
|
34905
35394
|
*/
|
|
@@ -42606,6 +43095,24 @@ export type SessionsDeleteData = {
|
|
|
42606
43095
|
query?: never;
|
|
42607
43096
|
url: '/agent/v1/sessions/{session_id}';
|
|
42608
43097
|
};
|
|
43098
|
+
export type SessionsDeleteErrors = {
|
|
43099
|
+
/**
|
|
43100
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
43101
|
+
*/
|
|
43102
|
+
401: unknown;
|
|
43103
|
+
/**
|
|
43104
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
43105
|
+
*/
|
|
43106
|
+
403: unknown;
|
|
43107
|
+
/**
|
|
43108
|
+
* Session not found: the id does not exist in your organization. Take ids from sessions.list or sessions.create.
|
|
43109
|
+
*/
|
|
43110
|
+
404: unknown;
|
|
43111
|
+
/**
|
|
43112
|
+
* INVALID_STATE: the session is running. Interrupt it or wait until it is idle or terminated, then delete.
|
|
43113
|
+
*/
|
|
43114
|
+
409: unknown;
|
|
43115
|
+
};
|
|
42609
43116
|
export type SessionsDeleteResponses = {
|
|
42610
43117
|
/**
|
|
42611
43118
|
* Successful response
|
|
@@ -42624,6 +43131,20 @@ export type SessionsRetrieveData = {
|
|
|
42624
43131
|
query?: never;
|
|
42625
43132
|
url: '/agent/v1/sessions/{session_id}';
|
|
42626
43133
|
};
|
|
43134
|
+
export type SessionsRetrieveErrors = {
|
|
43135
|
+
/**
|
|
43136
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
43137
|
+
*/
|
|
43138
|
+
401: unknown;
|
|
43139
|
+
/**
|
|
43140
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
43141
|
+
*/
|
|
43142
|
+
403: unknown;
|
|
43143
|
+
/**
|
|
43144
|
+
* Session not found: the id does not exist in your organization. Take ids from sessions.list or sessions.create.
|
|
43145
|
+
*/
|
|
43146
|
+
404: unknown;
|
|
43147
|
+
};
|
|
42627
43148
|
export type SessionsRetrieveResponses = {
|
|
42628
43149
|
/**
|
|
42629
43150
|
* Successful response
|
|
@@ -42655,12 +43176,9 @@ export type SessionsRetrieveResponses = {
|
|
|
42655
43176
|
*/
|
|
42656
43177
|
model: {
|
|
42657
43178
|
/**
|
|
42658
|
-
*
|
|
42659
|
-
*
|
|
42660
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
42661
|
-
* details and options.
|
|
43179
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
42662
43180
|
*/
|
|
42663
|
-
id:
|
|
43181
|
+
id: string;
|
|
42664
43182
|
/**
|
|
42665
43183
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
42666
43184
|
* Messages call the session makes.
|
|
@@ -42697,7 +43215,7 @@ export type SessionsRetrieveResponses = {
|
|
|
42697
43215
|
*/
|
|
42698
43216
|
name: string;
|
|
42699
43217
|
/**
|
|
42700
|
-
*
|
|
43218
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
42701
43219
|
*/
|
|
42702
43220
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
42703
43221
|
/**
|
|
@@ -42731,7 +43249,7 @@ export type SessionsRetrieveResponses = {
|
|
|
42731
43249
|
*/
|
|
42732
43250
|
created_at: string;
|
|
42733
43251
|
/**
|
|
42734
|
-
* Execution environment
|
|
43252
|
+
* Execution environment of this session. A service session created without environment_id uses the default environment saved in the agent version (light for a new agent); null means it was created without a machine; Computer sessions may omit this field.
|
|
42735
43253
|
*/
|
|
42736
43254
|
environment_id?: string;
|
|
42737
43255
|
metadata: AgentManaged173;
|
|
@@ -42853,13 +43371,6 @@ export type SessionsRetrieveResponses = {
|
|
|
42853
43371
|
export type SessionsRetrieveResponse = SessionsRetrieveResponses[keyof SessionsRetrieveResponses];
|
|
42854
43372
|
export type SessionsUpdateData = {
|
|
42855
43373
|
body: {
|
|
42856
|
-
/**
|
|
42857
|
-
* Mid-session agent configuration update. Only `tools` and
|
|
42858
|
-
* `mcp_servers` are updatable. Full replacement: the provided array becomes the
|
|
42859
|
-
* new value. To preserve existing entries, GET the session, modify the array, and
|
|
42860
|
-
* POST it back.
|
|
42861
|
-
*/
|
|
42862
|
-
agent?: AgentManaged182;
|
|
42863
43374
|
/**
|
|
42864
43375
|
* A hard spend ceiling. The session stops issuing new model requests
|
|
42865
43376
|
* once the tracked list cost reaches `max_list_cost`.
|
|
@@ -42902,6 +43413,28 @@ export type SessionsUpdateData = {
|
|
|
42902
43413
|
query?: never;
|
|
42903
43414
|
url: '/agent/v1/sessions/{session_id}';
|
|
42904
43415
|
};
|
|
43416
|
+
export type SessionsUpdateErrors = {
|
|
43417
|
+
/**
|
|
43418
|
+
* The body failed validation and the message names the field: an unsupported agent override, a model or thinking selection the agent does not allow, a budget limit at or below the cost already consumed, or invalid vault_ids or metadata.
|
|
43419
|
+
*/
|
|
43420
|
+
400: unknown;
|
|
43421
|
+
/**
|
|
43422
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
43423
|
+
*/
|
|
43424
|
+
401: unknown;
|
|
43425
|
+
/**
|
|
43426
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
43427
|
+
*/
|
|
43428
|
+
403: unknown;
|
|
43429
|
+
/**
|
|
43430
|
+
* Session not found: the id does not exist in your organization. Take ids from sessions.list or sessions.create.
|
|
43431
|
+
*/
|
|
43432
|
+
404: unknown;
|
|
43433
|
+
/**
|
|
43434
|
+
* Session is archived and cannot be updated.
|
|
43435
|
+
*/
|
|
43436
|
+
409: unknown;
|
|
43437
|
+
};
|
|
42905
43438
|
export type SessionsUpdateResponses = {
|
|
42906
43439
|
/**
|
|
42907
43440
|
* Successful response
|
|
@@ -42933,12 +43466,9 @@ export type SessionsUpdateResponses = {
|
|
|
42933
43466
|
*/
|
|
42934
43467
|
model: {
|
|
42935
43468
|
/**
|
|
42936
|
-
*
|
|
42937
|
-
*
|
|
42938
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
42939
|
-
* details and options.
|
|
43469
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
42940
43470
|
*/
|
|
42941
|
-
id:
|
|
43471
|
+
id: string;
|
|
42942
43472
|
/**
|
|
42943
43473
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
42944
43474
|
* Messages call the session makes.
|
|
@@ -42975,7 +43505,7 @@ export type SessionsUpdateResponses = {
|
|
|
42975
43505
|
*/
|
|
42976
43506
|
name: string;
|
|
42977
43507
|
/**
|
|
42978
|
-
*
|
|
43508
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
42979
43509
|
*/
|
|
42980
43510
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
42981
43511
|
/**
|
|
@@ -43009,7 +43539,7 @@ export type SessionsUpdateResponses = {
|
|
|
43009
43539
|
*/
|
|
43010
43540
|
created_at: string;
|
|
43011
43541
|
/**
|
|
43012
|
-
* Execution environment
|
|
43542
|
+
* Execution environment of this session. A service session created without environment_id uses the default environment saved in the agent version (light for a new agent); null means it was created without a machine; Computer sessions may omit this field.
|
|
43013
43543
|
*/
|
|
43014
43544
|
environment_id?: string;
|
|
43015
43545
|
metadata: AgentManaged173;
|
|
@@ -43157,6 +43687,20 @@ export type AgentsListData = {
|
|
|
43157
43687
|
};
|
|
43158
43688
|
url: '/agent/v1/agents';
|
|
43159
43689
|
};
|
|
43690
|
+
export type AgentsListErrors = {
|
|
43691
|
+
/**
|
|
43692
|
+
* include_archived is not true or false, kind is not personal or service, a created_at bound is not an RFC 3339 timestamp, or limit is not an integer from 1 to 100, or page is not a cursor from this same query. Pass next_page unchanged, with the same filters, to continue.
|
|
43693
|
+
*/
|
|
43694
|
+
400: unknown;
|
|
43695
|
+
/**
|
|
43696
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
43697
|
+
*/
|
|
43698
|
+
401: unknown;
|
|
43699
|
+
/**
|
|
43700
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
43701
|
+
*/
|
|
43702
|
+
403: unknown;
|
|
43703
|
+
};
|
|
43160
43704
|
export type AgentsListResponses = {
|
|
43161
43705
|
/**
|
|
43162
43706
|
* Successful response
|
|
@@ -43192,12 +43736,9 @@ export type AgentsListResponses = {
|
|
|
43192
43736
|
*/
|
|
43193
43737
|
model: {
|
|
43194
43738
|
/**
|
|
43195
|
-
*
|
|
43196
|
-
*
|
|
43197
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
43198
|
-
* details and options.
|
|
43739
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
43199
43740
|
*/
|
|
43200
|
-
id:
|
|
43741
|
+
id: string;
|
|
43201
43742
|
/**
|
|
43202
43743
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
43203
43744
|
* Messages call the session makes.
|
|
@@ -43233,7 +43774,7 @@ export type AgentsListResponses = {
|
|
|
43233
43774
|
*/
|
|
43234
43775
|
name: string;
|
|
43235
43776
|
/**
|
|
43236
|
-
*
|
|
43777
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
43237
43778
|
*/
|
|
43238
43779
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
43239
43780
|
/**
|
|
@@ -43292,38 +43833,21 @@ export type AgentsListResponses = {
|
|
|
43292
43833
|
*/
|
|
43293
43834
|
note: string | null;
|
|
43294
43835
|
/**
|
|
43295
|
-
*
|
|
43836
|
+
* 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.
|
|
43296
43837
|
*/
|
|
43297
|
-
|
|
43298
|
-
/**
|
|
43299
|
-
* Resource id from database.databases.list or database.databases.create; use the returned id, not its name. Must start with db_ and be unique within this binding array.
|
|
43300
|
-
*/
|
|
43301
|
-
id: string;
|
|
43302
|
-
/**
|
|
43303
|
-
* read_only permits reads of the bound resource; read_write permits reads and writes.
|
|
43304
|
-
*/
|
|
43305
|
-
access: 'read_only' | 'read_write';
|
|
43838
|
+
bindings: Array<{
|
|
43306
43839
|
/**
|
|
43307
|
-
*
|
|
43840
|
+
* Resource type. Decides the id format and the allowed access.
|
|
43308
43841
|
*/
|
|
43309
|
-
|
|
43842
|
+
type: 'database' | 'vector_store' | 'file' | 'media_library' | 'model' | 'workflow' | 'script';
|
|
43310
43843
|
/**
|
|
43311
|
-
*
|
|
43312
|
-
*/
|
|
43313
|
-
enabled?: boolean;
|
|
43314
|
-
}>;
|
|
43315
|
-
/**
|
|
43316
|
-
* Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
43317
|
-
*/
|
|
43318
|
-
vector_stores: Array<{
|
|
43319
|
-
/**
|
|
43320
|
-
* Resource id from knowledge.vectorStores.list or knowledge.vectorStores.create; use the returned id, not its name. Must start with vs_ and be unique within this binding array.
|
|
43844
|
+
* Resource id, never its name. database db_..., vector_store vs_..., file file- plus 24 letters or digits; media_library and model ids must not contain ':' or whitespace; workflow and script use <namespace>/<name> with no '/', '@', ':' or whitespace inside a part.
|
|
43321
43845
|
*/
|
|
43322
43846
|
id: string;
|
|
43323
43847
|
/**
|
|
43324
|
-
*
|
|
43848
|
+
* database, vector_store and media_library accept read_only or read_write; file accepts read_only; model, workflow and script accept invoke. Any other combination returns 400.
|
|
43325
43849
|
*/
|
|
43326
|
-
access: 'read_only' | 'read_write';
|
|
43850
|
+
access: 'read_only' | 'read_write' | 'invoke';
|
|
43327
43851
|
/**
|
|
43328
43852
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
43329
43853
|
*/
|
|
@@ -43332,25 +43856,13 @@ export type AgentsListResponses = {
|
|
|
43332
43856
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
43333
43857
|
*/
|
|
43334
43858
|
enabled?: boolean;
|
|
43335
|
-
}
|
|
43336
|
-
/**
|
|
43337
|
-
* File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
43338
|
-
*/
|
|
43339
|
-
files: Array<{
|
|
43340
|
-
/**
|
|
43341
|
-
* Resource id from file.files.list or file.files.create (upload); use the returned id, not its name. Must start with file_ and be unique within this binding array.
|
|
43342
|
-
*/
|
|
43343
|
-
id: string;
|
|
43344
|
-
/**
|
|
43345
|
-
* read_only permits reading the bound file; files do not accept read_write.
|
|
43346
|
-
*/
|
|
43347
|
-
access: 'read_only';
|
|
43859
|
+
} | {
|
|
43348
43860
|
/**
|
|
43349
|
-
*
|
|
43861
|
+
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
43350
43862
|
*/
|
|
43351
|
-
|
|
43863
|
+
type: 'search' | 'browser';
|
|
43352
43864
|
/**
|
|
43353
|
-
* Whether
|
|
43865
|
+
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
43354
43866
|
*/
|
|
43355
43867
|
enabled?: boolean;
|
|
43356
43868
|
}>;
|
|
@@ -43692,7 +44204,7 @@ export type AgentsListResponses = {
|
|
|
43692
44204
|
*/
|
|
43693
44205
|
commands?: Array<string>;
|
|
43694
44206
|
/**
|
|
43695
|
-
*
|
|
44207
|
+
* Names of disabled skills declarations.
|
|
43696
44208
|
*/
|
|
43697
44209
|
skills?: Array<string>;
|
|
43698
44210
|
/**
|
|
@@ -43714,6 +44226,26 @@ export type AgentsListResponses = {
|
|
|
43714
44226
|
*/
|
|
43715
44227
|
allowed: Array<string>;
|
|
43716
44228
|
};
|
|
44229
|
+
/**
|
|
44230
|
+
* Avatar image URL of this agent version (absolute https), shown in agent lists, the agent detail, the chat header and as the default avatar of embedded chat; null when none is set. Follows the version like other configuration: a version saved with apply=false does not change the avatar in effect. /agent/v1 only.
|
|
44231
|
+
*/
|
|
44232
|
+
avatar: string | null;
|
|
44233
|
+
/**
|
|
44234
|
+
* Channel the agent was created through (for example api or console); null for historical agents whose channel is unknown. Display only. /agent/v1 only; /anthropic neither returns it.
|
|
44235
|
+
*/
|
|
44236
|
+
creation_source: string | null;
|
|
44237
|
+
/**
|
|
44238
|
+
* Platform-wide identity number of the agent (8 characters), usable wherever an agent is addressed by identity_number; null when the agent has none. /agent/v1 only; /anthropic neither returns it.
|
|
44239
|
+
*/
|
|
44240
|
+
identity_number: string | null;
|
|
44241
|
+
/**
|
|
44242
|
+
* Default environment of this service agent version: the environment_id new sessions get when they name none; null means no environment. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the environment in effect. Versions saved before this field existed read as light. /agent/v1 only.
|
|
44243
|
+
*/
|
|
44244
|
+
environment_id?: string | null;
|
|
44245
|
+
/**
|
|
44246
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
44247
|
+
*/
|
|
44248
|
+
vault_ids?: Array<string>;
|
|
43717
44249
|
/**
|
|
43718
44250
|
* Current agent lifecycle status; unarchive restores an archived agent to active.
|
|
43719
44251
|
*/
|
|
@@ -43729,19 +44261,13 @@ export type AgentsListResponse = AgentsListResponses[keyof AgentsListResponses];
|
|
|
43729
44261
|
export type AgentsCreateData = {
|
|
43730
44262
|
body: {
|
|
43731
44263
|
/**
|
|
43732
|
-
*
|
|
43733
|
-
* [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison),
|
|
43734
|
-
* e.g. `claude-opus-5`, or a `model_config` object for additional configuration
|
|
43735
|
-
* control
|
|
44264
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
43736
44265
|
*/
|
|
43737
|
-
model:
|
|
44266
|
+
model: string | {
|
|
43738
44267
|
/**
|
|
43739
|
-
*
|
|
43740
|
-
*
|
|
43741
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
43742
|
-
* details and options.
|
|
44268
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
43743
44269
|
*/
|
|
43744
|
-
id:
|
|
44270
|
+
id: string;
|
|
43745
44271
|
/**
|
|
43746
44272
|
* How hard Claude works on each inference call. Accepts a bare level string
|
|
43747
44273
|
* (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model
|
|
@@ -43771,7 +44297,7 @@ export type AgentsCreateData = {
|
|
|
43771
44297
|
};
|
|
43772
44298
|
};
|
|
43773
44299
|
/**
|
|
43774
|
-
*
|
|
44300
|
+
* Display name of the agent, 1 to 256 characters after trimming, with no NUL or line breaks. A label, not a unique key: two agents may share a name.
|
|
43775
44301
|
*/
|
|
43776
44302
|
name: string;
|
|
43777
44303
|
/**
|
|
@@ -43794,7 +44320,7 @@ export type AgentsCreateData = {
|
|
|
43794
44320
|
*/
|
|
43795
44321
|
multiagent?: null | AgentManaged9;
|
|
43796
44322
|
/**
|
|
43797
|
-
*
|
|
44323
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
43798
44324
|
*/
|
|
43799
44325
|
skills?: Array<AgentManaged13 | AgentManaged14>;
|
|
43800
44326
|
/**
|
|
@@ -43807,38 +44333,21 @@ export type AgentsCreateData = {
|
|
|
43807
44333
|
*/
|
|
43808
44334
|
tools?: Array<AgentManaged15 | AgentManaged29 | AgentManaged32>;
|
|
43809
44335
|
/**
|
|
43810
|
-
*
|
|
44336
|
+
* 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.
|
|
43811
44337
|
*/
|
|
43812
|
-
|
|
43813
|
-
/**
|
|
43814
|
-
* Resource id from database.databases.list or database.databases.create; use the returned id, not its name. Must start with db_ and be unique within this binding array.
|
|
43815
|
-
*/
|
|
43816
|
-
id: string;
|
|
44338
|
+
bindings?: Array<{
|
|
43817
44339
|
/**
|
|
43818
|
-
*
|
|
44340
|
+
* Resource type. Decides the id format and the allowed access.
|
|
43819
44341
|
*/
|
|
43820
|
-
|
|
44342
|
+
type: 'database' | 'vector_store' | 'file' | 'media_library' | 'model' | 'workflow' | 'script';
|
|
43821
44343
|
/**
|
|
43822
|
-
*
|
|
43823
|
-
*/
|
|
43824
|
-
instructions?: string;
|
|
43825
|
-
/**
|
|
43826
|
-
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
43827
|
-
*/
|
|
43828
|
-
enabled?: boolean;
|
|
43829
|
-
}>;
|
|
43830
|
-
/**
|
|
43831
|
-
* Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
43832
|
-
*/
|
|
43833
|
-
vector_stores?: Array<{
|
|
43834
|
-
/**
|
|
43835
|
-
* Resource id from knowledge.vectorStores.list or knowledge.vectorStores.create; use the returned id, not its name. Must start with vs_ and be unique within this binding array.
|
|
44344
|
+
* Resource id, never its name. database db_..., vector_store vs_..., file file- plus 24 letters or digits; media_library and model ids must not contain ':' or whitespace; workflow and script use <namespace>/<name> with no '/', '@', ':' or whitespace inside a part.
|
|
43836
44345
|
*/
|
|
43837
44346
|
id: string;
|
|
43838
44347
|
/**
|
|
43839
|
-
*
|
|
44348
|
+
* database, vector_store and media_library accept read_only or read_write; file accepts read_only; model, workflow and script accept invoke. Any other combination returns 400.
|
|
43840
44349
|
*/
|
|
43841
|
-
access: 'read_only' | 'read_write';
|
|
44350
|
+
access: 'read_only' | 'read_write' | 'invoke';
|
|
43842
44351
|
/**
|
|
43843
44352
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
43844
44353
|
*/
|
|
@@ -43847,25 +44356,13 @@ export type AgentsCreateData = {
|
|
|
43847
44356
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
43848
44357
|
*/
|
|
43849
44358
|
enabled?: boolean;
|
|
43850
|
-
}
|
|
43851
|
-
/**
|
|
43852
|
-
* File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
43853
|
-
*/
|
|
43854
|
-
files?: Array<{
|
|
43855
|
-
/**
|
|
43856
|
-
* Resource id from file.files.list or file.files.create (upload); use the returned id, not its name. Must start with file_ and be unique within this binding array.
|
|
43857
|
-
*/
|
|
43858
|
-
id: string;
|
|
43859
|
-
/**
|
|
43860
|
-
* read_only permits reading the bound file; files do not accept read_write.
|
|
43861
|
-
*/
|
|
43862
|
-
access: 'read_only';
|
|
44359
|
+
} | {
|
|
43863
44360
|
/**
|
|
43864
|
-
*
|
|
44361
|
+
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
43865
44362
|
*/
|
|
43866
|
-
|
|
44363
|
+
type: 'search' | 'browser';
|
|
43867
44364
|
/**
|
|
43868
|
-
* Whether
|
|
44365
|
+
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
43869
44366
|
*/
|
|
43870
44367
|
enabled?: boolean;
|
|
43871
44368
|
}>;
|
|
@@ -44207,7 +44704,7 @@ export type AgentsCreateData = {
|
|
|
44207
44704
|
*/
|
|
44208
44705
|
commands?: Array<string>;
|
|
44209
44706
|
/**
|
|
44210
|
-
*
|
|
44707
|
+
* Names of disabled skills declarations.
|
|
44211
44708
|
*/
|
|
44212
44709
|
skills?: Array<string>;
|
|
44213
44710
|
/**
|
|
@@ -44229,6 +44726,18 @@ export type AgentsCreateData = {
|
|
|
44229
44726
|
*/
|
|
44230
44727
|
allowed: Array<string>;
|
|
44231
44728
|
};
|
|
44729
|
+
/**
|
|
44730
|
+
* Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it.
|
|
44731
|
+
*/
|
|
44732
|
+
avatar?: string | null;
|
|
44733
|
+
/**
|
|
44734
|
+
* Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.
|
|
44735
|
+
*/
|
|
44736
|
+
environment_id?: string | null;
|
|
44737
|
+
/**
|
|
44738
|
+
* Default vaults of a service agent: the vault_ids a new session gets when it names none, so the agent's credentials follow the version. At most 50 ids without duplicates; each must be a vault of your organization that is not archived, otherwise 400 vault_ids[<index>] <id> was not found. Saved with the agent version like other configuration, so apply=false keeps the previous vaults in effect for new sessions until that version is applied; a session that sets vault_ids itself, [] included, overrides it. Omit on create for []; on update, omit to keep the list and send an array to replace it as a whole. Versions saved before this field existed read as []. Embed tokens use the vault_ids of the version they pin; vault_ids on the embed policy is deprecated, still accepted and ignored. Personal agents get no default vaults: a non-empty value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.
|
|
44739
|
+
*/
|
|
44740
|
+
vault_ids?: Array<string>;
|
|
44232
44741
|
/**
|
|
44233
44742
|
* Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor.
|
|
44234
44743
|
*/
|
|
@@ -44238,6 +44747,24 @@ export type AgentsCreateData = {
|
|
|
44238
44747
|
query?: never;
|
|
44239
44748
|
url: '/agent/v1/agents';
|
|
44240
44749
|
};
|
|
44750
|
+
export type AgentsCreateErrors = {
|
|
44751
|
+
/**
|
|
44752
|
+
* The body failed validation and the message names the field: an unknown field, name outside 1 to 256 characters, a model that is not in the catalog or cannot run an agent, invalid tools or tools: null, a skill that is anthropic, repeated or not found, invalid bindings or vault_ids, or an environment_id that does not exist. Correct the field and retry.
|
|
44753
|
+
*/
|
|
44754
|
+
400: unknown;
|
|
44755
|
+
/**
|
|
44756
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
44757
|
+
*/
|
|
44758
|
+
401: unknown;
|
|
44759
|
+
/**
|
|
44760
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
44761
|
+
*/
|
|
44762
|
+
403: unknown;
|
|
44763
|
+
/**
|
|
44764
|
+
* The vault availability check for vault_ids failed upstream; nothing was saved. Retry later.
|
|
44765
|
+
*/
|
|
44766
|
+
502: unknown;
|
|
44767
|
+
};
|
|
44241
44768
|
export type AgentsCreateResponses = {
|
|
44242
44769
|
/**
|
|
44243
44770
|
* Successful response
|
|
@@ -44269,12 +44796,9 @@ export type AgentsCreateResponses = {
|
|
|
44269
44796
|
*/
|
|
44270
44797
|
model: {
|
|
44271
44798
|
/**
|
|
44272
|
-
*
|
|
44273
|
-
*
|
|
44274
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
44275
|
-
* details and options.
|
|
44799
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
44276
44800
|
*/
|
|
44277
|
-
id:
|
|
44801
|
+
id: string;
|
|
44278
44802
|
/**
|
|
44279
44803
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
44280
44804
|
* Messages call the session makes.
|
|
@@ -44310,7 +44834,7 @@ export type AgentsCreateResponses = {
|
|
|
44310
44834
|
*/
|
|
44311
44835
|
name: string;
|
|
44312
44836
|
/**
|
|
44313
|
-
*
|
|
44837
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
44314
44838
|
*/
|
|
44315
44839
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
44316
44840
|
/**
|
|
@@ -44369,38 +44893,21 @@ export type AgentsCreateResponses = {
|
|
|
44369
44893
|
*/
|
|
44370
44894
|
note: string | null;
|
|
44371
44895
|
/**
|
|
44372
|
-
*
|
|
44896
|
+
* 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.
|
|
44373
44897
|
*/
|
|
44374
|
-
|
|
44375
|
-
/**
|
|
44376
|
-
* Resource id from database.databases.list or database.databases.create; use the returned id, not its name. Must start with db_ and be unique within this binding array.
|
|
44377
|
-
*/
|
|
44378
|
-
id: string;
|
|
44379
|
-
/**
|
|
44380
|
-
* read_only permits reads of the bound resource; read_write permits reads and writes.
|
|
44381
|
-
*/
|
|
44382
|
-
access: 'read_only' | 'read_write';
|
|
44898
|
+
bindings: Array<{
|
|
44383
44899
|
/**
|
|
44384
|
-
*
|
|
44385
|
-
*/
|
|
44386
|
-
instructions?: string;
|
|
44387
|
-
/**
|
|
44388
|
-
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
44900
|
+
* Resource type. Decides the id format and the allowed access.
|
|
44389
44901
|
*/
|
|
44390
|
-
|
|
44391
|
-
}>;
|
|
44392
|
-
/**
|
|
44393
|
-
* Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
44394
|
-
*/
|
|
44395
|
-
vector_stores: Array<{
|
|
44902
|
+
type: 'database' | 'vector_store' | 'file' | 'media_library' | 'model' | 'workflow' | 'script';
|
|
44396
44903
|
/**
|
|
44397
|
-
* Resource id
|
|
44904
|
+
* Resource id, never its name. database db_..., vector_store vs_..., file file- plus 24 letters or digits; media_library and model ids must not contain ':' or whitespace; workflow and script use <namespace>/<name> with no '/', '@', ':' or whitespace inside a part.
|
|
44398
44905
|
*/
|
|
44399
44906
|
id: string;
|
|
44400
44907
|
/**
|
|
44401
|
-
*
|
|
44908
|
+
* database, vector_store and media_library accept read_only or read_write; file accepts read_only; model, workflow and script accept invoke. Any other combination returns 400.
|
|
44402
44909
|
*/
|
|
44403
|
-
access: 'read_only' | 'read_write';
|
|
44910
|
+
access: 'read_only' | 'read_write' | 'invoke';
|
|
44404
44911
|
/**
|
|
44405
44912
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
44406
44913
|
*/
|
|
@@ -44409,25 +44916,13 @@ export type AgentsCreateResponses = {
|
|
|
44409
44916
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
44410
44917
|
*/
|
|
44411
44918
|
enabled?: boolean;
|
|
44412
|
-
}
|
|
44413
|
-
/**
|
|
44414
|
-
* File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
44415
|
-
*/
|
|
44416
|
-
files: Array<{
|
|
44417
|
-
/**
|
|
44418
|
-
* Resource id from file.files.list or file.files.create (upload); use the returned id, not its name. Must start with file_ and be unique within this binding array.
|
|
44419
|
-
*/
|
|
44420
|
-
id: string;
|
|
44421
|
-
/**
|
|
44422
|
-
* read_only permits reading the bound file; files do not accept read_write.
|
|
44423
|
-
*/
|
|
44424
|
-
access: 'read_only';
|
|
44919
|
+
} | {
|
|
44425
44920
|
/**
|
|
44426
|
-
*
|
|
44921
|
+
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
44427
44922
|
*/
|
|
44428
|
-
|
|
44923
|
+
type: 'search' | 'browser';
|
|
44429
44924
|
/**
|
|
44430
|
-
* Whether
|
|
44925
|
+
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
44431
44926
|
*/
|
|
44432
44927
|
enabled?: boolean;
|
|
44433
44928
|
}>;
|
|
@@ -44769,7 +45264,7 @@ export type AgentsCreateResponses = {
|
|
|
44769
45264
|
*/
|
|
44770
45265
|
commands?: Array<string>;
|
|
44771
45266
|
/**
|
|
44772
|
-
*
|
|
45267
|
+
* Names of disabled skills declarations.
|
|
44773
45268
|
*/
|
|
44774
45269
|
skills?: Array<string>;
|
|
44775
45270
|
/**
|
|
@@ -44791,6 +45286,26 @@ export type AgentsCreateResponses = {
|
|
|
44791
45286
|
*/
|
|
44792
45287
|
allowed: Array<string>;
|
|
44793
45288
|
};
|
|
45289
|
+
/**
|
|
45290
|
+
* Avatar image URL of this agent version (absolute https), shown in agent lists, the agent detail, the chat header and as the default avatar of embedded chat; null when none is set. Follows the version like other configuration: a version saved with apply=false does not change the avatar in effect. /agent/v1 only.
|
|
45291
|
+
*/
|
|
45292
|
+
avatar: string | null;
|
|
45293
|
+
/**
|
|
45294
|
+
* Channel the agent was created through (for example api or console); null for historical agents whose channel is unknown. Display only. /agent/v1 only; /anthropic neither returns it.
|
|
45295
|
+
*/
|
|
45296
|
+
creation_source: string | null;
|
|
45297
|
+
/**
|
|
45298
|
+
* Platform-wide identity number of the agent (8 characters), usable wherever an agent is addressed by identity_number; null when the agent has none. /agent/v1 only; /anthropic neither returns it.
|
|
45299
|
+
*/
|
|
45300
|
+
identity_number: string | null;
|
|
45301
|
+
/**
|
|
45302
|
+
* Default environment of this service agent version: the environment_id new sessions get when they name none; null means no environment. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the environment in effect. Versions saved before this field existed read as light. /agent/v1 only.
|
|
45303
|
+
*/
|
|
45304
|
+
environment_id?: string | null;
|
|
45305
|
+
/**
|
|
45306
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
45307
|
+
*/
|
|
45308
|
+
vault_ids?: Array<string>;
|
|
44794
45309
|
/**
|
|
44795
45310
|
* Current agent lifecycle status; unarchive restores an archived agent to active.
|
|
44796
45311
|
*/
|
|
@@ -44815,6 +45330,24 @@ export type AgentsRetrieveData = {
|
|
|
44815
45330
|
};
|
|
44816
45331
|
url: '/agent/v1/agents/{agent_id}';
|
|
44817
45332
|
};
|
|
45333
|
+
export type AgentsRetrieveErrors = {
|
|
45334
|
+
/**
|
|
45335
|
+
* version is not a positive integer. Take versions from agents.versions.list.
|
|
45336
|
+
*/
|
|
45337
|
+
400: unknown;
|
|
45338
|
+
/**
|
|
45339
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
45340
|
+
*/
|
|
45341
|
+
401: unknown;
|
|
45342
|
+
/**
|
|
45343
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
45344
|
+
*/
|
|
45345
|
+
403: unknown;
|
|
45346
|
+
/**
|
|
45347
|
+
* Agent not found, or the requested version does not exist for it. Take ids from agents.list and versions from agents.versions.list.
|
|
45348
|
+
*/
|
|
45349
|
+
404: unknown;
|
|
45350
|
+
};
|
|
44818
45351
|
export type AgentsRetrieveResponses = {
|
|
44819
45352
|
/**
|
|
44820
45353
|
* Successful response
|
|
@@ -44846,12 +45379,9 @@ export type AgentsRetrieveResponses = {
|
|
|
44846
45379
|
*/
|
|
44847
45380
|
model: {
|
|
44848
45381
|
/**
|
|
44849
|
-
*
|
|
44850
|
-
*
|
|
44851
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
44852
|
-
* details and options.
|
|
45382
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
44853
45383
|
*/
|
|
44854
|
-
id:
|
|
45384
|
+
id: string;
|
|
44855
45385
|
/**
|
|
44856
45386
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
44857
45387
|
* Messages call the session makes.
|
|
@@ -44887,7 +45417,7 @@ export type AgentsRetrieveResponses = {
|
|
|
44887
45417
|
*/
|
|
44888
45418
|
name: string;
|
|
44889
45419
|
/**
|
|
44890
|
-
*
|
|
45420
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
44891
45421
|
*/
|
|
44892
45422
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
44893
45423
|
/**
|
|
@@ -44946,38 +45476,21 @@ export type AgentsRetrieveResponses = {
|
|
|
44946
45476
|
*/
|
|
44947
45477
|
note: string | null;
|
|
44948
45478
|
/**
|
|
44949
|
-
*
|
|
45479
|
+
* 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.
|
|
44950
45480
|
*/
|
|
44951
|
-
|
|
45481
|
+
bindings: Array<{
|
|
44952
45482
|
/**
|
|
44953
|
-
* Resource
|
|
45483
|
+
* Resource type. Decides the id format and the allowed access.
|
|
44954
45484
|
*/
|
|
44955
|
-
|
|
44956
|
-
/**
|
|
44957
|
-
* read_only permits reads of the bound resource; read_write permits reads and writes.
|
|
44958
|
-
*/
|
|
44959
|
-
access: 'read_only' | 'read_write';
|
|
44960
|
-
/**
|
|
44961
|
-
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
44962
|
-
*/
|
|
44963
|
-
instructions?: string;
|
|
44964
|
-
/**
|
|
44965
|
-
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
44966
|
-
*/
|
|
44967
|
-
enabled?: boolean;
|
|
44968
|
-
}>;
|
|
44969
|
-
/**
|
|
44970
|
-
* Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
44971
|
-
*/
|
|
44972
|
-
vector_stores: Array<{
|
|
45485
|
+
type: 'database' | 'vector_store' | 'file' | 'media_library' | 'model' | 'workflow' | 'script';
|
|
44973
45486
|
/**
|
|
44974
|
-
* Resource id
|
|
45487
|
+
* Resource id, never its name. database db_..., vector_store vs_..., file file- plus 24 letters or digits; media_library and model ids must not contain ':' or whitespace; workflow and script use <namespace>/<name> with no '/', '@', ':' or whitespace inside a part.
|
|
44975
45488
|
*/
|
|
44976
45489
|
id: string;
|
|
44977
45490
|
/**
|
|
44978
|
-
*
|
|
45491
|
+
* database, vector_store and media_library accept read_only or read_write; file accepts read_only; model, workflow and script accept invoke. Any other combination returns 400.
|
|
44979
45492
|
*/
|
|
44980
|
-
access: 'read_only' | 'read_write';
|
|
45493
|
+
access: 'read_only' | 'read_write' | 'invoke';
|
|
44981
45494
|
/**
|
|
44982
45495
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
44983
45496
|
*/
|
|
@@ -44986,25 +45499,13 @@ export type AgentsRetrieveResponses = {
|
|
|
44986
45499
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
44987
45500
|
*/
|
|
44988
45501
|
enabled?: boolean;
|
|
44989
|
-
}
|
|
44990
|
-
/**
|
|
44991
|
-
* File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
44992
|
-
*/
|
|
44993
|
-
files: Array<{
|
|
44994
|
-
/**
|
|
44995
|
-
* Resource id from file.files.list or file.files.create (upload); use the returned id, not its name. Must start with file_ and be unique within this binding array.
|
|
44996
|
-
*/
|
|
44997
|
-
id: string;
|
|
45502
|
+
} | {
|
|
44998
45503
|
/**
|
|
44999
|
-
*
|
|
45504
|
+
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
45000
45505
|
*/
|
|
45001
|
-
|
|
45506
|
+
type: 'search' | 'browser';
|
|
45002
45507
|
/**
|
|
45003
|
-
*
|
|
45004
|
-
*/
|
|
45005
|
-
instructions?: string;
|
|
45006
|
-
/**
|
|
45007
|
-
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
45508
|
+
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
45008
45509
|
*/
|
|
45009
45510
|
enabled?: boolean;
|
|
45010
45511
|
}>;
|
|
@@ -45346,7 +45847,7 @@ export type AgentsRetrieveResponses = {
|
|
|
45346
45847
|
*/
|
|
45347
45848
|
commands?: Array<string>;
|
|
45348
45849
|
/**
|
|
45349
|
-
*
|
|
45850
|
+
* Names of disabled skills declarations.
|
|
45350
45851
|
*/
|
|
45351
45852
|
skills?: Array<string>;
|
|
45352
45853
|
/**
|
|
@@ -45368,6 +45869,26 @@ export type AgentsRetrieveResponses = {
|
|
|
45368
45869
|
*/
|
|
45369
45870
|
allowed: Array<string>;
|
|
45370
45871
|
};
|
|
45872
|
+
/**
|
|
45873
|
+
* Avatar image URL of this agent version (absolute https), shown in agent lists, the agent detail, the chat header and as the default avatar of embedded chat; null when none is set. Follows the version like other configuration: a version saved with apply=false does not change the avatar in effect. /agent/v1 only.
|
|
45874
|
+
*/
|
|
45875
|
+
avatar: string | null;
|
|
45876
|
+
/**
|
|
45877
|
+
* Channel the agent was created through (for example api or console); null for historical agents whose channel is unknown. Display only. /agent/v1 only; /anthropic neither returns it.
|
|
45878
|
+
*/
|
|
45879
|
+
creation_source: string | null;
|
|
45880
|
+
/**
|
|
45881
|
+
* Platform-wide identity number of the agent (8 characters), usable wherever an agent is addressed by identity_number; null when the agent has none. /agent/v1 only; /anthropic neither returns it.
|
|
45882
|
+
*/
|
|
45883
|
+
identity_number: string | null;
|
|
45884
|
+
/**
|
|
45885
|
+
* Default environment of this service agent version: the environment_id new sessions get when they name none; null means no environment. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the environment in effect. Versions saved before this field existed read as light. /agent/v1 only.
|
|
45886
|
+
*/
|
|
45887
|
+
environment_id?: string | null;
|
|
45888
|
+
/**
|
|
45889
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
45890
|
+
*/
|
|
45891
|
+
vault_ids?: Array<string>;
|
|
45371
45892
|
/**
|
|
45372
45893
|
* Current agent lifecycle status; unarchive restores an archived agent to active.
|
|
45373
45894
|
*/
|
|
@@ -45392,19 +45913,13 @@ export type AgentsUpdateData = {
|
|
|
45392
45913
|
*/
|
|
45393
45914
|
metadata?: null | AgentManaged58Writable;
|
|
45394
45915
|
/**
|
|
45395
|
-
*
|
|
45396
|
-
* [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison),
|
|
45397
|
-
* e.g. `claude-opus-5`, or a `model_config` object for additional configuration
|
|
45398
|
-
* control. Omit to preserve. Cannot be cleared.
|
|
45916
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
45399
45917
|
*/
|
|
45400
|
-
model?:
|
|
45918
|
+
model?: string | {
|
|
45401
45919
|
/**
|
|
45402
|
-
*
|
|
45403
|
-
*
|
|
45404
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
45405
|
-
* details and options.
|
|
45920
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
45406
45921
|
*/
|
|
45407
|
-
id:
|
|
45922
|
+
id: string;
|
|
45408
45923
|
/**
|
|
45409
45924
|
* How hard Claude works on each inference call. Accepts a bare level string
|
|
45410
45925
|
* (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model
|
|
@@ -45440,12 +45955,11 @@ export type AgentsUpdateData = {
|
|
|
45440
45955
|
*/
|
|
45441
45956
|
multiagent?: null | AgentManaged9;
|
|
45442
45957
|
/**
|
|
45443
|
-
*
|
|
45444
|
-
* cleared.
|
|
45958
|
+
* New display name, 1 to 256 characters after trimming, with no NUL or line breaks. A label, not a unique key; omit to keep the current name.
|
|
45445
45959
|
*/
|
|
45446
45960
|
name?: string;
|
|
45447
45961
|
/**
|
|
45448
|
-
*
|
|
45962
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
45449
45963
|
*/
|
|
45450
45964
|
skills?: null | Array<AgentManaged13 | AgentManaged14>;
|
|
45451
45965
|
/**
|
|
@@ -45474,38 +45988,21 @@ export type AgentsUpdateData = {
|
|
|
45474
45988
|
*/
|
|
45475
45989
|
version_note?: string;
|
|
45476
45990
|
/**
|
|
45477
|
-
* Replace
|
|
45991
|
+
* Replace the whole bindings list; omission preserves it, and null or [] clears it. Additions apply only to new sessions; once this version is applied, disabling, removing or downgrading a binding revokes it immediately in running sessions on older versions, while apply=false changes no access. Only service agents accept a nonempty list.
|
|
45478
45992
|
*/
|
|
45479
|
-
|
|
45480
|
-
/**
|
|
45481
|
-
* Resource id from database.databases.list or database.databases.create; use the returned id, not its name. Must start with db_ and be unique within this binding array.
|
|
45482
|
-
*/
|
|
45483
|
-
id: string;
|
|
45993
|
+
bindings?: Array<{
|
|
45484
45994
|
/**
|
|
45485
|
-
*
|
|
45995
|
+
* Resource type. Decides the id format and the allowed access.
|
|
45486
45996
|
*/
|
|
45487
|
-
|
|
45997
|
+
type: 'database' | 'vector_store' | 'file' | 'media_library' | 'model' | 'workflow' | 'script';
|
|
45488
45998
|
/**
|
|
45489
|
-
*
|
|
45490
|
-
*/
|
|
45491
|
-
instructions?: string;
|
|
45492
|
-
/**
|
|
45493
|
-
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
45494
|
-
*/
|
|
45495
|
-
enabled?: boolean;
|
|
45496
|
-
}> | null;
|
|
45497
|
-
/**
|
|
45498
|
-
* Replace this resource allowlist; omission preserves it, and null or [] clears it. Additions apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Only service agents accept nonempty bindings.
|
|
45499
|
-
*/
|
|
45500
|
-
vector_stores?: Array<{
|
|
45501
|
-
/**
|
|
45502
|
-
* Resource id from knowledge.vectorStores.list or knowledge.vectorStores.create; use the returned id, not its name. Must start with vs_ and be unique within this binding array.
|
|
45999
|
+
* Resource id, never its name. database db_..., vector_store vs_..., file file- plus 24 letters or digits; media_library and model ids must not contain ':' or whitespace; workflow and script use <namespace>/<name> with no '/', '@', ':' or whitespace inside a part.
|
|
45503
46000
|
*/
|
|
45504
46001
|
id: string;
|
|
45505
46002
|
/**
|
|
45506
|
-
*
|
|
46003
|
+
* database, vector_store and media_library accept read_only or read_write; file accepts read_only; model, workflow and script accept invoke. Any other combination returns 400.
|
|
45507
46004
|
*/
|
|
45508
|
-
access: 'read_only' | 'read_write';
|
|
46005
|
+
access: 'read_only' | 'read_write' | 'invoke';
|
|
45509
46006
|
/**
|
|
45510
46007
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
45511
46008
|
*/
|
|
@@ -45514,25 +46011,13 @@ export type AgentsUpdateData = {
|
|
|
45514
46011
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
45515
46012
|
*/
|
|
45516
46013
|
enabled?: boolean;
|
|
45517
|
-
}
|
|
45518
|
-
/**
|
|
45519
|
-
* Replace this resource allowlist; omission preserves it, and null or [] clears it. Additions apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Only service agents accept nonempty bindings.
|
|
45520
|
-
*/
|
|
45521
|
-
files?: Array<{
|
|
45522
|
-
/**
|
|
45523
|
-
* Resource id from file.files.list or file.files.create (upload); use the returned id, not its name. Must start with file_ and be unique within this binding array.
|
|
45524
|
-
*/
|
|
45525
|
-
id: string;
|
|
45526
|
-
/**
|
|
45527
|
-
* read_only permits reading the bound file; files do not accept read_write.
|
|
45528
|
-
*/
|
|
45529
|
-
access: 'read_only';
|
|
46014
|
+
} | {
|
|
45530
46015
|
/**
|
|
45531
|
-
*
|
|
46016
|
+
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
45532
46017
|
*/
|
|
45533
|
-
|
|
46018
|
+
type: 'search' | 'browser';
|
|
45534
46019
|
/**
|
|
45535
|
-
* Whether
|
|
46020
|
+
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
45536
46021
|
*/
|
|
45537
46022
|
enabled?: boolean;
|
|
45538
46023
|
}> | null;
|
|
@@ -45874,7 +46359,7 @@ export type AgentsUpdateData = {
|
|
|
45874
46359
|
*/
|
|
45875
46360
|
commands?: Array<string>;
|
|
45876
46361
|
/**
|
|
45877
|
-
*
|
|
46362
|
+
* Names of disabled skills declarations.
|
|
45878
46363
|
*/
|
|
45879
46364
|
skills?: Array<string>;
|
|
45880
46365
|
/**
|
|
@@ -45896,6 +46381,18 @@ export type AgentsUpdateData = {
|
|
|
45896
46381
|
*/
|
|
45897
46382
|
allowed: Array<string>;
|
|
45898
46383
|
};
|
|
46384
|
+
/**
|
|
46385
|
+
* Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it.
|
|
46386
|
+
*/
|
|
46387
|
+
avatar?: string | null;
|
|
46388
|
+
/**
|
|
46389
|
+
* Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.
|
|
46390
|
+
*/
|
|
46391
|
+
environment_id?: string | null;
|
|
46392
|
+
/**
|
|
46393
|
+
* Default vaults of a service agent: the vault_ids a new session gets when it names none, so the agent's credentials follow the version. At most 50 ids without duplicates; each must be a vault of your organization that is not archived, otherwise 400 vault_ids[<index>] <id> was not found. Saved with the agent version like other configuration, so apply=false keeps the previous vaults in effect for new sessions until that version is applied; a session that sets vault_ids itself, [] included, overrides it. Omit on create for []; on update, omit to keep the list and send an array to replace it as a whole. Versions saved before this field existed read as []. Embed tokens use the vault_ids of the version they pin; vault_ids on the embed policy is deprecated, still accepted and ignored. Personal agents get no default vaults: a non-empty value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.
|
|
46394
|
+
*/
|
|
46395
|
+
vault_ids?: Array<string>;
|
|
45899
46396
|
/**
|
|
45900
46397
|
* Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor.
|
|
45901
46398
|
*/
|
|
@@ -45910,6 +46407,28 @@ export type AgentsUpdateData = {
|
|
|
45910
46407
|
query?: never;
|
|
45911
46408
|
url: '/agent/v1/agents/{agent_id}';
|
|
45912
46409
|
};
|
|
46410
|
+
export type AgentsUpdateErrors = {
|
|
46411
|
+
/**
|
|
46412
|
+
* The body failed validation and the message names the field (same rules as agents.create, including tools: null).
|
|
46413
|
+
*/
|
|
46414
|
+
400: unknown;
|
|
46415
|
+
/**
|
|
46416
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
46417
|
+
*/
|
|
46418
|
+
401: unknown;
|
|
46419
|
+
/**
|
|
46420
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
46421
|
+
*/
|
|
46422
|
+
403: unknown;
|
|
46423
|
+
/**
|
|
46424
|
+
* Agent not found: the id does not exist in your organization. Take ids from agents.list or agents.create.
|
|
46425
|
+
*/
|
|
46426
|
+
404: unknown;
|
|
46427
|
+
/**
|
|
46428
|
+
* Agent is archived (unarchive it first), or version does not match the agent's current version (retrieve it again and resend with that version), or a newer version saved with apply false is waiting (apply it or save over it).
|
|
46429
|
+
*/
|
|
46430
|
+
409: unknown;
|
|
46431
|
+
};
|
|
45913
46432
|
export type AgentsUpdateResponses = {
|
|
45914
46433
|
/**
|
|
45915
46434
|
* Successful response
|
|
@@ -45941,12 +46460,9 @@ export type AgentsUpdateResponses = {
|
|
|
45941
46460
|
*/
|
|
45942
46461
|
model: {
|
|
45943
46462
|
/**
|
|
45944
|
-
*
|
|
45945
|
-
*
|
|
45946
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
45947
|
-
* details and options.
|
|
46463
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
45948
46464
|
*/
|
|
45949
|
-
id:
|
|
46465
|
+
id: string;
|
|
45950
46466
|
/**
|
|
45951
46467
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
45952
46468
|
* Messages call the session makes.
|
|
@@ -45982,7 +46498,7 @@ export type AgentsUpdateResponses = {
|
|
|
45982
46498
|
*/
|
|
45983
46499
|
name: string;
|
|
45984
46500
|
/**
|
|
45985
|
-
*
|
|
46501
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
45986
46502
|
*/
|
|
45987
46503
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
45988
46504
|
/**
|
|
@@ -46041,38 +46557,21 @@ export type AgentsUpdateResponses = {
|
|
|
46041
46557
|
*/
|
|
46042
46558
|
note: string | null;
|
|
46043
46559
|
/**
|
|
46044
|
-
*
|
|
46560
|
+
* 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.
|
|
46045
46561
|
*/
|
|
46046
|
-
|
|
46562
|
+
bindings: Array<{
|
|
46047
46563
|
/**
|
|
46048
|
-
* Resource
|
|
46564
|
+
* Resource type. Decides the id format and the allowed access.
|
|
46049
46565
|
*/
|
|
46050
|
-
|
|
46566
|
+
type: 'database' | 'vector_store' | 'file' | 'media_library' | 'model' | 'workflow' | 'script';
|
|
46051
46567
|
/**
|
|
46052
|
-
*
|
|
46053
|
-
*/
|
|
46054
|
-
access: 'read_only' | 'read_write';
|
|
46055
|
-
/**
|
|
46056
|
-
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
46057
|
-
*/
|
|
46058
|
-
instructions?: string;
|
|
46059
|
-
/**
|
|
46060
|
-
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
46061
|
-
*/
|
|
46062
|
-
enabled?: boolean;
|
|
46063
|
-
}>;
|
|
46064
|
-
/**
|
|
46065
|
-
* Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
46066
|
-
*/
|
|
46067
|
-
vector_stores: Array<{
|
|
46068
|
-
/**
|
|
46069
|
-
* Resource id from knowledge.vectorStores.list or knowledge.vectorStores.create; use the returned id, not its name. Must start with vs_ and be unique within this binding array.
|
|
46568
|
+
* Resource id, never its name. database db_..., vector_store vs_..., file file- plus 24 letters or digits; media_library and model ids must not contain ':' or whitespace; workflow and script use <namespace>/<name> with no '/', '@', ':' or whitespace inside a part.
|
|
46070
46569
|
*/
|
|
46071
46570
|
id: string;
|
|
46072
46571
|
/**
|
|
46073
|
-
*
|
|
46572
|
+
* database, vector_store and media_library accept read_only or read_write; file accepts read_only; model, workflow and script accept invoke. Any other combination returns 400.
|
|
46074
46573
|
*/
|
|
46075
|
-
access: 'read_only' | 'read_write';
|
|
46574
|
+
access: 'read_only' | 'read_write' | 'invoke';
|
|
46076
46575
|
/**
|
|
46077
46576
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
46078
46577
|
*/
|
|
@@ -46081,25 +46580,13 @@ export type AgentsUpdateResponses = {
|
|
|
46081
46580
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
46082
46581
|
*/
|
|
46083
46582
|
enabled?: boolean;
|
|
46084
|
-
}
|
|
46085
|
-
/**
|
|
46086
|
-
* File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
46087
|
-
*/
|
|
46088
|
-
files: Array<{
|
|
46089
|
-
/**
|
|
46090
|
-
* Resource id from file.files.list or file.files.create (upload); use the returned id, not its name. Must start with file_ and be unique within this binding array.
|
|
46091
|
-
*/
|
|
46092
|
-
id: string;
|
|
46093
|
-
/**
|
|
46094
|
-
* read_only permits reading the bound file; files do not accept read_write.
|
|
46095
|
-
*/
|
|
46096
|
-
access: 'read_only';
|
|
46583
|
+
} | {
|
|
46097
46584
|
/**
|
|
46098
|
-
*
|
|
46585
|
+
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
46099
46586
|
*/
|
|
46100
|
-
|
|
46587
|
+
type: 'search' | 'browser';
|
|
46101
46588
|
/**
|
|
46102
|
-
* Whether
|
|
46589
|
+
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
46103
46590
|
*/
|
|
46104
46591
|
enabled?: boolean;
|
|
46105
46592
|
}>;
|
|
@@ -46441,7 +46928,7 @@ export type AgentsUpdateResponses = {
|
|
|
46441
46928
|
*/
|
|
46442
46929
|
commands?: Array<string>;
|
|
46443
46930
|
/**
|
|
46444
|
-
*
|
|
46931
|
+
* Names of disabled skills declarations.
|
|
46445
46932
|
*/
|
|
46446
46933
|
skills?: Array<string>;
|
|
46447
46934
|
/**
|
|
@@ -46463,6 +46950,26 @@ export type AgentsUpdateResponses = {
|
|
|
46463
46950
|
*/
|
|
46464
46951
|
allowed: Array<string>;
|
|
46465
46952
|
};
|
|
46953
|
+
/**
|
|
46954
|
+
* Avatar image URL of this agent version (absolute https), shown in agent lists, the agent detail, the chat header and as the default avatar of embedded chat; null when none is set. Follows the version like other configuration: a version saved with apply=false does not change the avatar in effect. /agent/v1 only.
|
|
46955
|
+
*/
|
|
46956
|
+
avatar: string | null;
|
|
46957
|
+
/**
|
|
46958
|
+
* Channel the agent was created through (for example api or console); null for historical agents whose channel is unknown. Display only. /agent/v1 only; /anthropic neither returns it.
|
|
46959
|
+
*/
|
|
46960
|
+
creation_source: string | null;
|
|
46961
|
+
/**
|
|
46962
|
+
* Platform-wide identity number of the agent (8 characters), usable wherever an agent is addressed by identity_number; null when the agent has none. /agent/v1 only; /anthropic neither returns it.
|
|
46963
|
+
*/
|
|
46964
|
+
identity_number: string | null;
|
|
46965
|
+
/**
|
|
46966
|
+
* Default environment of this service agent version: the environment_id new sessions get when they name none; null means no environment. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the environment in effect. Versions saved before this field existed read as light. /agent/v1 only.
|
|
46967
|
+
*/
|
|
46968
|
+
environment_id?: string | null;
|
|
46969
|
+
/**
|
|
46970
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
46971
|
+
*/
|
|
46972
|
+
vault_ids?: Array<string>;
|
|
46466
46973
|
/**
|
|
46467
46974
|
* Current agent lifecycle status; unarchive restores an archived agent to active.
|
|
46468
46975
|
*/
|
|
@@ -46481,6 +46988,20 @@ export type AgentsArchiveData = {
|
|
|
46481
46988
|
query?: never;
|
|
46482
46989
|
url: '/agent/v1/agents/{agent_id}/archive';
|
|
46483
46990
|
};
|
|
46991
|
+
export type AgentsArchiveErrors = {
|
|
46992
|
+
/**
|
|
46993
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
46994
|
+
*/
|
|
46995
|
+
401: unknown;
|
|
46996
|
+
/**
|
|
46997
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
46998
|
+
*/
|
|
46999
|
+
403: unknown;
|
|
47000
|
+
/**
|
|
47001
|
+
* Agent not found: the id does not exist in your organization. Take ids from agents.list or agents.create.
|
|
47002
|
+
*/
|
|
47003
|
+
404: unknown;
|
|
47004
|
+
};
|
|
46484
47005
|
export type AgentsArchiveResponses = {
|
|
46485
47006
|
/**
|
|
46486
47007
|
* Successful response
|
|
@@ -46512,12 +47033,9 @@ export type AgentsArchiveResponses = {
|
|
|
46512
47033
|
*/
|
|
46513
47034
|
model: {
|
|
46514
47035
|
/**
|
|
46515
|
-
*
|
|
46516
|
-
*
|
|
46517
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
46518
|
-
* details and options.
|
|
47036
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
46519
47037
|
*/
|
|
46520
|
-
id:
|
|
47038
|
+
id: string;
|
|
46521
47039
|
/**
|
|
46522
47040
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
46523
47041
|
* Messages call the session makes.
|
|
@@ -46553,7 +47071,7 @@ export type AgentsArchiveResponses = {
|
|
|
46553
47071
|
*/
|
|
46554
47072
|
name: string;
|
|
46555
47073
|
/**
|
|
46556
|
-
*
|
|
47074
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
46557
47075
|
*/
|
|
46558
47076
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
46559
47077
|
/**
|
|
@@ -46612,38 +47130,21 @@ export type AgentsArchiveResponses = {
|
|
|
46612
47130
|
*/
|
|
46613
47131
|
note: string | null;
|
|
46614
47132
|
/**
|
|
46615
|
-
*
|
|
47133
|
+
* 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.
|
|
46616
47134
|
*/
|
|
46617
|
-
|
|
46618
|
-
/**
|
|
46619
|
-
* Resource id from database.databases.list or database.databases.create; use the returned id, not its name. Must start with db_ and be unique within this binding array.
|
|
46620
|
-
*/
|
|
46621
|
-
id: string;
|
|
46622
|
-
/**
|
|
46623
|
-
* read_only permits reads of the bound resource; read_write permits reads and writes.
|
|
46624
|
-
*/
|
|
46625
|
-
access: 'read_only' | 'read_write';
|
|
47135
|
+
bindings: Array<{
|
|
46626
47136
|
/**
|
|
46627
|
-
*
|
|
47137
|
+
* Resource type. Decides the id format and the allowed access.
|
|
46628
47138
|
*/
|
|
46629
|
-
|
|
47139
|
+
type: 'database' | 'vector_store' | 'file' | 'media_library' | 'model' | 'workflow' | 'script';
|
|
46630
47140
|
/**
|
|
46631
|
-
*
|
|
46632
|
-
*/
|
|
46633
|
-
enabled?: boolean;
|
|
46634
|
-
}>;
|
|
46635
|
-
/**
|
|
46636
|
-
* Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
46637
|
-
*/
|
|
46638
|
-
vector_stores: Array<{
|
|
46639
|
-
/**
|
|
46640
|
-
* Resource id from knowledge.vectorStores.list or knowledge.vectorStores.create; use the returned id, not its name. Must start with vs_ and be unique within this binding array.
|
|
47141
|
+
* Resource id, never its name. database db_..., vector_store vs_..., file file- plus 24 letters or digits; media_library and model ids must not contain ':' or whitespace; workflow and script use <namespace>/<name> with no '/', '@', ':' or whitespace inside a part.
|
|
46641
47142
|
*/
|
|
46642
47143
|
id: string;
|
|
46643
47144
|
/**
|
|
46644
|
-
*
|
|
47145
|
+
* database, vector_store and media_library accept read_only or read_write; file accepts read_only; model, workflow and script accept invoke. Any other combination returns 400.
|
|
46645
47146
|
*/
|
|
46646
|
-
access: 'read_only' | 'read_write';
|
|
47147
|
+
access: 'read_only' | 'read_write' | 'invoke';
|
|
46647
47148
|
/**
|
|
46648
47149
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
46649
47150
|
*/
|
|
@@ -46652,25 +47153,13 @@ export type AgentsArchiveResponses = {
|
|
|
46652
47153
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
46653
47154
|
*/
|
|
46654
47155
|
enabled?: boolean;
|
|
46655
|
-
}
|
|
46656
|
-
/**
|
|
46657
|
-
* File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
46658
|
-
*/
|
|
46659
|
-
files: Array<{
|
|
46660
|
-
/**
|
|
46661
|
-
* Resource id from file.files.list or file.files.create (upload); use the returned id, not its name. Must start with file_ and be unique within this binding array.
|
|
46662
|
-
*/
|
|
46663
|
-
id: string;
|
|
46664
|
-
/**
|
|
46665
|
-
* read_only permits reading the bound file; files do not accept read_write.
|
|
46666
|
-
*/
|
|
46667
|
-
access: 'read_only';
|
|
47156
|
+
} | {
|
|
46668
47157
|
/**
|
|
46669
|
-
*
|
|
47158
|
+
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
46670
47159
|
*/
|
|
46671
|
-
|
|
47160
|
+
type: 'search' | 'browser';
|
|
46672
47161
|
/**
|
|
46673
|
-
* Whether
|
|
47162
|
+
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
46674
47163
|
*/
|
|
46675
47164
|
enabled?: boolean;
|
|
46676
47165
|
}>;
|
|
@@ -47012,7 +47501,7 @@ export type AgentsArchiveResponses = {
|
|
|
47012
47501
|
*/
|
|
47013
47502
|
commands?: Array<string>;
|
|
47014
47503
|
/**
|
|
47015
|
-
*
|
|
47504
|
+
* Names of disabled skills declarations.
|
|
47016
47505
|
*/
|
|
47017
47506
|
skills?: Array<string>;
|
|
47018
47507
|
/**
|
|
@@ -47034,6 +47523,26 @@ export type AgentsArchiveResponses = {
|
|
|
47034
47523
|
*/
|
|
47035
47524
|
allowed: Array<string>;
|
|
47036
47525
|
};
|
|
47526
|
+
/**
|
|
47527
|
+
* Avatar image URL of this agent version (absolute https), shown in agent lists, the agent detail, the chat header and as the default avatar of embedded chat; null when none is set. Follows the version like other configuration: a version saved with apply=false does not change the avatar in effect. /agent/v1 only.
|
|
47528
|
+
*/
|
|
47529
|
+
avatar: string | null;
|
|
47530
|
+
/**
|
|
47531
|
+
* Channel the agent was created through (for example api or console); null for historical agents whose channel is unknown. Display only. /agent/v1 only; /anthropic neither returns it.
|
|
47532
|
+
*/
|
|
47533
|
+
creation_source: string | null;
|
|
47534
|
+
/**
|
|
47535
|
+
* Platform-wide identity number of the agent (8 characters), usable wherever an agent is addressed by identity_number; null when the agent has none. /agent/v1 only; /anthropic neither returns it.
|
|
47536
|
+
*/
|
|
47537
|
+
identity_number: string | null;
|
|
47538
|
+
/**
|
|
47539
|
+
* Default environment of this service agent version: the environment_id new sessions get when they name none; null means no environment. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the environment in effect. Versions saved before this field existed read as light. /agent/v1 only.
|
|
47540
|
+
*/
|
|
47541
|
+
environment_id?: string | null;
|
|
47542
|
+
/**
|
|
47543
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
47544
|
+
*/
|
|
47545
|
+
vault_ids?: Array<string>;
|
|
47037
47546
|
/**
|
|
47038
47547
|
* Current agent lifecycle status; unarchive restores an archived agent to active.
|
|
47039
47548
|
*/
|
|
@@ -47058,6 +47567,24 @@ export type AgentsVersionsListData = {
|
|
|
47058
47567
|
};
|
|
47059
47568
|
url: '/agent/v1/agents/{agent_id}/versions';
|
|
47060
47569
|
};
|
|
47570
|
+
export type AgentsVersionsListErrors = {
|
|
47571
|
+
/**
|
|
47572
|
+
* limit is not an integer from 1 to 100, or page is not a cursor from this same query. Pass next_page unchanged, with the same filters, to continue.
|
|
47573
|
+
*/
|
|
47574
|
+
400: unknown;
|
|
47575
|
+
/**
|
|
47576
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
47577
|
+
*/
|
|
47578
|
+
401: unknown;
|
|
47579
|
+
/**
|
|
47580
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
47581
|
+
*/
|
|
47582
|
+
403: unknown;
|
|
47583
|
+
/**
|
|
47584
|
+
* Agent not found: the id does not exist in your organization. Take ids from agents.list or agents.create.
|
|
47585
|
+
*/
|
|
47586
|
+
404: unknown;
|
|
47587
|
+
};
|
|
47061
47588
|
export type AgentsVersionsListResponses = {
|
|
47062
47589
|
/**
|
|
47063
47590
|
* Successful response
|
|
@@ -47093,12 +47620,9 @@ export type AgentsVersionsListResponses = {
|
|
|
47093
47620
|
*/
|
|
47094
47621
|
model: {
|
|
47095
47622
|
/**
|
|
47096
|
-
*
|
|
47097
|
-
*
|
|
47098
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
47099
|
-
* details and options.
|
|
47623
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
47100
47624
|
*/
|
|
47101
|
-
id:
|
|
47625
|
+
id: string;
|
|
47102
47626
|
/**
|
|
47103
47627
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
47104
47628
|
* Messages call the session makes.
|
|
@@ -47134,7 +47658,7 @@ export type AgentsVersionsListResponses = {
|
|
|
47134
47658
|
*/
|
|
47135
47659
|
name: string;
|
|
47136
47660
|
/**
|
|
47137
|
-
*
|
|
47661
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
47138
47662
|
*/
|
|
47139
47663
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
47140
47664
|
/**
|
|
@@ -47193,38 +47717,21 @@ export type AgentsVersionsListResponses = {
|
|
|
47193
47717
|
*/
|
|
47194
47718
|
note: string | null;
|
|
47195
47719
|
/**
|
|
47196
|
-
*
|
|
47720
|
+
* 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.
|
|
47197
47721
|
*/
|
|
47198
|
-
|
|
47722
|
+
bindings: Array<{
|
|
47199
47723
|
/**
|
|
47200
|
-
* Resource
|
|
47724
|
+
* Resource type. Decides the id format and the allowed access.
|
|
47201
47725
|
*/
|
|
47202
|
-
|
|
47203
|
-
/**
|
|
47204
|
-
* read_only permits reads of the bound resource; read_write permits reads and writes.
|
|
47205
|
-
*/
|
|
47206
|
-
access: 'read_only' | 'read_write';
|
|
47726
|
+
type: 'database' | 'vector_store' | 'file' | 'media_library' | 'model' | 'workflow' | 'script';
|
|
47207
47727
|
/**
|
|
47208
|
-
*
|
|
47209
|
-
*/
|
|
47210
|
-
instructions?: string;
|
|
47211
|
-
/**
|
|
47212
|
-
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
47213
|
-
*/
|
|
47214
|
-
enabled?: boolean;
|
|
47215
|
-
}>;
|
|
47216
|
-
/**
|
|
47217
|
-
* Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
47218
|
-
*/
|
|
47219
|
-
vector_stores: Array<{
|
|
47220
|
-
/**
|
|
47221
|
-
* Resource id from knowledge.vectorStores.list or knowledge.vectorStores.create; use the returned id, not its name. Must start with vs_ and be unique within this binding array.
|
|
47728
|
+
* Resource id, never its name. database db_..., vector_store vs_..., file file- plus 24 letters or digits; media_library and model ids must not contain ':' or whitespace; workflow and script use <namespace>/<name> with no '/', '@', ':' or whitespace inside a part.
|
|
47222
47729
|
*/
|
|
47223
47730
|
id: string;
|
|
47224
47731
|
/**
|
|
47225
|
-
*
|
|
47732
|
+
* database, vector_store and media_library accept read_only or read_write; file accepts read_only; model, workflow and script accept invoke. Any other combination returns 400.
|
|
47226
47733
|
*/
|
|
47227
|
-
access: 'read_only' | 'read_write';
|
|
47734
|
+
access: 'read_only' | 'read_write' | 'invoke';
|
|
47228
47735
|
/**
|
|
47229
47736
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
47230
47737
|
*/
|
|
@@ -47233,25 +47740,13 @@ export type AgentsVersionsListResponses = {
|
|
|
47233
47740
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
47234
47741
|
*/
|
|
47235
47742
|
enabled?: boolean;
|
|
47236
|
-
}
|
|
47237
|
-
/**
|
|
47238
|
-
* File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.
|
|
47239
|
-
*/
|
|
47240
|
-
files: Array<{
|
|
47241
|
-
/**
|
|
47242
|
-
* Resource id from file.files.list or file.files.create (upload); use the returned id, not its name. Must start with file_ and be unique within this binding array.
|
|
47243
|
-
*/
|
|
47244
|
-
id: string;
|
|
47245
|
-
/**
|
|
47246
|
-
* read_only permits reading the bound file; files do not accept read_write.
|
|
47247
|
-
*/
|
|
47248
|
-
access: 'read_only';
|
|
47743
|
+
} | {
|
|
47249
47744
|
/**
|
|
47250
|
-
*
|
|
47745
|
+
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
47251
47746
|
*/
|
|
47252
|
-
|
|
47747
|
+
type: 'search' | 'browser';
|
|
47253
47748
|
/**
|
|
47254
|
-
* Whether
|
|
47749
|
+
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
47255
47750
|
*/
|
|
47256
47751
|
enabled?: boolean;
|
|
47257
47752
|
}>;
|
|
@@ -47593,7 +48088,7 @@ export type AgentsVersionsListResponses = {
|
|
|
47593
48088
|
*/
|
|
47594
48089
|
commands?: Array<string>;
|
|
47595
48090
|
/**
|
|
47596
|
-
*
|
|
48091
|
+
* Names of disabled skills declarations.
|
|
47597
48092
|
*/
|
|
47598
48093
|
skills?: Array<string>;
|
|
47599
48094
|
/**
|
|
@@ -47615,6 +48110,26 @@ export type AgentsVersionsListResponses = {
|
|
|
47615
48110
|
*/
|
|
47616
48111
|
allowed: Array<string>;
|
|
47617
48112
|
};
|
|
48113
|
+
/**
|
|
48114
|
+
* Avatar image URL of this agent version (absolute https), shown in agent lists, the agent detail, the chat header and as the default avatar of embedded chat; null when none is set. Follows the version like other configuration: a version saved with apply=false does not change the avatar in effect. /agent/v1 only.
|
|
48115
|
+
*/
|
|
48116
|
+
avatar: string | null;
|
|
48117
|
+
/**
|
|
48118
|
+
* Channel the agent was created through (for example api or console); null for historical agents whose channel is unknown. Display only. /agent/v1 only; /anthropic neither returns it.
|
|
48119
|
+
*/
|
|
48120
|
+
creation_source: string | null;
|
|
48121
|
+
/**
|
|
48122
|
+
* Platform-wide identity number of the agent (8 characters), usable wherever an agent is addressed by identity_number; null when the agent has none. /agent/v1 only; /anthropic neither returns it.
|
|
48123
|
+
*/
|
|
48124
|
+
identity_number: string | null;
|
|
48125
|
+
/**
|
|
48126
|
+
* Default environment of this service agent version: the environment_id new sessions get when they name none; null means no environment. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the environment in effect. Versions saved before this field existed read as light. /agent/v1 only.
|
|
48127
|
+
*/
|
|
48128
|
+
environment_id?: string | null;
|
|
48129
|
+
/**
|
|
48130
|
+
* Default vaults of this service agent version: the vault_ids new sessions get when they name none. Present for service agents only. Follows the version like other configuration: a version saved with apply=false does not change the vaults in effect. Versions saved before this field existed read as []. /agent/v1 only.
|
|
48131
|
+
*/
|
|
48132
|
+
vault_ids?: Array<string>;
|
|
47618
48133
|
/**
|
|
47619
48134
|
* Current agent lifecycle status; unarchive restores an archived agent to active.
|
|
47620
48135
|
*/
|
|
@@ -47695,6 +48210,20 @@ export type SessionsListData = {
|
|
|
47695
48210
|
};
|
|
47696
48211
|
url: '/agent/v1/sessions';
|
|
47697
48212
|
};
|
|
48213
|
+
export type SessionsListErrors = {
|
|
48214
|
+
/**
|
|
48215
|
+
* An unsupported or repeated query parameter, include_archived that is not true or false, an external_user_id or source value outside its range, an agent_id or deployment_id of the wrong form, or limit is not an integer from 1 to 100, or page is not a cursor from this same query. Pass next_page unchanged, with the same filters, to continue.
|
|
48216
|
+
*/
|
|
48217
|
+
400: unknown;
|
|
48218
|
+
/**
|
|
48219
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
48220
|
+
*/
|
|
48221
|
+
401: unknown;
|
|
48222
|
+
/**
|
|
48223
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
48224
|
+
*/
|
|
48225
|
+
403: unknown;
|
|
48226
|
+
};
|
|
47698
48227
|
export type SessionsListResponses = {
|
|
47699
48228
|
/**
|
|
47700
48229
|
* Successful response
|
|
@@ -47730,12 +48259,9 @@ export type SessionsListResponses = {
|
|
|
47730
48259
|
*/
|
|
47731
48260
|
model: {
|
|
47732
48261
|
/**
|
|
47733
|
-
*
|
|
47734
|
-
*
|
|
47735
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
47736
|
-
* details and options.
|
|
48262
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
47737
48263
|
*/
|
|
47738
|
-
id:
|
|
48264
|
+
id: string;
|
|
47739
48265
|
/**
|
|
47740
48266
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
47741
48267
|
* Messages call the session makes.
|
|
@@ -47772,7 +48298,7 @@ export type SessionsListResponses = {
|
|
|
47772
48298
|
*/
|
|
47773
48299
|
name: string;
|
|
47774
48300
|
/**
|
|
47775
|
-
*
|
|
48301
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
47776
48302
|
*/
|
|
47777
48303
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
47778
48304
|
/**
|
|
@@ -47806,7 +48332,7 @@ export type SessionsListResponses = {
|
|
|
47806
48332
|
*/
|
|
47807
48333
|
created_at: string;
|
|
47808
48334
|
/**
|
|
47809
|
-
* Execution environment
|
|
48335
|
+
* Execution environment of this session. A service session created without environment_id uses the default environment saved in the agent version (light for a new agent); null means it was created without a machine; Computer sessions may omit this field.
|
|
47810
48336
|
*/
|
|
47811
48337
|
environment_id?: string;
|
|
47812
48338
|
metadata: AgentManaged173;
|
|
@@ -47934,13 +48460,11 @@ export type SessionsListResponse = SessionsListResponses[keyof SessionsListRespo
|
|
|
47934
48460
|
export type SessionsCreateData = {
|
|
47935
48461
|
body: {
|
|
47936
48462
|
/**
|
|
47937
|
-
*
|
|
47938
|
-
* latest version for the session, or an `agent` object with both id and version
|
|
47939
|
-
* specified.
|
|
48463
|
+
* The agent to run: an agent id string, or {type: "agent", id, version?}. An id alone, or an object without version, pins the agent's active_version at the moment the session is created (the version chosen with agents.versions.apply, not necessarily the newest saved one); version pins that exact version. Unlike Managed Agents, the only inline override is a system prompt ({type: "agent_with_overrides", id, system}); to change the model, tools, MCP servers or skills, save a version instead.
|
|
47940
48464
|
*/
|
|
47941
48465
|
agent: string | AgentManaged10 | AgentManaged167;
|
|
47942
48466
|
/**
|
|
47943
|
-
* Execution environment id from agent.environments.list or agent.environments.create. For a service agent, omission
|
|
48467
|
+
* Execution environment id from agent.environments.list or agent.environments.create. For a service agent, omission uses the default environment saved in the agent version (light for a new agent) and returns it as session.environment_id; explicit null allocates no machine and makes machine tools, including codemode and bash, unavailable. Personal agents use their selected Computer.
|
|
47944
48468
|
*/
|
|
47945
48469
|
environment_id?: string | null;
|
|
47946
48470
|
/**
|
|
@@ -48007,6 +48531,32 @@ export type SessionsCreateData = {
|
|
|
48007
48531
|
query?: never;
|
|
48008
48532
|
url: '/agent/v1/sessions';
|
|
48009
48533
|
};
|
|
48534
|
+
export type SessionsCreateErrors = {
|
|
48535
|
+
/**
|
|
48536
|
+
* The body failed validation and the message names the field: an unknown field, environment_id together with computer_id, a model or thinking selection the agent does not allow, an invalid budget or vault_ids, invalid initial_events, or an agent reference with an unsupported override.
|
|
48537
|
+
*/
|
|
48538
|
+
400: unknown;
|
|
48539
|
+
/**
|
|
48540
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
48541
|
+
*/
|
|
48542
|
+
401: unknown;
|
|
48543
|
+
/**
|
|
48544
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
48545
|
+
*/
|
|
48546
|
+
403: unknown;
|
|
48547
|
+
/**
|
|
48548
|
+
* Agent not found, or the pinned agent version does not exist. Take agent ids from agents.list and versions from agents.versions.list.
|
|
48549
|
+
*/
|
|
48550
|
+
404: unknown;
|
|
48551
|
+
/**
|
|
48552
|
+
* Agent is archived; unarchive it to start new sessions. Existing sessions keep working.
|
|
48553
|
+
*/
|
|
48554
|
+
409: unknown;
|
|
48555
|
+
/**
|
|
48556
|
+
* The session could not be established (machine, vault or resource synchronization failed). Nothing usable was created; retry.
|
|
48557
|
+
*/
|
|
48558
|
+
502: unknown;
|
|
48559
|
+
};
|
|
48010
48560
|
export type SessionsCreateResponses = {
|
|
48011
48561
|
/**
|
|
48012
48562
|
* Successful response
|
|
@@ -48038,12 +48588,9 @@ export type SessionsCreateResponses = {
|
|
|
48038
48588
|
*/
|
|
48039
48589
|
model: {
|
|
48040
48590
|
/**
|
|
48041
|
-
*
|
|
48042
|
-
*
|
|
48043
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
48044
|
-
* details and options.
|
|
48591
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
48045
48592
|
*/
|
|
48046
|
-
id:
|
|
48593
|
+
id: string;
|
|
48047
48594
|
/**
|
|
48048
48595
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
48049
48596
|
* Messages call the session makes.
|
|
@@ -48080,7 +48627,7 @@ export type SessionsCreateResponses = {
|
|
|
48080
48627
|
*/
|
|
48081
48628
|
name: string;
|
|
48082
48629
|
/**
|
|
48083
|
-
*
|
|
48630
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
48084
48631
|
*/
|
|
48085
48632
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
48086
48633
|
/**
|
|
@@ -48114,7 +48661,7 @@ export type SessionsCreateResponses = {
|
|
|
48114
48661
|
*/
|
|
48115
48662
|
created_at: string;
|
|
48116
48663
|
/**
|
|
48117
|
-
* Execution environment
|
|
48664
|
+
* Execution environment of this session. A service session created without environment_id uses the default environment saved in the agent version (light for a new agent); null means it was created without a machine; Computer sessions may omit this field.
|
|
48118
48665
|
*/
|
|
48119
48666
|
environment_id?: string;
|
|
48120
48667
|
metadata: AgentManaged173;
|
|
@@ -48245,6 +48792,20 @@ export type SessionsArchiveData = {
|
|
|
48245
48792
|
query?: never;
|
|
48246
48793
|
url: '/agent/v1/sessions/{session_id}/archive';
|
|
48247
48794
|
};
|
|
48795
|
+
export type SessionsArchiveErrors = {
|
|
48796
|
+
/**
|
|
48797
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
48798
|
+
*/
|
|
48799
|
+
401: unknown;
|
|
48800
|
+
/**
|
|
48801
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
48802
|
+
*/
|
|
48803
|
+
403: unknown;
|
|
48804
|
+
/**
|
|
48805
|
+
* Session not found: the id does not exist in your organization. Take ids from sessions.list or sessions.create.
|
|
48806
|
+
*/
|
|
48807
|
+
404: unknown;
|
|
48808
|
+
};
|
|
48248
48809
|
export type SessionsArchiveResponses = {
|
|
48249
48810
|
/**
|
|
48250
48811
|
* Successful response
|
|
@@ -48276,12 +48837,9 @@ export type SessionsArchiveResponses = {
|
|
|
48276
48837
|
*/
|
|
48277
48838
|
model: {
|
|
48278
48839
|
/**
|
|
48279
|
-
*
|
|
48280
|
-
*
|
|
48281
|
-
* See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
|
|
48282
|
-
* details and options.
|
|
48840
|
+
* A model id from the Praxis model catalog (`praxis.model.models.list`). Unlike Anthropic, Claude model ids other than those in the catalog are rejected.
|
|
48283
48841
|
*/
|
|
48284
|
-
id:
|
|
48842
|
+
id: string;
|
|
48285
48843
|
/**
|
|
48286
48844
|
* How hard Claude works on each turn. Sets `output_config.effort` on every
|
|
48287
48845
|
* Messages call the session makes.
|
|
@@ -48318,7 +48876,7 @@ export type SessionsArchiveResponses = {
|
|
|
48318
48876
|
*/
|
|
48319
48877
|
name: string;
|
|
48320
48878
|
/**
|
|
48321
|
-
*
|
|
48879
|
+
* Custom skills attached to the agent, each {type: "custom", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send "latest", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.
|
|
48322
48880
|
*/
|
|
48323
48881
|
skills: Array<AgentManaged42 | AgentManaged43>;
|
|
48324
48882
|
/**
|
|
@@ -48352,7 +48910,7 @@ export type SessionsArchiveResponses = {
|
|
|
48352
48910
|
*/
|
|
48353
48911
|
created_at: string;
|
|
48354
48912
|
/**
|
|
48355
|
-
* Execution environment
|
|
48913
|
+
* Execution environment of this session. A service session created without environment_id uses the default environment saved in the agent version (light for a new agent); null means it was created without a machine; Computer sessions may omit this field.
|
|
48356
48914
|
*/
|
|
48357
48915
|
environment_id?: string;
|
|
48358
48916
|
metadata: AgentManaged173;
|
|
@@ -48520,6 +49078,24 @@ export type SessionsEventsListData = {
|
|
|
48520
49078
|
};
|
|
48521
49079
|
url: '/agent/v1/sessions/{session_id}/events';
|
|
48522
49080
|
};
|
|
49081
|
+
export type SessionsEventsListErrors = {
|
|
49082
|
+
/**
|
|
49083
|
+
* order is not asc or desc, types contains an unsupported event type, or limit is not an integer from 1 to 100, or page is not a cursor from this same query. Pass next_page unchanged, with the same filters, to continue.
|
|
49084
|
+
*/
|
|
49085
|
+
400: unknown;
|
|
49086
|
+
/**
|
|
49087
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
49088
|
+
*/
|
|
49089
|
+
401: unknown;
|
|
49090
|
+
/**
|
|
49091
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
49092
|
+
*/
|
|
49093
|
+
403: unknown;
|
|
49094
|
+
/**
|
|
49095
|
+
* Session not found: the id does not exist in your organization. Take ids from sessions.list or sessions.create.
|
|
49096
|
+
*/
|
|
49097
|
+
404: unknown;
|
|
49098
|
+
};
|
|
48523
49099
|
export type SessionsEventsListResponses = {
|
|
48524
49100
|
/**
|
|
48525
49101
|
* Successful response
|
|
@@ -49277,6 +49853,28 @@ export type SessionsEventsSendData = {
|
|
|
49277
49853
|
query?: never;
|
|
49278
49854
|
url: '/agent/v1/sessions/{session_id}/events';
|
|
49279
49855
|
};
|
|
49856
|
+
export type SessionsEventsSendErrors = {
|
|
49857
|
+
/**
|
|
49858
|
+
* The event failed validation and the message names the problem: an unsupported event type or content block, more than one text block, a missing tool_use_id or custom_tool_use_id, an unknown call id, or a session that is archived.
|
|
49859
|
+
*/
|
|
49860
|
+
400: unknown;
|
|
49861
|
+
/**
|
|
49862
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
49863
|
+
*/
|
|
49864
|
+
401: unknown;
|
|
49865
|
+
/**
|
|
49866
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
49867
|
+
*/
|
|
49868
|
+
403: unknown;
|
|
49869
|
+
/**
|
|
49870
|
+
* Session not found: the id does not exist in your organization. Take ids from sessions.list or sessions.create. A user.steer or user.withdraw that names a missing event also returns 404.
|
|
49871
|
+
*/
|
|
49872
|
+
404: unknown;
|
|
49873
|
+
/**
|
|
49874
|
+
* A duplicate result, a call that is no longer waiting, or a user.steer on an input that is already processing or withdrawn. Read the events to see the current state before retrying.
|
|
49875
|
+
*/
|
|
49876
|
+
409: unknown;
|
|
49877
|
+
};
|
|
49280
49878
|
export type SessionsEventsSendResponses = {
|
|
49281
49879
|
/**
|
|
49282
49880
|
* Successful response
|
|
@@ -49408,6 +50006,24 @@ export type SessionsEventsStreamData = {
|
|
|
49408
50006
|
};
|
|
49409
50007
|
url: '/agent/v1/sessions/{session_id}/events/stream';
|
|
49410
50008
|
};
|
|
50009
|
+
export type SessionsEventsStreamErrors = {
|
|
50010
|
+
/**
|
|
50011
|
+
* event_deltas contains a value other than the supported event types.
|
|
50012
|
+
*/
|
|
50013
|
+
400: unknown;
|
|
50014
|
+
/**
|
|
50015
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
50016
|
+
*/
|
|
50017
|
+
401: unknown;
|
|
50018
|
+
/**
|
|
50019
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
50020
|
+
*/
|
|
50021
|
+
403: unknown;
|
|
50022
|
+
/**
|
|
50023
|
+
* Session not found: the id does not exist in your organization. Take ids from sessions.list or sessions.create.
|
|
50024
|
+
*/
|
|
50025
|
+
404: unknown;
|
|
50026
|
+
};
|
|
49411
50027
|
export type SessionsEventsStreamResponses = {
|
|
49412
50028
|
/**
|
|
49413
50029
|
* Server-sent events
|
|
@@ -49432,6 +50048,24 @@ export type SessionsThreadsListData = {
|
|
|
49432
50048
|
};
|
|
49433
50049
|
url: '/agent/v1/sessions/{session_id}/threads';
|
|
49434
50050
|
};
|
|
50051
|
+
export type SessionsThreadsListErrors = {
|
|
50052
|
+
/**
|
|
50053
|
+
* limit is not an integer from 1 to 100, or page is not a cursor from this same query. Pass next_page unchanged, with the same filters, to continue.
|
|
50054
|
+
*/
|
|
50055
|
+
400: unknown;
|
|
50056
|
+
/**
|
|
50057
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
50058
|
+
*/
|
|
50059
|
+
401: unknown;
|
|
50060
|
+
/**
|
|
50061
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
50062
|
+
*/
|
|
50063
|
+
403: unknown;
|
|
50064
|
+
/**
|
|
50065
|
+
* Session not found: the id does not exist in your organization. Take ids from sessions.list or sessions.create.
|
|
50066
|
+
*/
|
|
50067
|
+
404: unknown;
|
|
50068
|
+
};
|
|
49435
50069
|
export type SessionsThreadsListResponses = {
|
|
49436
50070
|
/**
|
|
49437
50071
|
* Successful response
|
|
@@ -49468,6 +50102,20 @@ export type SessionsThreadsRetrieveData = {
|
|
|
49468
50102
|
};
|
|
49469
50103
|
url: '/agent/v1/sessions/{session_id}/threads/{thread_id}';
|
|
49470
50104
|
};
|
|
50105
|
+
export type SessionsThreadsRetrieveErrors = {
|
|
50106
|
+
/**
|
|
50107
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
50108
|
+
*/
|
|
50109
|
+
401: unknown;
|
|
50110
|
+
/**
|
|
50111
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
50112
|
+
*/
|
|
50113
|
+
403: unknown;
|
|
50114
|
+
/**
|
|
50115
|
+
* Session or thread not found. A malformed id and another session's thread answer the same way. Take thread ids from sessions.threads.list.
|
|
50116
|
+
*/
|
|
50117
|
+
404: unknown;
|
|
50118
|
+
};
|
|
49471
50119
|
export type SessionsThreadsRetrieveResponses = {
|
|
49472
50120
|
/**
|
|
49473
50121
|
* Successful response
|
|
@@ -49495,6 +50143,20 @@ export type SessionsThreadsArchiveData = {
|
|
|
49495
50143
|
};
|
|
49496
50144
|
url: '/agent/v1/sessions/{session_id}/threads/{thread_id}/archive';
|
|
49497
50145
|
};
|
|
50146
|
+
export type SessionsThreadsArchiveErrors = {
|
|
50147
|
+
/**
|
|
50148
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
50149
|
+
*/
|
|
50150
|
+
401: unknown;
|
|
50151
|
+
/**
|
|
50152
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
50153
|
+
*/
|
|
50154
|
+
403: unknown;
|
|
50155
|
+
/**
|
|
50156
|
+
* Session or thread not found. A malformed id and another session's thread answer the same way. Take thread ids from sessions.threads.list.
|
|
50157
|
+
*/
|
|
50158
|
+
404: unknown;
|
|
50159
|
+
};
|
|
49498
50160
|
export type SessionsThreadsArchiveResponses = {
|
|
49499
50161
|
/**
|
|
49500
50162
|
* Successful response
|
|
@@ -49527,6 +50189,24 @@ export type SessionsThreadsEventsListData = {
|
|
|
49527
50189
|
};
|
|
49528
50190
|
url: '/agent/v1/sessions/{session_id}/threads/{thread_id}/events';
|
|
49529
50191
|
};
|
|
50192
|
+
export type SessionsThreadsEventsListErrors = {
|
|
50193
|
+
/**
|
|
50194
|
+
* order is not asc or desc, types contains an unsupported event type, or limit is not an integer from 1 to 100, or page is not a cursor from this same query. Pass next_page unchanged, with the same filters, to continue.
|
|
50195
|
+
*/
|
|
50196
|
+
400: unknown;
|
|
50197
|
+
/**
|
|
50198
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
50199
|
+
*/
|
|
50200
|
+
401: unknown;
|
|
50201
|
+
/**
|
|
50202
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
50203
|
+
*/
|
|
50204
|
+
403: unknown;
|
|
50205
|
+
/**
|
|
50206
|
+
* Session or thread not found. A malformed id and another session's thread answer the same way. Take thread ids from sessions.threads.list.
|
|
50207
|
+
*/
|
|
50208
|
+
404: unknown;
|
|
50209
|
+
};
|
|
49530
50210
|
export type SessionsThreadsEventsListResponses = {
|
|
49531
50211
|
/**
|
|
49532
50212
|
* Successful response
|
|
@@ -50189,6 +50869,24 @@ export type SessionsThreadsEventsStreamData = {
|
|
|
50189
50869
|
};
|
|
50190
50870
|
url: '/agent/v1/sessions/{session_id}/threads/{thread_id}/stream';
|
|
50191
50871
|
};
|
|
50872
|
+
export type SessionsThreadsEventsStreamErrors = {
|
|
50873
|
+
/**
|
|
50874
|
+
* event_deltas contains a value other than the supported event types.
|
|
50875
|
+
*/
|
|
50876
|
+
400: unknown;
|
|
50877
|
+
/**
|
|
50878
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
50879
|
+
*/
|
|
50880
|
+
401: unknown;
|
|
50881
|
+
/**
|
|
50882
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
50883
|
+
*/
|
|
50884
|
+
403: unknown;
|
|
50885
|
+
/**
|
|
50886
|
+
* Session or thread not found. A malformed id and another session's thread answer the same way. Take thread ids from sessions.threads.list.
|
|
50887
|
+
*/
|
|
50888
|
+
404: unknown;
|
|
50889
|
+
};
|
|
50192
50890
|
export type SessionsThreadsEventsStreamResponses = {
|
|
50193
50891
|
/**
|
|
50194
50892
|
* Server-sent events
|
|
@@ -50207,6 +50905,20 @@ export type EnvironmentsRetrieveData = {
|
|
|
50207
50905
|
query?: never;
|
|
50208
50906
|
url: '/agent/v1/environments/{environment_id}';
|
|
50209
50907
|
};
|
|
50908
|
+
export type EnvironmentsRetrieveErrors = {
|
|
50909
|
+
/**
|
|
50910
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
50911
|
+
*/
|
|
50912
|
+
401: unknown;
|
|
50913
|
+
/**
|
|
50914
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
50915
|
+
*/
|
|
50916
|
+
403: unknown;
|
|
50917
|
+
/**
|
|
50918
|
+
* Environment not found. Take ids from environments.list or environments.create.
|
|
50919
|
+
*/
|
|
50920
|
+
404: unknown;
|
|
50921
|
+
};
|
|
50210
50922
|
export type EnvironmentsRetrieveResponses = {
|
|
50211
50923
|
/**
|
|
50212
50924
|
* Successful response
|
|
@@ -50234,12 +50946,6 @@ export type EnvironmentsUpdateData = {
|
|
|
50234
50946
|
* Updated name for the environment
|
|
50235
50947
|
*/
|
|
50236
50948
|
name?: null | string;
|
|
50237
|
-
/**
|
|
50238
|
-
* The visibility scope for this environment. 'organization' makes the
|
|
50239
|
-
* environment visible to all accounts. 'account' restricts visibility to the
|
|
50240
|
-
* owning account only.
|
|
50241
|
-
*/
|
|
50242
|
-
scope?: null | 'organization' | 'account';
|
|
50243
50949
|
};
|
|
50244
50950
|
path: {
|
|
50245
50951
|
/**
|
|
@@ -50250,6 +50956,28 @@ export type EnvironmentsUpdateData = {
|
|
|
50250
50956
|
query?: never;
|
|
50251
50957
|
url: '/agent/v1/environments/{environment_id}';
|
|
50252
50958
|
};
|
|
50959
|
+
export type EnvironmentsUpdateErrors = {
|
|
50960
|
+
/**
|
|
50961
|
+
* The body failed validation and the message names the field (same rules as environments.create).
|
|
50962
|
+
*/
|
|
50963
|
+
400: unknown;
|
|
50964
|
+
/**
|
|
50965
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
50966
|
+
*/
|
|
50967
|
+
401: unknown;
|
|
50968
|
+
/**
|
|
50969
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
50970
|
+
*/
|
|
50971
|
+
403: unknown;
|
|
50972
|
+
/**
|
|
50973
|
+
* Environment not found. Take ids from environments.list or environments.create.
|
|
50974
|
+
*/
|
|
50975
|
+
404: unknown;
|
|
50976
|
+
/**
|
|
50977
|
+
* The environment is built in (read-only), is archived, or changed since you read it (retrieve it again and retry).
|
|
50978
|
+
*/
|
|
50979
|
+
409: unknown;
|
|
50980
|
+
};
|
|
50253
50981
|
export type EnvironmentsUpdateResponses = {
|
|
50254
50982
|
/**
|
|
50255
50983
|
* Successful response
|
|
@@ -50268,6 +50996,24 @@ export type EnvironmentsArchiveData = {
|
|
|
50268
50996
|
query?: never;
|
|
50269
50997
|
url: '/agent/v1/environments/{environment_id}/archive';
|
|
50270
50998
|
};
|
|
50999
|
+
export type EnvironmentsArchiveErrors = {
|
|
51000
|
+
/**
|
|
51001
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
51002
|
+
*/
|
|
51003
|
+
401: unknown;
|
|
51004
|
+
/**
|
|
51005
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
51006
|
+
*/
|
|
51007
|
+
403: unknown;
|
|
51008
|
+
/**
|
|
51009
|
+
* Environment not found. Take ids from environments.list or environments.create.
|
|
51010
|
+
*/
|
|
51011
|
+
404: unknown;
|
|
51012
|
+
/**
|
|
51013
|
+
* The environment is built in (read-only), or RESOURCE_IN_USE: the active version of a non-archived agent uses it as environment_id; the message names the agents. Point them at another environment first.
|
|
51014
|
+
*/
|
|
51015
|
+
409: unknown;
|
|
51016
|
+
};
|
|
50271
51017
|
export type EnvironmentsArchiveResponses = {
|
|
50272
51018
|
/**
|
|
50273
51019
|
* Successful response
|
|
@@ -50291,6 +51037,20 @@ export type EnvironmentsListData = {
|
|
|
50291
51037
|
};
|
|
50292
51038
|
url: '/agent/v1/environments';
|
|
50293
51039
|
};
|
|
51040
|
+
export type EnvironmentsListErrors = {
|
|
51041
|
+
/**
|
|
51042
|
+
* include_archived is not true or false, or limit or page is invalid.
|
|
51043
|
+
*/
|
|
51044
|
+
400: unknown;
|
|
51045
|
+
/**
|
|
51046
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
51047
|
+
*/
|
|
51048
|
+
401: unknown;
|
|
51049
|
+
/**
|
|
51050
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
51051
|
+
*/
|
|
51052
|
+
403: unknown;
|
|
51053
|
+
};
|
|
50294
51054
|
export type EnvironmentsListResponses = {
|
|
50295
51055
|
/**
|
|
50296
51056
|
* Successful response
|
|
@@ -50325,18 +51085,25 @@ export type EnvironmentsCreateData = {
|
|
|
50325
51085
|
* User-provided metadata key-value pairs
|
|
50326
51086
|
*/
|
|
50327
51087
|
metadata?: AgentManaged137Writable;
|
|
50328
|
-
/**
|
|
50329
|
-
* The visibility scope for this environment. 'organization' makes the
|
|
50330
|
-
* environment visible to all accounts. 'account' restricts visibility to the
|
|
50331
|
-
* owning account only. API organizations support only 'organization'; 'account' is
|
|
50332
|
-
* rejected. If not specified, defaults based on organization type.
|
|
50333
|
-
*/
|
|
50334
|
-
scope?: null | 'organization' | 'account';
|
|
50335
51088
|
};
|
|
50336
51089
|
path?: never;
|
|
50337
51090
|
query?: never;
|
|
50338
51091
|
url: '/agent/v1/environments';
|
|
50339
51092
|
};
|
|
51093
|
+
export type EnvironmentsCreateErrors = {
|
|
51094
|
+
/**
|
|
51095
|
+
* The body failed validation and the message names the field: an unknown field (including scope), a self_hosted config, a config.template that is not available (the message lists the available ones), or invalid packages or networking.
|
|
51096
|
+
*/
|
|
51097
|
+
400: unknown;
|
|
51098
|
+
/**
|
|
51099
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
51100
|
+
*/
|
|
51101
|
+
401: unknown;
|
|
51102
|
+
/**
|
|
51103
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
51104
|
+
*/
|
|
51105
|
+
403: unknown;
|
|
51106
|
+
};
|
|
50340
51107
|
export type EnvironmentsCreateResponses = {
|
|
50341
51108
|
/**
|
|
50342
51109
|
* Successful response
|
|
@@ -50361,6 +51128,24 @@ export type SessionsResourcesListData = {
|
|
|
50361
51128
|
};
|
|
50362
51129
|
url: '/agent/v1/sessions/{session_id}/resources';
|
|
50363
51130
|
};
|
|
51131
|
+
export type SessionsResourcesListErrors = {
|
|
51132
|
+
/**
|
|
51133
|
+
* limit is not an integer from 1 to 1000, or page is not a cursor from this list.
|
|
51134
|
+
*/
|
|
51135
|
+
400: unknown;
|
|
51136
|
+
/**
|
|
51137
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
51138
|
+
*/
|
|
51139
|
+
401: unknown;
|
|
51140
|
+
/**
|
|
51141
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
51142
|
+
*/
|
|
51143
|
+
403: unknown;
|
|
51144
|
+
/**
|
|
51145
|
+
* Session not found: the id does not exist in your organization. Take ids from sessions.list or sessions.create.
|
|
51146
|
+
*/
|
|
51147
|
+
404: unknown;
|
|
51148
|
+
};
|
|
50364
51149
|
export type SessionsResourcesListResponses = {
|
|
50365
51150
|
/**
|
|
50366
51151
|
* Successful response
|
|
@@ -50403,6 +51188,32 @@ export type SessionsResourcesAddData = {
|
|
|
50403
51188
|
};
|
|
50404
51189
|
url: '/agent/v1/sessions/{session_id}/resources';
|
|
50405
51190
|
};
|
|
51191
|
+
export type SessionsResourcesAddErrors = {
|
|
51192
|
+
/**
|
|
51193
|
+
* Only file resources are supported; file_id or mount_path is invalid, or the session already holds 500 resources.
|
|
51194
|
+
*/
|
|
51195
|
+
400: unknown;
|
|
51196
|
+
/**
|
|
51197
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
51198
|
+
*/
|
|
51199
|
+
401: unknown;
|
|
51200
|
+
/**
|
|
51201
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
51202
|
+
*/
|
|
51203
|
+
403: unknown;
|
|
51204
|
+
/**
|
|
51205
|
+
* Session not found, or the file does not exist in your organization. Upload it first and pass its id.
|
|
51206
|
+
*/
|
|
51207
|
+
404: unknown;
|
|
51208
|
+
/**
|
|
51209
|
+
* The file is not ready yet, or another request is allocating the same mount path. Retry shortly.
|
|
51210
|
+
*/
|
|
51211
|
+
409: unknown;
|
|
51212
|
+
/**
|
|
51213
|
+
* File metadata could not be read. Retry later.
|
|
51214
|
+
*/
|
|
51215
|
+
502: unknown;
|
|
51216
|
+
};
|
|
50406
51217
|
export type SessionsResourcesAddResponses = {
|
|
50407
51218
|
/**
|
|
50408
51219
|
* Successful response
|
|
@@ -50430,6 +51241,20 @@ export type SessionsResourcesDeleteData = {
|
|
|
50430
51241
|
};
|
|
50431
51242
|
url: '/agent/v1/sessions/{session_id}/resources/{resource_id}';
|
|
50432
51243
|
};
|
|
51244
|
+
export type SessionsResourcesDeleteErrors = {
|
|
51245
|
+
/**
|
|
51246
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
51247
|
+
*/
|
|
51248
|
+
401: unknown;
|
|
51249
|
+
/**
|
|
51250
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
51251
|
+
*/
|
|
51252
|
+
403: unknown;
|
|
51253
|
+
/**
|
|
51254
|
+
* Session or resource not found. Take resource ids from sessions.resources.list.
|
|
51255
|
+
*/
|
|
51256
|
+
404: unknown;
|
|
51257
|
+
};
|
|
50433
51258
|
export type SessionsResourcesDeleteResponses = {
|
|
50434
51259
|
/**
|
|
50435
51260
|
* Successful response
|
|
@@ -50457,6 +51282,20 @@ export type SessionsResourcesRetrieveData = {
|
|
|
50457
51282
|
};
|
|
50458
51283
|
url: '/agent/v1/sessions/{session_id}/resources/{resource_id}';
|
|
50459
51284
|
};
|
|
51285
|
+
export type SessionsResourcesRetrieveErrors = {
|
|
51286
|
+
/**
|
|
51287
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
51288
|
+
*/
|
|
51289
|
+
401: unknown;
|
|
51290
|
+
/**
|
|
51291
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
51292
|
+
*/
|
|
51293
|
+
403: unknown;
|
|
51294
|
+
/**
|
|
51295
|
+
* Session or resource not found. Take resource ids from sessions.resources.list.
|
|
51296
|
+
*/
|
|
51297
|
+
404: unknown;
|
|
51298
|
+
};
|
|
50460
51299
|
export type SessionsResourcesRetrieveResponses = {
|
|
50461
51300
|
/**
|
|
50462
51301
|
* Successful response
|
|
@@ -50499,6 +51338,20 @@ export type DeploymentsListData = {
|
|
|
50499
51338
|
};
|
|
50500
51339
|
url: '/agent/v1/deployments';
|
|
50501
51340
|
};
|
|
51341
|
+
export type DeploymentsListErrors = {
|
|
51342
|
+
/**
|
|
51343
|
+
* status and include_archived were combined, a filter value is invalid, or limit or page is invalid.
|
|
51344
|
+
*/
|
|
51345
|
+
400: unknown;
|
|
51346
|
+
/**
|
|
51347
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
51348
|
+
*/
|
|
51349
|
+
401: unknown;
|
|
51350
|
+
/**
|
|
51351
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
51352
|
+
*/
|
|
51353
|
+
403: unknown;
|
|
51354
|
+
};
|
|
50502
51355
|
export type DeploymentsListResponses = {
|
|
50503
51356
|
/**
|
|
50504
51357
|
* Successful response
|
|
@@ -50758,6 +51611,20 @@ export type DeploymentsCreateData = {
|
|
|
50758
51611
|
query?: never;
|
|
50759
51612
|
url: '/agent/v1/deployments';
|
|
50760
51613
|
};
|
|
51614
|
+
export type DeploymentsCreateErrors = {
|
|
51615
|
+
/**
|
|
51616
|
+
* The body failed validation and the message names the field: an unknown field, a missing environment_id, initial_events other than user.message, an invalid schedule, or an extension used where it is not available.
|
|
51617
|
+
*/
|
|
51618
|
+
400: unknown;
|
|
51619
|
+
/**
|
|
51620
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
51621
|
+
*/
|
|
51622
|
+
401: unknown;
|
|
51623
|
+
/**
|
|
51624
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
51625
|
+
*/
|
|
51626
|
+
403: unknown;
|
|
51627
|
+
};
|
|
50761
51628
|
export type DeploymentsCreateResponses = {
|
|
50762
51629
|
/**
|
|
50763
51630
|
* Successful response
|
|
@@ -50912,6 +51779,20 @@ export type DeploymentsRetrieveData = {
|
|
|
50912
51779
|
query?: never;
|
|
50913
51780
|
url: '/agent/v1/deployments/{deployment_id}';
|
|
50914
51781
|
};
|
|
51782
|
+
export type DeploymentsRetrieveErrors = {
|
|
51783
|
+
/**
|
|
51784
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
51785
|
+
*/
|
|
51786
|
+
401: unknown;
|
|
51787
|
+
/**
|
|
51788
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
51789
|
+
*/
|
|
51790
|
+
403: unknown;
|
|
51791
|
+
/**
|
|
51792
|
+
* Deployment not found. Take ids from deployments.create or deployments.list.
|
|
51793
|
+
*/
|
|
51794
|
+
404: unknown;
|
|
51795
|
+
};
|
|
50915
51796
|
export type DeploymentsRetrieveResponses = {
|
|
50916
51797
|
/**
|
|
50917
51798
|
* Successful response
|
|
@@ -51169,6 +52050,28 @@ export type DeploymentsUpdateData = {
|
|
|
51169
52050
|
query?: never;
|
|
51170
52051
|
url: '/agent/v1/deployments/{deployment_id}';
|
|
51171
52052
|
};
|
|
52053
|
+
export type DeploymentsUpdateErrors = {
|
|
52054
|
+
/**
|
|
52055
|
+
* The body failed validation and the message names the field.
|
|
52056
|
+
*/
|
|
52057
|
+
400: unknown;
|
|
52058
|
+
/**
|
|
52059
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
52060
|
+
*/
|
|
52061
|
+
401: unknown;
|
|
52062
|
+
/**
|
|
52063
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
52064
|
+
*/
|
|
52065
|
+
403: unknown;
|
|
52066
|
+
/**
|
|
52067
|
+
* Deployment not found. Take ids from deployments.create or deployments.list.
|
|
52068
|
+
*/
|
|
52069
|
+
404: unknown;
|
|
52070
|
+
/**
|
|
52071
|
+
* The deployment is archived and cannot be updated.
|
|
52072
|
+
*/
|
|
52073
|
+
409: unknown;
|
|
52074
|
+
};
|
|
51172
52075
|
export type DeploymentsUpdateResponses = {
|
|
51173
52076
|
/**
|
|
51174
52077
|
* Successful response
|
|
@@ -51323,6 +52226,20 @@ export type DeploymentsArchiveData = {
|
|
|
51323
52226
|
query?: never;
|
|
51324
52227
|
url: '/agent/v1/deployments/{deployment_id}/archive';
|
|
51325
52228
|
};
|
|
52229
|
+
export type DeploymentsArchiveErrors = {
|
|
52230
|
+
/**
|
|
52231
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
52232
|
+
*/
|
|
52233
|
+
401: unknown;
|
|
52234
|
+
/**
|
|
52235
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
52236
|
+
*/
|
|
52237
|
+
403: unknown;
|
|
52238
|
+
/**
|
|
52239
|
+
* Deployment not found. Take ids from deployments.create or deployments.list.
|
|
52240
|
+
*/
|
|
52241
|
+
404: unknown;
|
|
52242
|
+
};
|
|
51326
52243
|
export type DeploymentsArchiveResponses = {
|
|
51327
52244
|
/**
|
|
51328
52245
|
* Successful response
|
|
@@ -51477,6 +52394,24 @@ export type DeploymentsPauseData = {
|
|
|
51477
52394
|
query?: never;
|
|
51478
52395
|
url: '/agent/v1/deployments/{deployment_id}/pause';
|
|
51479
52396
|
};
|
|
52397
|
+
export type DeploymentsPauseErrors = {
|
|
52398
|
+
/**
|
|
52399
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
52400
|
+
*/
|
|
52401
|
+
401: unknown;
|
|
52402
|
+
/**
|
|
52403
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
52404
|
+
*/
|
|
52405
|
+
403: unknown;
|
|
52406
|
+
/**
|
|
52407
|
+
* Deployment not found. Take ids from deployments.create or deployments.list.
|
|
52408
|
+
*/
|
|
52409
|
+
404: unknown;
|
|
52410
|
+
/**
|
|
52411
|
+
* The deployment is archived.
|
|
52412
|
+
*/
|
|
52413
|
+
409: unknown;
|
|
52414
|
+
};
|
|
51480
52415
|
export type DeploymentsPauseResponses = {
|
|
51481
52416
|
/**
|
|
51482
52417
|
* Successful response
|
|
@@ -51631,6 +52566,24 @@ export type DeploymentsUnpauseData = {
|
|
|
51631
52566
|
query?: never;
|
|
51632
52567
|
url: '/agent/v1/deployments/{deployment_id}/unpause';
|
|
51633
52568
|
};
|
|
52569
|
+
export type DeploymentsUnpauseErrors = {
|
|
52570
|
+
/**
|
|
52571
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
52572
|
+
*/
|
|
52573
|
+
401: unknown;
|
|
52574
|
+
/**
|
|
52575
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
52576
|
+
*/
|
|
52577
|
+
403: unknown;
|
|
52578
|
+
/**
|
|
52579
|
+
* Deployment not found. Take ids from deployments.create or deployments.list.
|
|
52580
|
+
*/
|
|
52581
|
+
404: unknown;
|
|
52582
|
+
/**
|
|
52583
|
+
* The deployment is archived.
|
|
52584
|
+
*/
|
|
52585
|
+
409: unknown;
|
|
52586
|
+
};
|
|
51634
52587
|
export type DeploymentsUnpauseResponses = {
|
|
51635
52588
|
/**
|
|
51636
52589
|
* Successful response
|
|
@@ -51817,6 +52770,20 @@ export type DeploymentRunsListData = {
|
|
|
51817
52770
|
};
|
|
51818
52771
|
url: '/agent/v1/deployment_runs';
|
|
51819
52772
|
};
|
|
52773
|
+
export type DeploymentRunsListErrors = {
|
|
52774
|
+
/**
|
|
52775
|
+
* A filter value is invalid, or limit or page is invalid.
|
|
52776
|
+
*/
|
|
52777
|
+
400: unknown;
|
|
52778
|
+
/**
|
|
52779
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
52780
|
+
*/
|
|
52781
|
+
401: unknown;
|
|
52782
|
+
/**
|
|
52783
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
52784
|
+
*/
|
|
52785
|
+
403: unknown;
|
|
52786
|
+
};
|
|
51820
52787
|
export type DeploymentRunsListResponses = {
|
|
51821
52788
|
/**
|
|
51822
52789
|
* Successful response
|
|
@@ -51844,6 +52811,20 @@ export type DeploymentRunsRetrieveData = {
|
|
|
51844
52811
|
query?: never;
|
|
51845
52812
|
url: '/agent/v1/deployment_runs/{deployment_run_id}';
|
|
51846
52813
|
};
|
|
52814
|
+
export type DeploymentRunsRetrieveErrors = {
|
|
52815
|
+
/**
|
|
52816
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
52817
|
+
*/
|
|
52818
|
+
401: unknown;
|
|
52819
|
+
/**
|
|
52820
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
52821
|
+
*/
|
|
52822
|
+
403: unknown;
|
|
52823
|
+
/**
|
|
52824
|
+
* Deployment run not found. Take ids from deployments.run or deployment_runs.list.
|
|
52825
|
+
*/
|
|
52826
|
+
404: unknown;
|
|
52827
|
+
};
|
|
51847
52828
|
export type DeploymentRunsRetrieveResponses = {
|
|
51848
52829
|
/**
|
|
51849
52830
|
* Successful response
|
|
@@ -51862,6 +52843,24 @@ export type DeploymentsRunData = {
|
|
|
51862
52843
|
query?: never;
|
|
51863
52844
|
url: '/agent/v1/deployments/{deployment_id}/run';
|
|
51864
52845
|
};
|
|
52846
|
+
export type DeploymentsRunErrors = {
|
|
52847
|
+
/**
|
|
52848
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
52849
|
+
*/
|
|
52850
|
+
401: unknown;
|
|
52851
|
+
/**
|
|
52852
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
52853
|
+
*/
|
|
52854
|
+
403: unknown;
|
|
52855
|
+
/**
|
|
52856
|
+
* Deployment not found. Take ids from deployments.create or deployments.list.
|
|
52857
|
+
*/
|
|
52858
|
+
404: unknown;
|
|
52859
|
+
/**
|
|
52860
|
+
* The deployment is paused or archived; unpause it first. No run was recorded.
|
|
52861
|
+
*/
|
|
52862
|
+
409: unknown;
|
|
52863
|
+
};
|
|
51865
52864
|
export type DeploymentsRunResponses = {
|
|
51866
52865
|
/**
|
|
51867
52866
|
* Successful response
|
|
@@ -51869,6 +52868,381 @@ export type DeploymentsRunResponses = {
|
|
|
51869
52868
|
200: AgentManaged113;
|
|
51870
52869
|
};
|
|
51871
52870
|
export type DeploymentsRunResponse = DeploymentsRunResponses[keyof DeploymentsRunResponses];
|
|
52871
|
+
export type SkillsListData = {
|
|
52872
|
+
body?: never;
|
|
52873
|
+
path?: never;
|
|
52874
|
+
query?: {
|
|
52875
|
+
/**
|
|
52876
|
+
* Filter skills by source.
|
|
52877
|
+
*
|
|
52878
|
+
* If provided, only skills from the specified source will be returned:
|
|
52879
|
+
*
|
|
52880
|
+
* - `"custom"`: only return user-created skills
|
|
52881
|
+
* - `"anthropic"`: only return Anthropic-created skills
|
|
52882
|
+
*/
|
|
52883
|
+
source?: null | string;
|
|
52884
|
+
/**
|
|
52885
|
+
* Number of items per page.
|
|
52886
|
+
*/
|
|
52887
|
+
limit?: number;
|
|
52888
|
+
page?: null | string;
|
|
52889
|
+
};
|
|
52890
|
+
url: '/agent/v1/skills';
|
|
52891
|
+
};
|
|
52892
|
+
export type SkillsListErrors = {
|
|
52893
|
+
/**
|
|
52894
|
+
* source is not custom or anthropic, or limit is not an integer from 1 to 100, or page is not a cursor from this same query. Pass next_page unchanged, with the same filters, to continue.
|
|
52895
|
+
*/
|
|
52896
|
+
400: unknown;
|
|
52897
|
+
/**
|
|
52898
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
52899
|
+
*/
|
|
52900
|
+
401: unknown;
|
|
52901
|
+
/**
|
|
52902
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
52903
|
+
*/
|
|
52904
|
+
403: unknown;
|
|
52905
|
+
};
|
|
52906
|
+
export type SkillsListResponses = {
|
|
52907
|
+
/**
|
|
52908
|
+
* Successful response
|
|
52909
|
+
*/
|
|
52910
|
+
200: {
|
|
52911
|
+
/**
|
|
52912
|
+
* Items of this page, in the order requested by the call.
|
|
52913
|
+
*/
|
|
52914
|
+
data: Array<AgentManaged308>;
|
|
52915
|
+
/**
|
|
52916
|
+
* Opaque cursor for the next page: pass it unchanged as page to continue. Null when this is the last page.
|
|
52917
|
+
*/
|
|
52918
|
+
next_page: string | null;
|
|
52919
|
+
};
|
|
52920
|
+
};
|
|
52921
|
+
export type SkillsListResponse = SkillsListResponses[keyof SkillsListResponses];
|
|
52922
|
+
export type SkillsCreateData = {
|
|
52923
|
+
body: {
|
|
52924
|
+
/**
|
|
52925
|
+
* Files to upload for the skill.
|
|
52926
|
+
*
|
|
52927
|
+
* All files must be in the same top-level directory and must include a SKILL.md
|
|
52928
|
+
* file at the root of that directory.
|
|
52929
|
+
*/
|
|
52930
|
+
files: Array<Blob | File>;
|
|
52931
|
+
/**
|
|
52932
|
+
* Human-readable, single-line label for the Skill. Maximum 255
|
|
52933
|
+
* characters. Always set: derived from the SKILL.md frontmatter `name` when
|
|
52934
|
+
* omitted at creation. Not unique.
|
|
52935
|
+
*/
|
|
52936
|
+
display_name?: null | string;
|
|
52937
|
+
};
|
|
52938
|
+
path?: never;
|
|
52939
|
+
query?: never;
|
|
52940
|
+
url: '/agent/v1/skills';
|
|
52941
|
+
};
|
|
52942
|
+
export type SkillsCreateErrors = {
|
|
52943
|
+
/**
|
|
52944
|
+
* Not multipart/form-data, or a file part is invalid: no top-level directory, no SKILL.md, no description in its frontmatter, a path with .. or an absolute path, more than 200 files, or more than 8 MB in total. The message names the path or field.
|
|
52945
|
+
*/
|
|
52946
|
+
400: unknown;
|
|
52947
|
+
/**
|
|
52948
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
52949
|
+
*/
|
|
52950
|
+
401: unknown;
|
|
52951
|
+
/**
|
|
52952
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
52953
|
+
*/
|
|
52954
|
+
403: unknown;
|
|
52955
|
+
/**
|
|
52956
|
+
* Skill storage is unavailable. Retry later.
|
|
52957
|
+
*/
|
|
52958
|
+
502: unknown;
|
|
52959
|
+
};
|
|
52960
|
+
export type SkillsCreateResponses = {
|
|
52961
|
+
/**
|
|
52962
|
+
* Successful response
|
|
52963
|
+
*/
|
|
52964
|
+
200: AgentManaged308;
|
|
52965
|
+
};
|
|
52966
|
+
export type SkillsCreateResponse = SkillsCreateResponses[keyof SkillsCreateResponses];
|
|
52967
|
+
export type SkillsDeleteData = {
|
|
52968
|
+
body?: never;
|
|
52969
|
+
path: {
|
|
52970
|
+
/**
|
|
52971
|
+
* Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.
|
|
52972
|
+
*/
|
|
52973
|
+
skill_id: string;
|
|
52974
|
+
};
|
|
52975
|
+
query?: never;
|
|
52976
|
+
url: '/agent/v1/skills/{skill_id}';
|
|
52977
|
+
};
|
|
52978
|
+
export type SkillsDeleteErrors = {
|
|
52979
|
+
/**
|
|
52980
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
52981
|
+
*/
|
|
52982
|
+
401: unknown;
|
|
52983
|
+
/**
|
|
52984
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
52985
|
+
*/
|
|
52986
|
+
403: unknown;
|
|
52987
|
+
/**
|
|
52988
|
+
* Skill not found, deleted, or owned by another organization. Take ids from skills.list.
|
|
52989
|
+
*/
|
|
52990
|
+
404: unknown;
|
|
52991
|
+
/**
|
|
52992
|
+
* Delete all versions first, or RESOURCE_IN_USE: a non-archived agent still attaches the skill; the message names up to 10 agent ids.
|
|
52993
|
+
*/
|
|
52994
|
+
409: unknown;
|
|
52995
|
+
};
|
|
52996
|
+
export type SkillsDeleteResponses = {
|
|
52997
|
+
/**
|
|
52998
|
+
* Successful response
|
|
52999
|
+
*/
|
|
53000
|
+
200: AgentManaged310;
|
|
53001
|
+
};
|
|
53002
|
+
export type SkillsDeleteResponse = SkillsDeleteResponses[keyof SkillsDeleteResponses];
|
|
53003
|
+
export type SkillsRetrieveData = {
|
|
53004
|
+
body?: never;
|
|
53005
|
+
path: {
|
|
53006
|
+
/**
|
|
53007
|
+
* Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.
|
|
53008
|
+
*/
|
|
53009
|
+
skill_id: string;
|
|
53010
|
+
};
|
|
53011
|
+
query?: never;
|
|
53012
|
+
url: '/agent/v1/skills/{skill_id}';
|
|
53013
|
+
};
|
|
53014
|
+
export type SkillsRetrieveErrors = {
|
|
53015
|
+
/**
|
|
53016
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
53017
|
+
*/
|
|
53018
|
+
401: unknown;
|
|
53019
|
+
/**
|
|
53020
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
53021
|
+
*/
|
|
53022
|
+
403: unknown;
|
|
53023
|
+
/**
|
|
53024
|
+
* Skill not found, deleted, or owned by another organization. Take ids from skills.list.
|
|
53025
|
+
*/
|
|
53026
|
+
404: unknown;
|
|
53027
|
+
};
|
|
53028
|
+
export type SkillsRetrieveResponses = {
|
|
53029
|
+
/**
|
|
53030
|
+
* Successful response
|
|
53031
|
+
*/
|
|
53032
|
+
200: AgentManaged308;
|
|
53033
|
+
};
|
|
53034
|
+
export type SkillsRetrieveResponse = SkillsRetrieveResponses[keyof SkillsRetrieveResponses];
|
|
53035
|
+
export type SkillsVersionsListData = {
|
|
53036
|
+
body?: never;
|
|
53037
|
+
path: {
|
|
53038
|
+
/**
|
|
53039
|
+
* Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.
|
|
53040
|
+
*/
|
|
53041
|
+
skill_id: string;
|
|
53042
|
+
};
|
|
53043
|
+
query?: {
|
|
53044
|
+
/**
|
|
53045
|
+
* Number of items per page.
|
|
53046
|
+
*/
|
|
53047
|
+
limit?: number;
|
|
53048
|
+
page?: null | string;
|
|
53049
|
+
};
|
|
53050
|
+
url: '/agent/v1/skills/{skill_id}/versions';
|
|
53051
|
+
};
|
|
53052
|
+
export type SkillsVersionsListErrors = {
|
|
53053
|
+
/**
|
|
53054
|
+
* limit is not an integer from 1 to 100, or page is not a cursor from this same query. Pass next_page unchanged, with the same filters, to continue.
|
|
53055
|
+
*/
|
|
53056
|
+
400: unknown;
|
|
53057
|
+
/**
|
|
53058
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
53059
|
+
*/
|
|
53060
|
+
401: unknown;
|
|
53061
|
+
/**
|
|
53062
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
53063
|
+
*/
|
|
53064
|
+
403: unknown;
|
|
53065
|
+
/**
|
|
53066
|
+
* Skill not found, deleted, or owned by another organization. Take ids from skills.list.
|
|
53067
|
+
*/
|
|
53068
|
+
404: unknown;
|
|
53069
|
+
};
|
|
53070
|
+
export type SkillsVersionsListResponses = {
|
|
53071
|
+
/**
|
|
53072
|
+
* Successful response
|
|
53073
|
+
*/
|
|
53074
|
+
200: {
|
|
53075
|
+
/**
|
|
53076
|
+
* Items of this page, in the order requested by the call.
|
|
53077
|
+
*/
|
|
53078
|
+
data: Array<AgentManaged311>;
|
|
53079
|
+
/**
|
|
53080
|
+
* Opaque cursor for the next page: pass it unchanged as page to continue. Null when this is the last page.
|
|
53081
|
+
*/
|
|
53082
|
+
next_page: string | null;
|
|
53083
|
+
};
|
|
53084
|
+
};
|
|
53085
|
+
export type SkillsVersionsListResponse = SkillsVersionsListResponses[keyof SkillsVersionsListResponses];
|
|
53086
|
+
export type SkillsVersionsCreateData = {
|
|
53087
|
+
body: {
|
|
53088
|
+
/**
|
|
53089
|
+
* Files to upload for the skill.
|
|
53090
|
+
*
|
|
53091
|
+
* All files must be in the same top-level directory and must include a SKILL.md
|
|
53092
|
+
* file at the root of that directory.
|
|
53093
|
+
*/
|
|
53094
|
+
files: Array<Blob | File>;
|
|
53095
|
+
};
|
|
53096
|
+
path: {
|
|
53097
|
+
/**
|
|
53098
|
+
* Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.
|
|
53099
|
+
*/
|
|
53100
|
+
skill_id: string;
|
|
53101
|
+
};
|
|
53102
|
+
query?: never;
|
|
53103
|
+
url: '/agent/v1/skills/{skill_id}/versions';
|
|
53104
|
+
};
|
|
53105
|
+
export type SkillsVersionsCreateErrors = {
|
|
53106
|
+
/**
|
|
53107
|
+
* The upload is invalid (same rules as skills.create), or the SKILL.md name differs from the skill's name.
|
|
53108
|
+
*/
|
|
53109
|
+
400: unknown;
|
|
53110
|
+
/**
|
|
53111
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
53112
|
+
*/
|
|
53113
|
+
401: unknown;
|
|
53114
|
+
/**
|
|
53115
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
53116
|
+
*/
|
|
53117
|
+
403: unknown;
|
|
53118
|
+
/**
|
|
53119
|
+
* Skill not found, deleted, or owned by another organization. Take ids from skills.list.
|
|
53120
|
+
*/
|
|
53121
|
+
404: unknown;
|
|
53122
|
+
/**
|
|
53123
|
+
* Skill storage is unavailable. Retry later.
|
|
53124
|
+
*/
|
|
53125
|
+
502: unknown;
|
|
53126
|
+
};
|
|
53127
|
+
export type SkillsVersionsCreateResponses = {
|
|
53128
|
+
/**
|
|
53129
|
+
* Successful response
|
|
53130
|
+
*/
|
|
53131
|
+
200: AgentManaged311;
|
|
53132
|
+
};
|
|
53133
|
+
export type SkillsVersionsCreateResponse = SkillsVersionsCreateResponses[keyof SkillsVersionsCreateResponses];
|
|
53134
|
+
export type SkillsVersionsDeleteData = {
|
|
53135
|
+
body?: never;
|
|
53136
|
+
path: {
|
|
53137
|
+
/**
|
|
53138
|
+
* Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.
|
|
53139
|
+
*/
|
|
53140
|
+
skill_id: string;
|
|
53141
|
+
/**
|
|
53142
|
+
* Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload.
|
|
53143
|
+
*/
|
|
53144
|
+
version: string;
|
|
53145
|
+
};
|
|
53146
|
+
query?: never;
|
|
53147
|
+
url: '/agent/v1/skills/{skill_id}/versions/{version}';
|
|
53148
|
+
};
|
|
53149
|
+
export type SkillsVersionsDeleteErrors = {
|
|
53150
|
+
/**
|
|
53151
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
53152
|
+
*/
|
|
53153
|
+
401: unknown;
|
|
53154
|
+
/**
|
|
53155
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
53156
|
+
*/
|
|
53157
|
+
403: unknown;
|
|
53158
|
+
/**
|
|
53159
|
+
* Skill or version not found. Take version ids from skills.versions.list.
|
|
53160
|
+
*/
|
|
53161
|
+
404: unknown;
|
|
53162
|
+
/**
|
|
53163
|
+
* RESOURCE_IN_USE: a non-archived agent pins this version, or attaches the skill without a pin and this is its last version; the message names the agents.
|
|
53164
|
+
*/
|
|
53165
|
+
409: unknown;
|
|
53166
|
+
};
|
|
53167
|
+
export type SkillsVersionsDeleteResponses = {
|
|
53168
|
+
/**
|
|
53169
|
+
* Successful response
|
|
53170
|
+
*/
|
|
53171
|
+
200: AgentManaged312;
|
|
53172
|
+
};
|
|
53173
|
+
export type SkillsVersionsDeleteResponse = SkillsVersionsDeleteResponses[keyof SkillsVersionsDeleteResponses];
|
|
53174
|
+
export type SkillsVersionsRetrieveData = {
|
|
53175
|
+
body?: never;
|
|
53176
|
+
path: {
|
|
53177
|
+
/**
|
|
53178
|
+
* Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.
|
|
53179
|
+
*/
|
|
53180
|
+
skill_id: string;
|
|
53181
|
+
/**
|
|
53182
|
+
* Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload.
|
|
53183
|
+
*/
|
|
53184
|
+
version: string;
|
|
53185
|
+
};
|
|
53186
|
+
query?: never;
|
|
53187
|
+
url: '/agent/v1/skills/{skill_id}/versions/{version}';
|
|
53188
|
+
};
|
|
53189
|
+
export type SkillsVersionsRetrieveErrors = {
|
|
53190
|
+
/**
|
|
53191
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
53192
|
+
*/
|
|
53193
|
+
401: unknown;
|
|
53194
|
+
/**
|
|
53195
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
53196
|
+
*/
|
|
53197
|
+
403: unknown;
|
|
53198
|
+
/**
|
|
53199
|
+
* Skill or version not found. Take version ids from skills.versions.list.
|
|
53200
|
+
*/
|
|
53201
|
+
404: unknown;
|
|
53202
|
+
};
|
|
53203
|
+
export type SkillsVersionsRetrieveResponses = {
|
|
53204
|
+
/**
|
|
53205
|
+
* Successful response
|
|
53206
|
+
*/
|
|
53207
|
+
200: AgentManaged311;
|
|
53208
|
+
};
|
|
53209
|
+
export type SkillsVersionsRetrieveResponse = SkillsVersionsRetrieveResponses[keyof SkillsVersionsRetrieveResponses];
|
|
53210
|
+
export type SkillsVersionsDownloadData = {
|
|
53211
|
+
body?: never;
|
|
53212
|
+
path: {
|
|
53213
|
+
/**
|
|
53214
|
+
* Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.
|
|
53215
|
+
*/
|
|
53216
|
+
skill_id: string;
|
|
53217
|
+
/**
|
|
53218
|
+
* Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload.
|
|
53219
|
+
*/
|
|
53220
|
+
version: string;
|
|
53221
|
+
};
|
|
53222
|
+
query?: never;
|
|
53223
|
+
url: '/agent/v1/skills/{skill_id}/versions/{version}/content';
|
|
53224
|
+
};
|
|
53225
|
+
export type SkillsVersionsDownloadErrors = {
|
|
53226
|
+
/**
|
|
53227
|
+
* The API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
|
|
53228
|
+
*/
|
|
53229
|
+
401: unknown;
|
|
53230
|
+
/**
|
|
53231
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
53232
|
+
*/
|
|
53233
|
+
403: unknown;
|
|
53234
|
+
/**
|
|
53235
|
+
* Skill or version not found, or the version was deleted. Take version ids from skills.versions.list.
|
|
53236
|
+
*/
|
|
53237
|
+
404: unknown;
|
|
53238
|
+
};
|
|
53239
|
+
export type SkillsVersionsDownloadResponses = {
|
|
53240
|
+
/**
|
|
53241
|
+
* Binary response body
|
|
53242
|
+
*/
|
|
53243
|
+
200: Blob | File;
|
|
53244
|
+
};
|
|
53245
|
+
export type SkillsVersionsDownloadResponse = SkillsVersionsDownloadResponses[keyof SkillsVersionsDownloadResponses];
|
|
51872
53246
|
export type ApplicationGetSubdomainData = {
|
|
51873
53247
|
body?: never;
|
|
51874
53248
|
path?: never;
|