@deepraxis/sdk 0.1.0-dev.79876bd → 0.1.0-dev.7ec6f84
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 +171 -1
- package/dist/core/client.d.ts +9 -1
- package/dist/core/client.js +6 -0
- package/dist/core/transport.d.ts +5 -0
- package/dist/core/transport.js +6 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +438 -82
- package/dist/generated/sdk.gen.js +1233 -119
- package/dist/generated/types.gen.d.ts +24428 -16231
- package/dist/helpers/database-count.d.ts +17 -0
- package/dist/helpers/database-count.js +11 -0
- package/dist/helpers/file-upload.d.ts +24 -0
- package/dist/helpers/file-upload.js +113 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2 -0
- package/dist/operations.generated.d.ts +1783 -160
- package/dist/operations.generated.js +2232 -210
- package/dist/resources.generated.d.ts +741 -14
- package/dist/resources.generated.js +111 -0
- package/package.json +1 -1
|
@@ -61,7 +61,7 @@ export const operations = [
|
|
|
61
61
|
"resource": "agent.agents",
|
|
62
62
|
"method": "create",
|
|
63
63
|
"summary": "Create agent",
|
|
64
|
-
"description": "Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions.
|
|
64
|
+
"description": "Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. skills attaches uploaded custom skills as [{type: \"custom\", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send \"latest\", to use the skill's newest version when a session starts. type anthropic returns 400. Use tools: [{type: \"agent_toolset_20260401\"}] for built-in tools including codemode, skill and agent; inspect toolsets.list for names and schemas, and keep bash enabled for native additions. To offer only some tools, set default_config: {enabled: false} and list the tools to keep in configs, e.g. tools: [{type: \"agent_toolset_20260401\", default_config: {enabled: false}, configs: [{name: \"codemode\", enabled: true}, {name: \"bash\", enabled: true, permission_policy: {type: \"always_ask\"}}]}]; every tool not listed, including todo_write, enter_plan_mode, ask_user_question and goal_read, follows default_config, and the response echoes it. codemode runs through bash, so enabling codemode while bash is disabled returns 400. Optional mcp_toolset entries pair with mcp_servers. model accepts platform model IDs such as deepseek-flash, not only the Claude IDs in the protocol examples. model.settings.reasoning sets default thinking; other extra model controls return 400. model and every models.allowed entry must be a catalog model that can run an agent: an unknown id returns 400 \"model <id> is not in the model catalog\" and an embedding, image or speech model returns 400 \"model <id> cannot run an agent\". name is a label, not a unique key: 1 to 256 characters after trimming, no NUL or line breaks. avatar is trimmed, must not contain spaces or point at a loopback, private or internal host, and its scheme is stored in lowercase. script and workflow binding ids are stored in lowercase, the form automation matches; bindings together with environment_id null return 400 because bindings need a machine. Example: {\"name\":\"helper\",\"model\":{\"id\":\"deepseek-flash\"},\"tools\":[{\"type\":\"agent_toolset_20260401\"}]}.",
|
|
65
65
|
"http": "POST",
|
|
66
66
|
"path": "/agent/v1/agents",
|
|
67
67
|
"streaming": "no",
|
|
@@ -75,13 +75,13 @@ export const operations = [
|
|
|
75
75
|
"name": "model",
|
|
76
76
|
"type": "object",
|
|
77
77
|
"required": true,
|
|
78
|
-
"description": "
|
|
78
|
+
"description": "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."
|
|
79
79
|
},
|
|
80
80
|
{
|
|
81
81
|
"name": "name",
|
|
82
82
|
"type": "string",
|
|
83
83
|
"required": true,
|
|
84
|
-
"description": "
|
|
84
|
+
"description": "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."
|
|
85
85
|
},
|
|
86
86
|
{
|
|
87
87
|
"name": "description",
|
|
@@ -113,7 +113,7 @@ export const operations = [
|
|
|
113
113
|
"type": "array",
|
|
114
114
|
"itemType": "object",
|
|
115
115
|
"required": false,
|
|
116
|
-
"description": "
|
|
116
|
+
"description": "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."
|
|
117
117
|
},
|
|
118
118
|
{
|
|
119
119
|
"name": "system",
|
|
@@ -128,6 +128,13 @@ export const operations = [
|
|
|
128
128
|
"required": false,
|
|
129
129
|
"description": "Tool configurations available to the agent. Maximum of 128 tools\nacross all toolsets allowed."
|
|
130
130
|
},
|
|
131
|
+
{
|
|
132
|
+
"name": "bindings",
|
|
133
|
+
"type": "array",
|
|
134
|
+
"itemType": "object",
|
|
135
|
+
"required": false,
|
|
136
|
+
"description": "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings."
|
|
137
|
+
},
|
|
131
138
|
{
|
|
132
139
|
"name": "kind",
|
|
133
140
|
"type": "string",
|
|
@@ -176,6 +183,25 @@ export const operations = [
|
|
|
176
183
|
"required": false,
|
|
177
184
|
"description": "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable."
|
|
178
185
|
},
|
|
186
|
+
{
|
|
187
|
+
"name": "avatar",
|
|
188
|
+
"type": "string",
|
|
189
|
+
"required": false,
|
|
190
|
+
"description": "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."
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"name": "environment_id",
|
|
194
|
+
"type": "string",
|
|
195
|
+
"required": false,
|
|
196
|
+
"description": "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."
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "vault_ids",
|
|
200
|
+
"type": "array",
|
|
201
|
+
"itemType": "string",
|
|
202
|
+
"required": false,
|
|
203
|
+
"description": "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."
|
|
204
|
+
},
|
|
179
205
|
{
|
|
180
206
|
"name": "preset",
|
|
181
207
|
"type": "string",
|
|
@@ -194,7 +220,7 @@ export const operations = [
|
|
|
194
220
|
"resource": "agent.agents",
|
|
195
221
|
"method": "retrieve",
|
|
196
222
|
"summary": "Get agent",
|
|
197
|
-
"description": "Read one agent by id
|
|
223
|
+
"description": "Read one agent by id. The top level is the latest saved version, the editable head whose version you send back for optimistic concurrency; after a save with apply false it differs from active_version, and new sessions use active_version, which you read with version=active. With version, read a specific saved version. The response lists every native tool with its resolved configuration in one agent_toolset_20260401 entry, so it can be sent back unchanged to agents.update. Use agents.versions.list to enumerate versions.",
|
|
198
224
|
"http": "GET",
|
|
199
225
|
"path": "/agent/v1/agents/{agent_id}",
|
|
200
226
|
"streaming": "no",
|
|
@@ -210,7 +236,7 @@ export const operations = [
|
|
|
210
236
|
"name": "version",
|
|
211
237
|
"type": "number",
|
|
212
238
|
"required": false,
|
|
213
|
-
"description": "Agent version to read; omit for the latest.
|
|
239
|
+
"description": "Agent version to read; omit for the latest saved version. An integer of at least 1 (versions are listed by agents.versions.list), or the string active for the version new sessions use."
|
|
214
240
|
}
|
|
215
241
|
]
|
|
216
242
|
},
|
|
@@ -218,7 +244,7 @@ export const operations = [
|
|
|
218
244
|
"resource": "agent.agents",
|
|
219
245
|
"method": "update",
|
|
220
246
|
"summary": "Update agent",
|
|
221
|
-
"description": "Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version
|
|
247
|
+
"description": "Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version. apply defaults to true and moves active_version to the new version, or to the latest when configuration is unchanged; apply false saves without applying. version_note optionally records up to 280 characters on a newly created version; null means no note, and a note sent when the request changes nothing else returns 400 because a note is stored only with a new version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. tools: [] removes every tool, while tools: null returns 400 (tools cannot be null; send [] to remove every tool). On update, omit skills to keep them, send an array to replace them, or send [] or null to clear them. skills attaches uploaded custom skills as [{type: \"custom\", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send \"latest\", to use the skill's newest version when a session starts. type anthropic returns 400.",
|
|
222
248
|
"http": "POST",
|
|
223
249
|
"path": "/agent/v1/agents/{agent_id}",
|
|
224
250
|
"streaming": "no",
|
|
@@ -256,7 +282,7 @@ export const operations = [
|
|
|
256
282
|
"name": "model",
|
|
257
283
|
"type": "object",
|
|
258
284
|
"required": false,
|
|
259
|
-
"description": "
|
|
285
|
+
"description": "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."
|
|
260
286
|
},
|
|
261
287
|
{
|
|
262
288
|
"name": "multiagent",
|
|
@@ -268,14 +294,14 @@ export const operations = [
|
|
|
268
294
|
"name": "name",
|
|
269
295
|
"type": "string",
|
|
270
296
|
"required": false,
|
|
271
|
-
"description": "
|
|
297
|
+
"description": "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."
|
|
272
298
|
},
|
|
273
299
|
{
|
|
274
300
|
"name": "skills",
|
|
275
301
|
"type": "array",
|
|
276
302
|
"itemType": "object",
|
|
277
303
|
"required": false,
|
|
278
|
-
"description": "
|
|
304
|
+
"description": "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."
|
|
279
305
|
},
|
|
280
306
|
{
|
|
281
307
|
"name": "system",
|
|
@@ -296,6 +322,25 @@ export const operations = [
|
|
|
296
322
|
"required": false,
|
|
297
323
|
"description": "The agent's current version, used to prevent concurrent overwrites.\nObtain this value from a create or retrieve response. Must be at least 1 if\nspecified. When supplied, the request fails if it does not match the server's\ncurrent version; omit to apply the update unconditionally."
|
|
298
324
|
},
|
|
325
|
+
{
|
|
326
|
+
"name": "apply",
|
|
327
|
+
"type": "boolean",
|
|
328
|
+
"required": false,
|
|
329
|
+
"description": "Defaults to true: apply the newly saved version, or the latest version when configuration is unchanged. Set false to save without changing active_version. Unlike Managed Agents, saving and applying can be separate."
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"name": "version_note",
|
|
333
|
+
"type": "string",
|
|
334
|
+
"required": false,
|
|
335
|
+
"description": "Optional change explanation stored as note on the new immutable version, up to 280 characters. Omission or null stores no note. A note sent when nothing else changes returns 400 (nothing to save), because a note is stored only with a new version."
|
|
336
|
+
},
|
|
337
|
+
{
|
|
338
|
+
"name": "bindings",
|
|
339
|
+
"type": "array",
|
|
340
|
+
"itemType": "object",
|
|
341
|
+
"required": false,
|
|
342
|
+
"description": "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."
|
|
343
|
+
},
|
|
299
344
|
{
|
|
300
345
|
"name": "kind",
|
|
301
346
|
"type": "string",
|
|
@@ -344,6 +389,25 @@ export const operations = [
|
|
|
344
389
|
"required": false,
|
|
345
390
|
"description": "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable."
|
|
346
391
|
},
|
|
392
|
+
{
|
|
393
|
+
"name": "avatar",
|
|
394
|
+
"type": "string",
|
|
395
|
+
"required": false,
|
|
396
|
+
"description": "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."
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"name": "environment_id",
|
|
400
|
+
"type": "string",
|
|
401
|
+
"required": false,
|
|
402
|
+
"description": "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."
|
|
403
|
+
},
|
|
404
|
+
{
|
|
405
|
+
"name": "vault_ids",
|
|
406
|
+
"type": "array",
|
|
407
|
+
"itemType": "string",
|
|
408
|
+
"required": false,
|
|
409
|
+
"description": "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."
|
|
410
|
+
},
|
|
347
411
|
{
|
|
348
412
|
"name": "preset",
|
|
349
413
|
"type": "string",
|
|
@@ -375,6 +439,144 @@ export const operations = [
|
|
|
375
439
|
],
|
|
376
440
|
"query": []
|
|
377
441
|
},
|
|
442
|
+
{
|
|
443
|
+
"resource": "agent.agents.customers.auth.accessTokens",
|
|
444
|
+
"method": "create",
|
|
445
|
+
"summary": "Create customer access token",
|
|
446
|
+
"description": "Exchange a grant code, or the agent's publishable key for an anonymous visitor, for a customer access token that authorizes the agent's embedded sessions.\n\nNo Authorization header is required: the grant code or the publishable key is the credential. Agent Kit calls this from the browser, so send the page Origin. With grant_code, the code is consumed atomically: concurrent attempts have exactly one winner, and unknown, used, expired and other-agent codes all return the same 401 GRANT_CODE_INVALID. The sign-in starts now and lasts the code's max_session_seconds. Unlike Shopify, a visitor without an account gets a token too: send publishable_key instead and a new anonymous customer (anon_…) is created, bound to the request Origin, for 7 days. The access token lasts at most two hours and never outlives the sign-in; renew it with access_tokens/renew before expires_at. Both forms share the per-IP minute limit of anonymous issuance (default 20). Example body: {\"grant_code\":\"cgc_…\"}.",
|
|
447
|
+
"http": "POST",
|
|
448
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/access_tokens",
|
|
449
|
+
"streaming": "no",
|
|
450
|
+
"pagination": false,
|
|
451
|
+
"pathParams": [
|
|
452
|
+
{
|
|
453
|
+
"name": "agent_id",
|
|
454
|
+
"sdkName": "agent_id"
|
|
455
|
+
}
|
|
456
|
+
],
|
|
457
|
+
"query": [],
|
|
458
|
+
"body": {
|
|
459
|
+
"required": true,
|
|
460
|
+
"fields": []
|
|
461
|
+
}
|
|
462
|
+
},
|
|
463
|
+
{
|
|
464
|
+
"resource": "agent.agents.customers.auth.accessTokens",
|
|
465
|
+
"method": "deleteCurrent",
|
|
466
|
+
"summary": "Log out customer",
|
|
467
|
+
"description": "Log the customer out by revoking the sign-in of the presented access token and every token issued in it.\n\nSend the current customer access token as the Bearer credential, with no body, when the customer logs out of your site. Every token of the sign-in, including renewed ones, stops working, and their live event streams close; the customer's conversations are kept. Returns 204. Calling it again with the same token returns 401 ACCESS_TOKEN_REVOKED, so treat that as already logged out.",
|
|
468
|
+
"http": "DELETE",
|
|
469
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current",
|
|
470
|
+
"streaming": "no",
|
|
471
|
+
"pagination": false,
|
|
472
|
+
"pathParams": [
|
|
473
|
+
{
|
|
474
|
+
"name": "agent_id",
|
|
475
|
+
"sdkName": "agent_id"
|
|
476
|
+
}
|
|
477
|
+
],
|
|
478
|
+
"query": []
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"resource": "agent.agents.customers.auth.accessTokens.renew",
|
|
482
|
+
"method": "create",
|
|
483
|
+
"summary": "Renew customer access token",
|
|
484
|
+
"description": "Get a fresh customer access token in the same sign-in, authenticated with the current one.\n\nSend the current customer access token as the Bearer credential, with no body, a few minutes before expires_at. The new token keeps the version, budget, context, metadata and origin binding of the sign-in and lasts at most two hours, never past session_expires_at. Unlike Shopify, renewal does not revoke the presented token: it stays valid until its own expiry, so a reply that is streaming on it is not cut off. When less than 60 seconds of the sign-in remain, renewal returns 401 CUSTOMER_SESSION_EXPIRED; sign the customer in again with a new grant code from your backend. A token that was logged out or merged returns 401 ACCESS_TOKEN_REVOKED.",
|
|
485
|
+
"http": "POST",
|
|
486
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew",
|
|
487
|
+
"streaming": "no",
|
|
488
|
+
"pagination": false,
|
|
489
|
+
"pathParams": [
|
|
490
|
+
{
|
|
491
|
+
"name": "agent_id",
|
|
492
|
+
"sdkName": "agent_id"
|
|
493
|
+
}
|
|
494
|
+
],
|
|
495
|
+
"query": []
|
|
496
|
+
},
|
|
497
|
+
{
|
|
498
|
+
"resource": "agent.agents.customers.auth.grantCodes",
|
|
499
|
+
"method": "create",
|
|
500
|
+
"summary": "Create customer grant code",
|
|
501
|
+
"description": "Sign your logged-in customer in to a service agent from your backend with a one-time grant code that Agent Kit exchanges for a customer access token.\n\nCall this from your backend with your API key after your own login succeeds, then pass the returned code to Agent Kit in the browser; never call it from the browser. Customer authorization follows Shopify Storefront customer access tokens (Multipass-style sign-in, a short-lived token, renewal and logout), so that experience applies. customer_id is your own identifier for the customer: use an opaque id such as your database user id, not an email address or phone number. The value auth is reserved, and ids starting with anon_ are reserved for anonymous customers. The code works once and expires after expires_in seconds (default 900). The sign-in it starts lasts max_session_seconds (default 7 days); version, budget_cents, system_message, agent_override and metadata apply to every token of the sign-in. Unlike Shopify, origin binds the whole sign-in to one page origin, and anonymous_access_token merges the conversations of the anonymous visitor who chatted before signing in into this customer. Example body: {\"customer_id\":\"cus_8f2a91\",\"origin\":\"https://shop.example.com\"}.",
|
|
502
|
+
"http": "POST",
|
|
503
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/grant_codes",
|
|
504
|
+
"streaming": "no",
|
|
505
|
+
"pagination": false,
|
|
506
|
+
"pathParams": [
|
|
507
|
+
{
|
|
508
|
+
"name": "agent_id",
|
|
509
|
+
"sdkName": "agent_id"
|
|
510
|
+
}
|
|
511
|
+
],
|
|
512
|
+
"query": [],
|
|
513
|
+
"body": {
|
|
514
|
+
"required": true,
|
|
515
|
+
"fields": [
|
|
516
|
+
{
|
|
517
|
+
"name": "customer_id",
|
|
518
|
+
"type": "string",
|
|
519
|
+
"required": true,
|
|
520
|
+
"description": "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."
|
|
521
|
+
},
|
|
522
|
+
{
|
|
523
|
+
"name": "version",
|
|
524
|
+
"type": "integer",
|
|
525
|
+
"required": false,
|
|
526
|
+
"description": "Existing agent version that every token of this sign-in pins. Defaults to the agent's active_version when the code is issued."
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
"name": "budget_cents",
|
|
530
|
+
"type": "integer",
|
|
531
|
+
"required": false,
|
|
532
|
+
"description": "Budget in cents for each session the customer starts. Defaults to the embed policy session budget and cannot exceed its maximum."
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"name": "system_message",
|
|
536
|
+
"type": "array",
|
|
537
|
+
"itemType": "object",
|
|
538
|
+
"required": false,
|
|
539
|
+
"description": "Optional context the agent receives at the start of each session, as text blocks, limited to 8192 UTF-8 bytes in total."
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"name": "agent_override",
|
|
543
|
+
"type": "object",
|
|
544
|
+
"required": false,
|
|
545
|
+
"description": "Optional system prompt override, accepted only when the embed policy allows agent overrides."
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"name": "metadata",
|
|
549
|
+
"type": "object",
|
|
550
|
+
"required": false,
|
|
551
|
+
"description": "Up to 16 string pairs copied onto every session the customer starts. The playground key is reserved."
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
"name": "origin",
|
|
555
|
+
"type": "string",
|
|
556
|
+
"required": false,
|
|
557
|
+
"description": "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."
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"name": "expires_in",
|
|
561
|
+
"type": "integer",
|
|
562
|
+
"required": false,
|
|
563
|
+
"description": "Seconds the code stays redeemable, from 60 to 86400. Defaults to 900."
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"name": "max_session_seconds",
|
|
567
|
+
"type": "integer",
|
|
568
|
+
"required": false,
|
|
569
|
+
"description": "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."
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
"name": "anonymous_access_token",
|
|
573
|
+
"type": "string",
|
|
574
|
+
"required": false,
|
|
575
|
+
"description": "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."
|
|
576
|
+
}
|
|
577
|
+
]
|
|
578
|
+
}
|
|
579
|
+
},
|
|
378
580
|
{
|
|
379
581
|
"resource": "agent.agents.endUsers",
|
|
380
582
|
"method": "list",
|
|
@@ -565,7 +767,7 @@ export const operations = [
|
|
|
565
767
|
"resource": "agent.agents.versions",
|
|
566
768
|
"method": "list",
|
|
567
769
|
"summary": "List agent versions",
|
|
568
|
-
"description": "List the saved versions of one agent, in pages of at most 100 (default 20). Each item is the full agent definition at that version, so you can compare what changed between versions. Use agents.retrieve with version to read a single one; agent_id comes from agents.list or agents.create.",
|
|
770
|
+
"description": "List the saved versions of one agent, in pages of at most 100 (default 20). Each item is the full agent definition at that version, so you can compare what changed between versions. active is true only for the item that new sessions use; active_version on each item is the agent-level value, kept for compatibility. Use agents.retrieve with version to read a single one; agent_id comes from agents.list or agents.create.",
|
|
569
771
|
"http": "GET",
|
|
570
772
|
"path": "/agent/v1/agents/{agent_id}/versions",
|
|
571
773
|
"streaming": "no",
|
|
@@ -591,11 +793,32 @@ export const operations = [
|
|
|
591
793
|
}
|
|
592
794
|
]
|
|
593
795
|
},
|
|
796
|
+
{
|
|
797
|
+
"resource": "agent.agents.versions",
|
|
798
|
+
"method": "apply",
|
|
799
|
+
"summary": "Apply Agent Version",
|
|
800
|
+
"description": "Apply a version from agents.versions.list by its version number. This idempotent operation changes active_version without creating a version; existing sessions and tokens keep their version. The response is the latest saved agent with its current active_version. Missing versions return 404 Agent version not found; archived agents return 409 Agent is archived. For example, POST /agent/v1/agents/{agent_id}/versions/2/apply with no body.",
|
|
801
|
+
"http": "POST",
|
|
802
|
+
"path": "/agent/v1/agents/{agent_id}/versions/{version}/apply",
|
|
803
|
+
"streaming": "no",
|
|
804
|
+
"pagination": false,
|
|
805
|
+
"pathParams": [
|
|
806
|
+
{
|
|
807
|
+
"name": "agent_id",
|
|
808
|
+
"sdkName": "agent_id"
|
|
809
|
+
},
|
|
810
|
+
{
|
|
811
|
+
"name": "version",
|
|
812
|
+
"sdkName": "version"
|
|
813
|
+
}
|
|
814
|
+
],
|
|
815
|
+
"query": []
|
|
816
|
+
},
|
|
594
817
|
{
|
|
595
818
|
"resource": "agent.computers",
|
|
596
819
|
"method": "list",
|
|
597
|
-
"summary": "
|
|
598
|
-
"description": "
|
|
820
|
+
"summary": "List Computers",
|
|
821
|
+
"description": "List the computers of your organization, archived ones included.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
599
822
|
"http": "GET",
|
|
600
823
|
"path": "/agent/v1/computers",
|
|
601
824
|
"streaming": "no",
|
|
@@ -619,8 +842,8 @@ export const operations = [
|
|
|
619
842
|
{
|
|
620
843
|
"resource": "agent.computers",
|
|
621
844
|
"method": "create",
|
|
622
|
-
"summary": "
|
|
623
|
-
"description": "
|
|
845
|
+
"summary": "Create Computer",
|
|
846
|
+
"description": "Create a durable computer: a named machine whose files outlive sessions, for personal agents.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
624
847
|
"http": "POST",
|
|
625
848
|
"path": "/agent/v1/computers",
|
|
626
849
|
"streaming": "no",
|
|
@@ -665,8 +888,8 @@ export const operations = [
|
|
|
665
888
|
{
|
|
666
889
|
"resource": "agent.computers",
|
|
667
890
|
"method": "retrieve",
|
|
668
|
-
"summary": "
|
|
669
|
-
"description": "
|
|
891
|
+
"summary": "Get Computer",
|
|
892
|
+
"description": "Read one computer's status, storage use and sandbox id.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
670
893
|
"http": "GET",
|
|
671
894
|
"path": "/agent/v1/computers/{computer_id}",
|
|
672
895
|
"streaming": "no",
|
|
@@ -682,8 +905,8 @@ export const operations = [
|
|
|
682
905
|
{
|
|
683
906
|
"resource": "agent.computers",
|
|
684
907
|
"method": "update",
|
|
685
|
-
"summary": "
|
|
686
|
-
"description": "
|
|
908
|
+
"summary": "Update Computer",
|
|
909
|
+
"description": "Rename a computer.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
687
910
|
"http": "POST",
|
|
688
911
|
"path": "/agent/v1/computers/{computer_id}",
|
|
689
912
|
"streaming": "no",
|
|
@@ -710,8 +933,8 @@ export const operations = [
|
|
|
710
933
|
{
|
|
711
934
|
"resource": "agent.computers",
|
|
712
935
|
"method": "archive",
|
|
713
|
-
"summary": "
|
|
714
|
-
"description": "
|
|
936
|
+
"summary": "Archive Computer",
|
|
937
|
+
"description": "Archive a computer: its files stay readable but new sessions cannot use it.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
715
938
|
"http": "POST",
|
|
716
939
|
"path": "/agent/v1/computers/{computer_id}/archive",
|
|
717
940
|
"streaming": "no",
|
|
@@ -756,7 +979,7 @@ export const operations = [
|
|
|
756
979
|
"resource": "agent.computers",
|
|
757
980
|
"method": "connect",
|
|
758
981
|
"summary": "Connect computer",
|
|
759
|
-
"description": "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy.
|
|
982
|
+
"description": "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy. Renew the lease while using the connection and release it with DELETE when finished.",
|
|
760
983
|
"http": "POST",
|
|
761
984
|
"path": "/agent/v1/computers/{computer_id}/connect",
|
|
762
985
|
"streaming": "no",
|
|
@@ -787,8 +1010,8 @@ export const operations = [
|
|
|
787
1010
|
{
|
|
788
1011
|
"resource": "agent.computers.files",
|
|
789
1012
|
"method": "list",
|
|
790
|
-
"summary": "
|
|
791
|
-
"description": "
|
|
1013
|
+
"summary": "List Computer Files",
|
|
1014
|
+
"description": "List the entries of one directory on a computer.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
792
1015
|
"http": "GET",
|
|
793
1016
|
"path": "/agent/v1/computers/{computer_id}/files",
|
|
794
1017
|
"streaming": "no",
|
|
@@ -811,8 +1034,8 @@ export const operations = [
|
|
|
811
1034
|
{
|
|
812
1035
|
"resource": "agent.computers.files",
|
|
813
1036
|
"method": "retrieveContent",
|
|
814
|
-
"summary": "
|
|
815
|
-
"description": "
|
|
1037
|
+
"summary": "Get Computer File Content",
|
|
1038
|
+
"description": "Download the bytes of one file on a computer, up to 16 MiB, with single-range support.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
816
1039
|
"http": "GET",
|
|
817
1040
|
"path": "/agent/v1/computers/{computer_id}/files/content",
|
|
818
1041
|
"streaming": "no",
|
|
@@ -1527,7 +1750,7 @@ export const operations = [
|
|
|
1527
1750
|
"resource": "agent.environments",
|
|
1528
1751
|
"method": "create",
|
|
1529
1752
|
"summary": "Create environment",
|
|
1530
|
-
"description": "Create a tenant-owned cloud environment: a sandbox recipe (packages to install and networking policy) that sessions can select through environment_id. Package installation happens when the session's sandbox is created; a failed install terminates that session with ENVIRONMENT_PACKAGE_INSTALL_FAILED. Limited networking is applied at sandbox creation. Unlike Anthropic Managed Agents, self_hosted environments, scope and cross-session package caching are not supported.",
|
|
1753
|
+
"description": "Create a tenant-owned cloud environment: a sandbox recipe (packages to install and networking policy) that sessions can select through environment_id. Package installation happens when the session's sandbox is created; a failed install terminates that session with ENVIRONMENT_PACKAGE_INSTALL_FAILED. Limited networking is applied at sandbox creation. Unlike Anthropic Managed Agents, self_hosted environments, scope and cross-session package caching are not supported. config.template must name an available sandbox template, otherwise 400 lists the available ones.",
|
|
1531
1754
|
"http": "POST",
|
|
1532
1755
|
"path": "/agent/v1/environments",
|
|
1533
1756
|
"streaming": "no",
|
|
@@ -1560,16 +1783,6 @@ export const operations = [
|
|
|
1560
1783
|
"type": "object",
|
|
1561
1784
|
"required": false,
|
|
1562
1785
|
"description": "Free-form string key/value pairs."
|
|
1563
|
-
},
|
|
1564
|
-
{
|
|
1565
|
-
"name": "scope",
|
|
1566
|
-
"type": "string",
|
|
1567
|
-
"enum": [
|
|
1568
|
-
"organization",
|
|
1569
|
-
"account"
|
|
1570
|
-
],
|
|
1571
|
-
"required": false,
|
|
1572
|
-
"description": "The visibility scope for this environment. 'organization' makes the\nenvironment visible to all accounts. 'account' restricts visibility to the\nowning account only. API organizations support only 'organization'; 'account' is\nrejected. If not specified, defaults based on organization type."
|
|
1573
1786
|
}
|
|
1574
1787
|
]
|
|
1575
1788
|
}
|
|
@@ -1595,7 +1808,7 @@ export const operations = [
|
|
|
1595
1808
|
"resource": "agent.environments",
|
|
1596
1809
|
"method": "update",
|
|
1597
1810
|
"summary": "Update environment",
|
|
1598
|
-
"description": "Update the configuration of a tenant-owned cloud environment. Built-in environments are read-only. Package installation and limited networking are applied when a session's sandbox is created. Omitted fields keep their value.",
|
|
1811
|
+
"description": "Update the configuration of a tenant-owned cloud environment. Built-in environments are read-only. Package installation and limited networking are applied when a session's sandbox is created. Omitted fields keep their value. A changed config.template must name an available sandbox template, otherwise 400 lists the available ones.",
|
|
1599
1812
|
"http": "POST",
|
|
1600
1813
|
"path": "/agent/v1/environments/{environment_id}",
|
|
1601
1814
|
"streaming": "no",
|
|
@@ -1633,16 +1846,6 @@ export const operations = [
|
|
|
1633
1846
|
"type": "string",
|
|
1634
1847
|
"required": false,
|
|
1635
1848
|
"description": "Updated name for the environment"
|
|
1636
|
-
},
|
|
1637
|
-
{
|
|
1638
|
-
"name": "scope",
|
|
1639
|
-
"type": "string",
|
|
1640
|
-
"enum": [
|
|
1641
|
-
"organization",
|
|
1642
|
-
"account"
|
|
1643
|
-
],
|
|
1644
|
-
"required": false,
|
|
1645
|
-
"description": "The visibility scope for this environment. 'organization' makes the\nenvironment visible to all accounts. 'account' restricts visibility to the\nowning account only."
|
|
1646
1849
|
}
|
|
1647
1850
|
]
|
|
1648
1851
|
}
|
|
@@ -1651,7 +1854,7 @@ export const operations = [
|
|
|
1651
1854
|
"resource": "agent.environments",
|
|
1652
1855
|
"method": "archive",
|
|
1653
1856
|
"summary": "Archive environment",
|
|
1654
|
-
"description": "Soft-archive a tenant-owned cloud environment so it can no longer be used to create new sessions. Built-in environments are read-only and cannot be archived.",
|
|
1857
|
+
"description": "Soft-archive a tenant-owned cloud environment so it can no longer be used to create new sessions. Built-in environments are read-only and cannot be archived. An environment that the active version of a non-archived agent uses as environment_id returns 409 RESOURCE_IN_USE naming the agents; point them at another environment first.",
|
|
1655
1858
|
"http": "POST",
|
|
1656
1859
|
"path": "/agent/v1/environments/{environment_id}/archive",
|
|
1657
1860
|
"streaming": "no",
|
|
@@ -1668,7 +1871,7 @@ export const operations = [
|
|
|
1668
1871
|
"resource": "agent.sessions",
|
|
1669
1872
|
"method": "list",
|
|
1670
1873
|
"summary": "List sessions",
|
|
1671
|
-
"description": "List sessions of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Unlike Anthropic Managed Agents, only limit, page, agent_id and
|
|
1874
|
+
"description": "List sessions of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Archived sessions are hidden unless include_archived is true. Unlike Anthropic Managed Agents, only limit, page, agent_id, deployment_id and include_archived are honored; the other filters declared here (agent_version, created_at ranges, memory_store_id, order, statuses) are not supported and return 400. Use the returned id with sessions.retrieve or sessions.events.list; pass next_page as page for the next page.",
|
|
1672
1875
|
"http": "GET",
|
|
1673
1876
|
"path": "/agent/v1/sessions",
|
|
1674
1877
|
"streaming": "no",
|
|
@@ -1697,7 +1900,7 @@ export const operations = [
|
|
|
1697
1900
|
"name": "created_at[gte]",
|
|
1698
1901
|
"type": "string",
|
|
1699
1902
|
"required": false,
|
|
1700
|
-
"description": "Created-at lower bound for sessions. Declared by the Managed Agents shape but not supported here: sessions.list honors only limit, page, agent_id and
|
|
1903
|
+
"description": "Created-at lower bound for sessions. Declared by the Managed Agents shape but not supported here: sessions.list honors only limit, page, agent_id, deployment_id and include_archived, and other filters return 400."
|
|
1701
1904
|
},
|
|
1702
1905
|
{
|
|
1703
1906
|
"name": "created_at[lt]",
|
|
@@ -1709,7 +1912,7 @@ export const operations = [
|
|
|
1709
1912
|
"name": "created_at[lte]",
|
|
1710
1913
|
"type": "string",
|
|
1711
1914
|
"required": false,
|
|
1712
|
-
"description": "Created-at upper bound for sessions. Declared by the Managed Agents shape but not supported here: sessions.list honors only limit, page, agent_id and
|
|
1915
|
+
"description": "Created-at upper bound for sessions. Declared by the Managed Agents shape but not supported here: sessions.list honors only limit, page, agent_id, deployment_id and include_archived, and other filters return 400."
|
|
1713
1916
|
},
|
|
1714
1917
|
{
|
|
1715
1918
|
"name": "deployment_id",
|
|
@@ -1725,7 +1928,7 @@ export const operations = [
|
|
|
1725
1928
|
true
|
|
1726
1929
|
],
|
|
1727
1930
|
"required": false,
|
|
1728
|
-
"description": "
|
|
1931
|
+
"description": "Whether archived sessions are listed: true includes them, false (the default) hides them. A value other than true or false returns 400. Archived sessions stay retrievable by id either way."
|
|
1729
1932
|
},
|
|
1730
1933
|
{
|
|
1731
1934
|
"name": "memory_store_id",
|
|
@@ -1793,7 +1996,7 @@ export const operations = [
|
|
|
1793
1996
|
"resource": "agent.sessions",
|
|
1794
1997
|
"method": "create",
|
|
1795
1998
|
"summary": "Create session",
|
|
1796
|
-
"description": "Create a session: one conversation with an agent
|
|
1999
|
+
"description": "Create a session: one conversation with an agent. Pass agent as an agent id or {type:\"agent\", id, version?}; an id alone, or an object without version, pins the agent's active_version (the version chosen with agents.versions.apply, not necessarily the newest saved one). Unlike Anthropic Managed Agents, omit environment_id to use the default environment saved in the agent version (light for a new agent), unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Unlike Anthropic Managed Agents, the only inline agent override is system ({type:\"agent_with_overrides\", id, system}); to change the model, tools, MCP servers or skills, save a version instead. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. budget is {type:\"limit\", max_list_cost:{amount, currency:\"USD\"}} where amount is a positive integer string of US cents (\"2000\" is USD 20.00); omitted budget defaults to \"2000\" and null removes the limit. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.",
|
|
1797
2000
|
"http": "POST",
|
|
1798
2001
|
"path": "/agent/v1/sessions",
|
|
1799
2002
|
"streaming": "no",
|
|
@@ -1807,19 +2010,19 @@ export const operations = [
|
|
|
1807
2010
|
"name": "agent",
|
|
1808
2011
|
"type": "object",
|
|
1809
2012
|
"required": true,
|
|
1810
|
-
"description": "
|
|
2013
|
+
"description": "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."
|
|
1811
2014
|
},
|
|
1812
2015
|
{
|
|
1813
2016
|
"name": "environment_id",
|
|
1814
2017
|
"type": "string",
|
|
1815
2018
|
"required": false,
|
|
1816
|
-
"description": "
|
|
2019
|
+
"description": "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."
|
|
1817
2020
|
},
|
|
1818
2021
|
{
|
|
1819
2022
|
"name": "budget",
|
|
1820
2023
|
"type": "object",
|
|
1821
2024
|
"required": false,
|
|
1822
|
-
"description": "Session spending limit
|
|
2025
|
+
"description": "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."
|
|
1823
2026
|
},
|
|
1824
2027
|
{
|
|
1825
2028
|
"name": "initial_events",
|
|
@@ -1940,12 +2143,6 @@ export const operations = [
|
|
|
1940
2143
|
"body": {
|
|
1941
2144
|
"required": true,
|
|
1942
2145
|
"fields": [
|
|
1943
|
-
{
|
|
1944
|
-
"name": "agent",
|
|
1945
|
-
"type": "object",
|
|
1946
|
-
"required": false,
|
|
1947
|
-
"description": "Agent definition the session uses after the change; null when unchanged."
|
|
1948
|
-
},
|
|
1949
2146
|
{
|
|
1950
2147
|
"name": "budget",
|
|
1951
2148
|
"type": "object",
|
|
@@ -2680,68 +2877,287 @@ export const operations = [
|
|
|
2680
2877
|
]
|
|
2681
2878
|
},
|
|
2682
2879
|
{
|
|
2683
|
-
"resource": "agent.
|
|
2880
|
+
"resource": "agent.skills",
|
|
2684
2881
|
"method": "list",
|
|
2685
|
-
"summary": "List
|
|
2686
|
-
"description": "
|
|
2882
|
+
"summary": "List skills",
|
|
2883
|
+
"description": "List the skills uploaded to your organization, newest first, in pages of at most 100 (default 20). Use it to find a skill id before reading, versioning or deleting it. Only source=custom has content; source=anthropic returns an empty list. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
2687
2884
|
"http": "GET",
|
|
2688
|
-
"path": "/agent/v1/
|
|
2885
|
+
"path": "/agent/v1/skills",
|
|
2689
2886
|
"streaming": "no",
|
|
2690
2887
|
"pagination": false,
|
|
2691
2888
|
"pathParams": [],
|
|
2692
|
-
"query": [
|
|
2889
|
+
"query": [
|
|
2890
|
+
{
|
|
2891
|
+
"name": "source",
|
|
2892
|
+
"type": "string",
|
|
2893
|
+
"required": false,
|
|
2894
|
+
"description": "Filter skills by source.\n\nIf provided, only skills from the specified source will be returned:\n\n- `\"custom\"`: only return user-created skills\n- `\"anthropic\"`: only return Anthropic-created skills"
|
|
2895
|
+
},
|
|
2896
|
+
{
|
|
2897
|
+
"name": "limit",
|
|
2898
|
+
"type": "number",
|
|
2899
|
+
"required": false,
|
|
2900
|
+
"description": "Number of items per page."
|
|
2901
|
+
},
|
|
2902
|
+
{
|
|
2903
|
+
"name": "page",
|
|
2904
|
+
"type": "string",
|
|
2905
|
+
"required": false,
|
|
2906
|
+
"description": "Opaque pagination cursor: pass the next_page value of the previous response unchanged. Omit it for the first page. A cursor from a different query or a malformed one returns 400."
|
|
2907
|
+
}
|
|
2908
|
+
]
|
|
2693
2909
|
},
|
|
2694
2910
|
{
|
|
2695
|
-
"resource": "
|
|
2911
|
+
"resource": "agent.skills",
|
|
2696
2912
|
"method": "create",
|
|
2697
|
-
"summary": "
|
|
2698
|
-
"description": "Upload
|
|
2913
|
+
"summary": "Create skill",
|
|
2914
|
+
"description": "Upload a skill: a directory that contains SKILL.md, which the agent reads when it needs the skill. Send multipart/form-data with one files part per file, each file name being its path under one top-level directory (pdf/SKILL.md, pdf/scripts/run.py), and an optional display_name. SKILL.md frontmatter needs a description; name defaults to the directory name and must be one folder name (1-255 characters, no \"/\", backslash or NUL, not \".\" or \"..\"), otherwise the upload returns 400 stating the allowed form. Limits: 8 MB in total, at most 200 files, no .. segments, absolute paths or empty names; a violation returns 400 naming the path or field. The upload creates the skill and its first version, and versions are immutable. Attach the skill to an agent with `skills` on the agent.",
|
|
2699
2915
|
"http": "POST",
|
|
2700
|
-
"path": "/
|
|
2916
|
+
"path": "/agent/v1/skills",
|
|
2701
2917
|
"streaming": "no",
|
|
2702
2918
|
"pagination": false,
|
|
2919
|
+
"multipart": true,
|
|
2703
2920
|
"pathParams": [],
|
|
2704
2921
|
"query": [],
|
|
2705
2922
|
"body": {
|
|
2706
2923
|
"required": true,
|
|
2707
2924
|
"fields": [
|
|
2708
2925
|
{
|
|
2709
|
-
"name": "
|
|
2710
|
-
"type": "
|
|
2926
|
+
"name": "files",
|
|
2927
|
+
"type": "array",
|
|
2928
|
+
"itemType": "string",
|
|
2711
2929
|
"required": true,
|
|
2712
|
-
"description": "
|
|
2930
|
+
"description": "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory."
|
|
2713
2931
|
},
|
|
2714
2932
|
{
|
|
2715
|
-
"name": "
|
|
2716
|
-
"type": "
|
|
2717
|
-
"required":
|
|
2718
|
-
"description": "
|
|
2933
|
+
"name": "display_name",
|
|
2934
|
+
"type": "string",
|
|
2935
|
+
"required": false,
|
|
2936
|
+
"description": "Human-readable, single-line label for the Skill. Maximum 255\ncharacters. Always set: derived from the SKILL.md frontmatter `name` when\nomitted at creation. Not unique."
|
|
2719
2937
|
}
|
|
2720
2938
|
]
|
|
2721
2939
|
}
|
|
2722
2940
|
},
|
|
2723
2941
|
{
|
|
2724
|
-
"resource": "
|
|
2725
|
-
"method": "
|
|
2726
|
-
"summary": "
|
|
2727
|
-
"description": "
|
|
2728
|
-
"http": "
|
|
2729
|
-
"path": "/
|
|
2942
|
+
"resource": "agent.skills",
|
|
2943
|
+
"method": "delete",
|
|
2944
|
+
"summary": "Delete skill",
|
|
2945
|
+
"description": "Delete a skill together with all of its versions. A skill that is still attached to an agent returns 409 RESOURCE_IN_USE naming up to 10 agent ids (the active or latest version of a non-archived agent counts); remove it from those agents first. Returns {id, type: skill_deleted}. skill_id comes from skills.create or skills.list.",
|
|
2946
|
+
"http": "DELETE",
|
|
2947
|
+
"path": "/agent/v1/skills/{skill_id}",
|
|
2730
2948
|
"streaming": "no",
|
|
2731
2949
|
"pagination": false,
|
|
2732
|
-
"pathParams": [
|
|
2950
|
+
"pathParams": [
|
|
2951
|
+
{
|
|
2952
|
+
"name": "skill_id",
|
|
2953
|
+
"sdkName": "skill_id"
|
|
2954
|
+
}
|
|
2955
|
+
],
|
|
2733
2956
|
"query": []
|
|
2734
2957
|
},
|
|
2735
2958
|
{
|
|
2736
|
-
"resource": "
|
|
2737
|
-
"method": "
|
|
2738
|
-
"summary": "
|
|
2739
|
-
"description": "
|
|
2740
|
-
"http": "
|
|
2741
|
-
"path": "/
|
|
2959
|
+
"resource": "agent.skills",
|
|
2960
|
+
"method": "retrieve",
|
|
2961
|
+
"summary": "Get skill",
|
|
2962
|
+
"description": "Read one skill by id: its display_name, source and latest_version_id. skill_id comes from skills.create or skills.list. A skill of another organization, or a deleted one, returns 404 Skill not found.",
|
|
2963
|
+
"http": "GET",
|
|
2964
|
+
"path": "/agent/v1/skills/{skill_id}",
|
|
2742
2965
|
"streaming": "no",
|
|
2743
2966
|
"pagination": false,
|
|
2744
|
-
"pathParams": [
|
|
2967
|
+
"pathParams": [
|
|
2968
|
+
{
|
|
2969
|
+
"name": "skill_id",
|
|
2970
|
+
"sdkName": "skill_id"
|
|
2971
|
+
}
|
|
2972
|
+
],
|
|
2973
|
+
"query": []
|
|
2974
|
+
},
|
|
2975
|
+
{
|
|
2976
|
+
"resource": "agent.skills.versions",
|
|
2977
|
+
"method": "list",
|
|
2978
|
+
"summary": "List skill versions",
|
|
2979
|
+
"description": "List the live versions of one skill, newest first, in pages of at most 100 (default 20). Each item carries the name and description read from the SKILL.md of that version. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
2980
|
+
"http": "GET",
|
|
2981
|
+
"path": "/agent/v1/skills/{skill_id}/versions",
|
|
2982
|
+
"streaming": "no",
|
|
2983
|
+
"pagination": false,
|
|
2984
|
+
"pathParams": [
|
|
2985
|
+
{
|
|
2986
|
+
"name": "skill_id",
|
|
2987
|
+
"sdkName": "skill_id"
|
|
2988
|
+
}
|
|
2989
|
+
],
|
|
2990
|
+
"query": [
|
|
2991
|
+
{
|
|
2992
|
+
"name": "limit",
|
|
2993
|
+
"type": "number",
|
|
2994
|
+
"required": false,
|
|
2995
|
+
"description": "Number of items per page."
|
|
2996
|
+
},
|
|
2997
|
+
{
|
|
2998
|
+
"name": "page",
|
|
2999
|
+
"type": "string",
|
|
3000
|
+
"required": false,
|
|
3001
|
+
"description": "Opaque pagination cursor: pass the next_page value of the previous response unchanged. Omit it for the first page. A cursor from a different query or a malformed one returns 400."
|
|
3002
|
+
}
|
|
3003
|
+
]
|
|
3004
|
+
},
|
|
3005
|
+
{
|
|
3006
|
+
"resource": "agent.skills.versions",
|
|
3007
|
+
"method": "create",
|
|
3008
|
+
"summary": "Create skill version",
|
|
3009
|
+
"description": "Upload a new version of a skill with the same multipart/form-data shape and limits as skills.create (8 MB, 200 files, one top-level directory containing SKILL.md). The SKILL.md name must equal the name of the skill; a different name returns 400. The new version becomes latest_version_id of the skill, and earlier versions stay unchanged because versions are immutable. Attach it to an agent with `skills` on the agent.",
|
|
3010
|
+
"http": "POST",
|
|
3011
|
+
"path": "/agent/v1/skills/{skill_id}/versions",
|
|
3012
|
+
"streaming": "no",
|
|
3013
|
+
"pagination": false,
|
|
3014
|
+
"multipart": true,
|
|
3015
|
+
"pathParams": [
|
|
3016
|
+
{
|
|
3017
|
+
"name": "skill_id",
|
|
3018
|
+
"sdkName": "skill_id"
|
|
3019
|
+
}
|
|
3020
|
+
],
|
|
3021
|
+
"query": [],
|
|
3022
|
+
"body": {
|
|
3023
|
+
"required": true,
|
|
3024
|
+
"fields": [
|
|
3025
|
+
{
|
|
3026
|
+
"name": "files",
|
|
3027
|
+
"type": "array",
|
|
3028
|
+
"itemType": "string",
|
|
3029
|
+
"required": true,
|
|
3030
|
+
"description": "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory."
|
|
3031
|
+
}
|
|
3032
|
+
]
|
|
3033
|
+
}
|
|
3034
|
+
},
|
|
3035
|
+
{
|
|
3036
|
+
"resource": "agent.skills.versions",
|
|
3037
|
+
"method": "delete",
|
|
3038
|
+
"summary": "Delete skill version",
|
|
3039
|
+
"description": "Soft-delete one version of a skill so it can no longer be read or downloaded; latest_version_id of the skill falls back to the newest remaining version. Returns {id, type: skill_version_deleted}. A skill keeps at least one version: deleting the last remaining version returns 409 SKILL_LAST_VERSION (delete the skill instead), so latest_version_id is never null. A version that a non-archived agent pins returns 409 RESOURCE_IN_USE naming the agents.",
|
|
3040
|
+
"http": "DELETE",
|
|
3041
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}",
|
|
3042
|
+
"streaming": "no",
|
|
3043
|
+
"pagination": false,
|
|
3044
|
+
"pathParams": [
|
|
3045
|
+
{
|
|
3046
|
+
"name": "skill_id",
|
|
3047
|
+
"sdkName": "skill_id"
|
|
3048
|
+
},
|
|
3049
|
+
{
|
|
3050
|
+
"name": "version",
|
|
3051
|
+
"sdkName": "version"
|
|
3052
|
+
}
|
|
3053
|
+
],
|
|
3054
|
+
"query": []
|
|
3055
|
+
},
|
|
3056
|
+
{
|
|
3057
|
+
"resource": "agent.skills.versions",
|
|
3058
|
+
"method": "retrieve",
|
|
3059
|
+
"summary": "Get skill version",
|
|
3060
|
+
"description": "Read one version of a skill: its name, description and created_at as read from SKILL.md. version is the id returned by skills.versions.create or skills.versions.list. A deleted or unknown version returns 404 Skill version not found.",
|
|
3061
|
+
"http": "GET",
|
|
3062
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}",
|
|
3063
|
+
"streaming": "no",
|
|
3064
|
+
"pagination": false,
|
|
3065
|
+
"pathParams": [
|
|
3066
|
+
{
|
|
3067
|
+
"name": "skill_id",
|
|
3068
|
+
"sdkName": "skill_id"
|
|
3069
|
+
},
|
|
3070
|
+
{
|
|
3071
|
+
"name": "version",
|
|
3072
|
+
"sdkName": "version"
|
|
3073
|
+
}
|
|
3074
|
+
],
|
|
3075
|
+
"query": []
|
|
3076
|
+
},
|
|
3077
|
+
{
|
|
3078
|
+
"resource": "agent.skills.versions",
|
|
3079
|
+
"method": "retrieveContent",
|
|
3080
|
+
"summary": "Download skill version",
|
|
3081
|
+
"description": "Download the content of one version as a zip archive (application/zip): the uploaded directory with its top-level folder and every file. version is the id returned by skills.versions.create or skills.versions.list; a deleted version returns 404.",
|
|
3082
|
+
"http": "GET",
|
|
3083
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}/content",
|
|
3084
|
+
"streaming": "no",
|
|
3085
|
+
"pagination": false,
|
|
3086
|
+
"pathParams": [
|
|
3087
|
+
{
|
|
3088
|
+
"name": "skill_id",
|
|
3089
|
+
"sdkName": "skill_id"
|
|
3090
|
+
},
|
|
3091
|
+
{
|
|
3092
|
+
"name": "version",
|
|
3093
|
+
"sdkName": "version"
|
|
3094
|
+
}
|
|
3095
|
+
],
|
|
3096
|
+
"query": []
|
|
3097
|
+
},
|
|
3098
|
+
{
|
|
3099
|
+
"resource": "agent.toolsets",
|
|
3100
|
+
"method": "list",
|
|
3101
|
+
"summary": "List Toolsets",
|
|
3102
|
+
"description": "Discover tool names, input schemas, read-only status and default permission policies before configuring an agent. The catalog is read-only: enable tools through agents.create or agents.update. agent_toolset_20260401 includes bash, edit, glob, grep, read, write, web_search, web_fetch, task_output, task_stop, monitor, agent, send_message, codemode and skill, plus todo_write, enter_plan_mode, ask_user_question and goal_read, which are listed so they can be switched off. Native additions require bash enabled; codemode requires bash (enabling it with bash disabled returns 400; keep bash enabled with permission_policy always_ask to restrict it); send_message also requires agent. To keep only some tools, set default_config.enabled to false and enable the wanted tools in configs; unlisted tools follow default_config. The catalog includes plugin names and versions. Sessions created through /anthropic/v1 expose only the eight official tools.",
|
|
3103
|
+
"http": "GET",
|
|
3104
|
+
"path": "/agent/v1/toolsets",
|
|
3105
|
+
"streaming": "no",
|
|
3106
|
+
"pagination": false,
|
|
3107
|
+
"pathParams": [],
|
|
3108
|
+
"query": []
|
|
3109
|
+
},
|
|
3110
|
+
{
|
|
3111
|
+
"resource": "application.assets.upload",
|
|
3112
|
+
"method": "create",
|
|
3113
|
+
"summary": "Upload assets",
|
|
3114
|
+
"description": "Upload one batch: files maps hash to base64 content. The last batch returns the completion token.",
|
|
3115
|
+
"http": "POST",
|
|
3116
|
+
"path": "/application/v1/assets/upload",
|
|
3117
|
+
"streaming": "no",
|
|
3118
|
+
"pagination": false,
|
|
3119
|
+
"pathParams": [],
|
|
3120
|
+
"query": [],
|
|
3121
|
+
"body": {
|
|
3122
|
+
"required": true,
|
|
3123
|
+
"fields": [
|
|
3124
|
+
{
|
|
3125
|
+
"name": "jwt",
|
|
3126
|
+
"type": "string",
|
|
3127
|
+
"required": true,
|
|
3128
|
+
"description": "Upload token from the session."
|
|
3129
|
+
},
|
|
3130
|
+
{
|
|
3131
|
+
"name": "files",
|
|
3132
|
+
"type": "object",
|
|
3133
|
+
"required": true,
|
|
3134
|
+
"description": "Hash → base64 file content."
|
|
3135
|
+
}
|
|
3136
|
+
]
|
|
3137
|
+
}
|
|
3138
|
+
},
|
|
3139
|
+
{
|
|
3140
|
+
"resource": "application.subdomain",
|
|
3141
|
+
"method": "retrieve",
|
|
3142
|
+
"summary": "Get account subdomain",
|
|
3143
|
+
"description": "Return the account subdomain used in every Worker URL. A default is created on first use.",
|
|
3144
|
+
"http": "GET",
|
|
3145
|
+
"path": "/application/v1/subdomain",
|
|
3146
|
+
"streaming": "no",
|
|
3147
|
+
"pagination": false,
|
|
3148
|
+
"pathParams": [],
|
|
3149
|
+
"query": []
|
|
3150
|
+
},
|
|
3151
|
+
{
|
|
3152
|
+
"resource": "application.subdomain",
|
|
3153
|
+
"method": "update",
|
|
3154
|
+
"summary": "Change account subdomain",
|
|
3155
|
+
"description": "Change the account subdomain. Every Worker moves to the new address at once; old addresses stop resolving.",
|
|
3156
|
+
"http": "PUT",
|
|
3157
|
+
"path": "/application/v1/subdomain",
|
|
3158
|
+
"streaming": "no",
|
|
3159
|
+
"pagination": false,
|
|
3160
|
+
"pathParams": [],
|
|
2745
3161
|
"query": [],
|
|
2746
3162
|
"body": {
|
|
2747
3163
|
"required": true,
|
|
@@ -3521,13 +3937,13 @@ export const operations = [
|
|
|
3521
3937
|
"name": "namespace",
|
|
3522
3938
|
"type": "string",
|
|
3523
3939
|
"required": true,
|
|
3524
|
-
"description": "Choose a namespace without prior registration; praxis is
|
|
3940
|
+
"description": "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
3525
3941
|
},
|
|
3526
3942
|
{
|
|
3527
3943
|
"name": "name",
|
|
3528
3944
|
"type": "string",
|
|
3529
3945
|
"required": true,
|
|
3530
|
-
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
3946
|
+
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
3531
3947
|
},
|
|
3532
3948
|
{
|
|
3533
3949
|
"name": "description",
|
|
@@ -3590,8 +4006,8 @@ export const operations = [
|
|
|
3590
4006
|
{
|
|
3591
4007
|
"resource": "automation.actions",
|
|
3592
4008
|
"method": "retrieve",
|
|
3593
|
-
"summary": "Get an
|
|
3594
|
-
"description": "Read the
|
|
4009
|
+
"summary": "Get an Action with its current input and output JSON Schemas",
|
|
4010
|
+
"description": "Read the Action and its full current implementation, with input and output JSON Schemas at current_revision.input_schema and current_revision.output_schema. To read a built-in Action, use ns=praxis and name=<bare name>, for example name=ocr; invoke it in a script with call(\"ocr\", input). The response ETag is the current revision ID for conditional updates.",
|
|
3595
4011
|
"http": "GET",
|
|
3596
4012
|
"path": "/automation/v1/actions/{ns}/{name}",
|
|
3597
4013
|
"streaming": "no",
|
|
@@ -4165,8 +4581,8 @@ export const operations = [
|
|
|
4165
4581
|
{
|
|
4166
4582
|
"resource": "automation.runs",
|
|
4167
4583
|
"method": "create",
|
|
4168
|
-
"summary": "
|
|
4169
|
-
"description": "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. New non-deterministic run IDs contain 78 characters
|
|
4584
|
+
"summary": "Run a published target or execute draft source",
|
|
4585
|
+
"description": "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call(\"ocr\", { document: { type: \"file\", file_id } }); return result; }`; send it as source with language=\"ts\", input={\"file_id\":\"<uploaded file ID>\"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: \"glm-ocr\", document: { type: \"file\", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke(\"namespace/name\", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 30 s (run-sandbox after 10 min); scripts have a 5 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to 7 days. Each run can start at most 100 child runs, with at most 20 active at once; nesting depth is limited to 10. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. New non-deterministic run IDs contain 78 characters, compared with 46 for legacy random IDs; treat IDs as opaque strings. Historical and deterministic IDs remain valid; same-millisecond order is not guaranteed.",
|
|
4170
4586
|
"http": "POST",
|
|
4171
4587
|
"path": "/automation/v1/runs",
|
|
4172
4588
|
"streaming": "no",
|
|
@@ -4644,7 +5060,7 @@ export const operations = [
|
|
|
4644
5060
|
"resource": "automation.scripts",
|
|
4645
5061
|
"method": "create",
|
|
4646
5062
|
"summary": "Create a script",
|
|
4647
|
-
"description": "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is
|
|
5063
|
+
"description": "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. The draft is a source string with a default-exported function, for example `export default async (input: {name: string}) => ({greeting: \"Hello, \" + input.name});`. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist. To test it, pass that source and language=ts to praxis.automation.runs.create without publishing. To publish later, use the returned draft.revision as expected_draft_revision.",
|
|
4648
5064
|
"http": "POST",
|
|
4649
5065
|
"path": "/automation/v1/scripts",
|
|
4650
5066
|
"streaming": "no",
|
|
@@ -4658,13 +5074,13 @@ export const operations = [
|
|
|
4658
5074
|
"name": "namespace",
|
|
4659
5075
|
"type": "string",
|
|
4660
5076
|
"required": true,
|
|
4661
|
-
"description": "Choose a namespace without prior registration; praxis is
|
|
5077
|
+
"description": "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
4662
5078
|
},
|
|
4663
5079
|
{
|
|
4664
5080
|
"name": "name",
|
|
4665
5081
|
"type": "string",
|
|
4666
5082
|
"required": true,
|
|
4667
|
-
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
5083
|
+
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
4668
5084
|
},
|
|
4669
5085
|
{
|
|
4670
5086
|
"name": "description",
|
|
@@ -4712,7 +5128,7 @@ export const operations = [
|
|
|
4712
5128
|
"resource": "automation.scripts",
|
|
4713
5129
|
"method": "update",
|
|
4714
5130
|
"summary": "Update a script draft",
|
|
4715
|
-
"description": "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.",
|
|
5131
|
+
"description": "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist.",
|
|
4716
5132
|
"http": "PATCH",
|
|
4717
5133
|
"path": "/automation/v1/scripts/{ns}/{name}",
|
|
4718
5134
|
"streaming": "no",
|
|
@@ -5666,7 +6082,7 @@ export const operations = [
|
|
|
5666
6082
|
"resource": "automation.workflows",
|
|
5667
6083
|
"method": "create",
|
|
5668
6084
|
"summary": "Create a workflow",
|
|
5669
|
-
"description": "Save a YAML workflow as an editable draft without publishing or starting a run. Choose your own namespace without registering it first; praxis is
|
|
6085
|
+
"description": "Save a YAML workflow as an editable draft without publishing or starting a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. To test the draft, send its source and language=yaml to praxis.automation.runs.create. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. run.workflow accepts ns/name@range or {namespace, name, version, input}; run.script uses the same reference shape as a platform extension. Object namespace, name and version are required; version accepts an exact version, dist-tag or range, locked at publication. Object input defaults to {} and supports expressions; string references retain task-level with. run.await defaults to true and returns the child output. With false, the child uses detach and the task immediately returns {run_id}; parent cancellation does not cascade. Inline script.code returns DEFINITION_INVALID with a detail asking you to save a script and reference it first. raise.error retains its type URI, status, title and detail in the run error.",
|
|
5670
6086
|
"http": "POST",
|
|
5671
6087
|
"path": "/automation/v1/workflows",
|
|
5672
6088
|
"streaming": "no",
|
|
@@ -5680,13 +6096,13 @@ export const operations = [
|
|
|
5680
6096
|
"name": "namespace",
|
|
5681
6097
|
"type": "string",
|
|
5682
6098
|
"required": true,
|
|
5683
|
-
"description": "Choose a namespace without prior registration; praxis is
|
|
6099
|
+
"description": "Choose a namespace without prior registration; praxis is reserved for built-in Actions. Folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
5684
6100
|
},
|
|
5685
6101
|
{
|
|
5686
6102
|
"name": "name",
|
|
5687
6103
|
"type": "string",
|
|
5688
6104
|
"required": true,
|
|
5689
|
-
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
6105
|
+
"description": "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}."
|
|
5690
6106
|
},
|
|
5691
6107
|
{
|
|
5692
6108
|
"name": "description",
|
|
@@ -6841,7 +7257,7 @@ export const operations = [
|
|
|
6841
7257
|
"name": "{column}",
|
|
6842
7258
|
"type": "string",
|
|
6843
7259
|
"required": false,
|
|
6844
|
-
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
7260
|
+
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported."
|
|
6845
7261
|
},
|
|
6846
7262
|
{
|
|
6847
7263
|
"name": "and",
|
|
@@ -6889,7 +7305,7 @@ export const operations = [
|
|
|
6889
7305
|
"name": "on_conflict",
|
|
6890
7306
|
"type": "string",
|
|
6891
7307
|
"required": false,
|
|
6892
|
-
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7308
|
+
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
6893
7309
|
},
|
|
6894
7310
|
{
|
|
6895
7311
|
"name": "columns",
|
|
@@ -6903,7 +7319,7 @@ export const operations = [
|
|
|
6903
7319
|
"resource": "database.databases.rest",
|
|
6904
7320
|
"method": "retrieve",
|
|
6905
7321
|
"summary": "Select rows",
|
|
6906
|
-
"description": "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property.
|
|
7322
|
+
"description": "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property. Use praxis.database.count in the SDK or codemode to return { count: number | null }; a page length is not a total unless you know all matches fit in that page.",
|
|
6907
7323
|
"http": "GET",
|
|
6908
7324
|
"path": "/database/v1/databases/{database_id}/rest/{table}",
|
|
6909
7325
|
"streaming": "no",
|
|
@@ -6929,7 +7345,7 @@ export const operations = [
|
|
|
6929
7345
|
"name": "{column}",
|
|
6930
7346
|
"type": "string",
|
|
6931
7347
|
"required": false,
|
|
6932
|
-
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
7348
|
+
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported."
|
|
6933
7349
|
},
|
|
6934
7350
|
{
|
|
6935
7351
|
"name": "and",
|
|
@@ -6977,7 +7393,7 @@ export const operations = [
|
|
|
6977
7393
|
"name": "on_conflict",
|
|
6978
7394
|
"type": "string",
|
|
6979
7395
|
"required": false,
|
|
6980
|
-
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7396
|
+
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
6981
7397
|
},
|
|
6982
7398
|
{
|
|
6983
7399
|
"name": "columns",
|
|
@@ -6991,7 +7407,7 @@ export const operations = [
|
|
|
6991
7407
|
"resource": "database.databases.rest",
|
|
6992
7408
|
"method": "head",
|
|
6993
7409
|
"summary": "Count rows",
|
|
6994
|
-
"description": "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode.
|
|
7410
|
+
"description": "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Use praxis.database.count in the SDK or codemode to return { count: number | null } from this header without retrieving rows.",
|
|
6995
7411
|
"http": "HEAD",
|
|
6996
7412
|
"path": "/database/v1/databases/{database_id}/rest/{table}",
|
|
6997
7413
|
"streaming": "no",
|
|
@@ -7017,7 +7433,7 @@ export const operations = [
|
|
|
7017
7433
|
"name": "{column}",
|
|
7018
7434
|
"type": "string",
|
|
7019
7435
|
"required": false,
|
|
7020
|
-
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
7436
|
+
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported."
|
|
7021
7437
|
},
|
|
7022
7438
|
{
|
|
7023
7439
|
"name": "and",
|
|
@@ -7065,7 +7481,7 @@ export const operations = [
|
|
|
7065
7481
|
"name": "on_conflict",
|
|
7066
7482
|
"type": "string",
|
|
7067
7483
|
"required": false,
|
|
7068
|
-
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7484
|
+
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7069
7485
|
},
|
|
7070
7486
|
{
|
|
7071
7487
|
"name": "columns",
|
|
@@ -7105,7 +7521,7 @@ export const operations = [
|
|
|
7105
7521
|
"name": "{column}",
|
|
7106
7522
|
"type": "string",
|
|
7107
7523
|
"required": false,
|
|
7108
|
-
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
7524
|
+
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported."
|
|
7109
7525
|
},
|
|
7110
7526
|
{
|
|
7111
7527
|
"name": "and",
|
|
@@ -7153,7 +7569,7 @@ export const operations = [
|
|
|
7153
7569
|
"name": "on_conflict",
|
|
7154
7570
|
"type": "string",
|
|
7155
7571
|
"required": false,
|
|
7156
|
-
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7572
|
+
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7157
7573
|
},
|
|
7158
7574
|
{
|
|
7159
7575
|
"name": "columns",
|
|
@@ -7171,7 +7587,7 @@ export const operations = [
|
|
|
7171
7587
|
"resource": "database.databases.rest",
|
|
7172
7588
|
"method": "create",
|
|
7173
7589
|
"summary": "Insert rows",
|
|
7174
|
-
"description": "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.",
|
|
7590
|
+
"description": "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.",
|
|
7175
7591
|
"http": "POST",
|
|
7176
7592
|
"path": "/database/v1/databases/{database_id}/rest/{table}",
|
|
7177
7593
|
"streaming": "no",
|
|
@@ -7197,7 +7613,7 @@ export const operations = [
|
|
|
7197
7613
|
"name": "{column}",
|
|
7198
7614
|
"type": "string",
|
|
7199
7615
|
"required": false,
|
|
7200
|
-
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
7616
|
+
"description": "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported."
|
|
7201
7617
|
},
|
|
7202
7618
|
{
|
|
7203
7619
|
"name": "and",
|
|
@@ -7245,7 +7661,7 @@ export const operations = [
|
|
|
7245
7661
|
"name": "on_conflict",
|
|
7246
7662
|
"type": "string",
|
|
7247
7663
|
"required": false,
|
|
7248
|
-
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7664
|
+
"description": "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id."
|
|
7249
7665
|
},
|
|
7250
7666
|
{
|
|
7251
7667
|
"name": "columns",
|
|
@@ -7297,7 +7713,7 @@ export const operations = [
|
|
|
7297
7713
|
"resource": "database.databases.tables",
|
|
7298
7714
|
"method": "create",
|
|
7299
7715
|
"summary": "Create table",
|
|
7300
|
-
"description": "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.",
|
|
7716
|
+
"description": "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.",
|
|
7301
7717
|
"http": "POST",
|
|
7302
7718
|
"path": "/database/v1/databases/{database_id}/tables",
|
|
7303
7719
|
"streaming": "no",
|
|
@@ -7418,7 +7834,7 @@ export const operations = [
|
|
|
7418
7834
|
"resource": "database.databases.tables.fields",
|
|
7419
7835
|
"method": "create",
|
|
7420
7836
|
"summary": "Add field",
|
|
7421
|
-
"description": "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row.
|
|
7837
|
+
"description": "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. JSON and link fields cannot be indexed. Limits: 64 fields and 16 indexed or unique fields per table (400 LIMIT_EXCEEDED). Unlike Supabase, schema evolution uses field definitions rather than ALTER TABLE statements or SQL migrations.",
|
|
7422
7838
|
"http": "POST",
|
|
7423
7839
|
"path": "/database/v1/databases/{database_id}/tables/{table}/fields",
|
|
7424
7840
|
"streaming": "no",
|
|
@@ -7587,7 +8003,7 @@ export const operations = [
|
|
|
7587
8003
|
"resource": "file.files",
|
|
7588
8004
|
"method": "create",
|
|
7589
8005
|
"summary": "Upload file",
|
|
7590
|
-
"description": "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most
|
|
8006
|
+
"description": "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–2592000), or praxis[expires_in_seconds] (3600–7776000), never both. Without expiry, the file persists until deleted.",
|
|
7591
8007
|
"http": "POST",
|
|
7592
8008
|
"path": "/file/v1/files",
|
|
7593
8009
|
"streaming": "no",
|
|
@@ -7602,7 +8018,7 @@ export const operations = [
|
|
|
7602
8018
|
"name": "file",
|
|
7603
8019
|
"type": "string",
|
|
7604
8020
|
"required": true,
|
|
7605
|
-
"description": "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most
|
|
8021
|
+
"description": "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most 100000000 bytes; its content determines the MIME type."
|
|
7606
8022
|
},
|
|
7607
8023
|
{
|
|
7608
8024
|
"name": "purpose",
|
|
@@ -7651,7 +8067,7 @@ export const operations = [
|
|
|
7651
8067
|
"resource": "file.files",
|
|
7652
8068
|
"method": "retrieve",
|
|
7653
8069
|
"summary": "Retrieve file",
|
|
7654
|
-
"description": "Retrieve metadata for a live file owned by your tenant. Use its
|
|
8070
|
+
"description": "Retrieve metadata for a live file owned by your tenant. Use its file- ID from upload or list. Missing, deleted, expired and other-tenant files return 404; use the content endpoint to download the bytes.",
|
|
7655
8071
|
"http": "GET",
|
|
7656
8072
|
"path": "/file/v1/files/{file_id}",
|
|
7657
8073
|
"streaming": "no",
|
|
@@ -7668,7 +8084,7 @@ export const operations = [
|
|
|
7668
8084
|
"resource": "file.files",
|
|
7669
8085
|
"method": "retrieveContent",
|
|
7670
8086
|
"summary": "Retrieve file content",
|
|
7671
|
-
"description": "Download the original bytes of a live file owned by your tenant. Supply its
|
|
8087
|
+
"description": "Download the original bytes of a live file owned by your tenant. Supply its file- ID from upload or list. A single byte Range can return a partial response; a range outside the file returns 416. Missing, deleted, expired and other-tenant files return 404.",
|
|
7672
8088
|
"http": "GET",
|
|
7673
8089
|
"path": "/file/v1/files/{file_id}/content",
|
|
7674
8090
|
"streaming": "no",
|
|
@@ -7682,63 +8098,12 @@ export const operations = [
|
|
|
7682
8098
|
"query": []
|
|
7683
8099
|
},
|
|
7684
8100
|
{
|
|
7685
|
-
"resource": "
|
|
7686
|
-
"method": "list",
|
|
7687
|
-
"summary": "List knowledge bases",
|
|
7688
|
-
"description": "Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.",
|
|
7689
|
-
"http": "GET",
|
|
7690
|
-
"path": "/knowledge/v1/vector_stores",
|
|
7691
|
-
"streaming": "no",
|
|
7692
|
-
"pagination": false,
|
|
7693
|
-
"pathParams": [],
|
|
7694
|
-
"query": [
|
|
7695
|
-
{
|
|
7696
|
-
"name": "status",
|
|
7697
|
-
"type": "string",
|
|
7698
|
-
"enum": [
|
|
7699
|
-
"active",
|
|
7700
|
-
"deleting"
|
|
7701
|
-
],
|
|
7702
|
-
"required": false,
|
|
7703
|
-
"description": "active selects active stores; deleting selects soft-deleted stores awaiting purge. Omission excludes soft-deleted stores."
|
|
7704
|
-
},
|
|
7705
|
-
{
|
|
7706
|
-
"name": "after",
|
|
7707
|
-
"type": "string",
|
|
7708
|
-
"required": false,
|
|
7709
|
-
"description": "Cursor ID from the previous page."
|
|
7710
|
-
},
|
|
7711
|
-
{
|
|
7712
|
-
"name": "before",
|
|
7713
|
-
"type": "string",
|
|
7714
|
-
"required": false,
|
|
7715
|
-
"description": "Return items before this ID."
|
|
7716
|
-
},
|
|
7717
|
-
{
|
|
7718
|
-
"name": "limit",
|
|
7719
|
-
"type": "integer",
|
|
7720
|
-
"required": false,
|
|
7721
|
-
"description": "Page size."
|
|
7722
|
-
},
|
|
7723
|
-
{
|
|
7724
|
-
"name": "order",
|
|
7725
|
-
"type": "string",
|
|
7726
|
-
"enum": [
|
|
7727
|
-
"asc",
|
|
7728
|
-
"desc"
|
|
7729
|
-
],
|
|
7730
|
-
"required": false,
|
|
7731
|
-
"description": "Order by creation time; defaults to desc for stores/files and asc by index for segments."
|
|
7732
|
-
}
|
|
7733
|
-
]
|
|
7734
|
-
},
|
|
7735
|
-
{
|
|
7736
|
-
"resource": "knowledge.vectorStores",
|
|
8101
|
+
"resource": "file.uploads",
|
|
7737
8102
|
"method": "create",
|
|
7738
|
-
"summary": "Create
|
|
7739
|
-
"description": "
|
|
8103
|
+
"summary": "Create an upload",
|
|
8104
|
+
"description": "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
|
|
7740
8105
|
"http": "POST",
|
|
7741
|
-
"path": "/
|
|
8106
|
+
"path": "/file/v1/uploads",
|
|
7742
8107
|
"streaming": "no",
|
|
7743
8108
|
"pagination": false,
|
|
7744
8109
|
"pathParams": [],
|
|
@@ -7747,42 +8112,239 @@ export const operations = [
|
|
|
7747
8112
|
"required": true,
|
|
7748
8113
|
"fields": [
|
|
7749
8114
|
{
|
|
7750
|
-
"name": "
|
|
7751
|
-
"type": "
|
|
7752
|
-
"required":
|
|
7753
|
-
"description": "
|
|
8115
|
+
"name": "bytes",
|
|
8116
|
+
"type": "integer",
|
|
8117
|
+
"required": true,
|
|
8118
|
+
"description": "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match."
|
|
7754
8119
|
},
|
|
7755
8120
|
{
|
|
7756
|
-
"name": "
|
|
7757
|
-
"type": "
|
|
7758
|
-
"required":
|
|
7759
|
-
"description": "
|
|
8121
|
+
"name": "filename",
|
|
8122
|
+
"type": "string",
|
|
8123
|
+
"required": true,
|
|
8124
|
+
"description": "Filename for the resulting file, at most 255 UTF-8 bytes."
|
|
7760
8125
|
},
|
|
7761
8126
|
{
|
|
7762
|
-
"name": "
|
|
7763
|
-
"type": "
|
|
7764
|
-
"required":
|
|
7765
|
-
"description": "
|
|
8127
|
+
"name": "mime_type",
|
|
8128
|
+
"type": "string",
|
|
8129
|
+
"required": true,
|
|
8130
|
+
"description": "Declared MIME type; validated against the assembled content."
|
|
7766
8131
|
},
|
|
7767
8132
|
{
|
|
7768
|
-
"name": "
|
|
7769
|
-
"type": "
|
|
7770
|
-
"
|
|
7771
|
-
|
|
7772
|
-
|
|
8133
|
+
"name": "purpose",
|
|
8134
|
+
"type": "string",
|
|
8135
|
+
"enum": [
|
|
8136
|
+
"user_data",
|
|
8137
|
+
"assistants",
|
|
8138
|
+
"vision"
|
|
8139
|
+
],
|
|
8140
|
+
"required": true,
|
|
8141
|
+
"description": "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images."
|
|
7773
8142
|
},
|
|
7774
8143
|
{
|
|
7775
|
-
"name": "
|
|
8144
|
+
"name": "expires_after",
|
|
7776
8145
|
"type": "object",
|
|
7777
8146
|
"required": false,
|
|
7778
|
-
"description": "
|
|
8147
|
+
"description": "Optional expiry policy for the resulting file; omission retains the file until deletion."
|
|
7779
8148
|
},
|
|
7780
8149
|
{
|
|
7781
|
-
"name": "
|
|
7782
|
-
"type": "
|
|
8150
|
+
"name": "part_size",
|
|
8151
|
+
"type": "integer",
|
|
7783
8152
|
"required": false,
|
|
7784
|
-
"description": "
|
|
7785
|
-
}
|
|
8153
|
+
"description": "Optional fixed part size in bytes, 5242880–64000000. Requires part_number on every part; retries of identical bytes at the same number return the same part. Omit to use arbitrary-sized parts."
|
|
8154
|
+
}
|
|
8155
|
+
]
|
|
8156
|
+
}
|
|
8157
|
+
},
|
|
8158
|
+
{
|
|
8159
|
+
"resource": "file.uploads",
|
|
8160
|
+
"method": "cancel",
|
|
8161
|
+
"summary": "Cancel an upload",
|
|
8162
|
+
"description": "Cancel an unfinished upload using upload_id from create and release its reserved storage. Further parts and completion are rejected. Cancelling an already cancelled upload returns the same terminal result; a completed upload cannot be cancelled. Delete its resulting file instead.",
|
|
8163
|
+
"http": "POST",
|
|
8164
|
+
"path": "/file/v1/uploads/{upload_id}/cancel",
|
|
8165
|
+
"streaming": "no",
|
|
8166
|
+
"pagination": false,
|
|
8167
|
+
"pathParams": [
|
|
8168
|
+
{
|
|
8169
|
+
"name": "upload_id",
|
|
8170
|
+
"sdkName": "upload_id"
|
|
8171
|
+
}
|
|
8172
|
+
],
|
|
8173
|
+
"query": []
|
|
8174
|
+
},
|
|
8175
|
+
{
|
|
8176
|
+
"resource": "file.uploads",
|
|
8177
|
+
"method": "complete",
|
|
8178
|
+
"summary": "Complete an upload",
|
|
8179
|
+
"description": "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.",
|
|
8180
|
+
"http": "POST",
|
|
8181
|
+
"path": "/file/v1/uploads/{upload_id}/complete",
|
|
8182
|
+
"streaming": "no",
|
|
8183
|
+
"pagination": false,
|
|
8184
|
+
"pathParams": [
|
|
8185
|
+
{
|
|
8186
|
+
"name": "upload_id",
|
|
8187
|
+
"sdkName": "upload_id"
|
|
8188
|
+
}
|
|
8189
|
+
],
|
|
8190
|
+
"query": [],
|
|
8191
|
+
"body": {
|
|
8192
|
+
"required": true,
|
|
8193
|
+
"fields": [
|
|
8194
|
+
{
|
|
8195
|
+
"name": "part_ids",
|
|
8196
|
+
"type": "array",
|
|
8197
|
+
"itemType": "string",
|
|
8198
|
+
"required": true,
|
|
8199
|
+
"description": "All part IDs in concatenation order, without duplicates. Fixed-size uploads require increasing part_number order."
|
|
8200
|
+
},
|
|
8201
|
+
{
|
|
8202
|
+
"name": "md5",
|
|
8203
|
+
"type": "string",
|
|
8204
|
+
"required": false,
|
|
8205
|
+
"description": "Optional whole-file MD5 as 32 hexadecimal characters; verified after assembly."
|
|
8206
|
+
}
|
|
8207
|
+
]
|
|
8208
|
+
}
|
|
8209
|
+
},
|
|
8210
|
+
{
|
|
8211
|
+
"resource": "file.uploads.parts",
|
|
8212
|
+
"method": "create",
|
|
8213
|
+
"summary": "Add an upload part",
|
|
8214
|
+
"description": "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.",
|
|
8215
|
+
"http": "POST",
|
|
8216
|
+
"path": "/file/v1/uploads/{upload_id}/parts",
|
|
8217
|
+
"streaming": "no",
|
|
8218
|
+
"pagination": false,
|
|
8219
|
+
"multipart": true,
|
|
8220
|
+
"pathParams": [
|
|
8221
|
+
{
|
|
8222
|
+
"name": "upload_id",
|
|
8223
|
+
"sdkName": "upload_id"
|
|
8224
|
+
}
|
|
8225
|
+
],
|
|
8226
|
+
"query": [
|
|
8227
|
+
{
|
|
8228
|
+
"name": "part_number",
|
|
8229
|
+
"type": "integer",
|
|
8230
|
+
"required": false,
|
|
8231
|
+
"description": "Required when create set part_size; 1 through ceil(bytes / part_size). Ignored for general uploads."
|
|
8232
|
+
}
|
|
8233
|
+
],
|
|
8234
|
+
"body": {
|
|
8235
|
+
"required": true,
|
|
8236
|
+
"fields": [
|
|
8237
|
+
{
|
|
8238
|
+
"name": "data",
|
|
8239
|
+
"type": "string",
|
|
8240
|
+
"required": true,
|
|
8241
|
+
"description": "Raw bytes of this part, nonempty and at most 64000000 bytes."
|
|
8242
|
+
}
|
|
8243
|
+
]
|
|
8244
|
+
}
|
|
8245
|
+
},
|
|
8246
|
+
{
|
|
8247
|
+
"resource": "knowledge.vectorStores",
|
|
8248
|
+
"method": "list",
|
|
8249
|
+
"summary": "List knowledge bases",
|
|
8250
|
+
"description": "Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.",
|
|
8251
|
+
"http": "GET",
|
|
8252
|
+
"path": "/knowledge/v1/vector_stores",
|
|
8253
|
+
"streaming": "no",
|
|
8254
|
+
"pagination": false,
|
|
8255
|
+
"pathParams": [],
|
|
8256
|
+
"query": [
|
|
8257
|
+
{
|
|
8258
|
+
"name": "status",
|
|
8259
|
+
"type": "string",
|
|
8260
|
+
"enum": [
|
|
8261
|
+
"active",
|
|
8262
|
+
"deleting"
|
|
8263
|
+
],
|
|
8264
|
+
"required": false,
|
|
8265
|
+
"description": "active selects active stores; deleting selects soft-deleted stores awaiting purge. Omission excludes soft-deleted stores."
|
|
8266
|
+
},
|
|
8267
|
+
{
|
|
8268
|
+
"name": "after",
|
|
8269
|
+
"type": "string",
|
|
8270
|
+
"required": false,
|
|
8271
|
+
"description": "Cursor ID from the previous page."
|
|
8272
|
+
},
|
|
8273
|
+
{
|
|
8274
|
+
"name": "before",
|
|
8275
|
+
"type": "string",
|
|
8276
|
+
"required": false,
|
|
8277
|
+
"description": "Return items before this ID."
|
|
8278
|
+
},
|
|
8279
|
+
{
|
|
8280
|
+
"name": "limit",
|
|
8281
|
+
"type": "integer",
|
|
8282
|
+
"required": false,
|
|
8283
|
+
"description": "Page size."
|
|
8284
|
+
},
|
|
8285
|
+
{
|
|
8286
|
+
"name": "order",
|
|
8287
|
+
"type": "string",
|
|
8288
|
+
"enum": [
|
|
8289
|
+
"asc",
|
|
8290
|
+
"desc"
|
|
8291
|
+
],
|
|
8292
|
+
"required": false,
|
|
8293
|
+
"description": "Order by creation time; defaults to desc for stores/files and asc by index for segments."
|
|
8294
|
+
}
|
|
8295
|
+
]
|
|
8296
|
+
},
|
|
8297
|
+
{
|
|
8298
|
+
"resource": "knowledge.vectorStores",
|
|
8299
|
+
"method": "create",
|
|
8300
|
+
"summary": "Create knowledge base",
|
|
8301
|
+
"description": "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. Unlike OpenAI vector stores, each file is limited to 100000000 bytes and each account to 100 active/nondeleted stores. Minimal body: {\"name\":\"Refund policies\"}.",
|
|
8302
|
+
"http": "POST",
|
|
8303
|
+
"path": "/knowledge/v1/vector_stores",
|
|
8304
|
+
"streaming": "no",
|
|
8305
|
+
"pagination": false,
|
|
8306
|
+
"pathParams": [],
|
|
8307
|
+
"query": [],
|
|
8308
|
+
"body": {
|
|
8309
|
+
"required": true,
|
|
8310
|
+
"fields": [
|
|
8311
|
+
{
|
|
8312
|
+
"name": "name",
|
|
8313
|
+
"type": "string",
|
|
8314
|
+
"required": false,
|
|
8315
|
+
"description": "Omitted name becomes an empty string; null is rejected."
|
|
8316
|
+
},
|
|
8317
|
+
{
|
|
8318
|
+
"name": "metadata",
|
|
8319
|
+
"type": "object",
|
|
8320
|
+
"required": false,
|
|
8321
|
+
"description": "User-defined string metadata for the store; omission or null creates an empty map."
|
|
8322
|
+
},
|
|
8323
|
+
{
|
|
8324
|
+
"name": "expires_after",
|
|
8325
|
+
"type": "object",
|
|
8326
|
+
"required": false,
|
|
8327
|
+
"description": "Expiry policy from last activity; omission or null disables automatic expiry."
|
|
8328
|
+
},
|
|
8329
|
+
{
|
|
8330
|
+
"name": "file_ids",
|
|
8331
|
+
"type": "array",
|
|
8332
|
+
"itemType": "string",
|
|
8333
|
+
"required": false,
|
|
8334
|
+
"description": "Existing File IDs to attach; the store allows up to 10,000 files."
|
|
8335
|
+
},
|
|
8336
|
+
{
|
|
8337
|
+
"name": "chunking_strategy",
|
|
8338
|
+
"type": "object",
|
|
8339
|
+
"required": false,
|
|
8340
|
+
"description": "auto resolves to static with 800 estimated tokens and 400 overlap tokens. Unlike OpenAI vector stores, token counts are estimates; each Han character counts as one, and other whitespace-delimited words count as their UTF-16 length divided by four, rounded up."
|
|
8341
|
+
},
|
|
8342
|
+
{
|
|
8343
|
+
"name": "description",
|
|
8344
|
+
"type": "string",
|
|
8345
|
+
"required": false,
|
|
8346
|
+
"description": "Accepted but not saved or returned; its type is not validated."
|
|
8347
|
+
},
|
|
7786
8348
|
{
|
|
7787
8349
|
"name": "models",
|
|
7788
8350
|
"type": "object",
|
|
@@ -11811,7 +12373,7 @@ export const operations = [
|
|
|
11811
12373
|
"name": "message",
|
|
11812
12374
|
"type": "string",
|
|
11813
12375
|
"required": true,
|
|
11814
|
-
"description": "Problem description
|
|
12376
|
+
"description": "Problem description, at most 4096 Unicode code points; may be empty only when contexts.praxis.error.message is a non-empty string."
|
|
11815
12377
|
},
|
|
11816
12378
|
{
|
|
11817
12379
|
"name": "contact_email",
|
|
@@ -12109,7 +12671,7 @@ export const operations = [
|
|
|
12109
12671
|
"resource": "sandbox.sandboxes",
|
|
12110
12672
|
"method": "create",
|
|
12111
12673
|
"summary": "Create sandbox (v2)",
|
|
12112
|
-
"description": "
|
|
12674
|
+
"description": "Create a sandbox from the template. All system communication with the sandbox is secured.",
|
|
12113
12675
|
"http": "POST",
|
|
12114
12676
|
"path": "/sandbox/v1/sandboxes",
|
|
12115
12677
|
"streaming": "no",
|
|
@@ -12123,7 +12685,7 @@ export const operations = [
|
|
|
12123
12685
|
"name": "templateID",
|
|
12124
12686
|
"type": "string",
|
|
12125
12687
|
"required": true,
|
|
12126
|
-
"description": "
|
|
12688
|
+
"description": "Identifier of the required template"
|
|
12127
12689
|
},
|
|
12128
12690
|
{
|
|
12129
12691
|
"name": "timeout",
|
|
@@ -12261,7 +12823,7 @@ export const operations = [
|
|
|
12261
12823
|
"resource": "sandbox.sandboxes",
|
|
12262
12824
|
"method": "connect",
|
|
12263
12825
|
"summary": "Connect sandbox (v2)",
|
|
12264
|
-
"description": "
|
|
12826
|
+
"description": "Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. The request body is optional; an omitted timeout defaults to 300 seconds.",
|
|
12265
12827
|
"http": "POST",
|
|
12266
12828
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/connect",
|
|
12267
12829
|
"streaming": "no",
|
|
@@ -12420,7 +12982,7 @@ export const operations = [
|
|
|
12420
12982
|
"resource": "sandbox.sandboxes.metrics",
|
|
12421
12983
|
"method": "list",
|
|
12422
12984
|
"summary": "Sandbox metrics",
|
|
12423
|
-
"description": "Read CPU, memory and disk usage over
|
|
12985
|
+
"description": "Read CPU, memory and disk usage samples of a sandbox over a time window. Use it to size a sandbox or find out why it is slow. start and end are Unix timestamps in seconds; without them the recent samples are returned. An unknown id answers 404.",
|
|
12424
12986
|
"http": "GET",
|
|
12425
12987
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/metrics",
|
|
12426
12988
|
"streaming": "no",
|
|
@@ -12504,7 +13066,7 @@ export const operations = [
|
|
|
12504
13066
|
"resource": "sandbox.sandboxes",
|
|
12505
13067
|
"method": "pause",
|
|
12506
13068
|
"summary": "Pause sandbox",
|
|
12507
|
-
"description": "
|
|
13069
|
+
"description": "Pause a running sandbox, keeping its files and memory so that connectSandbox can resume it later. Use it to stop paying for compute without losing state; to discard the sandbox use killSandbox. Success answers 204. A sandbox that is not running answers 409.",
|
|
12508
13070
|
"http": "POST",
|
|
12509
13071
|
"path": "/sandbox/v1/sandboxes/{sandboxID}/pause",
|
|
12510
13072
|
"streaming": "no",
|
|
@@ -12896,7 +13458,7 @@ export const operations = [
|
|
|
12896
13458
|
"resource": "sandbox.templates",
|
|
12897
13459
|
"method": "list",
|
|
12898
13460
|
"summary": "List templates (v2)",
|
|
12899
|
-
"description": "
|
|
13461
|
+
"description": "List the templates you can create sandboxes from. Use it to pick the template id or alias for createSandbox. `base` is the default template that createSandbox uses when templateID is omitted. limit is 1 to 100 (default 100); send the cursor from the response back as nextToken to continue.",
|
|
12900
13462
|
"http": "GET",
|
|
12901
13463
|
"path": "/sandbox/v1/templates",
|
|
12902
13464
|
"streaming": "no",
|
|
@@ -13657,6 +14219,1466 @@ export const operations = [
|
|
|
13657
14219
|
]
|
|
13658
14220
|
}
|
|
13659
14221
|
},
|
|
14222
|
+
{
|
|
14223
|
+
"resource": "ticket.activity",
|
|
14224
|
+
"method": "retrieve",
|
|
14225
|
+
"summary": "List activity",
|
|
14226
|
+
"description": "List activity within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14227
|
+
"http": "GET",
|
|
14228
|
+
"path": "/ticket/v1/activity",
|
|
14229
|
+
"streaming": "no",
|
|
14230
|
+
"pagination": false,
|
|
14231
|
+
"pathParams": [],
|
|
14232
|
+
"query": [
|
|
14233
|
+
{
|
|
14234
|
+
"name": "repository",
|
|
14235
|
+
"type": "string",
|
|
14236
|
+
"required": false,
|
|
14237
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14238
|
+
},
|
|
14239
|
+
{
|
|
14240
|
+
"name": "page_size",
|
|
14241
|
+
"type": "integer",
|
|
14242
|
+
"required": false,
|
|
14243
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14244
|
+
},
|
|
14245
|
+
{
|
|
14246
|
+
"name": "page_token",
|
|
14247
|
+
"type": "string",
|
|
14248
|
+
"required": false,
|
|
14249
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14250
|
+
},
|
|
14251
|
+
{
|
|
14252
|
+
"name": "filter",
|
|
14253
|
+
"type": "string",
|
|
14254
|
+
"required": false,
|
|
14255
|
+
"description": "Activity qualifiers: actor, actor-kind, action, ticket, source and since; passed unchanged to the service."
|
|
14256
|
+
}
|
|
14257
|
+
]
|
|
14258
|
+
},
|
|
14259
|
+
{
|
|
14260
|
+
"resource": "ticket.comments",
|
|
14261
|
+
"method": "delete",
|
|
14262
|
+
"summary": "Remove comments",
|
|
14263
|
+
"description": "Remove comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14264
|
+
"http": "DELETE",
|
|
14265
|
+
"path": "/ticket/v1/comments/{id}",
|
|
14266
|
+
"streaming": "no",
|
|
14267
|
+
"pagination": false,
|
|
14268
|
+
"pathParams": [
|
|
14269
|
+
{
|
|
14270
|
+
"name": "id",
|
|
14271
|
+
"sdkName": "id"
|
|
14272
|
+
}
|
|
14273
|
+
],
|
|
14274
|
+
"query": [
|
|
14275
|
+
{
|
|
14276
|
+
"name": "repository",
|
|
14277
|
+
"type": "string",
|
|
14278
|
+
"required": false,
|
|
14279
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14280
|
+
}
|
|
14281
|
+
]
|
|
14282
|
+
},
|
|
14283
|
+
{
|
|
14284
|
+
"resource": "ticket.comments",
|
|
14285
|
+
"method": "retrieve",
|
|
14286
|
+
"summary": "Read comments",
|
|
14287
|
+
"description": "Read comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14288
|
+
"http": "GET",
|
|
14289
|
+
"path": "/ticket/v1/comments/{id}",
|
|
14290
|
+
"streaming": "no",
|
|
14291
|
+
"pagination": false,
|
|
14292
|
+
"pathParams": [
|
|
14293
|
+
{
|
|
14294
|
+
"name": "id",
|
|
14295
|
+
"sdkName": "id"
|
|
14296
|
+
}
|
|
14297
|
+
],
|
|
14298
|
+
"query": [
|
|
14299
|
+
{
|
|
14300
|
+
"name": "repository",
|
|
14301
|
+
"type": "string",
|
|
14302
|
+
"required": false,
|
|
14303
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14304
|
+
}
|
|
14305
|
+
]
|
|
14306
|
+
},
|
|
14307
|
+
{
|
|
14308
|
+
"resource": "ticket.comments",
|
|
14309
|
+
"method": "update",
|
|
14310
|
+
"summary": "Update comments",
|
|
14311
|
+
"description": "Update comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14312
|
+
"http": "PATCH",
|
|
14313
|
+
"path": "/ticket/v1/comments/{id}",
|
|
14314
|
+
"streaming": "no",
|
|
14315
|
+
"pagination": false,
|
|
14316
|
+
"pathParams": [
|
|
14317
|
+
{
|
|
14318
|
+
"name": "id",
|
|
14319
|
+
"sdkName": "id"
|
|
14320
|
+
}
|
|
14321
|
+
],
|
|
14322
|
+
"query": [
|
|
14323
|
+
{
|
|
14324
|
+
"name": "repository",
|
|
14325
|
+
"type": "string",
|
|
14326
|
+
"required": false,
|
|
14327
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14328
|
+
}
|
|
14329
|
+
],
|
|
14330
|
+
"body": {
|
|
14331
|
+
"required": true,
|
|
14332
|
+
"fields": [
|
|
14333
|
+
{
|
|
14334
|
+
"name": "body",
|
|
14335
|
+
"type": "string",
|
|
14336
|
+
"required": true,
|
|
14337
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14338
|
+
},
|
|
14339
|
+
{
|
|
14340
|
+
"name": "in_reply_to",
|
|
14341
|
+
"type": "string",
|
|
14342
|
+
"required": false,
|
|
14343
|
+
"description": "Opaque identifier returned by this resource's create or list operation."
|
|
14344
|
+
}
|
|
14345
|
+
]
|
|
14346
|
+
}
|
|
14347
|
+
},
|
|
14348
|
+
{
|
|
14349
|
+
"resource": "ticket.comments.reactions",
|
|
14350
|
+
"method": "list",
|
|
14351
|
+
"summary": "List reactions",
|
|
14352
|
+
"description": "List reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14353
|
+
"http": "GET",
|
|
14354
|
+
"path": "/ticket/v1/comments/{id}/reactions",
|
|
14355
|
+
"streaming": "no",
|
|
14356
|
+
"pagination": false,
|
|
14357
|
+
"pathParams": [
|
|
14358
|
+
{
|
|
14359
|
+
"name": "id",
|
|
14360
|
+
"sdkName": "id"
|
|
14361
|
+
}
|
|
14362
|
+
],
|
|
14363
|
+
"query": [
|
|
14364
|
+
{
|
|
14365
|
+
"name": "repository",
|
|
14366
|
+
"type": "string",
|
|
14367
|
+
"required": false,
|
|
14368
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14369
|
+
},
|
|
14370
|
+
{
|
|
14371
|
+
"name": "page_size",
|
|
14372
|
+
"type": "integer",
|
|
14373
|
+
"required": false,
|
|
14374
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14375
|
+
},
|
|
14376
|
+
{
|
|
14377
|
+
"name": "page_token",
|
|
14378
|
+
"type": "string",
|
|
14379
|
+
"required": false,
|
|
14380
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14381
|
+
}
|
|
14382
|
+
]
|
|
14383
|
+
},
|
|
14384
|
+
{
|
|
14385
|
+
"resource": "ticket.comments.reactions",
|
|
14386
|
+
"method": "create",
|
|
14387
|
+
"summary": "Create or add reactions",
|
|
14388
|
+
"description": "Create or add reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14389
|
+
"http": "POST",
|
|
14390
|
+
"path": "/ticket/v1/comments/{id}/reactions",
|
|
14391
|
+
"streaming": "no",
|
|
14392
|
+
"pagination": false,
|
|
14393
|
+
"pathParams": [
|
|
14394
|
+
{
|
|
14395
|
+
"name": "id",
|
|
14396
|
+
"sdkName": "id"
|
|
14397
|
+
}
|
|
14398
|
+
],
|
|
14399
|
+
"query": [
|
|
14400
|
+
{
|
|
14401
|
+
"name": "repository",
|
|
14402
|
+
"type": "string",
|
|
14403
|
+
"required": false,
|
|
14404
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14405
|
+
}
|
|
14406
|
+
],
|
|
14407
|
+
"body": {
|
|
14408
|
+
"required": true,
|
|
14409
|
+
"fields": [
|
|
14410
|
+
{
|
|
14411
|
+
"name": "content",
|
|
14412
|
+
"type": "string",
|
|
14413
|
+
"enum": [
|
|
14414
|
+
"+1",
|
|
14415
|
+
"-1",
|
|
14416
|
+
"laugh",
|
|
14417
|
+
"confused",
|
|
14418
|
+
"heart",
|
|
14419
|
+
"hooray",
|
|
14420
|
+
"eyes",
|
|
14421
|
+
"rocket"
|
|
14422
|
+
],
|
|
14423
|
+
"required": true,
|
|
14424
|
+
"description": "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket."
|
|
14425
|
+
}
|
|
14426
|
+
]
|
|
14427
|
+
}
|
|
14428
|
+
},
|
|
14429
|
+
{
|
|
14430
|
+
"resource": "ticket.comments.reactions",
|
|
14431
|
+
"method": "delete",
|
|
14432
|
+
"summary": "Remove reactions",
|
|
14433
|
+
"description": "Remove reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14434
|
+
"http": "DELETE",
|
|
14435
|
+
"path": "/ticket/v1/comments/{id}/reactions/{content}",
|
|
14436
|
+
"streaming": "no",
|
|
14437
|
+
"pagination": false,
|
|
14438
|
+
"pathParams": [
|
|
14439
|
+
{
|
|
14440
|
+
"name": "id",
|
|
14441
|
+
"sdkName": "id"
|
|
14442
|
+
},
|
|
14443
|
+
{
|
|
14444
|
+
"name": "content",
|
|
14445
|
+
"sdkName": "content"
|
|
14446
|
+
}
|
|
14447
|
+
],
|
|
14448
|
+
"query": [
|
|
14449
|
+
{
|
|
14450
|
+
"name": "repository",
|
|
14451
|
+
"type": "string",
|
|
14452
|
+
"required": false,
|
|
14453
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14454
|
+
}
|
|
14455
|
+
]
|
|
14456
|
+
},
|
|
14457
|
+
{
|
|
14458
|
+
"resource": "ticket.labels",
|
|
14459
|
+
"method": "list",
|
|
14460
|
+
"summary": "List labels",
|
|
14461
|
+
"description": "List labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14462
|
+
"http": "GET",
|
|
14463
|
+
"path": "/ticket/v1/labels",
|
|
14464
|
+
"streaming": "no",
|
|
14465
|
+
"pagination": false,
|
|
14466
|
+
"pathParams": [],
|
|
14467
|
+
"query": [
|
|
14468
|
+
{
|
|
14469
|
+
"name": "repository",
|
|
14470
|
+
"type": "string",
|
|
14471
|
+
"required": false,
|
|
14472
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14473
|
+
},
|
|
14474
|
+
{
|
|
14475
|
+
"name": "page_size",
|
|
14476
|
+
"type": "integer",
|
|
14477
|
+
"required": false,
|
|
14478
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14479
|
+
},
|
|
14480
|
+
{
|
|
14481
|
+
"name": "page_token",
|
|
14482
|
+
"type": "string",
|
|
14483
|
+
"required": false,
|
|
14484
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14485
|
+
}
|
|
14486
|
+
]
|
|
14487
|
+
},
|
|
14488
|
+
{
|
|
14489
|
+
"resource": "ticket.labels",
|
|
14490
|
+
"method": "create",
|
|
14491
|
+
"summary": "Create or add labels",
|
|
14492
|
+
"description": "Create or add labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14493
|
+
"http": "POST",
|
|
14494
|
+
"path": "/ticket/v1/labels",
|
|
14495
|
+
"streaming": "no",
|
|
14496
|
+
"pagination": false,
|
|
14497
|
+
"pathParams": [],
|
|
14498
|
+
"query": [
|
|
14499
|
+
{
|
|
14500
|
+
"name": "repository",
|
|
14501
|
+
"type": "string",
|
|
14502
|
+
"required": false,
|
|
14503
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14504
|
+
}
|
|
14505
|
+
],
|
|
14506
|
+
"body": {
|
|
14507
|
+
"required": true,
|
|
14508
|
+
"fields": [
|
|
14509
|
+
{
|
|
14510
|
+
"name": "name",
|
|
14511
|
+
"type": "string",
|
|
14512
|
+
"required": true,
|
|
14513
|
+
"description": "Case-insensitive label name within the repository."
|
|
14514
|
+
},
|
|
14515
|
+
{
|
|
14516
|
+
"name": "color",
|
|
14517
|
+
"type": "string",
|
|
14518
|
+
"required": true,
|
|
14519
|
+
"description": "Six hexadecimal digits without #."
|
|
14520
|
+
},
|
|
14521
|
+
{
|
|
14522
|
+
"name": "description",
|
|
14523
|
+
"type": "string",
|
|
14524
|
+
"required": false,
|
|
14525
|
+
"description": "Label's purpose."
|
|
14526
|
+
}
|
|
14527
|
+
]
|
|
14528
|
+
}
|
|
14529
|
+
},
|
|
14530
|
+
{
|
|
14531
|
+
"resource": "ticket.labels",
|
|
14532
|
+
"method": "delete",
|
|
14533
|
+
"summary": "Remove labels",
|
|
14534
|
+
"description": "Remove labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14535
|
+
"http": "DELETE",
|
|
14536
|
+
"path": "/ticket/v1/labels/{name}",
|
|
14537
|
+
"streaming": "no",
|
|
14538
|
+
"pagination": false,
|
|
14539
|
+
"pathParams": [
|
|
14540
|
+
{
|
|
14541
|
+
"name": "name",
|
|
14542
|
+
"sdkName": "name"
|
|
14543
|
+
}
|
|
14544
|
+
],
|
|
14545
|
+
"query": [
|
|
14546
|
+
{
|
|
14547
|
+
"name": "repository",
|
|
14548
|
+
"type": "string",
|
|
14549
|
+
"required": false,
|
|
14550
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14551
|
+
}
|
|
14552
|
+
]
|
|
14553
|
+
},
|
|
14554
|
+
{
|
|
14555
|
+
"resource": "ticket.labels",
|
|
14556
|
+
"method": "update",
|
|
14557
|
+
"summary": "Update labels",
|
|
14558
|
+
"description": "Update labels within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14559
|
+
"http": "PATCH",
|
|
14560
|
+
"path": "/ticket/v1/labels/{name}",
|
|
14561
|
+
"streaming": "no",
|
|
14562
|
+
"pagination": false,
|
|
14563
|
+
"pathParams": [
|
|
14564
|
+
{
|
|
14565
|
+
"name": "name",
|
|
14566
|
+
"sdkName": "name"
|
|
14567
|
+
}
|
|
14568
|
+
],
|
|
14569
|
+
"query": [
|
|
14570
|
+
{
|
|
14571
|
+
"name": "repository",
|
|
14572
|
+
"type": "string",
|
|
14573
|
+
"required": false,
|
|
14574
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14575
|
+
}
|
|
14576
|
+
],
|
|
14577
|
+
"body": {
|
|
14578
|
+
"required": true,
|
|
14579
|
+
"fields": [
|
|
14580
|
+
{
|
|
14581
|
+
"name": "color",
|
|
14582
|
+
"type": "string",
|
|
14583
|
+
"required": false,
|
|
14584
|
+
"description": "Six hexadecimal digits without #."
|
|
14585
|
+
},
|
|
14586
|
+
{
|
|
14587
|
+
"name": "description",
|
|
14588
|
+
"type": "string",
|
|
14589
|
+
"required": false,
|
|
14590
|
+
"description": "Label's purpose."
|
|
14591
|
+
},
|
|
14592
|
+
{
|
|
14593
|
+
"name": "new_name",
|
|
14594
|
+
"type": "string",
|
|
14595
|
+
"required": false,
|
|
14596
|
+
"description": "Case-insensitive label name within the repository."
|
|
14597
|
+
}
|
|
14598
|
+
]
|
|
14599
|
+
}
|
|
14600
|
+
},
|
|
14601
|
+
{
|
|
14602
|
+
"resource": "ticket.milestones",
|
|
14603
|
+
"method": "list",
|
|
14604
|
+
"summary": "List milestones",
|
|
14605
|
+
"description": "List milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14606
|
+
"http": "GET",
|
|
14607
|
+
"path": "/ticket/v1/milestones",
|
|
14608
|
+
"streaming": "no",
|
|
14609
|
+
"pagination": false,
|
|
14610
|
+
"pathParams": [],
|
|
14611
|
+
"query": [
|
|
14612
|
+
{
|
|
14613
|
+
"name": "repository",
|
|
14614
|
+
"type": "string",
|
|
14615
|
+
"required": false,
|
|
14616
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14617
|
+
},
|
|
14618
|
+
{
|
|
14619
|
+
"name": "page_size",
|
|
14620
|
+
"type": "integer",
|
|
14621
|
+
"required": false,
|
|
14622
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14623
|
+
},
|
|
14624
|
+
{
|
|
14625
|
+
"name": "page_token",
|
|
14626
|
+
"type": "string",
|
|
14627
|
+
"required": false,
|
|
14628
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14629
|
+
}
|
|
14630
|
+
]
|
|
14631
|
+
},
|
|
14632
|
+
{
|
|
14633
|
+
"resource": "ticket.milestones",
|
|
14634
|
+
"method": "create",
|
|
14635
|
+
"summary": "Create or add milestones",
|
|
14636
|
+
"description": "Create or add milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14637
|
+
"http": "POST",
|
|
14638
|
+
"path": "/ticket/v1/milestones",
|
|
14639
|
+
"streaming": "no",
|
|
14640
|
+
"pagination": false,
|
|
14641
|
+
"pathParams": [],
|
|
14642
|
+
"query": [
|
|
14643
|
+
{
|
|
14644
|
+
"name": "repository",
|
|
14645
|
+
"type": "string",
|
|
14646
|
+
"required": false,
|
|
14647
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14648
|
+
}
|
|
14649
|
+
],
|
|
14650
|
+
"body": {
|
|
14651
|
+
"required": true,
|
|
14652
|
+
"fields": [
|
|
14653
|
+
{
|
|
14654
|
+
"name": "title",
|
|
14655
|
+
"type": "string",
|
|
14656
|
+
"required": true,
|
|
14657
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14658
|
+
},
|
|
14659
|
+
{
|
|
14660
|
+
"name": "description",
|
|
14661
|
+
"type": "string",
|
|
14662
|
+
"required": false,
|
|
14663
|
+
"description": "Milestone description."
|
|
14664
|
+
},
|
|
14665
|
+
{
|
|
14666
|
+
"name": "due_on",
|
|
14667
|
+
"type": "string",
|
|
14668
|
+
"required": false,
|
|
14669
|
+
"description": "Due date, or null if unset."
|
|
14670
|
+
},
|
|
14671
|
+
{
|
|
14672
|
+
"name": "state",
|
|
14673
|
+
"type": "string",
|
|
14674
|
+
"enum": [
|
|
14675
|
+
"open",
|
|
14676
|
+
"closed"
|
|
14677
|
+
],
|
|
14678
|
+
"required": false,
|
|
14679
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
14680
|
+
}
|
|
14681
|
+
]
|
|
14682
|
+
}
|
|
14683
|
+
},
|
|
14684
|
+
{
|
|
14685
|
+
"resource": "ticket.milestones",
|
|
14686
|
+
"method": "delete",
|
|
14687
|
+
"summary": "Remove milestones",
|
|
14688
|
+
"description": "Remove milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14689
|
+
"http": "DELETE",
|
|
14690
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14691
|
+
"streaming": "no",
|
|
14692
|
+
"pagination": false,
|
|
14693
|
+
"pathParams": [
|
|
14694
|
+
{
|
|
14695
|
+
"name": "number",
|
|
14696
|
+
"sdkName": "number"
|
|
14697
|
+
}
|
|
14698
|
+
],
|
|
14699
|
+
"query": [
|
|
14700
|
+
{
|
|
14701
|
+
"name": "repository",
|
|
14702
|
+
"type": "string",
|
|
14703
|
+
"required": false,
|
|
14704
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14705
|
+
}
|
|
14706
|
+
]
|
|
14707
|
+
},
|
|
14708
|
+
{
|
|
14709
|
+
"resource": "ticket.milestones",
|
|
14710
|
+
"method": "retrieve",
|
|
14711
|
+
"summary": "Read milestones",
|
|
14712
|
+
"description": "Read milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14713
|
+
"http": "GET",
|
|
14714
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14715
|
+
"streaming": "no",
|
|
14716
|
+
"pagination": false,
|
|
14717
|
+
"pathParams": [
|
|
14718
|
+
{
|
|
14719
|
+
"name": "number",
|
|
14720
|
+
"sdkName": "number"
|
|
14721
|
+
}
|
|
14722
|
+
],
|
|
14723
|
+
"query": [
|
|
14724
|
+
{
|
|
14725
|
+
"name": "repository",
|
|
14726
|
+
"type": "string",
|
|
14727
|
+
"required": false,
|
|
14728
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14729
|
+
}
|
|
14730
|
+
]
|
|
14731
|
+
},
|
|
14732
|
+
{
|
|
14733
|
+
"resource": "ticket.milestones",
|
|
14734
|
+
"method": "update",
|
|
14735
|
+
"summary": "Update milestones",
|
|
14736
|
+
"description": "Update milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
14737
|
+
"http": "PATCH",
|
|
14738
|
+
"path": "/ticket/v1/milestones/{number}",
|
|
14739
|
+
"streaming": "no",
|
|
14740
|
+
"pagination": false,
|
|
14741
|
+
"pathParams": [
|
|
14742
|
+
{
|
|
14743
|
+
"name": "number",
|
|
14744
|
+
"sdkName": "number"
|
|
14745
|
+
}
|
|
14746
|
+
],
|
|
14747
|
+
"query": [
|
|
14748
|
+
{
|
|
14749
|
+
"name": "repository",
|
|
14750
|
+
"type": "string",
|
|
14751
|
+
"required": false,
|
|
14752
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14753
|
+
}
|
|
14754
|
+
],
|
|
14755
|
+
"body": {
|
|
14756
|
+
"required": true,
|
|
14757
|
+
"fields": [
|
|
14758
|
+
{
|
|
14759
|
+
"name": "title",
|
|
14760
|
+
"type": "string",
|
|
14761
|
+
"required": false,
|
|
14762
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14763
|
+
},
|
|
14764
|
+
{
|
|
14765
|
+
"name": "description",
|
|
14766
|
+
"type": "string",
|
|
14767
|
+
"required": false,
|
|
14768
|
+
"description": "Milestone description."
|
|
14769
|
+
},
|
|
14770
|
+
{
|
|
14771
|
+
"name": "due_on",
|
|
14772
|
+
"type": "string",
|
|
14773
|
+
"required": false,
|
|
14774
|
+
"description": "Due date, or null if unset."
|
|
14775
|
+
},
|
|
14776
|
+
{
|
|
14777
|
+
"name": "state",
|
|
14778
|
+
"type": "string",
|
|
14779
|
+
"enum": [
|
|
14780
|
+
"open",
|
|
14781
|
+
"closed"
|
|
14782
|
+
],
|
|
14783
|
+
"required": false,
|
|
14784
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
14785
|
+
}
|
|
14786
|
+
]
|
|
14787
|
+
}
|
|
14788
|
+
},
|
|
14789
|
+
{
|
|
14790
|
+
"resource": "ticket.repositories",
|
|
14791
|
+
"method": "list",
|
|
14792
|
+
"summary": "List repositories",
|
|
14793
|
+
"description": "List repositories within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14794
|
+
"http": "GET",
|
|
14795
|
+
"path": "/ticket/v1/repositories",
|
|
14796
|
+
"streaming": "no",
|
|
14797
|
+
"pagination": false,
|
|
14798
|
+
"pathParams": [],
|
|
14799
|
+
"query": [
|
|
14800
|
+
{
|
|
14801
|
+
"name": "page_size",
|
|
14802
|
+
"type": "integer",
|
|
14803
|
+
"required": false,
|
|
14804
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14805
|
+
},
|
|
14806
|
+
{
|
|
14807
|
+
"name": "page_token",
|
|
14808
|
+
"type": "string",
|
|
14809
|
+
"required": false,
|
|
14810
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14811
|
+
}
|
|
14812
|
+
]
|
|
14813
|
+
},
|
|
14814
|
+
{
|
|
14815
|
+
"resource": "ticket.tickets",
|
|
14816
|
+
"method": "list",
|
|
14817
|
+
"summary": "List tickets",
|
|
14818
|
+
"description": "List tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
14819
|
+
"http": "GET",
|
|
14820
|
+
"path": "/ticket/v1/tickets",
|
|
14821
|
+
"streaming": "no",
|
|
14822
|
+
"pagination": false,
|
|
14823
|
+
"pathParams": [],
|
|
14824
|
+
"query": [
|
|
14825
|
+
{
|
|
14826
|
+
"name": "repository",
|
|
14827
|
+
"type": "string",
|
|
14828
|
+
"required": false,
|
|
14829
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14830
|
+
},
|
|
14831
|
+
{
|
|
14832
|
+
"name": "page_size",
|
|
14833
|
+
"type": "integer",
|
|
14834
|
+
"required": false,
|
|
14835
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
14836
|
+
},
|
|
14837
|
+
{
|
|
14838
|
+
"name": "page_token",
|
|
14839
|
+
"type": "string",
|
|
14840
|
+
"required": false,
|
|
14841
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
14842
|
+
},
|
|
14843
|
+
{
|
|
14844
|
+
"name": "filter",
|
|
14845
|
+
"type": "string",
|
|
14846
|
+
"required": false,
|
|
14847
|
+
"description": "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service."
|
|
14848
|
+
}
|
|
14849
|
+
]
|
|
14850
|
+
},
|
|
14851
|
+
{
|
|
14852
|
+
"resource": "ticket.tickets",
|
|
14853
|
+
"method": "create",
|
|
14854
|
+
"summary": "Create or add tickets",
|
|
14855
|
+
"description": "Create or add tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14856
|
+
"http": "POST",
|
|
14857
|
+
"path": "/ticket/v1/tickets",
|
|
14858
|
+
"streaming": "no",
|
|
14859
|
+
"pagination": false,
|
|
14860
|
+
"pathParams": [],
|
|
14861
|
+
"query": [
|
|
14862
|
+
{
|
|
14863
|
+
"name": "repository",
|
|
14864
|
+
"type": "string",
|
|
14865
|
+
"required": false,
|
|
14866
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14867
|
+
}
|
|
14868
|
+
],
|
|
14869
|
+
"body": {
|
|
14870
|
+
"required": true,
|
|
14871
|
+
"fields": [
|
|
14872
|
+
{
|
|
14873
|
+
"name": "title",
|
|
14874
|
+
"type": "string",
|
|
14875
|
+
"required": true,
|
|
14876
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14877
|
+
},
|
|
14878
|
+
{
|
|
14879
|
+
"name": "body",
|
|
14880
|
+
"type": "string",
|
|
14881
|
+
"required": false,
|
|
14882
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14883
|
+
},
|
|
14884
|
+
{
|
|
14885
|
+
"name": "type",
|
|
14886
|
+
"type": "string",
|
|
14887
|
+
"required": false,
|
|
14888
|
+
"description": "Built-in type name; null clears an existing type."
|
|
14889
|
+
},
|
|
14890
|
+
{
|
|
14891
|
+
"name": "labels",
|
|
14892
|
+
"type": "array",
|
|
14893
|
+
"itemType": "string",
|
|
14894
|
+
"required": false,
|
|
14895
|
+
"description": "Labels attached to this ticket; updates replace the complete list."
|
|
14896
|
+
},
|
|
14897
|
+
{
|
|
14898
|
+
"name": "assignees",
|
|
14899
|
+
"type": "array",
|
|
14900
|
+
"itemType": "string",
|
|
14901
|
+
"required": false,
|
|
14902
|
+
"description": "Complete assignee list, at most ten."
|
|
14903
|
+
},
|
|
14904
|
+
{
|
|
14905
|
+
"name": "milestone",
|
|
14906
|
+
"type": "integer",
|
|
14907
|
+
"required": false,
|
|
14908
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14909
|
+
},
|
|
14910
|
+
{
|
|
14911
|
+
"name": "parent",
|
|
14912
|
+
"type": "integer",
|
|
14913
|
+
"required": false,
|
|
14914
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
14915
|
+
}
|
|
14916
|
+
]
|
|
14917
|
+
}
|
|
14918
|
+
},
|
|
14919
|
+
{
|
|
14920
|
+
"resource": "ticket.tickets",
|
|
14921
|
+
"method": "retrieve",
|
|
14922
|
+
"summary": "Read tickets",
|
|
14923
|
+
"description": "Read tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14924
|
+
"http": "GET",
|
|
14925
|
+
"path": "/ticket/v1/tickets/{number}",
|
|
14926
|
+
"streaming": "no",
|
|
14927
|
+
"pagination": false,
|
|
14928
|
+
"pathParams": [
|
|
14929
|
+
{
|
|
14930
|
+
"name": "number",
|
|
14931
|
+
"sdkName": "number"
|
|
14932
|
+
}
|
|
14933
|
+
],
|
|
14934
|
+
"query": [
|
|
14935
|
+
{
|
|
14936
|
+
"name": "repository",
|
|
14937
|
+
"type": "string",
|
|
14938
|
+
"required": false,
|
|
14939
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14940
|
+
}
|
|
14941
|
+
]
|
|
14942
|
+
},
|
|
14943
|
+
{
|
|
14944
|
+
"resource": "ticket.tickets",
|
|
14945
|
+
"method": "update",
|
|
14946
|
+
"summary": "Update tickets",
|
|
14947
|
+
"description": "Update tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
14948
|
+
"http": "PATCH",
|
|
14949
|
+
"path": "/ticket/v1/tickets/{number}",
|
|
14950
|
+
"streaming": "no",
|
|
14951
|
+
"pagination": false,
|
|
14952
|
+
"pathParams": [
|
|
14953
|
+
{
|
|
14954
|
+
"name": "number",
|
|
14955
|
+
"sdkName": "number"
|
|
14956
|
+
}
|
|
14957
|
+
],
|
|
14958
|
+
"query": [
|
|
14959
|
+
{
|
|
14960
|
+
"name": "repository",
|
|
14961
|
+
"type": "string",
|
|
14962
|
+
"required": false,
|
|
14963
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
14964
|
+
}
|
|
14965
|
+
],
|
|
14966
|
+
"body": {
|
|
14967
|
+
"required": true,
|
|
14968
|
+
"fields": [
|
|
14969
|
+
{
|
|
14970
|
+
"name": "title",
|
|
14971
|
+
"type": "string",
|
|
14972
|
+
"required": false,
|
|
14973
|
+
"description": "Short title, at most 256 Unicode characters."
|
|
14974
|
+
},
|
|
14975
|
+
{
|
|
14976
|
+
"name": "body",
|
|
14977
|
+
"type": "string",
|
|
14978
|
+
"required": false,
|
|
14979
|
+
"description": "Markdown text, at most 65536 characters."
|
|
14980
|
+
},
|
|
14981
|
+
{
|
|
14982
|
+
"name": "type",
|
|
14983
|
+
"type": "string",
|
|
14984
|
+
"required": false,
|
|
14985
|
+
"description": "Built-in type name; null clears an existing type."
|
|
14986
|
+
},
|
|
14987
|
+
{
|
|
14988
|
+
"name": "labels",
|
|
14989
|
+
"type": "array",
|
|
14990
|
+
"itemType": "string",
|
|
14991
|
+
"required": false,
|
|
14992
|
+
"description": "Labels attached to this ticket; updates replace the complete list."
|
|
14993
|
+
},
|
|
14994
|
+
{
|
|
14995
|
+
"name": "assignees",
|
|
14996
|
+
"type": "array",
|
|
14997
|
+
"itemType": "string",
|
|
14998
|
+
"required": false,
|
|
14999
|
+
"description": "Complete assignee list, at most ten."
|
|
15000
|
+
},
|
|
15001
|
+
{
|
|
15002
|
+
"name": "milestone",
|
|
15003
|
+
"type": "integer",
|
|
15004
|
+
"required": false,
|
|
15005
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15006
|
+
},
|
|
15007
|
+
{
|
|
15008
|
+
"name": "state",
|
|
15009
|
+
"type": "string",
|
|
15010
|
+
"enum": [
|
|
15011
|
+
"open",
|
|
15012
|
+
"closed"
|
|
15013
|
+
],
|
|
15014
|
+
"required": false,
|
|
15015
|
+
"description": "open means actionable; closed means resolved or declined."
|
|
15016
|
+
},
|
|
15017
|
+
{
|
|
15018
|
+
"name": "state_reason",
|
|
15019
|
+
"type": "string",
|
|
15020
|
+
"enum": [
|
|
15021
|
+
"completed",
|
|
15022
|
+
"not_planned",
|
|
15023
|
+
"duplicate"
|
|
15024
|
+
],
|
|
15025
|
+
"required": false,
|
|
15026
|
+
"description": "Reason for closing: completed resolves, not_planned declines, duplicate marks a duplicate."
|
|
15027
|
+
},
|
|
15028
|
+
{
|
|
15029
|
+
"name": "duplicate_of",
|
|
15030
|
+
"type": "integer",
|
|
15031
|
+
"required": false,
|
|
15032
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15033
|
+
}
|
|
15034
|
+
]
|
|
15035
|
+
}
|
|
15036
|
+
},
|
|
15037
|
+
{
|
|
15038
|
+
"resource": "ticket.tickets.comments",
|
|
15039
|
+
"method": "list",
|
|
15040
|
+
"summary": "List comments",
|
|
15041
|
+
"description": "List comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15042
|
+
"http": "GET",
|
|
15043
|
+
"path": "/ticket/v1/tickets/{number}/comments",
|
|
15044
|
+
"streaming": "no",
|
|
15045
|
+
"pagination": false,
|
|
15046
|
+
"pathParams": [
|
|
15047
|
+
{
|
|
15048
|
+
"name": "number",
|
|
15049
|
+
"sdkName": "number"
|
|
15050
|
+
}
|
|
15051
|
+
],
|
|
15052
|
+
"query": [
|
|
15053
|
+
{
|
|
15054
|
+
"name": "repository",
|
|
15055
|
+
"type": "string",
|
|
15056
|
+
"required": false,
|
|
15057
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15058
|
+
},
|
|
15059
|
+
{
|
|
15060
|
+
"name": "page_size",
|
|
15061
|
+
"type": "integer",
|
|
15062
|
+
"required": false,
|
|
15063
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15064
|
+
},
|
|
15065
|
+
{
|
|
15066
|
+
"name": "page_token",
|
|
15067
|
+
"type": "string",
|
|
15068
|
+
"required": false,
|
|
15069
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15070
|
+
}
|
|
15071
|
+
]
|
|
15072
|
+
},
|
|
15073
|
+
{
|
|
15074
|
+
"resource": "ticket.tickets.comments",
|
|
15075
|
+
"method": "create",
|
|
15076
|
+
"summary": "Create or add comments",
|
|
15077
|
+
"description": "Create or add comments within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15078
|
+
"http": "POST",
|
|
15079
|
+
"path": "/ticket/v1/tickets/{number}/comments",
|
|
15080
|
+
"streaming": "no",
|
|
15081
|
+
"pagination": false,
|
|
15082
|
+
"pathParams": [
|
|
15083
|
+
{
|
|
15084
|
+
"name": "number",
|
|
15085
|
+
"sdkName": "number"
|
|
15086
|
+
}
|
|
15087
|
+
],
|
|
15088
|
+
"query": [
|
|
15089
|
+
{
|
|
15090
|
+
"name": "repository",
|
|
15091
|
+
"type": "string",
|
|
15092
|
+
"required": false,
|
|
15093
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15094
|
+
}
|
|
15095
|
+
],
|
|
15096
|
+
"body": {
|
|
15097
|
+
"required": true,
|
|
15098
|
+
"fields": [
|
|
15099
|
+
{
|
|
15100
|
+
"name": "body",
|
|
15101
|
+
"type": "string",
|
|
15102
|
+
"required": true,
|
|
15103
|
+
"description": "Markdown text, at most 65536 characters."
|
|
15104
|
+
},
|
|
15105
|
+
{
|
|
15106
|
+
"name": "in_reply_to",
|
|
15107
|
+
"type": "string",
|
|
15108
|
+
"required": false,
|
|
15109
|
+
"description": "Opaque identifier returned by this resource's create or list operation."
|
|
15110
|
+
}
|
|
15111
|
+
]
|
|
15112
|
+
}
|
|
15113
|
+
},
|
|
15114
|
+
{
|
|
15115
|
+
"resource": "ticket.tickets.dependencies",
|
|
15116
|
+
"method": "retrieveBlockedBy",
|
|
15117
|
+
"summary": "List blocked by",
|
|
15118
|
+
"description": "List blocked by within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15119
|
+
"http": "GET",
|
|
15120
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by",
|
|
15121
|
+
"streaming": "no",
|
|
15122
|
+
"pagination": false,
|
|
15123
|
+
"pathParams": [
|
|
15124
|
+
{
|
|
15125
|
+
"name": "number",
|
|
15126
|
+
"sdkName": "number"
|
|
15127
|
+
}
|
|
15128
|
+
],
|
|
15129
|
+
"query": [
|
|
15130
|
+
{
|
|
15131
|
+
"name": "repository",
|
|
15132
|
+
"type": "string",
|
|
15133
|
+
"required": false,
|
|
15134
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15135
|
+
},
|
|
15136
|
+
{
|
|
15137
|
+
"name": "page_size",
|
|
15138
|
+
"type": "integer",
|
|
15139
|
+
"required": false,
|
|
15140
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15141
|
+
},
|
|
15142
|
+
{
|
|
15143
|
+
"name": "page_token",
|
|
15144
|
+
"type": "string",
|
|
15145
|
+
"required": false,
|
|
15146
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15147
|
+
}
|
|
15148
|
+
]
|
|
15149
|
+
},
|
|
15150
|
+
{
|
|
15151
|
+
"resource": "ticket.tickets.dependencies.blockedBy",
|
|
15152
|
+
"method": "create",
|
|
15153
|
+
"summary": "Create or add blocked by",
|
|
15154
|
+
"description": "Create or add blocked by within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15155
|
+
"http": "POST",
|
|
15156
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by",
|
|
15157
|
+
"streaming": "no",
|
|
15158
|
+
"pagination": false,
|
|
15159
|
+
"pathParams": [
|
|
15160
|
+
{
|
|
15161
|
+
"name": "number",
|
|
15162
|
+
"sdkName": "number"
|
|
15163
|
+
}
|
|
15164
|
+
],
|
|
15165
|
+
"query": [
|
|
15166
|
+
{
|
|
15167
|
+
"name": "repository",
|
|
15168
|
+
"type": "string",
|
|
15169
|
+
"required": false,
|
|
15170
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15171
|
+
}
|
|
15172
|
+
],
|
|
15173
|
+
"body": {
|
|
15174
|
+
"required": true,
|
|
15175
|
+
"fields": [
|
|
15176
|
+
{
|
|
15177
|
+
"name": "blocked_by",
|
|
15178
|
+
"type": "integer",
|
|
15179
|
+
"required": true,
|
|
15180
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15181
|
+
}
|
|
15182
|
+
]
|
|
15183
|
+
}
|
|
15184
|
+
},
|
|
15185
|
+
{
|
|
15186
|
+
"resource": "ticket.tickets.dependencies.blockedBy",
|
|
15187
|
+
"method": "delete",
|
|
15188
|
+
"summary": "Remove blocked by",
|
|
15189
|
+
"description": "Remove blocked by within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15190
|
+
"http": "DELETE",
|
|
15191
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocked_by/{n}",
|
|
15192
|
+
"streaming": "no",
|
|
15193
|
+
"pagination": false,
|
|
15194
|
+
"pathParams": [
|
|
15195
|
+
{
|
|
15196
|
+
"name": "number",
|
|
15197
|
+
"sdkName": "number"
|
|
15198
|
+
},
|
|
15199
|
+
{
|
|
15200
|
+
"name": "n",
|
|
15201
|
+
"sdkName": "n"
|
|
15202
|
+
}
|
|
15203
|
+
],
|
|
15204
|
+
"query": [
|
|
15205
|
+
{
|
|
15206
|
+
"name": "repository",
|
|
15207
|
+
"type": "string",
|
|
15208
|
+
"required": false,
|
|
15209
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15210
|
+
}
|
|
15211
|
+
]
|
|
15212
|
+
},
|
|
15213
|
+
{
|
|
15214
|
+
"resource": "ticket.tickets.dependencies",
|
|
15215
|
+
"method": "retrieveBlocking",
|
|
15216
|
+
"summary": "List blocking",
|
|
15217
|
+
"description": "List blocking within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15218
|
+
"http": "GET",
|
|
15219
|
+
"path": "/ticket/v1/tickets/{number}/dependencies/blocking",
|
|
15220
|
+
"streaming": "no",
|
|
15221
|
+
"pagination": false,
|
|
15222
|
+
"pathParams": [
|
|
15223
|
+
{
|
|
15224
|
+
"name": "number",
|
|
15225
|
+
"sdkName": "number"
|
|
15226
|
+
}
|
|
15227
|
+
],
|
|
15228
|
+
"query": [
|
|
15229
|
+
{
|
|
15230
|
+
"name": "repository",
|
|
15231
|
+
"type": "string",
|
|
15232
|
+
"required": false,
|
|
15233
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15234
|
+
},
|
|
15235
|
+
{
|
|
15236
|
+
"name": "page_size",
|
|
15237
|
+
"type": "integer",
|
|
15238
|
+
"required": false,
|
|
15239
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15240
|
+
},
|
|
15241
|
+
{
|
|
15242
|
+
"name": "page_token",
|
|
15243
|
+
"type": "string",
|
|
15244
|
+
"required": false,
|
|
15245
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15246
|
+
}
|
|
15247
|
+
]
|
|
15248
|
+
},
|
|
15249
|
+
{
|
|
15250
|
+
"resource": "ticket.tickets.events",
|
|
15251
|
+
"method": "list",
|
|
15252
|
+
"summary": "List events",
|
|
15253
|
+
"description": "List events within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15254
|
+
"http": "GET",
|
|
15255
|
+
"path": "/ticket/v1/tickets/{number}/events",
|
|
15256
|
+
"streaming": "no",
|
|
15257
|
+
"pagination": false,
|
|
15258
|
+
"pathParams": [
|
|
15259
|
+
{
|
|
15260
|
+
"name": "number",
|
|
15261
|
+
"sdkName": "number"
|
|
15262
|
+
}
|
|
15263
|
+
],
|
|
15264
|
+
"query": [
|
|
15265
|
+
{
|
|
15266
|
+
"name": "repository",
|
|
15267
|
+
"type": "string",
|
|
15268
|
+
"required": false,
|
|
15269
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15270
|
+
},
|
|
15271
|
+
{
|
|
15272
|
+
"name": "page_size",
|
|
15273
|
+
"type": "integer",
|
|
15274
|
+
"required": false,
|
|
15275
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15276
|
+
},
|
|
15277
|
+
{
|
|
15278
|
+
"name": "page_token",
|
|
15279
|
+
"type": "string",
|
|
15280
|
+
"required": false,
|
|
15281
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15282
|
+
}
|
|
15283
|
+
]
|
|
15284
|
+
},
|
|
15285
|
+
{
|
|
15286
|
+
"resource": "ticket.tickets",
|
|
15287
|
+
"method": "deleteLock",
|
|
15288
|
+
"summary": "Remove lock",
|
|
15289
|
+
"description": "Remove lock within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
15290
|
+
"http": "DELETE",
|
|
15291
|
+
"path": "/ticket/v1/tickets/{number}/lock",
|
|
15292
|
+
"streaming": "no",
|
|
15293
|
+
"pagination": false,
|
|
15294
|
+
"pathParams": [
|
|
15295
|
+
{
|
|
15296
|
+
"name": "number",
|
|
15297
|
+
"sdkName": "number"
|
|
15298
|
+
}
|
|
15299
|
+
],
|
|
15300
|
+
"query": [
|
|
15301
|
+
{
|
|
15302
|
+
"name": "repository",
|
|
15303
|
+
"type": "string",
|
|
15304
|
+
"required": false,
|
|
15305
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15306
|
+
}
|
|
15307
|
+
]
|
|
15308
|
+
},
|
|
15309
|
+
{
|
|
15310
|
+
"resource": "ticket.tickets",
|
|
15311
|
+
"method": "updateLock",
|
|
15312
|
+
"summary": "Update lock",
|
|
15313
|
+
"description": "Update lock within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
|
|
15314
|
+
"http": "PUT",
|
|
15315
|
+
"path": "/ticket/v1/tickets/{number}/lock",
|
|
15316
|
+
"streaming": "no",
|
|
15317
|
+
"pagination": false,
|
|
15318
|
+
"pathParams": [
|
|
15319
|
+
{
|
|
15320
|
+
"name": "number",
|
|
15321
|
+
"sdkName": "number"
|
|
15322
|
+
}
|
|
15323
|
+
],
|
|
15324
|
+
"query": [
|
|
15325
|
+
{
|
|
15326
|
+
"name": "repository",
|
|
15327
|
+
"type": "string",
|
|
15328
|
+
"required": false,
|
|
15329
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15330
|
+
}
|
|
15331
|
+
],
|
|
15332
|
+
"body": {
|
|
15333
|
+
"required": false,
|
|
15334
|
+
"fields": [
|
|
15335
|
+
{
|
|
15336
|
+
"name": "lock_reason",
|
|
15337
|
+
"type": "string",
|
|
15338
|
+
"enum": [
|
|
15339
|
+
"off-topic",
|
|
15340
|
+
"too heated",
|
|
15341
|
+
"resolved",
|
|
15342
|
+
"spam"
|
|
15343
|
+
],
|
|
15344
|
+
"required": false,
|
|
15345
|
+
"description": "Reason for locking: off-topic, too heated, resolved, or spam."
|
|
15346
|
+
}
|
|
15347
|
+
]
|
|
15348
|
+
}
|
|
15349
|
+
},
|
|
15350
|
+
{
|
|
15351
|
+
"resource": "ticket.tickets.reactions",
|
|
15352
|
+
"method": "list",
|
|
15353
|
+
"summary": "List reactions",
|
|
15354
|
+
"description": "List reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15355
|
+
"http": "GET",
|
|
15356
|
+
"path": "/ticket/v1/tickets/{number}/reactions",
|
|
15357
|
+
"streaming": "no",
|
|
15358
|
+
"pagination": false,
|
|
15359
|
+
"pathParams": [
|
|
15360
|
+
{
|
|
15361
|
+
"name": "number",
|
|
15362
|
+
"sdkName": "number"
|
|
15363
|
+
}
|
|
15364
|
+
],
|
|
15365
|
+
"query": [
|
|
15366
|
+
{
|
|
15367
|
+
"name": "repository",
|
|
15368
|
+
"type": "string",
|
|
15369
|
+
"required": false,
|
|
15370
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15371
|
+
},
|
|
15372
|
+
{
|
|
15373
|
+
"name": "page_size",
|
|
15374
|
+
"type": "integer",
|
|
15375
|
+
"required": false,
|
|
15376
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15377
|
+
},
|
|
15378
|
+
{
|
|
15379
|
+
"name": "page_token",
|
|
15380
|
+
"type": "string",
|
|
15381
|
+
"required": false,
|
|
15382
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15383
|
+
}
|
|
15384
|
+
]
|
|
15385
|
+
},
|
|
15386
|
+
{
|
|
15387
|
+
"resource": "ticket.tickets.reactions",
|
|
15388
|
+
"method": "create",
|
|
15389
|
+
"summary": "Create or add reactions",
|
|
15390
|
+
"description": "Create or add reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15391
|
+
"http": "POST",
|
|
15392
|
+
"path": "/ticket/v1/tickets/{number}/reactions",
|
|
15393
|
+
"streaming": "no",
|
|
15394
|
+
"pagination": false,
|
|
15395
|
+
"pathParams": [
|
|
15396
|
+
{
|
|
15397
|
+
"name": "number",
|
|
15398
|
+
"sdkName": "number"
|
|
15399
|
+
}
|
|
15400
|
+
],
|
|
15401
|
+
"query": [
|
|
15402
|
+
{
|
|
15403
|
+
"name": "repository",
|
|
15404
|
+
"type": "string",
|
|
15405
|
+
"required": false,
|
|
15406
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15407
|
+
}
|
|
15408
|
+
],
|
|
15409
|
+
"body": {
|
|
15410
|
+
"required": true,
|
|
15411
|
+
"fields": [
|
|
15412
|
+
{
|
|
15413
|
+
"name": "content",
|
|
15414
|
+
"type": "string",
|
|
15415
|
+
"enum": [
|
|
15416
|
+
"+1",
|
|
15417
|
+
"-1",
|
|
15418
|
+
"laugh",
|
|
15419
|
+
"confused",
|
|
15420
|
+
"heart",
|
|
15421
|
+
"hooray",
|
|
15422
|
+
"eyes",
|
|
15423
|
+
"rocket"
|
|
15424
|
+
],
|
|
15425
|
+
"required": true,
|
|
15426
|
+
"description": "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket."
|
|
15427
|
+
}
|
|
15428
|
+
]
|
|
15429
|
+
}
|
|
15430
|
+
},
|
|
15431
|
+
{
|
|
15432
|
+
"resource": "ticket.tickets.reactions",
|
|
15433
|
+
"method": "delete",
|
|
15434
|
+
"summary": "Remove reactions",
|
|
15435
|
+
"description": "Remove reactions within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15436
|
+
"http": "DELETE",
|
|
15437
|
+
"path": "/ticket/v1/tickets/{number}/reactions/{content}",
|
|
15438
|
+
"streaming": "no",
|
|
15439
|
+
"pagination": false,
|
|
15440
|
+
"pathParams": [
|
|
15441
|
+
{
|
|
15442
|
+
"name": "number",
|
|
15443
|
+
"sdkName": "number"
|
|
15444
|
+
},
|
|
15445
|
+
{
|
|
15446
|
+
"name": "content",
|
|
15447
|
+
"sdkName": "content"
|
|
15448
|
+
}
|
|
15449
|
+
],
|
|
15450
|
+
"query": [
|
|
15451
|
+
{
|
|
15452
|
+
"name": "repository",
|
|
15453
|
+
"type": "string",
|
|
15454
|
+
"required": false,
|
|
15455
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15456
|
+
}
|
|
15457
|
+
]
|
|
15458
|
+
},
|
|
15459
|
+
{
|
|
15460
|
+
"resource": "ticket.tickets.relations",
|
|
15461
|
+
"method": "list",
|
|
15462
|
+
"summary": "List relations",
|
|
15463
|
+
"description": "List relations within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15464
|
+
"http": "GET",
|
|
15465
|
+
"path": "/ticket/v1/tickets/{number}/relations",
|
|
15466
|
+
"streaming": "no",
|
|
15467
|
+
"pagination": false,
|
|
15468
|
+
"pathParams": [
|
|
15469
|
+
{
|
|
15470
|
+
"name": "number",
|
|
15471
|
+
"sdkName": "number"
|
|
15472
|
+
}
|
|
15473
|
+
],
|
|
15474
|
+
"query": [
|
|
15475
|
+
{
|
|
15476
|
+
"name": "repository",
|
|
15477
|
+
"type": "string",
|
|
15478
|
+
"required": false,
|
|
15479
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15480
|
+
},
|
|
15481
|
+
{
|
|
15482
|
+
"name": "page_size",
|
|
15483
|
+
"type": "integer",
|
|
15484
|
+
"required": false,
|
|
15485
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15486
|
+
},
|
|
15487
|
+
{
|
|
15488
|
+
"name": "page_token",
|
|
15489
|
+
"type": "string",
|
|
15490
|
+
"required": false,
|
|
15491
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15492
|
+
}
|
|
15493
|
+
]
|
|
15494
|
+
},
|
|
15495
|
+
{
|
|
15496
|
+
"resource": "ticket.tickets.relations",
|
|
15497
|
+
"method": "create",
|
|
15498
|
+
"summary": "Create or add relations",
|
|
15499
|
+
"description": "Create or add relations within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15500
|
+
"http": "POST",
|
|
15501
|
+
"path": "/ticket/v1/tickets/{number}/relations",
|
|
15502
|
+
"streaming": "no",
|
|
15503
|
+
"pagination": false,
|
|
15504
|
+
"pathParams": [
|
|
15505
|
+
{
|
|
15506
|
+
"name": "number",
|
|
15507
|
+
"sdkName": "number"
|
|
15508
|
+
}
|
|
15509
|
+
],
|
|
15510
|
+
"query": [
|
|
15511
|
+
{
|
|
15512
|
+
"name": "repository",
|
|
15513
|
+
"type": "string",
|
|
15514
|
+
"required": false,
|
|
15515
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15516
|
+
}
|
|
15517
|
+
],
|
|
15518
|
+
"body": {
|
|
15519
|
+
"required": true,
|
|
15520
|
+
"fields": [
|
|
15521
|
+
{
|
|
15522
|
+
"name": "relates_to",
|
|
15523
|
+
"type": "integer",
|
|
15524
|
+
"required": true,
|
|
15525
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15526
|
+
}
|
|
15527
|
+
]
|
|
15528
|
+
}
|
|
15529
|
+
},
|
|
15530
|
+
{
|
|
15531
|
+
"resource": "ticket.tickets.relations",
|
|
15532
|
+
"method": "delete",
|
|
15533
|
+
"summary": "Remove relations",
|
|
15534
|
+
"description": "Remove relations within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15535
|
+
"http": "DELETE",
|
|
15536
|
+
"path": "/ticket/v1/tickets/{number}/relations/{n}",
|
|
15537
|
+
"streaming": "no",
|
|
15538
|
+
"pagination": false,
|
|
15539
|
+
"pathParams": [
|
|
15540
|
+
{
|
|
15541
|
+
"name": "number",
|
|
15542
|
+
"sdkName": "number"
|
|
15543
|
+
},
|
|
15544
|
+
{
|
|
15545
|
+
"name": "n",
|
|
15546
|
+
"sdkName": "n"
|
|
15547
|
+
}
|
|
15548
|
+
],
|
|
15549
|
+
"query": [
|
|
15550
|
+
{
|
|
15551
|
+
"name": "repository",
|
|
15552
|
+
"type": "string",
|
|
15553
|
+
"required": false,
|
|
15554
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15555
|
+
}
|
|
15556
|
+
]
|
|
15557
|
+
},
|
|
15558
|
+
{
|
|
15559
|
+
"resource": "ticket.tickets.subTickets",
|
|
15560
|
+
"method": "list",
|
|
15561
|
+
"summary": "List sub tickets",
|
|
15562
|
+
"description": "List sub tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Pass next_page_token as page_token to continue with the same filter. Service authorization applies to the verified human subject.",
|
|
15563
|
+
"http": "GET",
|
|
15564
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets",
|
|
15565
|
+
"streaming": "no",
|
|
15566
|
+
"pagination": false,
|
|
15567
|
+
"pathParams": [
|
|
15568
|
+
{
|
|
15569
|
+
"name": "number",
|
|
15570
|
+
"sdkName": "number"
|
|
15571
|
+
}
|
|
15572
|
+
],
|
|
15573
|
+
"query": [
|
|
15574
|
+
{
|
|
15575
|
+
"name": "repository",
|
|
15576
|
+
"type": "string",
|
|
15577
|
+
"required": false,
|
|
15578
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15579
|
+
},
|
|
15580
|
+
{
|
|
15581
|
+
"name": "page_size",
|
|
15582
|
+
"type": "integer",
|
|
15583
|
+
"required": false,
|
|
15584
|
+
"description": "Records per page; defaults to 30, maximum 100."
|
|
15585
|
+
},
|
|
15586
|
+
{
|
|
15587
|
+
"name": "page_token",
|
|
15588
|
+
"type": "string",
|
|
15589
|
+
"required": false,
|
|
15590
|
+
"description": "Cursor returned as next_page_token; omit for the first page."
|
|
15591
|
+
}
|
|
15592
|
+
]
|
|
15593
|
+
},
|
|
15594
|
+
{
|
|
15595
|
+
"resource": "ticket.tickets.subTickets",
|
|
15596
|
+
"method": "create",
|
|
15597
|
+
"summary": "Create or add sub tickets",
|
|
15598
|
+
"description": "Create or add sub tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15599
|
+
"http": "POST",
|
|
15600
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets",
|
|
15601
|
+
"streaming": "no",
|
|
15602
|
+
"pagination": false,
|
|
15603
|
+
"pathParams": [
|
|
15604
|
+
{
|
|
15605
|
+
"name": "number",
|
|
15606
|
+
"sdkName": "number"
|
|
15607
|
+
}
|
|
15608
|
+
],
|
|
15609
|
+
"query": [
|
|
15610
|
+
{
|
|
15611
|
+
"name": "repository",
|
|
15612
|
+
"type": "string",
|
|
15613
|
+
"required": false,
|
|
15614
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15615
|
+
}
|
|
15616
|
+
],
|
|
15617
|
+
"body": {
|
|
15618
|
+
"required": true,
|
|
15619
|
+
"fields": [
|
|
15620
|
+
{
|
|
15621
|
+
"name": "child",
|
|
15622
|
+
"type": "integer",
|
|
15623
|
+
"required": true,
|
|
15624
|
+
"description": "Repository-local number returned by create or list; distinct from the object's id."
|
|
15625
|
+
},
|
|
15626
|
+
{
|
|
15627
|
+
"name": "replace_parent",
|
|
15628
|
+
"type": "boolean",
|
|
15629
|
+
"required": false,
|
|
15630
|
+
"description": "Allow replacing an existing parent."
|
|
15631
|
+
}
|
|
15632
|
+
]
|
|
15633
|
+
}
|
|
15634
|
+
},
|
|
15635
|
+
{
|
|
15636
|
+
"resource": "ticket.tickets.subTickets",
|
|
15637
|
+
"method": "delete",
|
|
15638
|
+
"summary": "Remove sub tickets",
|
|
15639
|
+
"description": "Remove sub tickets within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15640
|
+
"http": "DELETE",
|
|
15641
|
+
"path": "/ticket/v1/tickets/{number}/sub_tickets/{child}",
|
|
15642
|
+
"streaming": "no",
|
|
15643
|
+
"pagination": false,
|
|
15644
|
+
"pathParams": [
|
|
15645
|
+
{
|
|
15646
|
+
"name": "number",
|
|
15647
|
+
"sdkName": "number"
|
|
15648
|
+
},
|
|
15649
|
+
{
|
|
15650
|
+
"name": "child",
|
|
15651
|
+
"sdkName": "child"
|
|
15652
|
+
}
|
|
15653
|
+
],
|
|
15654
|
+
"query": [
|
|
15655
|
+
{
|
|
15656
|
+
"name": "repository",
|
|
15657
|
+
"type": "string",
|
|
15658
|
+
"required": false,
|
|
15659
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15660
|
+
}
|
|
15661
|
+
]
|
|
15662
|
+
},
|
|
15663
|
+
{
|
|
15664
|
+
"resource": "ticket.types",
|
|
15665
|
+
"method": "list",
|
|
15666
|
+
"summary": "Read types",
|
|
15667
|
+
"description": "Read types within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
|
|
15668
|
+
"http": "GET",
|
|
15669
|
+
"path": "/ticket/v1/types",
|
|
15670
|
+
"streaming": "no",
|
|
15671
|
+
"pagination": false,
|
|
15672
|
+
"pathParams": [],
|
|
15673
|
+
"query": [
|
|
15674
|
+
{
|
|
15675
|
+
"name": "repository",
|
|
15676
|
+
"type": "string",
|
|
15677
|
+
"required": false,
|
|
15678
|
+
"description": "Repository id from GET /ticket/v1/repositories; omit for the default tickets container."
|
|
15679
|
+
}
|
|
15680
|
+
]
|
|
15681
|
+
},
|
|
13660
15682
|
{
|
|
13661
15683
|
"resource": "vault.authorizations",
|
|
13662
15684
|
"method": "create",
|