Repository navigation
Expand file tree
/
Copy pathopenapi.json
More file actions
3728 lines (3728 loc) · 123 KB
/
Copy pathopenapi.json
File metadata and controls
3728 lines (3728 loc) · 123 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.1.0",
"info": {
"title": "modelschemas",
"version": "0.1.0",
"description": "Live AI model schema service: per-endpoint request/response JSON Schemas and model metadata for monitored providers, with stale-while-revalidate caching and a change feed. Anonymous reads are allowed at a low rate limit; register (agent-auth or API key) for higher limits and webhook subscriptions."
},
"servers": [
{
"url": "/"
}
],
"paths": {
"/v1": {
"get": {
"operationId": "getServiceIndex",
"summary": "Service description and endpoint index",
"responses": {
"200": {
"description": "Service index with _links to every surface.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
},
"/v1/status": {
"get": {
"operationId": "getStatus",
"summary": "Per-provider sync status and row counts",
"parameters": [
{
"name": "wait",
"in": "query",
"description": "Long-poll: hold up to N seconds (cap 60; \"30s\" form accepted) until new data exists, then return current data.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Service status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceStatus"
}
}
}
}
}
}
},
"/v1/providers": {
"get": {
"operationId": "listProviders",
"summary": "List monitored providers with sync status",
"responses": {
"200": {
"description": "Providers.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
},
"/v1/providers/{provider}": {
"get": {
"operationId": "getProvider",
"summary": "One provider: status, counts, live models per activity",
"description": "The same row as GET /v1/providers plus activities: live model counts keyed by activity, the values GET /v1/openapi/{provider}?activity= and GET /v1/models?activity= accept.",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"description": "Provider slug (see GET /v1/providers).",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Provider detail.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/providers/{provider}/models": {
"get": {
"operationId": "listProviderModels",
"summary": "List models for one provider",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"description": "Provider slug (see GET /v1/providers).",
"schema": {
"type": "string"
}
},
{
"name": "provenance",
"in": "query",
"description": "Include recorded per-field sources by default; 0 omits them.",
"schema": {
"type": "string",
"enum": [
"0",
"1"
],
"default": "1"
}
}
],
"responses": {
"200": {
"description": "Models for the provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderModelList"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/models": {
"get": {
"operationId": "listModels",
"summary": "Cross-provider model catalog",
"description": "The headline \"what can I use right now\" endpoint. Filterable.",
"parameters": [
{
"name": "activity",
"in": "query",
"schema": {
"type": "string",
"enum": [
"chat",
"image",
"video",
"audio",
"embeddings",
"moderation",
"world",
"decision"
]
}
},
{
"name": "provider",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "capability",
"in": "query",
"description": "A capability flag the model is stated to support: matches rows whose capabilities map has this key set to true (capability=tools). Exact flag name, not a substring.",
"schema": {
"type": "string"
}
},
{
"name": "q",
"in": "query",
"description": "Free-text match against id and display name.",
"schema": {
"type": "string"
}
},
{
"name": "provenance",
"in": "query",
"description": "Per-field factSources are included by default. Set to 0 to omit them on list rows; 1 explicitly includes them. Model detail always includes factSources and OpenRouter discrepancies.",
"schema": {
"type": "string",
"enum": [
"0",
"1"
],
"default": "1"
}
},
{
"name": "pricing",
"in": "query",
"description": "Set to 1 to include the full rate card on each list row. Default is a compact summary: per-million base rates for token cards, otherwise the unit the card bills by.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
],
"responses": {
"200": {
"description": "Matching models. pricing is a compact token projection, a full RateCard when ?pricing=1, or null. OpenRouter-shaped vendor blobs are not served.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelList"
}
}
}
}
}
}
},
"/v1/models/{provider}/{modelId}": {
"get": {
"operationId": "getModel",
"summary": "Full metadata for one model",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"description": "Provider slug (see GET /v1/providers).",
"schema": {
"type": "string"
}
},
{
"name": "modelId",
"in": "path",
"required": true,
"description": "Model slug or raw provider id.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Model metadata with activity, schemaEndpointId (canonical generation route on grain=provider catalogs), a RateCard or null for pricing, factSources (per-field provenance), OpenRouter discrepancies, and _links.schema when bound.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelDetail"
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/schemas": {
"get": {
"operationId": "listAllSchemas",
"summary": "System-wide schema index",
"description": "Every provider with extracted schemas, each with its activities and endpoint ids — the discovery entry point for all schemas on the system.",
"responses": {
"200": {
"description": "Provider → activity → endpoint-id index.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
},
"/v1/schemas/{provider}": {
"get": {
"operationId": "listProviderSchemas",
"summary": "Activities and endpoint ids for a provider",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"description": "Provider slug (see GET /v1/providers).",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Activity → endpoint-id index.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/schemas/{provider}/{activity}": {
"get": {
"operationId": "getActivitySchemas",
"summary": "Endpoint-id-keyed schema map for one activity",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"description": "Provider slug (see GET /v1/providers).",
"schema": {
"type": "string"
}
},
{
"name": "activity",
"in": "path",
"required": true,
"description": "Activity group.",
"schema": {
"type": "string",
"enum": [
"chat",
"image",
"video",
"audio",
"embeddings",
"moderation",
"world",
"decision"
]
}
}
],
"responses": {
"200": {
"description": "Map of endpoint id → { input, output } self-contained JSON Schemas (current versions).",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/schemas/{provider}/{activity}/{endpointId}": {
"get": {
"operationId": "getSchema",
"summary": "One self-contained JSON Schema",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"description": "Provider slug (see GET /v1/providers).",
"schema": {
"type": "string"
}
},
{
"name": "activity",
"in": "path",
"required": true,
"description": "Activity group.",
"schema": {
"type": "string",
"enum": [
"chat",
"image",
"video",
"audio",
"embeddings",
"moderation",
"world",
"decision"
]
}
},
{
"name": "endpointId",
"in": "path",
"required": true,
"description": "Path-derived endpoint id (URL-encode slashes), or a listed model rawId/slug which aliases onto that activity's generation route and pins the request `model` field.",
"schema": {
"type": "string"
}
},
{
"name": "kind",
"in": "query",
"description": "Defaults to input.",
"schema": {
"type": "string",
"enum": [
"input",
"output"
]
}
},
{
"name": "version",
"in": "query",
"description": "Content hash of a historical version.",
"schema": {
"type": "string"
}
},
{
"name": "format",
"in": "query",
"description": "json (default) or types — a self-contained TypeScript module (schema const + generated types, tree-shakeable, zero imports). format=types on an input schema with a model property overlays the live catalog union plus ListedModelId; the schema const and content hash stay the bundled schema.",
"schema": {
"type": "string",
"enum": [
"json",
"types"
]
}
},
{
"name": "optional",
"in": "query",
"description": "format=types only: optional-property style. exact (default) emits `foo?: T`; undefined emits `foo?: T | undefined`.",
"schema": {
"type": "string",
"enum": [
"exact",
"undefined"
]
}
}
],
"responses": {
"200": {
"description": "Self-contained JSON Schema ($defs-bundled) — or, with format=types, a TypeScript module — served with ETag. JSON responses carry `provenance` (upstream sourceUrl, sourceHash, fetchedAt, extractorVersion) so derivations are independently verifiable. `provenance.derivation` grades how the content was arrived at — `upstream-spec` and `generated` are re-derived every sync and self-heal. `probe-verified` is a live API call recorded in `src/server/providers/probes/<provider>.ts` on `provenance.verifiedAt` (`YYYY-MM-DD`). Re-run it with `bun scripts/probe.ts <provider> [--write]`. A record older than 90 days is still served; `GET /v1/status` counts those on `staleProbes`. `docs-derived` was never confirmed against the API. Both are point-in-time claims that can go stale.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
},
"text/typescript": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/openapi/{provider}": {
"get": {
"operationId": "getProviderOpenApi",
"summary": "Generation-only OpenAPI document for one provider",
"description": "Assembled from classified endpoints plus the provider connect profile (servers, auth, required headers). Not a raw upstream-spec mirror. FAL (model-grained, queue) is one document: POST /{endpoint_id} and GET /{endpoint_id}/requests/{request_id}. endpoint_id is the model raw id (x-modelschemas-encode raw: do not percent-encode slashes). With no selector the bodies are untyped; ?activity= narrows the enum and inlines each model's own body schema (x-modelschemas-model), up to 1024 models; ?model= is that one model's paths. Other model-grained providers (Reactor) keep one path per endpoint; bare or with ?activity=, each body is an input_/output_ component schema tagged x-modelschemas-model. A filter that matches no endpoint returns 400 spec_requires_selector; there is no cap on the number of paths in a provider-grained document. An unsynced provider returns 404 no_endpoints. ?model= pins the live model enum on provider-grained specs; it does not drop endpoints.",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"description": "Provider slug (see GET /v1/providers).",
"schema": {
"type": "string"
}
},
{
"name": "model",
"in": "query",
"description": "Pin to one model (raw id or slug).",
"schema": {
"type": "string"
}
},
{
"name": "activity",
"in": "query",
"description": "Restrict to one activity group.",
"schema": {
"type": "string",
"enum": [
"chat",
"image",
"video",
"audio",
"embeddings",
"moderation",
"world",
"decision"
]
}
}
],
"responses": {
"200": {
"description": "OpenAPI 3.1 document.",
"content": {
"application/openapi+json": {
"schema": {
"type": "object"
}
},
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/validate": {
"post": {
"operationId": "validatePayload",
"summary": "Validate a payload against a provider endpoint schema",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Validation result.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateResult"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/estimate": {
"post": {
"operationId": "estimateCost",
"summary": "Evaluate a stored rate card against request and usage",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateRequest"
}
}
}
},
"responses": {
"200": {
"description": "The amount for this call and its currency, the card source, which inputs (if any) were estimated or took a default, and which request keys the card ignored. For a routed model with a pricingRange: min and max over its routes, each naming its route. When the call omits exactly one required choice input: byInput, one estimate per allowed value.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/EstimateResult"
},
{
"$ref": "#/components/schemas/EstimateRangeResult"
},
{
"$ref": "#/components/schemas/EstimateByInputResult"
}
]
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/changes": {
"get": {
"operationId": "listChanges",
"summary": "Changelog feed (cursor-paginated)",
"description": "The polling-friendly alternative to webhooks.",
"parameters": [
{
"name": "since",
"in": "query",
"description": "Unix epoch seconds lower bound.",
"schema": {
"type": "integer"
}
},
{
"name": "provider",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"schema": {
"type": "string",
"enum": [
"model.added",
"model.removed",
"model.updated",
"catalog.shape_changed",
"model.deprecated",
"schema.added",
"schema.updated",
"endpoint.added",
"endpoint.removed"
]
}
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "wait",
"in": "query",
"description": "Long-poll: hold up to N seconds (cap 60; \"30s\" form accepted) until new data exists, then return current data.",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 200
}
}
],
"responses": {
"200": {
"description": "Changes page with next cursor.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangesPage"
}
}
}
}
}
}
},
"/v1/admin/sync/{provider}": {
"post": {
"operationId": "syncProvider",
"summary": "Manually trigger a provider spec sync (admin only)",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"description": "Provider slug (see GET /v1/providers).",
"schema": {
"type": "string"
}
}
],
"security": [
{
"adminKey": []
}
],
"responses": {
"200": {
"description": "Sync outcome.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/admin/extract/fal": {
"post": {
"operationId": "extractFalPricing",
"summary": "Manually trigger the FAL llms.txt rate-card extract (admin only). Spec sync stays on POST /v1/admin/sync/fal.",
"security": [
{
"adminKey": []
}
],
"responses": {
"200": {
"description": "Extract outcome.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/v1/admin/export": {
"get": {
"operationId": "exportCatalog",
"summary": "The whole catalog in one streamed response, for the public git mirror (admin only)",
"description": "Returns `latestChange` (the newest change id and createdAt, or null), then `models` (live and deprecated, full rate card), `providers`, and `schemas` (each endpoint with its current input and output versions). Object keys are sorted, and fields that change on every poll (`lastSeenAt`, `lastPolledAt`, `lastSyncedAt`, `_links`) are left out; provenance timestamps such as `factSources.*.fetchedAt` are kept and can move without a value changing. The export is not one snapshot: rows read after `latestChange` may already hold newer changes. To catch up from an earlier export, read every page of GET /v1/changes?since=<its latestChange.createdAt> and skip only its latestChange.id (change ids are random, so do not stop at it). A failure part way breaks the stream, so the body is not valid JSON.",
"security": [
{
"adminKey": []
}
],
"responses": {
"200": {
"description": "Catalog export. `models[]` items are the Model shape without `lastSeenAt` and `_links`.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"latestChange",
"models",
"providers",
"schemas"
],
"properties": {
"latestChange": {
"type": [
"object",
"null"
],
"required": [
"id",
"createdAt"
],
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "integer"
}
}
},
"models": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportModel"
}
},
"providers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"displayName",
"status",
"modelNamespaces"
],
"properties": {
"id": {
"type": "string"
},
"displayName": {
"type": "string"