@arke-institute/sdk 2.6.2 → 2.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{crypto-wBQ1LBgz.d.cts → crypto-BOurdm0r.d.cts} +2 -0
- package/dist/{crypto-96bEBoO_.d.ts → crypto-BP-3sfHW.d.ts} +2 -0
- package/dist/generated/index.d.cts +476 -17
- package/dist/generated/index.d.ts +476 -17
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js.map +1 -1
- package/dist/operations/index.cjs +4 -4
- package/dist/operations/index.cjs.map +1 -1
- package/dist/operations/index.d.cts +2 -2
- package/dist/operations/index.d.ts +2 -2
- package/dist/operations/index.js +4 -4
- package/dist/operations/index.js.map +1 -1
- package/openapi/spec.json +645 -10
- package/openapi/version.json +1 -1
- package/package.json +1 -1
package/openapi/spec.json
CHANGED
|
@@ -284,6 +284,11 @@
|
|
|
284
284
|
"type": "string",
|
|
285
285
|
"minLength": 1
|
|
286
286
|
},
|
|
287
|
+
"user_label": {
|
|
288
|
+
"type": "string",
|
|
289
|
+
"description": "Display name of the user/agent (populated during expansion)",
|
|
290
|
+
"example": "Captain Ahab"
|
|
291
|
+
},
|
|
287
292
|
"method": {
|
|
288
293
|
"type": "string",
|
|
289
294
|
"enum": [
|
|
@@ -295,15 +300,21 @@
|
|
|
295
300
|
},
|
|
296
301
|
"on_behalf_of": {
|
|
297
302
|
"type": "string"
|
|
303
|
+
},
|
|
304
|
+
"on_behalf_of_label": {
|
|
305
|
+
"type": "string",
|
|
306
|
+
"description": "Display name of the on_behalf_of user/agent (populated during expansion)",
|
|
307
|
+
"example": "Research Assistant"
|
|
298
308
|
}
|
|
299
309
|
},
|
|
300
310
|
"required": [
|
|
301
311
|
"user_id",
|
|
302
312
|
"method"
|
|
303
313
|
],
|
|
304
|
-
"description": "Audit trail for edits",
|
|
314
|
+
"description": "Audit trail for edits. Label fields are populated when ?expand=relationships is used.",
|
|
305
315
|
"example": {
|
|
306
316
|
"user_id": "01JCAPTAINAHAB000000000000",
|
|
317
|
+
"user_label": "Captain Ahab",
|
|
307
318
|
"method": "manual"
|
|
308
319
|
}
|
|
309
320
|
},
|
|
@@ -1944,6 +1955,11 @@
|
|
|
1944
1955
|
"type": "string",
|
|
1945
1956
|
"minLength": 1
|
|
1946
1957
|
},
|
|
1958
|
+
"user_label": {
|
|
1959
|
+
"type": "string",
|
|
1960
|
+
"description": "Display name of the user/agent (populated during expansion)",
|
|
1961
|
+
"example": "Captain Ahab"
|
|
1962
|
+
},
|
|
1947
1963
|
"method": {
|
|
1948
1964
|
"type": "string",
|
|
1949
1965
|
"enum": [
|
|
@@ -1955,15 +1971,21 @@
|
|
|
1955
1971
|
},
|
|
1956
1972
|
"on_behalf_of": {
|
|
1957
1973
|
"type": "string"
|
|
1974
|
+
},
|
|
1975
|
+
"on_behalf_of_label": {
|
|
1976
|
+
"type": "string",
|
|
1977
|
+
"description": "Display name of the on_behalf_of user/agent (populated during expansion)",
|
|
1978
|
+
"example": "Research Assistant"
|
|
1958
1979
|
}
|
|
1959
1980
|
},
|
|
1960
1981
|
"required": [
|
|
1961
1982
|
"user_id",
|
|
1962
1983
|
"method"
|
|
1963
1984
|
],
|
|
1964
|
-
"description": "Audit trail for edits",
|
|
1985
|
+
"description": "Audit trail for edits. Label fields are populated when ?expand=relationships is used.",
|
|
1965
1986
|
"example": {
|
|
1966
1987
|
"user_id": "01JCAPTAINAHAB000000000000",
|
|
1988
|
+
"user_label": "Captain Ahab",
|
|
1967
1989
|
"method": "manual"
|
|
1968
1990
|
}
|
|
1969
1991
|
},
|
|
@@ -2068,6 +2090,211 @@
|
|
|
2068
2090
|
"type"
|
|
2069
2091
|
]
|
|
2070
2092
|
},
|
|
2093
|
+
"BatchCreateSuccess": {
|
|
2094
|
+
"type": "object",
|
|
2095
|
+
"properties": {
|
|
2096
|
+
"success": {
|
|
2097
|
+
"type": "boolean",
|
|
2098
|
+
"enum": [
|
|
2099
|
+
true
|
|
2100
|
+
]
|
|
2101
|
+
},
|
|
2102
|
+
"index": {
|
|
2103
|
+
"type": "integer"
|
|
2104
|
+
},
|
|
2105
|
+
"id": {
|
|
2106
|
+
"type": "string",
|
|
2107
|
+
"pattern": "^(?:II[0-9A-HJKMNP-TV-Z]{24}|[FC][0-9A-HJKMNP-TV-Z]{25}|[0-9A-HJKMNP-TV-Z]{26})$",
|
|
2108
|
+
"description": "Entity ID (ULID format)",
|
|
2109
|
+
"example": "01KDETYWYWM0MJVKM8DK3AEXPY"
|
|
2110
|
+
},
|
|
2111
|
+
"cid": {
|
|
2112
|
+
"type": "string",
|
|
2113
|
+
"minLength": 1,
|
|
2114
|
+
"description": "Content Identifier (CID) - content-addressed hash",
|
|
2115
|
+
"example": "bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy"
|
|
2116
|
+
},
|
|
2117
|
+
"type": {
|
|
2118
|
+
"type": "string"
|
|
2119
|
+
},
|
|
2120
|
+
"ver": {
|
|
2121
|
+
"type": "integer",
|
|
2122
|
+
"minimum": 0,
|
|
2123
|
+
"exclusiveMinimum": true,
|
|
2124
|
+
"description": "Entity version number",
|
|
2125
|
+
"example": 1
|
|
2126
|
+
}
|
|
2127
|
+
},
|
|
2128
|
+
"required": [
|
|
2129
|
+
"success",
|
|
2130
|
+
"index",
|
|
2131
|
+
"id",
|
|
2132
|
+
"cid",
|
|
2133
|
+
"type",
|
|
2134
|
+
"ver"
|
|
2135
|
+
]
|
|
2136
|
+
},
|
|
2137
|
+
"BatchCreateFailure": {
|
|
2138
|
+
"type": "object",
|
|
2139
|
+
"properties": {
|
|
2140
|
+
"success": {
|
|
2141
|
+
"type": "boolean",
|
|
2142
|
+
"enum": [
|
|
2143
|
+
false
|
|
2144
|
+
]
|
|
2145
|
+
},
|
|
2146
|
+
"index": {
|
|
2147
|
+
"type": "integer"
|
|
2148
|
+
},
|
|
2149
|
+
"error": {
|
|
2150
|
+
"type": "string"
|
|
2151
|
+
},
|
|
2152
|
+
"code": {
|
|
2153
|
+
"type": "string"
|
|
2154
|
+
}
|
|
2155
|
+
},
|
|
2156
|
+
"required": [
|
|
2157
|
+
"success",
|
|
2158
|
+
"index",
|
|
2159
|
+
"error",
|
|
2160
|
+
"code"
|
|
2161
|
+
]
|
|
2162
|
+
},
|
|
2163
|
+
"BatchCreateEntityResponse": {
|
|
2164
|
+
"type": "object",
|
|
2165
|
+
"properties": {
|
|
2166
|
+
"results": {
|
|
2167
|
+
"type": "array",
|
|
2168
|
+
"items": {
|
|
2169
|
+
"anyOf": [
|
|
2170
|
+
{
|
|
2171
|
+
"$ref": "#/components/schemas/BatchCreateSuccess"
|
|
2172
|
+
},
|
|
2173
|
+
{
|
|
2174
|
+
"$ref": "#/components/schemas/BatchCreateFailure"
|
|
2175
|
+
}
|
|
2176
|
+
]
|
|
2177
|
+
}
|
|
2178
|
+
},
|
|
2179
|
+
"summary": {
|
|
2180
|
+
"type": "object",
|
|
2181
|
+
"properties": {
|
|
2182
|
+
"total": {
|
|
2183
|
+
"type": "integer"
|
|
2184
|
+
},
|
|
2185
|
+
"succeeded": {
|
|
2186
|
+
"type": "integer"
|
|
2187
|
+
},
|
|
2188
|
+
"failed": {
|
|
2189
|
+
"type": "integer"
|
|
2190
|
+
}
|
|
2191
|
+
},
|
|
2192
|
+
"required": [
|
|
2193
|
+
"total",
|
|
2194
|
+
"succeeded",
|
|
2195
|
+
"failed"
|
|
2196
|
+
]
|
|
2197
|
+
}
|
|
2198
|
+
},
|
|
2199
|
+
"required": [
|
|
2200
|
+
"results",
|
|
2201
|
+
"summary"
|
|
2202
|
+
]
|
|
2203
|
+
},
|
|
2204
|
+
"BatchCreateEntityItem": {
|
|
2205
|
+
"type": "object",
|
|
2206
|
+
"properties": {
|
|
2207
|
+
"note": {
|
|
2208
|
+
"type": "string",
|
|
2209
|
+
"description": "Optional note describing this change",
|
|
2210
|
+
"example": "Added Chapter 42: The Whiteness of the Whale"
|
|
2211
|
+
},
|
|
2212
|
+
"type": {
|
|
2213
|
+
"type": "string",
|
|
2214
|
+
"minLength": 1,
|
|
2215
|
+
"maxLength": 100,
|
|
2216
|
+
"description": "Entity type identifier"
|
|
2217
|
+
},
|
|
2218
|
+
"properties": {
|
|
2219
|
+
"type": "object",
|
|
2220
|
+
"additionalProperties": {
|
|
2221
|
+
"nullable": true
|
|
2222
|
+
},
|
|
2223
|
+
"description": "Entity properties"
|
|
2224
|
+
},
|
|
2225
|
+
"relationships": {
|
|
2226
|
+
"type": "array",
|
|
2227
|
+
"items": {
|
|
2228
|
+
"type": "object",
|
|
2229
|
+
"properties": {
|
|
2230
|
+
"predicate": {
|
|
2231
|
+
"type": "string",
|
|
2232
|
+
"minLength": 1
|
|
2233
|
+
},
|
|
2234
|
+
"peer": {
|
|
2235
|
+
"type": "string",
|
|
2236
|
+
"minLength": 1
|
|
2237
|
+
},
|
|
2238
|
+
"peer_type": {
|
|
2239
|
+
"type": "string"
|
|
2240
|
+
},
|
|
2241
|
+
"peer_label": {
|
|
2242
|
+
"type": "string"
|
|
2243
|
+
},
|
|
2244
|
+
"properties": {
|
|
2245
|
+
"type": "object",
|
|
2246
|
+
"additionalProperties": {
|
|
2247
|
+
"nullable": true
|
|
2248
|
+
}
|
|
2249
|
+
}
|
|
2250
|
+
},
|
|
2251
|
+
"required": [
|
|
2252
|
+
"predicate",
|
|
2253
|
+
"peer"
|
|
2254
|
+
],
|
|
2255
|
+
"description": "Entity relationship",
|
|
2256
|
+
"example": {
|
|
2257
|
+
"predicate": "crew",
|
|
2258
|
+
"peer": "01KDETYWYWM0MJVKM8DK3AEXPY",
|
|
2259
|
+
"peer_type": "collection"
|
|
2260
|
+
}
|
|
2261
|
+
},
|
|
2262
|
+
"description": "Entity relationships"
|
|
2263
|
+
},
|
|
2264
|
+
"collection": {
|
|
2265
|
+
"type": "string",
|
|
2266
|
+
"pattern": "^(?:II[0-9A-HJKMNP-TV-Z]{24}|[FC][0-9A-HJKMNP-TV-Z]{25}|[0-9A-HJKMNP-TV-Z]{26})$",
|
|
2267
|
+
"description": "Parent collection ID (creates collection relationship)",
|
|
2268
|
+
"example": "01KDETYWYWM0MJVKM8DK3AEXPY"
|
|
2269
|
+
}
|
|
2270
|
+
},
|
|
2271
|
+
"required": [
|
|
2272
|
+
"type"
|
|
2273
|
+
]
|
|
2274
|
+
},
|
|
2275
|
+
"BatchCreateEntityRequest": {
|
|
2276
|
+
"type": "object",
|
|
2277
|
+
"properties": {
|
|
2278
|
+
"entities": {
|
|
2279
|
+
"type": "array",
|
|
2280
|
+
"items": {
|
|
2281
|
+
"$ref": "#/components/schemas/BatchCreateEntityItem"
|
|
2282
|
+
},
|
|
2283
|
+
"minItems": 1,
|
|
2284
|
+
"maxItems": 100,
|
|
2285
|
+
"description": "Array of entities to create (1-100)"
|
|
2286
|
+
},
|
|
2287
|
+
"default_collection": {
|
|
2288
|
+
"type": "string",
|
|
2289
|
+
"pattern": "^(?:II[0-9A-HJKMNP-TV-Z]{24}|[FC][0-9A-HJKMNP-TV-Z]{25}|[0-9A-HJKMNP-TV-Z]{26})$",
|
|
2290
|
+
"description": "Default collection for entities that do not specify one",
|
|
2291
|
+
"example": "01KDETYWYWM0MJVKM8DK3AEXPY"
|
|
2292
|
+
}
|
|
2293
|
+
},
|
|
2294
|
+
"required": [
|
|
2295
|
+
"entities"
|
|
2296
|
+
]
|
|
2297
|
+
},
|
|
2071
2298
|
"TipResponse": {
|
|
2072
2299
|
"type": "object",
|
|
2073
2300
|
"properties": {
|
|
@@ -3472,6 +3699,11 @@
|
|
|
3472
3699
|
"type": "string",
|
|
3473
3700
|
"minLength": 1
|
|
3474
3701
|
},
|
|
3702
|
+
"user_label": {
|
|
3703
|
+
"type": "string",
|
|
3704
|
+
"description": "Display name of the user/agent (populated during expansion)",
|
|
3705
|
+
"example": "Captain Ahab"
|
|
3706
|
+
},
|
|
3475
3707
|
"method": {
|
|
3476
3708
|
"type": "string",
|
|
3477
3709
|
"enum": [
|
|
@@ -3483,15 +3715,21 @@
|
|
|
3483
3715
|
},
|
|
3484
3716
|
"on_behalf_of": {
|
|
3485
3717
|
"type": "string"
|
|
3718
|
+
},
|
|
3719
|
+
"on_behalf_of_label": {
|
|
3720
|
+
"type": "string",
|
|
3721
|
+
"description": "Display name of the on_behalf_of user/agent (populated during expansion)",
|
|
3722
|
+
"example": "Research Assistant"
|
|
3486
3723
|
}
|
|
3487
3724
|
},
|
|
3488
3725
|
"required": [
|
|
3489
3726
|
"user_id",
|
|
3490
3727
|
"method"
|
|
3491
3728
|
],
|
|
3492
|
-
"description": "Audit trail for edits",
|
|
3729
|
+
"description": "Audit trail for edits. Label fields are populated when ?expand=relationships is used.",
|
|
3493
3730
|
"example": {
|
|
3494
3731
|
"user_id": "01JCAPTAINAHAB000000000000",
|
|
3732
|
+
"user_label": "Captain Ahab",
|
|
3495
3733
|
"method": "manual"
|
|
3496
3734
|
}
|
|
3497
3735
|
}
|
|
@@ -4017,6 +4255,11 @@
|
|
|
4017
4255
|
"type": "string",
|
|
4018
4256
|
"minLength": 1
|
|
4019
4257
|
},
|
|
4258
|
+
"user_label": {
|
|
4259
|
+
"type": "string",
|
|
4260
|
+
"description": "Display name of the user/agent (populated during expansion)",
|
|
4261
|
+
"example": "Captain Ahab"
|
|
4262
|
+
},
|
|
4020
4263
|
"method": {
|
|
4021
4264
|
"type": "string",
|
|
4022
4265
|
"enum": [
|
|
@@ -4028,15 +4271,21 @@
|
|
|
4028
4271
|
},
|
|
4029
4272
|
"on_behalf_of": {
|
|
4030
4273
|
"type": "string"
|
|
4274
|
+
},
|
|
4275
|
+
"on_behalf_of_label": {
|
|
4276
|
+
"type": "string",
|
|
4277
|
+
"description": "Display name of the on_behalf_of user/agent (populated during expansion)",
|
|
4278
|
+
"example": "Research Assistant"
|
|
4031
4279
|
}
|
|
4032
4280
|
},
|
|
4033
4281
|
"required": [
|
|
4034
4282
|
"user_id",
|
|
4035
4283
|
"method"
|
|
4036
4284
|
],
|
|
4037
|
-
"description": "Audit trail for edits",
|
|
4285
|
+
"description": "Audit trail for edits. Label fields are populated when ?expand=relationships is used.",
|
|
4038
4286
|
"example": {
|
|
4039
4287
|
"user_id": "01JCAPTAINAHAB000000000000",
|
|
4288
|
+
"user_label": "Captain Ahab",
|
|
4040
4289
|
"method": "manual"
|
|
4041
4290
|
}
|
|
4042
4291
|
}
|
|
@@ -4740,6 +4989,11 @@
|
|
|
4740
4989
|
"type": "string",
|
|
4741
4990
|
"minLength": 1
|
|
4742
4991
|
},
|
|
4992
|
+
"user_label": {
|
|
4993
|
+
"type": "string",
|
|
4994
|
+
"description": "Display name of the user/agent (populated during expansion)",
|
|
4995
|
+
"example": "Captain Ahab"
|
|
4996
|
+
},
|
|
4743
4997
|
"method": {
|
|
4744
4998
|
"type": "string",
|
|
4745
4999
|
"enum": [
|
|
@@ -4751,15 +5005,21 @@
|
|
|
4751
5005
|
},
|
|
4752
5006
|
"on_behalf_of": {
|
|
4753
5007
|
"type": "string"
|
|
5008
|
+
},
|
|
5009
|
+
"on_behalf_of_label": {
|
|
5010
|
+
"type": "string",
|
|
5011
|
+
"description": "Display name of the on_behalf_of user/agent (populated during expansion)",
|
|
5012
|
+
"example": "Research Assistant"
|
|
4754
5013
|
}
|
|
4755
5014
|
},
|
|
4756
5015
|
"required": [
|
|
4757
5016
|
"user_id",
|
|
4758
5017
|
"method"
|
|
4759
5018
|
],
|
|
4760
|
-
"description": "Audit trail for edits",
|
|
5019
|
+
"description": "Audit trail for edits. Label fields are populated when ?expand=relationships is used.",
|
|
4761
5020
|
"example": {
|
|
4762
5021
|
"user_id": "01JCAPTAINAHAB000000000000",
|
|
5022
|
+
"user_label": "Captain Ahab",
|
|
4763
5023
|
"method": "manual"
|
|
4764
5024
|
}
|
|
4765
5025
|
},
|
|
@@ -4935,6 +5195,11 @@
|
|
|
4935
5195
|
"type": "string",
|
|
4936
5196
|
"minLength": 1
|
|
4937
5197
|
},
|
|
5198
|
+
"user_label": {
|
|
5199
|
+
"type": "string",
|
|
5200
|
+
"description": "Display name of the user/agent (populated during expansion)",
|
|
5201
|
+
"example": "Captain Ahab"
|
|
5202
|
+
},
|
|
4938
5203
|
"method": {
|
|
4939
5204
|
"type": "string",
|
|
4940
5205
|
"enum": [
|
|
@@ -4946,15 +5211,21 @@
|
|
|
4946
5211
|
},
|
|
4947
5212
|
"on_behalf_of": {
|
|
4948
5213
|
"type": "string"
|
|
5214
|
+
},
|
|
5215
|
+
"on_behalf_of_label": {
|
|
5216
|
+
"type": "string",
|
|
5217
|
+
"description": "Display name of the on_behalf_of user/agent (populated during expansion)",
|
|
5218
|
+
"example": "Research Assistant"
|
|
4949
5219
|
}
|
|
4950
5220
|
},
|
|
4951
5221
|
"required": [
|
|
4952
5222
|
"user_id",
|
|
4953
5223
|
"method"
|
|
4954
5224
|
],
|
|
4955
|
-
"description": "Audit trail for edits",
|
|
5225
|
+
"description": "Audit trail for edits. Label fields are populated when ?expand=relationships is used.",
|
|
4956
5226
|
"example": {
|
|
4957
5227
|
"user_id": "01JCAPTAINAHAB000000000000",
|
|
5228
|
+
"user_label": "Captain Ahab",
|
|
4958
5229
|
"method": "manual"
|
|
4959
5230
|
}
|
|
4960
5231
|
},
|
|
@@ -7140,6 +7411,104 @@
|
|
|
7140
7411
|
"path"
|
|
7141
7412
|
]
|
|
7142
7413
|
},
|
|
7414
|
+
"MessageTooLargeDetails": {
|
|
7415
|
+
"type": "object",
|
|
7416
|
+
"properties": {
|
|
7417
|
+
"code": {
|
|
7418
|
+
"type": "string",
|
|
7419
|
+
"enum": [
|
|
7420
|
+
"MESSAGE_TOO_LARGE"
|
|
7421
|
+
]
|
|
7422
|
+
},
|
|
7423
|
+
"message": {
|
|
7424
|
+
"type": "string"
|
|
7425
|
+
},
|
|
7426
|
+
"limit": {
|
|
7427
|
+
"type": "string",
|
|
7428
|
+
"example": "2MB"
|
|
7429
|
+
},
|
|
7430
|
+
"actual": {
|
|
7431
|
+
"type": "string",
|
|
7432
|
+
"example": "2.48MB"
|
|
7433
|
+
}
|
|
7434
|
+
},
|
|
7435
|
+
"required": [
|
|
7436
|
+
"code",
|
|
7437
|
+
"message",
|
|
7438
|
+
"limit"
|
|
7439
|
+
]
|
|
7440
|
+
},
|
|
7441
|
+
"MessageTooLargeError": {
|
|
7442
|
+
"type": "object",
|
|
7443
|
+
"properties": {
|
|
7444
|
+
"error": {
|
|
7445
|
+
"type": "string",
|
|
7446
|
+
"description": "Human-readable error message",
|
|
7447
|
+
"example": "Message exceeds maximum size limit. Please shorten your message."
|
|
7448
|
+
},
|
|
7449
|
+
"code": {
|
|
7450
|
+
"type": "string",
|
|
7451
|
+
"enum": [
|
|
7452
|
+
"MESSAGE_TOO_LARGE"
|
|
7453
|
+
],
|
|
7454
|
+
"description": "Error code for client handling"
|
|
7455
|
+
},
|
|
7456
|
+
"details": {
|
|
7457
|
+
"$ref": "#/components/schemas/MessageTooLargeDetails"
|
|
7458
|
+
}
|
|
7459
|
+
},
|
|
7460
|
+
"required": [
|
|
7461
|
+
"error",
|
|
7462
|
+
"code"
|
|
7463
|
+
]
|
|
7464
|
+
},
|
|
7465
|
+
"ChatStorageFullDetails": {
|
|
7466
|
+
"type": "object",
|
|
7467
|
+
"properties": {
|
|
7468
|
+
"code": {
|
|
7469
|
+
"type": "string",
|
|
7470
|
+
"enum": [
|
|
7471
|
+
"CHAT_STORAGE_FULL"
|
|
7472
|
+
]
|
|
7473
|
+
},
|
|
7474
|
+
"message": {
|
|
7475
|
+
"type": "string"
|
|
7476
|
+
},
|
|
7477
|
+
"limit": {
|
|
7478
|
+
"type": "string",
|
|
7479
|
+
"example": "10GB"
|
|
7480
|
+
}
|
|
7481
|
+
},
|
|
7482
|
+
"required": [
|
|
7483
|
+
"code",
|
|
7484
|
+
"message",
|
|
7485
|
+
"limit"
|
|
7486
|
+
]
|
|
7487
|
+
},
|
|
7488
|
+
"ChatStorageFullError": {
|
|
7489
|
+
"type": "object",
|
|
7490
|
+
"properties": {
|
|
7491
|
+
"error": {
|
|
7492
|
+
"type": "string",
|
|
7493
|
+
"description": "Human-readable error message",
|
|
7494
|
+
"example": "This conversation has reached its maximum storage capacity. Please start a new conversation."
|
|
7495
|
+
},
|
|
7496
|
+
"code": {
|
|
7497
|
+
"type": "string",
|
|
7498
|
+
"enum": [
|
|
7499
|
+
"CHAT_STORAGE_FULL"
|
|
7500
|
+
],
|
|
7501
|
+
"description": "Error code for client handling"
|
|
7502
|
+
},
|
|
7503
|
+
"details": {
|
|
7504
|
+
"$ref": "#/components/schemas/ChatStorageFullDetails"
|
|
7505
|
+
}
|
|
7506
|
+
},
|
|
7507
|
+
"required": [
|
|
7508
|
+
"error",
|
|
7509
|
+
"code"
|
|
7510
|
+
]
|
|
7511
|
+
},
|
|
7143
7512
|
"TextPart": {
|
|
7144
7513
|
"type": "object",
|
|
7145
7514
|
"properties": {
|
|
@@ -7258,6 +7627,72 @@
|
|
|
7258
7627
|
"messages"
|
|
7259
7628
|
]
|
|
7260
7629
|
},
|
|
7630
|
+
"ChatListItem": {
|
|
7631
|
+
"type": "object",
|
|
7632
|
+
"properties": {
|
|
7633
|
+
"id": {
|
|
7634
|
+
"type": "string",
|
|
7635
|
+
"description": "Chat UUID (use with X-Chat-ID header)",
|
|
7636
|
+
"example": "550e8400-e29b-41d4-a716-446655440000"
|
|
7637
|
+
},
|
|
7638
|
+
"title": {
|
|
7639
|
+
"type": "string",
|
|
7640
|
+
"nullable": true,
|
|
7641
|
+
"description": "Auto-generated from first message (50 chars)",
|
|
7642
|
+
"example": "Help me understand the Arke API..."
|
|
7643
|
+
},
|
|
7644
|
+
"createdAt": {
|
|
7645
|
+
"type": "string",
|
|
7646
|
+
"description": "ISO8601 timestamp of chat creation",
|
|
7647
|
+
"example": "2026-01-26T14:30:00.000Z"
|
|
7648
|
+
},
|
|
7649
|
+
"updatedAt": {
|
|
7650
|
+
"type": "string",
|
|
7651
|
+
"description": "ISO8601 timestamp of last message",
|
|
7652
|
+
"example": "2026-01-26T15:45:00.000Z"
|
|
7653
|
+
},
|
|
7654
|
+
"lastMessagePreview": {
|
|
7655
|
+
"type": "string",
|
|
7656
|
+
"nullable": true,
|
|
7657
|
+
"description": "Last assistant response (100 chars, markdown stripped)",
|
|
7658
|
+
"example": "I found 3 entities matching your query. The first one is..."
|
|
7659
|
+
}
|
|
7660
|
+
},
|
|
7661
|
+
"required": [
|
|
7662
|
+
"id",
|
|
7663
|
+
"title",
|
|
7664
|
+
"createdAt",
|
|
7665
|
+
"updatedAt",
|
|
7666
|
+
"lastMessagePreview"
|
|
7667
|
+
]
|
|
7668
|
+
},
|
|
7669
|
+
"ListChatsResponse": {
|
|
7670
|
+
"type": "object",
|
|
7671
|
+
"properties": {
|
|
7672
|
+
"chats": {
|
|
7673
|
+
"type": "array",
|
|
7674
|
+
"items": {
|
|
7675
|
+
"$ref": "#/components/schemas/ChatListItem"
|
|
7676
|
+
},
|
|
7677
|
+
"description": "Array of chat metadata objects"
|
|
7678
|
+
},
|
|
7679
|
+
"total": {
|
|
7680
|
+
"type": "number",
|
|
7681
|
+
"description": "Total number of chats for this user",
|
|
7682
|
+
"example": 42
|
|
7683
|
+
},
|
|
7684
|
+
"hasMore": {
|
|
7685
|
+
"type": "boolean",
|
|
7686
|
+
"description": "True if more chats exist beyond current page",
|
|
7687
|
+
"example": true
|
|
7688
|
+
}
|
|
7689
|
+
},
|
|
7690
|
+
"required": [
|
|
7691
|
+
"chats",
|
|
7692
|
+
"total",
|
|
7693
|
+
"hasMore"
|
|
7694
|
+
]
|
|
7695
|
+
},
|
|
7261
7696
|
"ChatSession": {
|
|
7262
7697
|
"type": "object",
|
|
7263
7698
|
"properties": {
|
|
@@ -9545,6 +9980,104 @@
|
|
|
9545
9980
|
}
|
|
9546
9981
|
}
|
|
9547
9982
|
},
|
|
9983
|
+
"/entities/batch": {
|
|
9984
|
+
"post": {
|
|
9985
|
+
"tags": [
|
|
9986
|
+
"Entities"
|
|
9987
|
+
],
|
|
9988
|
+
"summary": "Batch create entities",
|
|
9989
|
+
"description": "Creates multiple entities in a single request with bounded internal concurrency.\n\nEntities are created in chunks of 10 internally. Each entity follows the same permission model as single creates.\n\nReturns per-entity results. HTTP 201 if all succeed, 207 if some fail.\n\n**Max batch size:** 100 entities.\n\n---\n**Permission:** `entity:create` \n**Auth:** required",
|
|
9990
|
+
"x-arke-action": "entity:create",
|
|
9991
|
+
"x-arke-auth": "required",
|
|
9992
|
+
"x-arke-tier": "standard",
|
|
9993
|
+
"security": [
|
|
9994
|
+
{
|
|
9995
|
+
"bearerAuth": []
|
|
9996
|
+
}
|
|
9997
|
+
],
|
|
9998
|
+
"requestBody": {
|
|
9999
|
+
"content": {
|
|
10000
|
+
"application/json": {
|
|
10001
|
+
"schema": {
|
|
10002
|
+
"$ref": "#/components/schemas/BatchCreateEntityRequest"
|
|
10003
|
+
}
|
|
10004
|
+
}
|
|
10005
|
+
}
|
|
10006
|
+
},
|
|
10007
|
+
"responses": {
|
|
10008
|
+
"201": {
|
|
10009
|
+
"description": "All entities created successfully",
|
|
10010
|
+
"content": {
|
|
10011
|
+
"application/json": {
|
|
10012
|
+
"schema": {
|
|
10013
|
+
"$ref": "#/components/schemas/BatchCreateEntityResponse"
|
|
10014
|
+
}
|
|
10015
|
+
}
|
|
10016
|
+
}
|
|
10017
|
+
},
|
|
10018
|
+
"207": {
|
|
10019
|
+
"description": "Partial success - some entities failed",
|
|
10020
|
+
"content": {
|
|
10021
|
+
"application/json": {
|
|
10022
|
+
"schema": {
|
|
10023
|
+
"$ref": "#/components/schemas/BatchCreateEntityResponse"
|
|
10024
|
+
}
|
|
10025
|
+
}
|
|
10026
|
+
}
|
|
10027
|
+
},
|
|
10028
|
+
"400": {
|
|
10029
|
+
"description": "Bad Request - Invalid input",
|
|
10030
|
+
"content": {
|
|
10031
|
+
"application/json": {
|
|
10032
|
+
"schema": {
|
|
10033
|
+
"$ref": "#/components/schemas/ValidationErrorResponse"
|
|
10034
|
+
},
|
|
10035
|
+
"example": {
|
|
10036
|
+
"error": "Validation failed",
|
|
10037
|
+
"details": {
|
|
10038
|
+
"issues": [
|
|
10039
|
+
{
|
|
10040
|
+
"path": [
|
|
10041
|
+
"properties",
|
|
10042
|
+
"label"
|
|
10043
|
+
],
|
|
10044
|
+
"message": "Required"
|
|
10045
|
+
}
|
|
10046
|
+
]
|
|
10047
|
+
}
|
|
10048
|
+
}
|
|
10049
|
+
}
|
|
10050
|
+
}
|
|
10051
|
+
},
|
|
10052
|
+
"401": {
|
|
10053
|
+
"description": "Unauthorized - Missing or invalid authentication",
|
|
10054
|
+
"content": {
|
|
10055
|
+
"application/json": {
|
|
10056
|
+
"schema": {
|
|
10057
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
10058
|
+
},
|
|
10059
|
+
"example": {
|
|
10060
|
+
"error": "Unauthorized: Missing or invalid authentication token"
|
|
10061
|
+
}
|
|
10062
|
+
}
|
|
10063
|
+
}
|
|
10064
|
+
},
|
|
10065
|
+
"403": {
|
|
10066
|
+
"description": "Forbidden - Insufficient permissions",
|
|
10067
|
+
"content": {
|
|
10068
|
+
"application/json": {
|
|
10069
|
+
"schema": {
|
|
10070
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
10071
|
+
},
|
|
10072
|
+
"example": {
|
|
10073
|
+
"error": "Forbidden: You do not have permission to perform this action"
|
|
10074
|
+
}
|
|
10075
|
+
}
|
|
10076
|
+
}
|
|
10077
|
+
}
|
|
10078
|
+
}
|
|
10079
|
+
}
|
|
10080
|
+
},
|
|
9548
10081
|
"/entities/{id}": {
|
|
9549
10082
|
"get": {
|
|
9550
10083
|
"tags": [
|
|
@@ -14909,7 +15442,7 @@
|
|
|
14909
15442
|
"Search"
|
|
14910
15443
|
],
|
|
14911
15444
|
"summary": "Search agents by text",
|
|
14912
|
-
"description": "Search for agents using semantic text search.\n\
|
|
15445
|
+
"description": "Search for agents using semantic text search.\n\n**Official Agents (Default):** By default, this endpoint searches only the official Arke agents collection (`01KFF0H1KSR4SHHDQ7T2HXQEK6`). These agents are pre-approved, actively maintained, and tested for security and reliability.\n\n**All Agents:** Set `scope: \"all\"` to search network-wide. This is not recommended as results may include duplicates, outdated agents, or unapproved implementations.\n\nResults are ranked by semantic similarity to your query based on agent descriptions and capabilities.\n\n**Entity Expansion:**\n\nBy default, agent search returns **full entity manifests** (including `endpoint`, `input_schema`, `actions_required`, etc.) to make discovery results immediately useful.\n\n- **`expand: \"full\"` (default)**: Complete agent manifests with all properties\n- **`expand: \"preview\"`**: Lightweight previews (id, type, label, description_preview, timestamps)\n- **`expand: \"none\"`**: Search metadata only (fastest)\n\n---\n**Permission:** `search:query` \n**Auth:** required",
|
|
14913
15446
|
"x-arke-action": "search:query",
|
|
14914
15447
|
"x-arke-auth": "required",
|
|
14915
15448
|
"x-arke-tier": "external",
|
|
@@ -14946,6 +15479,15 @@
|
|
|
14946
15479
|
],
|
|
14947
15480
|
"description": "Entity expansion mode. Default: \"preview\" for lightweight previews, \"full\" for complete manifests, \"none\" for no expansion.",
|
|
14948
15481
|
"example": "preview"
|
|
15482
|
+
},
|
|
15483
|
+
"scope": {
|
|
15484
|
+
"type": "string",
|
|
15485
|
+
"enum": [
|
|
15486
|
+
"official",
|
|
15487
|
+
"all"
|
|
15488
|
+
],
|
|
15489
|
+
"default": "official",
|
|
15490
|
+
"description": "Search scope. \"official\" (default) searches only the pre-approved Arke agents collection. \"all\" searches all agents network-wide (not recommended - may include duplicates, outdated, or unapproved agents)."
|
|
14949
15491
|
}
|
|
14950
15492
|
},
|
|
14951
15493
|
"required": [
|
|
@@ -15546,7 +16088,7 @@
|
|
|
15546
16088
|
"Chat"
|
|
15547
16089
|
],
|
|
15548
16090
|
"summary": "Send chat message",
|
|
15549
|
-
"description": "Send a message to the Arke chat agent and receive a streaming response.\n\nThe agent can execute Arke API operations on your behalf using the authenticated user's permissions.\n\n## Headers\n\n- `X-Chat-ID`: Optional. Specify to continue an existing chat session. If omitted, a new session is created.\n\n## Response Format\n\nThe response is a Server-Sent Events (SSE) stream in AI SDK v5 UIMessage format.\nStream chunks include text deltas, tool calls, and usage information.\n\n## Token Usage Tracking\n\nUsage information is included at the end of the stream in the format:\n```json\n{\"type\":\"message_delta\",\"delta\":{\"usage\":{\"input_tokens\":123,\"output_tokens\":456}}}\n```\n\n\n---\n**Permission:** `chat:send` \n**Auth:** required",
|
|
16091
|
+
"description": "Send a message to the Arke chat agent and receive a streaming response.\n\nThe agent can execute Arke API operations on your behalf using the authenticated user's permissions.\n\n## Headers\n\n- `X-Chat-ID`: Optional. Specify to continue an existing chat session. If omitted, a new session is created.\n\n## Response Format\n\nThe response is a Server-Sent Events (SSE) stream in AI SDK v5 UIMessage format.\nStream chunks include text deltas, tool calls, and usage information.\n\n## Token Usage Tracking\n\nUsage information is included at the end of the stream in the format:\n```json\n{\"type\":\"message_delta\",\"delta\":{\"usage\":{\"input_tokens\":123,\"output_tokens\":456}}}\n```\n\n## Storage Limits\n\n- **Single message**: 2 MB max (returns 413 with code `MESSAGE_TOO_LARGE`)\n- **Chat database**: 10 GB max (returns 507 with code `CHAT_STORAGE_FULL`)\n- **LLM context**: ~128K tokens (returns stream error)\n\n\n---\n**Permission:** `chat:send` \n**Auth:** required",
|
|
15550
16092
|
"x-arke-action": "chat:send",
|
|
15551
16093
|
"x-arke-auth": "required",
|
|
15552
16094
|
"x-arke-tier": "external",
|
|
@@ -15601,6 +16143,68 @@
|
|
|
15601
16143
|
}
|
|
15602
16144
|
}
|
|
15603
16145
|
}
|
|
16146
|
+
},
|
|
16147
|
+
"413": {
|
|
16148
|
+
"description": "Message exceeds 2MB storage limit",
|
|
16149
|
+
"content": {
|
|
16150
|
+
"application/json": {
|
|
16151
|
+
"schema": {
|
|
16152
|
+
"$ref": "#/components/schemas/MessageTooLargeError"
|
|
16153
|
+
}
|
|
16154
|
+
}
|
|
16155
|
+
}
|
|
16156
|
+
},
|
|
16157
|
+
"507": {
|
|
16158
|
+
"description": "Chat storage full (10GB limit)",
|
|
16159
|
+
"content": {
|
|
16160
|
+
"application/json": {
|
|
16161
|
+
"schema": {
|
|
16162
|
+
"$ref": "#/components/schemas/ChatStorageFullError"
|
|
16163
|
+
}
|
|
16164
|
+
}
|
|
16165
|
+
}
|
|
16166
|
+
}
|
|
16167
|
+
}
|
|
16168
|
+
}
|
|
16169
|
+
},
|
|
16170
|
+
"/chat/sessions": {
|
|
16171
|
+
"get": {
|
|
16172
|
+
"tags": [
|
|
16173
|
+
"Chat"
|
|
16174
|
+
],
|
|
16175
|
+
"summary": "List user chats",
|
|
16176
|
+
"description": "Returns a paginated list of the authenticated user's chats, sorted newest-first.\n\nOnly returns chats owned by the authenticated user. Anonymous chats are not indexed.\n\nQuery parameters:\n- `limit`: Max chats to return (1-100, default 20)\n- `offset`: Number of chats to skip for pagination (default 0)\n\n---\n**Permission:** `chat:view` \n**Auth:** required",
|
|
16177
|
+
"x-arke-action": "chat:view",
|
|
16178
|
+
"x-arke-auth": "required",
|
|
16179
|
+
"x-arke-tier": "standard",
|
|
16180
|
+
"security": [
|
|
16181
|
+
{
|
|
16182
|
+
"bearerAuth": []
|
|
16183
|
+
}
|
|
16184
|
+
],
|
|
16185
|
+
"responses": {
|
|
16186
|
+
"200": {
|
|
16187
|
+
"description": "List of user chats",
|
|
16188
|
+
"content": {
|
|
16189
|
+
"application/json": {
|
|
16190
|
+
"schema": {
|
|
16191
|
+
"$ref": "#/components/schemas/ListChatsResponse"
|
|
16192
|
+
}
|
|
16193
|
+
}
|
|
16194
|
+
}
|
|
16195
|
+
},
|
|
16196
|
+
"401": {
|
|
16197
|
+
"description": "Unauthorized - Missing or invalid authentication",
|
|
16198
|
+
"content": {
|
|
16199
|
+
"application/json": {
|
|
16200
|
+
"schema": {
|
|
16201
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
16202
|
+
},
|
|
16203
|
+
"example": {
|
|
16204
|
+
"error": "Unauthorized: Missing or invalid authentication token"
|
|
16205
|
+
}
|
|
16206
|
+
}
|
|
16207
|
+
}
|
|
15604
16208
|
}
|
|
15605
16209
|
}
|
|
15606
16210
|
}
|
|
@@ -15611,10 +16215,15 @@
|
|
|
15611
16215
|
"Chat"
|
|
15612
16216
|
],
|
|
15613
16217
|
"summary": "Get chat session",
|
|
15614
|
-
"description": "Get information about a chat session including message history.\n\
|
|
16218
|
+
"description": "Get information about a chat session including message history.\n\nOnly the session owner can view their chat sessions.\n\n---\n**Permission:** `chat:view` \n**Auth:** required",
|
|
15615
16219
|
"x-arke-action": "chat:view",
|
|
15616
|
-
"x-arke-auth": "
|
|
16220
|
+
"x-arke-auth": "required",
|
|
15617
16221
|
"x-arke-tier": "standard",
|
|
16222
|
+
"security": [
|
|
16223
|
+
{
|
|
16224
|
+
"bearerAuth": []
|
|
16225
|
+
}
|
|
16226
|
+
],
|
|
15618
16227
|
"responses": {
|
|
15619
16228
|
"200": {
|
|
15620
16229
|
"description": "Chat session info",
|
|
@@ -15626,6 +16235,32 @@
|
|
|
15626
16235
|
}
|
|
15627
16236
|
}
|
|
15628
16237
|
},
|
|
16238
|
+
"401": {
|
|
16239
|
+
"description": "Unauthorized - Missing or invalid authentication",
|
|
16240
|
+
"content": {
|
|
16241
|
+
"application/json": {
|
|
16242
|
+
"schema": {
|
|
16243
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
16244
|
+
},
|
|
16245
|
+
"example": {
|
|
16246
|
+
"error": "Unauthorized: Missing or invalid authentication token"
|
|
16247
|
+
}
|
|
16248
|
+
}
|
|
16249
|
+
}
|
|
16250
|
+
},
|
|
16251
|
+
"403": {
|
|
16252
|
+
"description": "Forbidden - Insufficient permissions",
|
|
16253
|
+
"content": {
|
|
16254
|
+
"application/json": {
|
|
16255
|
+
"schema": {
|
|
16256
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
16257
|
+
},
|
|
16258
|
+
"example": {
|
|
16259
|
+
"error": "Forbidden: You do not have permission to perform this action"
|
|
16260
|
+
}
|
|
16261
|
+
}
|
|
16262
|
+
}
|
|
16263
|
+
},
|
|
15629
16264
|
"404": {
|
|
15630
16265
|
"description": "Not Found - Resource does not exist",
|
|
15631
16266
|
"content": {
|