@arke-institute/sdk 2.3.9 → 2.3.10
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/generated/index.d.cts +359 -1
- package/dist/generated/index.d.ts +359 -1
- package/openapi/spec.json +508 -0
- package/openapi/version.json +1 -1
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*
|
|
7
7
|
* Source: Arke v1 API
|
|
8
8
|
* Version: 1.0.0
|
|
9
|
-
* Generated: 2026-01-
|
|
9
|
+
* Generated: 2026-01-13T18:00:18.256Z
|
|
10
10
|
*/
|
|
11
11
|
type paths = {
|
|
12
12
|
"/auth/register": {
|
|
@@ -6202,6 +6202,364 @@ type paths = {
|
|
|
6202
6202
|
patch?: never;
|
|
6203
6203
|
trace?: never;
|
|
6204
6204
|
};
|
|
6205
|
+
"/search/collections": {
|
|
6206
|
+
parameters: {
|
|
6207
|
+
query?: never;
|
|
6208
|
+
header?: never;
|
|
6209
|
+
path?: never;
|
|
6210
|
+
cookie?: never;
|
|
6211
|
+
};
|
|
6212
|
+
get?: never;
|
|
6213
|
+
put?: never;
|
|
6214
|
+
/**
|
|
6215
|
+
* Search collections by text
|
|
6216
|
+
* @description Search for collections using semantic text search.
|
|
6217
|
+
*
|
|
6218
|
+
* Use this endpoint to discover collections about a topic. Results are ranked by semantic similarity to your query.
|
|
6219
|
+
*/
|
|
6220
|
+
post: {
|
|
6221
|
+
parameters: {
|
|
6222
|
+
query?: never;
|
|
6223
|
+
header?: never;
|
|
6224
|
+
path?: never;
|
|
6225
|
+
cookie?: never;
|
|
6226
|
+
};
|
|
6227
|
+
requestBody?: {
|
|
6228
|
+
content: {
|
|
6229
|
+
"application/json": {
|
|
6230
|
+
/** @description Search query text */
|
|
6231
|
+
query: string;
|
|
6232
|
+
/**
|
|
6233
|
+
* @description Maximum results to return
|
|
6234
|
+
* @default 10
|
|
6235
|
+
*/
|
|
6236
|
+
limit?: number;
|
|
6237
|
+
/** @description Filter by collection types */
|
|
6238
|
+
types?: string[];
|
|
6239
|
+
};
|
|
6240
|
+
};
|
|
6241
|
+
};
|
|
6242
|
+
responses: {
|
|
6243
|
+
/** @description Search results */
|
|
6244
|
+
200: {
|
|
6245
|
+
headers: {
|
|
6246
|
+
[name: string]: unknown;
|
|
6247
|
+
};
|
|
6248
|
+
content: {
|
|
6249
|
+
"application/json": {
|
|
6250
|
+
results: {
|
|
6251
|
+
pi: string;
|
|
6252
|
+
label: string;
|
|
6253
|
+
type: string;
|
|
6254
|
+
score: number;
|
|
6255
|
+
created_at?: string;
|
|
6256
|
+
updated_at?: string;
|
|
6257
|
+
}[];
|
|
6258
|
+
metadata: {
|
|
6259
|
+
query: string;
|
|
6260
|
+
result_count: number;
|
|
6261
|
+
};
|
|
6262
|
+
};
|
|
6263
|
+
};
|
|
6264
|
+
};
|
|
6265
|
+
/** @description Bad Request - Invalid input */
|
|
6266
|
+
400: {
|
|
6267
|
+
headers: {
|
|
6268
|
+
[name: string]: unknown;
|
|
6269
|
+
};
|
|
6270
|
+
content: {
|
|
6271
|
+
/**
|
|
6272
|
+
* @example {
|
|
6273
|
+
* "error": "Validation failed",
|
|
6274
|
+
* "details": {
|
|
6275
|
+
* "issues": [
|
|
6276
|
+
* {
|
|
6277
|
+
* "path": [
|
|
6278
|
+
* "properties",
|
|
6279
|
+
* "label"
|
|
6280
|
+
* ],
|
|
6281
|
+
* "message": "Required"
|
|
6282
|
+
* }
|
|
6283
|
+
* ]
|
|
6284
|
+
* }
|
|
6285
|
+
* }
|
|
6286
|
+
*/
|
|
6287
|
+
"application/json": components["schemas"]["ValidationErrorResponse"];
|
|
6288
|
+
};
|
|
6289
|
+
};
|
|
6290
|
+
/** @description Service Unavailable - External service not available */
|
|
6291
|
+
503: {
|
|
6292
|
+
headers: {
|
|
6293
|
+
[name: string]: unknown;
|
|
6294
|
+
};
|
|
6295
|
+
content: {
|
|
6296
|
+
/**
|
|
6297
|
+
* @example {
|
|
6298
|
+
* "error": "Service unavailable",
|
|
6299
|
+
* "details": {
|
|
6300
|
+
* "service": "pinecone"
|
|
6301
|
+
* }
|
|
6302
|
+
* }
|
|
6303
|
+
*/
|
|
6304
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
6305
|
+
};
|
|
6306
|
+
};
|
|
6307
|
+
};
|
|
6308
|
+
};
|
|
6309
|
+
delete?: never;
|
|
6310
|
+
options?: never;
|
|
6311
|
+
head?: never;
|
|
6312
|
+
patch?: never;
|
|
6313
|
+
trace?: never;
|
|
6314
|
+
};
|
|
6315
|
+
"/search/entities": {
|
|
6316
|
+
parameters: {
|
|
6317
|
+
query?: never;
|
|
6318
|
+
header?: never;
|
|
6319
|
+
path?: never;
|
|
6320
|
+
cookie?: never;
|
|
6321
|
+
};
|
|
6322
|
+
get?: never;
|
|
6323
|
+
put?: never;
|
|
6324
|
+
/**
|
|
6325
|
+
* Search entities within collection(s)
|
|
6326
|
+
* @description Search for entities within one or more collections using semantic text search.
|
|
6327
|
+
*
|
|
6328
|
+
* Provide either `collection_pi` for a single collection or `collection_pis` for multiple collections (searched in parallel).
|
|
6329
|
+
*
|
|
6330
|
+
* Use `per_collection_limit` to ensure result diversity when searching multiple collections.
|
|
6331
|
+
*/
|
|
6332
|
+
post: {
|
|
6333
|
+
parameters: {
|
|
6334
|
+
query?: never;
|
|
6335
|
+
header?: never;
|
|
6336
|
+
path?: never;
|
|
6337
|
+
cookie?: never;
|
|
6338
|
+
};
|
|
6339
|
+
requestBody?: {
|
|
6340
|
+
content: {
|
|
6341
|
+
"application/json": {
|
|
6342
|
+
/** @description Single collection PI to search within */
|
|
6343
|
+
collection_pi?: string;
|
|
6344
|
+
/** @description Multiple collection PIs to search (max 20) */
|
|
6345
|
+
collection_pis?: string[];
|
|
6346
|
+
/** @description Search query text */
|
|
6347
|
+
query: string;
|
|
6348
|
+
/**
|
|
6349
|
+
* @description Maximum total results to return
|
|
6350
|
+
* @default 20
|
|
6351
|
+
*/
|
|
6352
|
+
limit?: number;
|
|
6353
|
+
/** @description Filter by entity types */
|
|
6354
|
+
types?: string[];
|
|
6355
|
+
/** @description Max results per collection for diversity */
|
|
6356
|
+
per_collection_limit?: number;
|
|
6357
|
+
};
|
|
6358
|
+
};
|
|
6359
|
+
};
|
|
6360
|
+
responses: {
|
|
6361
|
+
/** @description Search results */
|
|
6362
|
+
200: {
|
|
6363
|
+
headers: {
|
|
6364
|
+
[name: string]: unknown;
|
|
6365
|
+
};
|
|
6366
|
+
content: {
|
|
6367
|
+
"application/json": {
|
|
6368
|
+
results: {
|
|
6369
|
+
pi: string;
|
|
6370
|
+
label: string;
|
|
6371
|
+
type: string;
|
|
6372
|
+
score: number;
|
|
6373
|
+
collection_pi: string;
|
|
6374
|
+
created_at?: string;
|
|
6375
|
+
updated_at?: string;
|
|
6376
|
+
}[];
|
|
6377
|
+
metadata: {
|
|
6378
|
+
collection_pis: string[];
|
|
6379
|
+
query: string;
|
|
6380
|
+
collections_searched: number;
|
|
6381
|
+
result_count: number;
|
|
6382
|
+
};
|
|
6383
|
+
};
|
|
6384
|
+
};
|
|
6385
|
+
};
|
|
6386
|
+
/** @description Bad Request - Invalid input */
|
|
6387
|
+
400: {
|
|
6388
|
+
headers: {
|
|
6389
|
+
[name: string]: unknown;
|
|
6390
|
+
};
|
|
6391
|
+
content: {
|
|
6392
|
+
/**
|
|
6393
|
+
* @example {
|
|
6394
|
+
* "error": "Validation failed",
|
|
6395
|
+
* "details": {
|
|
6396
|
+
* "issues": [
|
|
6397
|
+
* {
|
|
6398
|
+
* "path": [
|
|
6399
|
+
* "properties",
|
|
6400
|
+
* "label"
|
|
6401
|
+
* ],
|
|
6402
|
+
* "message": "Required"
|
|
6403
|
+
* }
|
|
6404
|
+
* ]
|
|
6405
|
+
* }
|
|
6406
|
+
* }
|
|
6407
|
+
*/
|
|
6408
|
+
"application/json": components["schemas"]["ValidationErrorResponse"];
|
|
6409
|
+
};
|
|
6410
|
+
};
|
|
6411
|
+
/** @description Service Unavailable - External service not available */
|
|
6412
|
+
503: {
|
|
6413
|
+
headers: {
|
|
6414
|
+
[name: string]: unknown;
|
|
6415
|
+
};
|
|
6416
|
+
content: {
|
|
6417
|
+
/**
|
|
6418
|
+
* @example {
|
|
6419
|
+
* "error": "Service unavailable",
|
|
6420
|
+
* "details": {
|
|
6421
|
+
* "service": "pinecone"
|
|
6422
|
+
* }
|
|
6423
|
+
* }
|
|
6424
|
+
*/
|
|
6425
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
6426
|
+
};
|
|
6427
|
+
};
|
|
6428
|
+
};
|
|
6429
|
+
};
|
|
6430
|
+
delete?: never;
|
|
6431
|
+
options?: never;
|
|
6432
|
+
head?: never;
|
|
6433
|
+
patch?: never;
|
|
6434
|
+
trace?: never;
|
|
6435
|
+
};
|
|
6436
|
+
"/search/discover": {
|
|
6437
|
+
parameters: {
|
|
6438
|
+
query?: never;
|
|
6439
|
+
header?: never;
|
|
6440
|
+
path?: never;
|
|
6441
|
+
cookie?: never;
|
|
6442
|
+
};
|
|
6443
|
+
get?: never;
|
|
6444
|
+
put?: never;
|
|
6445
|
+
/**
|
|
6446
|
+
* Discover entities across all collections
|
|
6447
|
+
* @description Two-step discovery search: first finds relevant collections, then searches within them.
|
|
6448
|
+
*
|
|
6449
|
+
* Use this endpoint when you don't know which collections to search. The system will:
|
|
6450
|
+
* 1. Find collections semantically related to your query
|
|
6451
|
+
* 2. Search within each collection in parallel
|
|
6452
|
+
* 3. Aggregate and rank results across all collections
|
|
6453
|
+
*
|
|
6454
|
+
* Great for exploration and AI agents navigating the network.
|
|
6455
|
+
*/
|
|
6456
|
+
post: {
|
|
6457
|
+
parameters: {
|
|
6458
|
+
query?: never;
|
|
6459
|
+
header?: never;
|
|
6460
|
+
path?: never;
|
|
6461
|
+
cookie?: never;
|
|
6462
|
+
};
|
|
6463
|
+
requestBody?: {
|
|
6464
|
+
content: {
|
|
6465
|
+
"application/json": {
|
|
6466
|
+
/** @description Search query text */
|
|
6467
|
+
query: string;
|
|
6468
|
+
/**
|
|
6469
|
+
* @description Maximum total results to return
|
|
6470
|
+
* @default 20
|
|
6471
|
+
*/
|
|
6472
|
+
limit?: number;
|
|
6473
|
+
/** @description Filter by entity types */
|
|
6474
|
+
types?: string[];
|
|
6475
|
+
/**
|
|
6476
|
+
* @description Number of collections to search
|
|
6477
|
+
* @default 10
|
|
6478
|
+
*/
|
|
6479
|
+
collection_limit?: number;
|
|
6480
|
+
/**
|
|
6481
|
+
* @description Max results per collection
|
|
6482
|
+
* @default 5
|
|
6483
|
+
*/
|
|
6484
|
+
per_collection_limit?: number;
|
|
6485
|
+
};
|
|
6486
|
+
};
|
|
6487
|
+
};
|
|
6488
|
+
responses: {
|
|
6489
|
+
/** @description Discovery results */
|
|
6490
|
+
200: {
|
|
6491
|
+
headers: {
|
|
6492
|
+
[name: string]: unknown;
|
|
6493
|
+
};
|
|
6494
|
+
content: {
|
|
6495
|
+
"application/json": {
|
|
6496
|
+
results: {
|
|
6497
|
+
pi: string;
|
|
6498
|
+
label: string;
|
|
6499
|
+
type: string;
|
|
6500
|
+
score: number;
|
|
6501
|
+
collection_pi: string;
|
|
6502
|
+
created_at?: string;
|
|
6503
|
+
updated_at?: string;
|
|
6504
|
+
}[];
|
|
6505
|
+
metadata: {
|
|
6506
|
+
query: string;
|
|
6507
|
+
collections_searched: number;
|
|
6508
|
+
result_count: number;
|
|
6509
|
+
};
|
|
6510
|
+
};
|
|
6511
|
+
};
|
|
6512
|
+
};
|
|
6513
|
+
/** @description Bad Request - Invalid input */
|
|
6514
|
+
400: {
|
|
6515
|
+
headers: {
|
|
6516
|
+
[name: string]: unknown;
|
|
6517
|
+
};
|
|
6518
|
+
content: {
|
|
6519
|
+
/**
|
|
6520
|
+
* @example {
|
|
6521
|
+
* "error": "Validation failed",
|
|
6522
|
+
* "details": {
|
|
6523
|
+
* "issues": [
|
|
6524
|
+
* {
|
|
6525
|
+
* "path": [
|
|
6526
|
+
* "properties",
|
|
6527
|
+
* "label"
|
|
6528
|
+
* ],
|
|
6529
|
+
* "message": "Required"
|
|
6530
|
+
* }
|
|
6531
|
+
* ]
|
|
6532
|
+
* }
|
|
6533
|
+
* }
|
|
6534
|
+
*/
|
|
6535
|
+
"application/json": components["schemas"]["ValidationErrorResponse"];
|
|
6536
|
+
};
|
|
6537
|
+
};
|
|
6538
|
+
/** @description Service Unavailable - External service not available */
|
|
6539
|
+
503: {
|
|
6540
|
+
headers: {
|
|
6541
|
+
[name: string]: unknown;
|
|
6542
|
+
};
|
|
6543
|
+
content: {
|
|
6544
|
+
/**
|
|
6545
|
+
* @example {
|
|
6546
|
+
* "error": "Service unavailable",
|
|
6547
|
+
* "details": {
|
|
6548
|
+
* "service": "pinecone"
|
|
6549
|
+
* }
|
|
6550
|
+
* }
|
|
6551
|
+
*/
|
|
6552
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
6553
|
+
};
|
|
6554
|
+
};
|
|
6555
|
+
};
|
|
6556
|
+
};
|
|
6557
|
+
delete?: never;
|
|
6558
|
+
options?: never;
|
|
6559
|
+
head?: never;
|
|
6560
|
+
patch?: never;
|
|
6561
|
+
trace?: never;
|
|
6562
|
+
};
|
|
6205
6563
|
"/entities/{id}/attestation": {
|
|
6206
6564
|
parameters: {
|
|
6207
6565
|
query?: never;
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*
|
|
7
7
|
* Source: Arke v1 API
|
|
8
8
|
* Version: 1.0.0
|
|
9
|
-
* Generated: 2026-01-
|
|
9
|
+
* Generated: 2026-01-13T18:00:18.256Z
|
|
10
10
|
*/
|
|
11
11
|
type paths = {
|
|
12
12
|
"/auth/register": {
|
|
@@ -6202,6 +6202,364 @@ type paths = {
|
|
|
6202
6202
|
patch?: never;
|
|
6203
6203
|
trace?: never;
|
|
6204
6204
|
};
|
|
6205
|
+
"/search/collections": {
|
|
6206
|
+
parameters: {
|
|
6207
|
+
query?: never;
|
|
6208
|
+
header?: never;
|
|
6209
|
+
path?: never;
|
|
6210
|
+
cookie?: never;
|
|
6211
|
+
};
|
|
6212
|
+
get?: never;
|
|
6213
|
+
put?: never;
|
|
6214
|
+
/**
|
|
6215
|
+
* Search collections by text
|
|
6216
|
+
* @description Search for collections using semantic text search.
|
|
6217
|
+
*
|
|
6218
|
+
* Use this endpoint to discover collections about a topic. Results are ranked by semantic similarity to your query.
|
|
6219
|
+
*/
|
|
6220
|
+
post: {
|
|
6221
|
+
parameters: {
|
|
6222
|
+
query?: never;
|
|
6223
|
+
header?: never;
|
|
6224
|
+
path?: never;
|
|
6225
|
+
cookie?: never;
|
|
6226
|
+
};
|
|
6227
|
+
requestBody?: {
|
|
6228
|
+
content: {
|
|
6229
|
+
"application/json": {
|
|
6230
|
+
/** @description Search query text */
|
|
6231
|
+
query: string;
|
|
6232
|
+
/**
|
|
6233
|
+
* @description Maximum results to return
|
|
6234
|
+
* @default 10
|
|
6235
|
+
*/
|
|
6236
|
+
limit?: number;
|
|
6237
|
+
/** @description Filter by collection types */
|
|
6238
|
+
types?: string[];
|
|
6239
|
+
};
|
|
6240
|
+
};
|
|
6241
|
+
};
|
|
6242
|
+
responses: {
|
|
6243
|
+
/** @description Search results */
|
|
6244
|
+
200: {
|
|
6245
|
+
headers: {
|
|
6246
|
+
[name: string]: unknown;
|
|
6247
|
+
};
|
|
6248
|
+
content: {
|
|
6249
|
+
"application/json": {
|
|
6250
|
+
results: {
|
|
6251
|
+
pi: string;
|
|
6252
|
+
label: string;
|
|
6253
|
+
type: string;
|
|
6254
|
+
score: number;
|
|
6255
|
+
created_at?: string;
|
|
6256
|
+
updated_at?: string;
|
|
6257
|
+
}[];
|
|
6258
|
+
metadata: {
|
|
6259
|
+
query: string;
|
|
6260
|
+
result_count: number;
|
|
6261
|
+
};
|
|
6262
|
+
};
|
|
6263
|
+
};
|
|
6264
|
+
};
|
|
6265
|
+
/** @description Bad Request - Invalid input */
|
|
6266
|
+
400: {
|
|
6267
|
+
headers: {
|
|
6268
|
+
[name: string]: unknown;
|
|
6269
|
+
};
|
|
6270
|
+
content: {
|
|
6271
|
+
/**
|
|
6272
|
+
* @example {
|
|
6273
|
+
* "error": "Validation failed",
|
|
6274
|
+
* "details": {
|
|
6275
|
+
* "issues": [
|
|
6276
|
+
* {
|
|
6277
|
+
* "path": [
|
|
6278
|
+
* "properties",
|
|
6279
|
+
* "label"
|
|
6280
|
+
* ],
|
|
6281
|
+
* "message": "Required"
|
|
6282
|
+
* }
|
|
6283
|
+
* ]
|
|
6284
|
+
* }
|
|
6285
|
+
* }
|
|
6286
|
+
*/
|
|
6287
|
+
"application/json": components["schemas"]["ValidationErrorResponse"];
|
|
6288
|
+
};
|
|
6289
|
+
};
|
|
6290
|
+
/** @description Service Unavailable - External service not available */
|
|
6291
|
+
503: {
|
|
6292
|
+
headers: {
|
|
6293
|
+
[name: string]: unknown;
|
|
6294
|
+
};
|
|
6295
|
+
content: {
|
|
6296
|
+
/**
|
|
6297
|
+
* @example {
|
|
6298
|
+
* "error": "Service unavailable",
|
|
6299
|
+
* "details": {
|
|
6300
|
+
* "service": "pinecone"
|
|
6301
|
+
* }
|
|
6302
|
+
* }
|
|
6303
|
+
*/
|
|
6304
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
6305
|
+
};
|
|
6306
|
+
};
|
|
6307
|
+
};
|
|
6308
|
+
};
|
|
6309
|
+
delete?: never;
|
|
6310
|
+
options?: never;
|
|
6311
|
+
head?: never;
|
|
6312
|
+
patch?: never;
|
|
6313
|
+
trace?: never;
|
|
6314
|
+
};
|
|
6315
|
+
"/search/entities": {
|
|
6316
|
+
parameters: {
|
|
6317
|
+
query?: never;
|
|
6318
|
+
header?: never;
|
|
6319
|
+
path?: never;
|
|
6320
|
+
cookie?: never;
|
|
6321
|
+
};
|
|
6322
|
+
get?: never;
|
|
6323
|
+
put?: never;
|
|
6324
|
+
/**
|
|
6325
|
+
* Search entities within collection(s)
|
|
6326
|
+
* @description Search for entities within one or more collections using semantic text search.
|
|
6327
|
+
*
|
|
6328
|
+
* Provide either `collection_pi` for a single collection or `collection_pis` for multiple collections (searched in parallel).
|
|
6329
|
+
*
|
|
6330
|
+
* Use `per_collection_limit` to ensure result diversity when searching multiple collections.
|
|
6331
|
+
*/
|
|
6332
|
+
post: {
|
|
6333
|
+
parameters: {
|
|
6334
|
+
query?: never;
|
|
6335
|
+
header?: never;
|
|
6336
|
+
path?: never;
|
|
6337
|
+
cookie?: never;
|
|
6338
|
+
};
|
|
6339
|
+
requestBody?: {
|
|
6340
|
+
content: {
|
|
6341
|
+
"application/json": {
|
|
6342
|
+
/** @description Single collection PI to search within */
|
|
6343
|
+
collection_pi?: string;
|
|
6344
|
+
/** @description Multiple collection PIs to search (max 20) */
|
|
6345
|
+
collection_pis?: string[];
|
|
6346
|
+
/** @description Search query text */
|
|
6347
|
+
query: string;
|
|
6348
|
+
/**
|
|
6349
|
+
* @description Maximum total results to return
|
|
6350
|
+
* @default 20
|
|
6351
|
+
*/
|
|
6352
|
+
limit?: number;
|
|
6353
|
+
/** @description Filter by entity types */
|
|
6354
|
+
types?: string[];
|
|
6355
|
+
/** @description Max results per collection for diversity */
|
|
6356
|
+
per_collection_limit?: number;
|
|
6357
|
+
};
|
|
6358
|
+
};
|
|
6359
|
+
};
|
|
6360
|
+
responses: {
|
|
6361
|
+
/** @description Search results */
|
|
6362
|
+
200: {
|
|
6363
|
+
headers: {
|
|
6364
|
+
[name: string]: unknown;
|
|
6365
|
+
};
|
|
6366
|
+
content: {
|
|
6367
|
+
"application/json": {
|
|
6368
|
+
results: {
|
|
6369
|
+
pi: string;
|
|
6370
|
+
label: string;
|
|
6371
|
+
type: string;
|
|
6372
|
+
score: number;
|
|
6373
|
+
collection_pi: string;
|
|
6374
|
+
created_at?: string;
|
|
6375
|
+
updated_at?: string;
|
|
6376
|
+
}[];
|
|
6377
|
+
metadata: {
|
|
6378
|
+
collection_pis: string[];
|
|
6379
|
+
query: string;
|
|
6380
|
+
collections_searched: number;
|
|
6381
|
+
result_count: number;
|
|
6382
|
+
};
|
|
6383
|
+
};
|
|
6384
|
+
};
|
|
6385
|
+
};
|
|
6386
|
+
/** @description Bad Request - Invalid input */
|
|
6387
|
+
400: {
|
|
6388
|
+
headers: {
|
|
6389
|
+
[name: string]: unknown;
|
|
6390
|
+
};
|
|
6391
|
+
content: {
|
|
6392
|
+
/**
|
|
6393
|
+
* @example {
|
|
6394
|
+
* "error": "Validation failed",
|
|
6395
|
+
* "details": {
|
|
6396
|
+
* "issues": [
|
|
6397
|
+
* {
|
|
6398
|
+
* "path": [
|
|
6399
|
+
* "properties",
|
|
6400
|
+
* "label"
|
|
6401
|
+
* ],
|
|
6402
|
+
* "message": "Required"
|
|
6403
|
+
* }
|
|
6404
|
+
* ]
|
|
6405
|
+
* }
|
|
6406
|
+
* }
|
|
6407
|
+
*/
|
|
6408
|
+
"application/json": components["schemas"]["ValidationErrorResponse"];
|
|
6409
|
+
};
|
|
6410
|
+
};
|
|
6411
|
+
/** @description Service Unavailable - External service not available */
|
|
6412
|
+
503: {
|
|
6413
|
+
headers: {
|
|
6414
|
+
[name: string]: unknown;
|
|
6415
|
+
};
|
|
6416
|
+
content: {
|
|
6417
|
+
/**
|
|
6418
|
+
* @example {
|
|
6419
|
+
* "error": "Service unavailable",
|
|
6420
|
+
* "details": {
|
|
6421
|
+
* "service": "pinecone"
|
|
6422
|
+
* }
|
|
6423
|
+
* }
|
|
6424
|
+
*/
|
|
6425
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
6426
|
+
};
|
|
6427
|
+
};
|
|
6428
|
+
};
|
|
6429
|
+
};
|
|
6430
|
+
delete?: never;
|
|
6431
|
+
options?: never;
|
|
6432
|
+
head?: never;
|
|
6433
|
+
patch?: never;
|
|
6434
|
+
trace?: never;
|
|
6435
|
+
};
|
|
6436
|
+
"/search/discover": {
|
|
6437
|
+
parameters: {
|
|
6438
|
+
query?: never;
|
|
6439
|
+
header?: never;
|
|
6440
|
+
path?: never;
|
|
6441
|
+
cookie?: never;
|
|
6442
|
+
};
|
|
6443
|
+
get?: never;
|
|
6444
|
+
put?: never;
|
|
6445
|
+
/**
|
|
6446
|
+
* Discover entities across all collections
|
|
6447
|
+
* @description Two-step discovery search: first finds relevant collections, then searches within them.
|
|
6448
|
+
*
|
|
6449
|
+
* Use this endpoint when you don't know which collections to search. The system will:
|
|
6450
|
+
* 1. Find collections semantically related to your query
|
|
6451
|
+
* 2. Search within each collection in parallel
|
|
6452
|
+
* 3. Aggregate and rank results across all collections
|
|
6453
|
+
*
|
|
6454
|
+
* Great for exploration and AI agents navigating the network.
|
|
6455
|
+
*/
|
|
6456
|
+
post: {
|
|
6457
|
+
parameters: {
|
|
6458
|
+
query?: never;
|
|
6459
|
+
header?: never;
|
|
6460
|
+
path?: never;
|
|
6461
|
+
cookie?: never;
|
|
6462
|
+
};
|
|
6463
|
+
requestBody?: {
|
|
6464
|
+
content: {
|
|
6465
|
+
"application/json": {
|
|
6466
|
+
/** @description Search query text */
|
|
6467
|
+
query: string;
|
|
6468
|
+
/**
|
|
6469
|
+
* @description Maximum total results to return
|
|
6470
|
+
* @default 20
|
|
6471
|
+
*/
|
|
6472
|
+
limit?: number;
|
|
6473
|
+
/** @description Filter by entity types */
|
|
6474
|
+
types?: string[];
|
|
6475
|
+
/**
|
|
6476
|
+
* @description Number of collections to search
|
|
6477
|
+
* @default 10
|
|
6478
|
+
*/
|
|
6479
|
+
collection_limit?: number;
|
|
6480
|
+
/**
|
|
6481
|
+
* @description Max results per collection
|
|
6482
|
+
* @default 5
|
|
6483
|
+
*/
|
|
6484
|
+
per_collection_limit?: number;
|
|
6485
|
+
};
|
|
6486
|
+
};
|
|
6487
|
+
};
|
|
6488
|
+
responses: {
|
|
6489
|
+
/** @description Discovery results */
|
|
6490
|
+
200: {
|
|
6491
|
+
headers: {
|
|
6492
|
+
[name: string]: unknown;
|
|
6493
|
+
};
|
|
6494
|
+
content: {
|
|
6495
|
+
"application/json": {
|
|
6496
|
+
results: {
|
|
6497
|
+
pi: string;
|
|
6498
|
+
label: string;
|
|
6499
|
+
type: string;
|
|
6500
|
+
score: number;
|
|
6501
|
+
collection_pi: string;
|
|
6502
|
+
created_at?: string;
|
|
6503
|
+
updated_at?: string;
|
|
6504
|
+
}[];
|
|
6505
|
+
metadata: {
|
|
6506
|
+
query: string;
|
|
6507
|
+
collections_searched: number;
|
|
6508
|
+
result_count: number;
|
|
6509
|
+
};
|
|
6510
|
+
};
|
|
6511
|
+
};
|
|
6512
|
+
};
|
|
6513
|
+
/** @description Bad Request - Invalid input */
|
|
6514
|
+
400: {
|
|
6515
|
+
headers: {
|
|
6516
|
+
[name: string]: unknown;
|
|
6517
|
+
};
|
|
6518
|
+
content: {
|
|
6519
|
+
/**
|
|
6520
|
+
* @example {
|
|
6521
|
+
* "error": "Validation failed",
|
|
6522
|
+
* "details": {
|
|
6523
|
+
* "issues": [
|
|
6524
|
+
* {
|
|
6525
|
+
* "path": [
|
|
6526
|
+
* "properties",
|
|
6527
|
+
* "label"
|
|
6528
|
+
* ],
|
|
6529
|
+
* "message": "Required"
|
|
6530
|
+
* }
|
|
6531
|
+
* ]
|
|
6532
|
+
* }
|
|
6533
|
+
* }
|
|
6534
|
+
*/
|
|
6535
|
+
"application/json": components["schemas"]["ValidationErrorResponse"];
|
|
6536
|
+
};
|
|
6537
|
+
};
|
|
6538
|
+
/** @description Service Unavailable - External service not available */
|
|
6539
|
+
503: {
|
|
6540
|
+
headers: {
|
|
6541
|
+
[name: string]: unknown;
|
|
6542
|
+
};
|
|
6543
|
+
content: {
|
|
6544
|
+
/**
|
|
6545
|
+
* @example {
|
|
6546
|
+
* "error": "Service unavailable",
|
|
6547
|
+
* "details": {
|
|
6548
|
+
* "service": "pinecone"
|
|
6549
|
+
* }
|
|
6550
|
+
* }
|
|
6551
|
+
*/
|
|
6552
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
6553
|
+
};
|
|
6554
|
+
};
|
|
6555
|
+
};
|
|
6556
|
+
};
|
|
6557
|
+
delete?: never;
|
|
6558
|
+
options?: never;
|
|
6559
|
+
head?: never;
|
|
6560
|
+
patch?: never;
|
|
6561
|
+
trace?: never;
|
|
6562
|
+
};
|
|
6205
6563
|
"/entities/{id}/attestation": {
|
|
6206
6564
|
parameters: {
|
|
6207
6565
|
query?: never;
|
package/openapi/spec.json
CHANGED
|
@@ -11947,6 +11947,514 @@
|
|
|
11947
11947
|
}
|
|
11948
11948
|
}
|
|
11949
11949
|
},
|
|
11950
|
+
"/search/collections": {
|
|
11951
|
+
"post": {
|
|
11952
|
+
"tags": [
|
|
11953
|
+
"Search"
|
|
11954
|
+
],
|
|
11955
|
+
"summary": "Search collections by text",
|
|
11956
|
+
"description": "Search for collections using semantic text search.\n\nUse this endpoint to discover collections about a topic. Results are ranked by semantic similarity to your query.",
|
|
11957
|
+
"x-arke-action": "search:query",
|
|
11958
|
+
"x-arke-auth": "optional",
|
|
11959
|
+
"x-arke-tier": "external",
|
|
11960
|
+
"requestBody": {
|
|
11961
|
+
"content": {
|
|
11962
|
+
"application/json": {
|
|
11963
|
+
"schema": {
|
|
11964
|
+
"type": "object",
|
|
11965
|
+
"properties": {
|
|
11966
|
+
"query": {
|
|
11967
|
+
"type": "string",
|
|
11968
|
+
"minLength": 1,
|
|
11969
|
+
"maxLength": 500,
|
|
11970
|
+
"description": "Search query text"
|
|
11971
|
+
},
|
|
11972
|
+
"limit": {
|
|
11973
|
+
"type": "number",
|
|
11974
|
+
"minimum": 1,
|
|
11975
|
+
"maximum": 100,
|
|
11976
|
+
"default": 10,
|
|
11977
|
+
"description": "Maximum results to return"
|
|
11978
|
+
},
|
|
11979
|
+
"types": {
|
|
11980
|
+
"type": "array",
|
|
11981
|
+
"items": {
|
|
11982
|
+
"type": "string"
|
|
11983
|
+
},
|
|
11984
|
+
"description": "Filter by collection types"
|
|
11985
|
+
}
|
|
11986
|
+
},
|
|
11987
|
+
"required": [
|
|
11988
|
+
"query"
|
|
11989
|
+
]
|
|
11990
|
+
}
|
|
11991
|
+
}
|
|
11992
|
+
}
|
|
11993
|
+
},
|
|
11994
|
+
"responses": {
|
|
11995
|
+
"200": {
|
|
11996
|
+
"description": "Search results",
|
|
11997
|
+
"content": {
|
|
11998
|
+
"application/json": {
|
|
11999
|
+
"schema": {
|
|
12000
|
+
"type": "object",
|
|
12001
|
+
"properties": {
|
|
12002
|
+
"results": {
|
|
12003
|
+
"type": "array",
|
|
12004
|
+
"items": {
|
|
12005
|
+
"type": "object",
|
|
12006
|
+
"properties": {
|
|
12007
|
+
"pi": {
|
|
12008
|
+
"type": "string"
|
|
12009
|
+
},
|
|
12010
|
+
"label": {
|
|
12011
|
+
"type": "string"
|
|
12012
|
+
},
|
|
12013
|
+
"type": {
|
|
12014
|
+
"type": "string"
|
|
12015
|
+
},
|
|
12016
|
+
"score": {
|
|
12017
|
+
"type": "number"
|
|
12018
|
+
},
|
|
12019
|
+
"created_at": {
|
|
12020
|
+
"type": "string"
|
|
12021
|
+
},
|
|
12022
|
+
"updated_at": {
|
|
12023
|
+
"type": "string"
|
|
12024
|
+
}
|
|
12025
|
+
},
|
|
12026
|
+
"required": [
|
|
12027
|
+
"pi",
|
|
12028
|
+
"label",
|
|
12029
|
+
"type",
|
|
12030
|
+
"score"
|
|
12031
|
+
]
|
|
12032
|
+
}
|
|
12033
|
+
},
|
|
12034
|
+
"metadata": {
|
|
12035
|
+
"type": "object",
|
|
12036
|
+
"properties": {
|
|
12037
|
+
"query": {
|
|
12038
|
+
"type": "string"
|
|
12039
|
+
},
|
|
12040
|
+
"result_count": {
|
|
12041
|
+
"type": "number"
|
|
12042
|
+
}
|
|
12043
|
+
},
|
|
12044
|
+
"required": [
|
|
12045
|
+
"query",
|
|
12046
|
+
"result_count"
|
|
12047
|
+
]
|
|
12048
|
+
}
|
|
12049
|
+
},
|
|
12050
|
+
"required": [
|
|
12051
|
+
"results",
|
|
12052
|
+
"metadata"
|
|
12053
|
+
]
|
|
12054
|
+
}
|
|
12055
|
+
}
|
|
12056
|
+
}
|
|
12057
|
+
},
|
|
12058
|
+
"400": {
|
|
12059
|
+
"description": "Bad Request - Invalid input",
|
|
12060
|
+
"content": {
|
|
12061
|
+
"application/json": {
|
|
12062
|
+
"schema": {
|
|
12063
|
+
"$ref": "#/components/schemas/ValidationErrorResponse"
|
|
12064
|
+
},
|
|
12065
|
+
"example": {
|
|
12066
|
+
"error": "Validation failed",
|
|
12067
|
+
"details": {
|
|
12068
|
+
"issues": [
|
|
12069
|
+
{
|
|
12070
|
+
"path": [
|
|
12071
|
+
"properties",
|
|
12072
|
+
"label"
|
|
12073
|
+
],
|
|
12074
|
+
"message": "Required"
|
|
12075
|
+
}
|
|
12076
|
+
]
|
|
12077
|
+
}
|
|
12078
|
+
}
|
|
12079
|
+
}
|
|
12080
|
+
}
|
|
12081
|
+
},
|
|
12082
|
+
"503": {
|
|
12083
|
+
"description": "Service Unavailable - External service not available",
|
|
12084
|
+
"content": {
|
|
12085
|
+
"application/json": {
|
|
12086
|
+
"schema": {
|
|
12087
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12088
|
+
},
|
|
12089
|
+
"example": {
|
|
12090
|
+
"error": "Service unavailable",
|
|
12091
|
+
"details": {
|
|
12092
|
+
"service": "pinecone"
|
|
12093
|
+
}
|
|
12094
|
+
}
|
|
12095
|
+
}
|
|
12096
|
+
}
|
|
12097
|
+
}
|
|
12098
|
+
}
|
|
12099
|
+
}
|
|
12100
|
+
},
|
|
12101
|
+
"/search/entities": {
|
|
12102
|
+
"post": {
|
|
12103
|
+
"tags": [
|
|
12104
|
+
"Search"
|
|
12105
|
+
],
|
|
12106
|
+
"summary": "Search entities within collection(s)",
|
|
12107
|
+
"description": "Search for entities within one or more collections using semantic text search.\n\nProvide either `collection_pi` for a single collection or `collection_pis` for multiple collections (searched in parallel).\n\nUse `per_collection_limit` to ensure result diversity when searching multiple collections.",
|
|
12108
|
+
"x-arke-action": "search:query",
|
|
12109
|
+
"x-arke-auth": "optional",
|
|
12110
|
+
"x-arke-tier": "external",
|
|
12111
|
+
"requestBody": {
|
|
12112
|
+
"content": {
|
|
12113
|
+
"application/json": {
|
|
12114
|
+
"schema": {
|
|
12115
|
+
"type": "object",
|
|
12116
|
+
"properties": {
|
|
12117
|
+
"collection_pi": {
|
|
12118
|
+
"type": "string",
|
|
12119
|
+
"description": "Single collection PI to search within"
|
|
12120
|
+
},
|
|
12121
|
+
"collection_pis": {
|
|
12122
|
+
"type": "array",
|
|
12123
|
+
"items": {
|
|
12124
|
+
"type": "string"
|
|
12125
|
+
},
|
|
12126
|
+
"maxItems": 20,
|
|
12127
|
+
"description": "Multiple collection PIs to search (max 20)"
|
|
12128
|
+
},
|
|
12129
|
+
"query": {
|
|
12130
|
+
"type": "string",
|
|
12131
|
+
"minLength": 1,
|
|
12132
|
+
"maxLength": 500,
|
|
12133
|
+
"description": "Search query text"
|
|
12134
|
+
},
|
|
12135
|
+
"limit": {
|
|
12136
|
+
"type": "number",
|
|
12137
|
+
"minimum": 1,
|
|
12138
|
+
"maximum": 100,
|
|
12139
|
+
"default": 20,
|
|
12140
|
+
"description": "Maximum total results to return"
|
|
12141
|
+
},
|
|
12142
|
+
"types": {
|
|
12143
|
+
"type": "array",
|
|
12144
|
+
"items": {
|
|
12145
|
+
"type": "string"
|
|
12146
|
+
},
|
|
12147
|
+
"description": "Filter by entity types"
|
|
12148
|
+
},
|
|
12149
|
+
"per_collection_limit": {
|
|
12150
|
+
"type": "number",
|
|
12151
|
+
"minimum": 1,
|
|
12152
|
+
"maximum": 50,
|
|
12153
|
+
"description": "Max results per collection for diversity"
|
|
12154
|
+
}
|
|
12155
|
+
},
|
|
12156
|
+
"required": [
|
|
12157
|
+
"query"
|
|
12158
|
+
]
|
|
12159
|
+
}
|
|
12160
|
+
}
|
|
12161
|
+
}
|
|
12162
|
+
},
|
|
12163
|
+
"responses": {
|
|
12164
|
+
"200": {
|
|
12165
|
+
"description": "Search results",
|
|
12166
|
+
"content": {
|
|
12167
|
+
"application/json": {
|
|
12168
|
+
"schema": {
|
|
12169
|
+
"type": "object",
|
|
12170
|
+
"properties": {
|
|
12171
|
+
"results": {
|
|
12172
|
+
"type": "array",
|
|
12173
|
+
"items": {
|
|
12174
|
+
"type": "object",
|
|
12175
|
+
"properties": {
|
|
12176
|
+
"pi": {
|
|
12177
|
+
"type": "string"
|
|
12178
|
+
},
|
|
12179
|
+
"label": {
|
|
12180
|
+
"type": "string"
|
|
12181
|
+
},
|
|
12182
|
+
"type": {
|
|
12183
|
+
"type": "string"
|
|
12184
|
+
},
|
|
12185
|
+
"score": {
|
|
12186
|
+
"type": "number"
|
|
12187
|
+
},
|
|
12188
|
+
"collection_pi": {
|
|
12189
|
+
"type": "string"
|
|
12190
|
+
},
|
|
12191
|
+
"created_at": {
|
|
12192
|
+
"type": "string"
|
|
12193
|
+
},
|
|
12194
|
+
"updated_at": {
|
|
12195
|
+
"type": "string"
|
|
12196
|
+
}
|
|
12197
|
+
},
|
|
12198
|
+
"required": [
|
|
12199
|
+
"pi",
|
|
12200
|
+
"label",
|
|
12201
|
+
"type",
|
|
12202
|
+
"score",
|
|
12203
|
+
"collection_pi"
|
|
12204
|
+
]
|
|
12205
|
+
}
|
|
12206
|
+
},
|
|
12207
|
+
"metadata": {
|
|
12208
|
+
"type": "object",
|
|
12209
|
+
"properties": {
|
|
12210
|
+
"collection_pis": {
|
|
12211
|
+
"type": "array",
|
|
12212
|
+
"items": {
|
|
12213
|
+
"type": "string"
|
|
12214
|
+
}
|
|
12215
|
+
},
|
|
12216
|
+
"query": {
|
|
12217
|
+
"type": "string"
|
|
12218
|
+
},
|
|
12219
|
+
"collections_searched": {
|
|
12220
|
+
"type": "number"
|
|
12221
|
+
},
|
|
12222
|
+
"result_count": {
|
|
12223
|
+
"type": "number"
|
|
12224
|
+
}
|
|
12225
|
+
},
|
|
12226
|
+
"required": [
|
|
12227
|
+
"collection_pis",
|
|
12228
|
+
"query",
|
|
12229
|
+
"collections_searched",
|
|
12230
|
+
"result_count"
|
|
12231
|
+
]
|
|
12232
|
+
}
|
|
12233
|
+
},
|
|
12234
|
+
"required": [
|
|
12235
|
+
"results",
|
|
12236
|
+
"metadata"
|
|
12237
|
+
]
|
|
12238
|
+
}
|
|
12239
|
+
}
|
|
12240
|
+
}
|
|
12241
|
+
},
|
|
12242
|
+
"400": {
|
|
12243
|
+
"description": "Bad Request - Invalid input",
|
|
12244
|
+
"content": {
|
|
12245
|
+
"application/json": {
|
|
12246
|
+
"schema": {
|
|
12247
|
+
"$ref": "#/components/schemas/ValidationErrorResponse"
|
|
12248
|
+
},
|
|
12249
|
+
"example": {
|
|
12250
|
+
"error": "Validation failed",
|
|
12251
|
+
"details": {
|
|
12252
|
+
"issues": [
|
|
12253
|
+
{
|
|
12254
|
+
"path": [
|
|
12255
|
+
"properties",
|
|
12256
|
+
"label"
|
|
12257
|
+
],
|
|
12258
|
+
"message": "Required"
|
|
12259
|
+
}
|
|
12260
|
+
]
|
|
12261
|
+
}
|
|
12262
|
+
}
|
|
12263
|
+
}
|
|
12264
|
+
}
|
|
12265
|
+
},
|
|
12266
|
+
"503": {
|
|
12267
|
+
"description": "Service Unavailable - External service not available",
|
|
12268
|
+
"content": {
|
|
12269
|
+
"application/json": {
|
|
12270
|
+
"schema": {
|
|
12271
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12272
|
+
},
|
|
12273
|
+
"example": {
|
|
12274
|
+
"error": "Service unavailable",
|
|
12275
|
+
"details": {
|
|
12276
|
+
"service": "pinecone"
|
|
12277
|
+
}
|
|
12278
|
+
}
|
|
12279
|
+
}
|
|
12280
|
+
}
|
|
12281
|
+
}
|
|
12282
|
+
}
|
|
12283
|
+
}
|
|
12284
|
+
},
|
|
12285
|
+
"/search/discover": {
|
|
12286
|
+
"post": {
|
|
12287
|
+
"tags": [
|
|
12288
|
+
"Search"
|
|
12289
|
+
],
|
|
12290
|
+
"summary": "Discover entities across all collections",
|
|
12291
|
+
"description": "Two-step discovery search: first finds relevant collections, then searches within them.\n\nUse this endpoint when you don't know which collections to search. The system will:\n1. Find collections semantically related to your query\n2. Search within each collection in parallel\n3. Aggregate and rank results across all collections\n\nGreat for exploration and AI agents navigating the network.",
|
|
12292
|
+
"x-arke-action": "search:query",
|
|
12293
|
+
"x-arke-auth": "optional",
|
|
12294
|
+
"x-arke-tier": "external",
|
|
12295
|
+
"requestBody": {
|
|
12296
|
+
"content": {
|
|
12297
|
+
"application/json": {
|
|
12298
|
+
"schema": {
|
|
12299
|
+
"type": "object",
|
|
12300
|
+
"properties": {
|
|
12301
|
+
"query": {
|
|
12302
|
+
"type": "string",
|
|
12303
|
+
"minLength": 1,
|
|
12304
|
+
"maxLength": 500,
|
|
12305
|
+
"description": "Search query text"
|
|
12306
|
+
},
|
|
12307
|
+
"limit": {
|
|
12308
|
+
"type": "number",
|
|
12309
|
+
"minimum": 1,
|
|
12310
|
+
"maximum": 100,
|
|
12311
|
+
"default": 20,
|
|
12312
|
+
"description": "Maximum total results to return"
|
|
12313
|
+
},
|
|
12314
|
+
"types": {
|
|
12315
|
+
"type": "array",
|
|
12316
|
+
"items": {
|
|
12317
|
+
"type": "string"
|
|
12318
|
+
},
|
|
12319
|
+
"description": "Filter by entity types"
|
|
12320
|
+
},
|
|
12321
|
+
"collection_limit": {
|
|
12322
|
+
"type": "number",
|
|
12323
|
+
"minimum": 1,
|
|
12324
|
+
"maximum": 50,
|
|
12325
|
+
"default": 10,
|
|
12326
|
+
"description": "Number of collections to search"
|
|
12327
|
+
},
|
|
12328
|
+
"per_collection_limit": {
|
|
12329
|
+
"type": "number",
|
|
12330
|
+
"minimum": 1,
|
|
12331
|
+
"maximum": 20,
|
|
12332
|
+
"default": 5,
|
|
12333
|
+
"description": "Max results per collection"
|
|
12334
|
+
}
|
|
12335
|
+
},
|
|
12336
|
+
"required": [
|
|
12337
|
+
"query"
|
|
12338
|
+
]
|
|
12339
|
+
}
|
|
12340
|
+
}
|
|
12341
|
+
}
|
|
12342
|
+
},
|
|
12343
|
+
"responses": {
|
|
12344
|
+
"200": {
|
|
12345
|
+
"description": "Discovery results",
|
|
12346
|
+
"content": {
|
|
12347
|
+
"application/json": {
|
|
12348
|
+
"schema": {
|
|
12349
|
+
"type": "object",
|
|
12350
|
+
"properties": {
|
|
12351
|
+
"results": {
|
|
12352
|
+
"type": "array",
|
|
12353
|
+
"items": {
|
|
12354
|
+
"type": "object",
|
|
12355
|
+
"properties": {
|
|
12356
|
+
"pi": {
|
|
12357
|
+
"type": "string"
|
|
12358
|
+
},
|
|
12359
|
+
"label": {
|
|
12360
|
+
"type": "string"
|
|
12361
|
+
},
|
|
12362
|
+
"type": {
|
|
12363
|
+
"type": "string"
|
|
12364
|
+
},
|
|
12365
|
+
"score": {
|
|
12366
|
+
"type": "number"
|
|
12367
|
+
},
|
|
12368
|
+
"collection_pi": {
|
|
12369
|
+
"type": "string"
|
|
12370
|
+
},
|
|
12371
|
+
"created_at": {
|
|
12372
|
+
"type": "string"
|
|
12373
|
+
},
|
|
12374
|
+
"updated_at": {
|
|
12375
|
+
"type": "string"
|
|
12376
|
+
}
|
|
12377
|
+
},
|
|
12378
|
+
"required": [
|
|
12379
|
+
"pi",
|
|
12380
|
+
"label",
|
|
12381
|
+
"type",
|
|
12382
|
+
"score",
|
|
12383
|
+
"collection_pi"
|
|
12384
|
+
]
|
|
12385
|
+
}
|
|
12386
|
+
},
|
|
12387
|
+
"metadata": {
|
|
12388
|
+
"type": "object",
|
|
12389
|
+
"properties": {
|
|
12390
|
+
"query": {
|
|
12391
|
+
"type": "string"
|
|
12392
|
+
},
|
|
12393
|
+
"collections_searched": {
|
|
12394
|
+
"type": "number"
|
|
12395
|
+
},
|
|
12396
|
+
"result_count": {
|
|
12397
|
+
"type": "number"
|
|
12398
|
+
}
|
|
12399
|
+
},
|
|
12400
|
+
"required": [
|
|
12401
|
+
"query",
|
|
12402
|
+
"collections_searched",
|
|
12403
|
+
"result_count"
|
|
12404
|
+
]
|
|
12405
|
+
}
|
|
12406
|
+
},
|
|
12407
|
+
"required": [
|
|
12408
|
+
"results",
|
|
12409
|
+
"metadata"
|
|
12410
|
+
]
|
|
12411
|
+
}
|
|
12412
|
+
}
|
|
12413
|
+
}
|
|
12414
|
+
},
|
|
12415
|
+
"400": {
|
|
12416
|
+
"description": "Bad Request - Invalid input",
|
|
12417
|
+
"content": {
|
|
12418
|
+
"application/json": {
|
|
12419
|
+
"schema": {
|
|
12420
|
+
"$ref": "#/components/schemas/ValidationErrorResponse"
|
|
12421
|
+
},
|
|
12422
|
+
"example": {
|
|
12423
|
+
"error": "Validation failed",
|
|
12424
|
+
"details": {
|
|
12425
|
+
"issues": [
|
|
12426
|
+
{
|
|
12427
|
+
"path": [
|
|
12428
|
+
"properties",
|
|
12429
|
+
"label"
|
|
12430
|
+
],
|
|
12431
|
+
"message": "Required"
|
|
12432
|
+
}
|
|
12433
|
+
]
|
|
12434
|
+
}
|
|
12435
|
+
}
|
|
12436
|
+
}
|
|
12437
|
+
}
|
|
12438
|
+
},
|
|
12439
|
+
"503": {
|
|
12440
|
+
"description": "Service Unavailable - External service not available",
|
|
12441
|
+
"content": {
|
|
12442
|
+
"application/json": {
|
|
12443
|
+
"schema": {
|
|
12444
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
12445
|
+
},
|
|
12446
|
+
"example": {
|
|
12447
|
+
"error": "Service unavailable",
|
|
12448
|
+
"details": {
|
|
12449
|
+
"service": "pinecone"
|
|
12450
|
+
}
|
|
12451
|
+
}
|
|
12452
|
+
}
|
|
12453
|
+
}
|
|
12454
|
+
}
|
|
12455
|
+
}
|
|
12456
|
+
}
|
|
12457
|
+
},
|
|
11950
12458
|
"/entities/{id}/attestation": {
|
|
11951
12459
|
"get": {
|
|
11952
12460
|
"tags": [
|
package/openapi/version.json
CHANGED