File size: 42,698 Bytes
dcedb25 | 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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 | // Hand-written OpenAPI 3.0 description of the public `/v1` surface.
//
// Why a TypeScript module and not a raw `openapi.json`: the server ships three
// ways — `tsc` build then `node dist/index.js` (Docker / npm), `tsx` (dev), and
// an esbuild single-file bundle for the desktop app (which carries no server
// `node_modules`). A raw `.json` served from disk breaks the compiled and
// bundled targets (tsc does not copy `.json` into `dist/`, and the bundle has
// no file to read). Exporting the spec from a `.ts` module compiles, bundles,
// and type-checks in every one of those targets with zero extra build wiring.
//
// Served as JSON at `GET /v1/openapi.json`. Keep it in sync with the routers in
// `routes/proxy.ts`, `routes/responses.ts`, and `routes/anthropic.ts` — the
// docs route test asserts every path here resolves to a real route.
// A relative server URL keeps the docs correct on any host or port (localhost,
// LAN, container) and avoids baking an address into the repo.
export const openapiSpec = {
openapi: '3.0.3',
info: {
title: 'FreeLLMAPI',
version: '0.4.1',
description:
'OpenAI-compatible proxy that aggregates free LLM provider tiers behind a single /v1 endpoint. ' +
'A router picks an available model per request and fails over when a provider is rate-limited. ' +
'The gateway also speaks OpenAI Responses, Anthropic Messages, native Gemini, and Ollama wire formats.',
license: { name: 'MIT', url: 'https://github.com/tashfeenahmed/freellmapi/blob/main/LICENSE' },
},
servers: [
{ url: '/', description: 'This proxy instance' },
],
security: [
{ bearerAuth: [] },
{ apiKeyAuth: [] },
],
tags: [
{ name: 'Chat', description: 'OpenAI-compatible chat and completion endpoints' },
{ name: 'Media', description: 'Image generation and text-to-speech' },
{ name: 'Responses', description: 'OpenAI Responses API (Codex CLI wire format)' },
{ name: 'Anthropic', description: 'Anthropic Messages API (Claude Code and the Anthropic SDKs)' },
{ name: 'Models', description: 'Model discovery' },
{ name: 'Gemini', description: 'Native Gemini generateContent wire format' },
{ name: 'Ollama', description: 'Opt-in Ollama-compatible local-client surface' },
{ name: 'URL tokens', description: 'Headerless-client aliases using separately revocable URL tokens' },
],
paths: {
'/v1/chat/completions': {
post: {
tags: ['Chat'],
operationId: 'createChatCompletion',
summary: 'Create a chat completion',
description:
'OpenAI-compatible chat completions. Set `model` to `auto` (the default) to let the router ' +
'pick a free model, or pass a specific model id. Supports streaming, tools, and vision.',
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: '#/components/schemas/ChatCompletionRequest' },
},
},
},
responses: {
'200': {
description:
'A chat completion. When `stream: true`, the body is a `text/event-stream` of ' +
'OpenAI-style `chat.completion.chunk` events terminated by `data: [DONE]`.',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/ChatCompletionResponse' },
},
},
},
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
'429': { $ref: '#/components/responses/RateLimited' },
'502': { $ref: '#/components/responses/UpstreamError' },
},
},
},
'/v1/completions': {
post: {
tags: ['Chat'],
operationId: 'createCompletion',
summary: 'Create a legacy text completion',
description:
'OpenAI-compatible legacy completions. Editor ghost-text clients still send `prompt`/`suffix` ' +
'here; requests are routed through chat models while preserving the `text_completion` shape.',
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: '#/components/schemas/CompletionRequest' },
},
},
},
responses: {
'200': {
description: 'A text completion (`object: "text_completion"`), or an SSE stream when `stream: true`.',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/CompletionResponse' },
},
},
},
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
'429': { $ref: '#/components/responses/RateLimited' },
'502': { $ref: '#/components/responses/UpstreamError' },
},
},
},
'/v1/embeddings': {
post: {
tags: ['Chat'],
operationId: 'createEmbedding',
summary: 'Create embeddings',
description: 'OpenAI-compatible embeddings. `input` accepts a string or an array of strings.',
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: '#/components/schemas/EmbeddingRequest' },
},
},
},
responses: {
'200': {
description: 'A list of embedding vectors.',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/EmbeddingResponse' },
},
},
},
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
'429': { $ref: '#/components/responses/RateLimited' },
'502': { $ref: '#/components/responses/UpstreamError' },
},
},
},
'/v1/images/generations': {
post: {
tags: ['Media'],
operationId: 'createImage',
summary: 'Generate images',
description:
'OpenAI-compatible image generation, routed through the media catalog. Omit `model` (or set ' +
'`auto`) to try every enabled image provider in order; pass a provider model id to pin one.',
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: '#/components/schemas/ImageRequest' },
},
},
},
responses: {
'200': {
description: 'Generated image(s), as URLs or base64 depending on `response_format`.',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/ImageResponse' },
},
},
},
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
'429': { $ref: '#/components/responses/RateLimited' },
'502': { $ref: '#/components/responses/UpstreamError' },
},
},
},
'/v1/videos/generations': {
post: {
tags: ['Media'],
operationId: 'createVideo',
summary: 'Generate video',
description:
'Text-to-video generation routed through the dedicated video catalog. Omit `model` (or set ' +
'`auto`) to fail over across configured providers. The completed video is returned as MP4 bytes; ' +
'provider-specific options that are unsupported by the selected model are ignored.',
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: '#/components/schemas/VideoRequest' },
},
},
},
responses: {
'200': {
description: 'The generated video.',
content: {
'video/mp4': { schema: { type: 'string', format: 'binary' } },
},
},
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
'429': { $ref: '#/components/responses/RateLimited' },
'502': { $ref: '#/components/responses/UpstreamError' },
},
},
},
'/v1/audio/speech': {
post: {
tags: ['Media'],
operationId: 'createSpeech',
summary: 'Generate speech (text-to-speech)',
description:
'OpenAI-compatible text-to-speech, routed through the media catalog. Returns raw audio bytes; ' +
'the `Content-Type` reflects the chosen `response_format`.',
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: '#/components/schemas/SpeechRequest' },
},
},
},
responses: {
'200': {
description: 'Raw audio bytes.',
content: {
'audio/mpeg': { schema: { type: 'string', format: 'binary' } },
},
},
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
'429': { $ref: '#/components/responses/RateLimited' },
'502': { $ref: '#/components/responses/UpstreamError' },
},
},
},
'/v1/audio/transcriptions': {
post: {
tags: ['Media'],
operationId: 'createTranscription',
summary: 'Transcribe audio (speech-to-text)',
description:
'OpenAI-compatible speech-to-text over free whisper deployments (Groq, Cloudflare Workers AI), ' +
'with failover across providers. Multipart upload, held in memory only; maximum file size 25 MB. ' +
"response_format 'vtt' is only available from providers that produce it natively; 'srt' is not " +
'supported and returns 400 unsupported_format. The model registry is delivered by catalog sync; ' +
"an install that has not yet synced any transcription models returns 503 with code 'no_transcription_models'.",
requestBody: {
required: true,
content: {
'multipart/form-data': {
schema: { $ref: '#/components/schemas/TranscriptionRequest' },
},
},
},
responses: {
'200': {
description: 'The transcription in the requested format.',
content: {
'application/json': {
schema: {
type: 'object',
properties: { text: { type: 'string' } },
},
},
'text/plain': { schema: { type: 'string' } },
},
},
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
'413': {
description: 'The uploaded audio exceeds the 25 MB limit.',
content: {
'application/json': { schema: { $ref: '#/components/schemas/Error' } },
},
},
'429': { $ref: '#/components/responses/RateLimited' },
'502': { $ref: '#/components/responses/UpstreamError' },
'503': {
description:
"No transcription models synced yet (code 'no_transcription_models'): the registry arrives via catalog sync.",
content: {
'application/json': { schema: { $ref: '#/components/schemas/Error' } },
},
},
},
},
},
'/v1/responses': {
post: {
tags: ['Responses'],
operationId: 'createResponse',
summary: 'Create a model response (OpenAI Responses API)',
description:
'The OpenAI Responses wire format that current Codex CLI versions require, implemented as a ' +
'translating shim over the same router. Supports streaming events and tool calls. Image input ' +
'is not supported here; use /chat/completions with an image_url content part instead.',
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: '#/components/schemas/ResponseRequest' },
},
},
},
responses: {
'200': {
description: 'A response object, or an SSE stream of Responses events when `stream: true`.',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/ResponseObject' },
},
},
},
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
'429': { $ref: '#/components/responses/RateLimited' },
'502': { $ref: '#/components/responses/UpstreamError' },
},
},
},
'/v1/messages': {
post: {
tags: ['Anthropic'],
operationId: 'createMessage',
summary: 'Create a message (Anthropic Messages API)',
description:
"Anthropic's Messages wire format over the same router, so Claude Code and the official " +
'Anthropic SDKs run against your free pool. Claude family names (opus / sonnet / haiku / ' +
'default) map to `auto` or a pinned model on the Keys page. Send the key via the `x-api-key` ' +
'header (Anthropic style) or an Authorization bearer token.',
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: '#/components/schemas/AnthropicMessageRequest' },
},
},
},
responses: {
'200': {
description: 'An Anthropic message, or an SSE stream of Anthropic events when `stream: true`.',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/AnthropicMessageResponse' },
},
},
},
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
'429': { $ref: '#/components/responses/RateLimited' },
'502': { $ref: '#/components/responses/UpstreamError' },
},
},
},
'/v1/messages/count_tokens': {
post: {
tags: ['Anthropic'],
operationId: 'countTokens',
summary: 'Count input tokens (Anthropic Messages API)',
description: 'Estimates the input token count for an Anthropic Messages request without running it.',
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: '#/components/schemas/AnthropicMessageRequest' },
},
},
},
responses: {
'200': {
description: 'An estimated input token count.',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/CountTokensResponse' },
},
},
},
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
},
},
},
'/v1/models': {
get: {
tags: ['Models'],
operationId: 'listModels',
summary: 'List available models',
description:
'Lists the catalog, one row per model id, each tagged with whether it is usable right now, ' +
'plus the virtual `auto` id. Content-negotiated: sending an `anthropic-version` header returns ' +
'the Anthropic model-list shape; otherwise the OpenAI shape is returned. `?available=true` ' +
'filters to models that can serve a request now.',
parameters: [
{
name: 'available',
in: 'query',
required: false,
description: 'When `true`, return only models that are currently usable.',
schema: { type: 'boolean' },
},
],
responses: {
'200': {
description: 'The model list.',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/ModelList' },
},
},
},
'401': { $ref: '#/components/responses/Unauthorized' },
},
},
},
'/v1beta/models': {
get: {
tags: ['Gemini'],
operationId: 'listGeminiModels',
summary: 'List models in Gemini format',
security: [{ googleApiKeyHeader: [] }, { googleApiKeyQuery: [] }, { bearerAuth: [] }],
responses: {
'200': { description: 'Gemini-shaped model list.' },
'401': { $ref: '#/components/responses/Unauthorized' },
},
},
},
'/v1beta/models/{model}': {
get: {
tags: ['Gemini'],
operationId: 'getGeminiModel',
summary: 'Get Gemini-shaped model metadata',
security: [{ googleApiKeyHeader: [] }, { googleApiKeyQuery: [] }, { bearerAuth: [] }],
parameters: [{
name: 'model',
in: 'path',
required: true,
schema: { type: 'string' },
}],
responses: {
'200': { description: 'Gemini-shaped model metadata.' },
'404': { description: 'Model not found.' },
},
},
},
'/v1beta/models/{model}:generateContent': {
post: {
tags: ['Gemini'],
operationId: 'generateGeminiContent',
summary: 'Generate content using the native Gemini wire format',
security: [{ googleApiKeyHeader: [] }, { googleApiKeyQuery: [] }, { bearerAuth: [] }],
parameters: [{
name: 'model',
in: 'path',
required: true,
schema: { type: 'string' },
}],
requestBody: {
required: true,
content: { 'application/json': { schema: { $ref: '#/components/schemas/GeminiGenerateRequest' } } },
},
responses: {
'200': { description: 'Gemini candidates and usage metadata.' },
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
},
},
},
'/v1beta/models/{model}:streamGenerateContent': {
post: {
tags: ['Gemini'],
operationId: 'streamGeminiContent',
summary: 'Stream native Gemini content',
description: 'Use `?alt=sse` for Gemini CLI SSE. Without it, the response is a streamed JSON array.',
security: [{ googleApiKeyHeader: [] }, { googleApiKeyQuery: [] }, { bearerAuth: [] }],
parameters: [
{ name: 'model', in: 'path', required: true, schema: { type: 'string' } },
{ name: 'alt', in: 'query', required: false, schema: { type: 'string', enum: ['sse'] } },
],
requestBody: {
required: true,
content: { 'application/json': { schema: { $ref: '#/components/schemas/GeminiGenerateRequest' } } },
},
responses: {
'200': { description: 'SSE or JSON-array Gemini stream.' },
'400': { $ref: '#/components/responses/BadRequest' },
'401': { $ref: '#/components/responses/Unauthorized' },
},
},
},
'/v1beta/models/{model}:countTokens': {
post: {
tags: ['Gemini'],
operationId: 'countGeminiTokens',
summary: 'Estimate tokens for Gemini content',
security: [{ googleApiKeyHeader: [] }, { googleApiKeyQuery: [] }, { bearerAuth: [] }],
parameters: [{
name: 'model',
in: 'path',
required: true,
schema: { type: 'string' },
}],
requestBody: {
required: true,
content: { 'application/json': { schema: { $ref: '#/components/schemas/GeminiGenerateRequest' } } },
},
responses: {
'200': { description: 'Heuristic token count.' },
'401': { $ref: '#/components/responses/Unauthorized' },
},
},
},
'/api/tags': {
get: {
tags: ['Ollama'],
operationId: 'listOllamaModels',
summary: 'List models in Ollama format',
'x-optional-surface': true,
responses: { '200': { description: 'Ollama model list.' }, '404': { description: 'Emulation disabled.' } },
},
},
'/api/chat': {
post: {
tags: ['Ollama'],
operationId: 'ollamaChat',
summary: 'Create an Ollama chat response',
description: 'Streaming defaults to NDJSON, matching Ollama.',
'x-optional-surface': true,
responses: { '200': { description: 'Ollama chat response or NDJSON stream.' }, '404': { description: 'Emulation disabled.' } },
},
},
'/api/generate': {
post: {
tags: ['Ollama'],
operationId: 'ollamaGenerate',
summary: 'Create an Ollama legacy prompt response',
'x-optional-surface': true,
responses: { '200': { description: 'Ollama generation response or NDJSON stream.' }, '404': { description: 'Emulation disabled.' } },
},
},
'/api/show': {
post: {
tags: ['Ollama'],
operationId: 'showOllamaModel',
summary: 'Show Ollama model metadata',
'x-optional-surface': true,
responses: { '200': { description: 'Ollama model metadata.' }, '404': { description: 'Emulation disabled or model missing.' } },
},
},
'/api/version': {
get: {
tags: ['Ollama'],
operationId: 'getOllamaVersion',
summary: 'Get emulated Ollama version',
'x-optional-surface': true,
responses: { '200': { description: 'Emulation version.' }, '404': { description: 'Emulation disabled.' } },
},
},
'/api/embed': {
post: {
tags: ['Ollama'],
operationId: 'ollamaEmbed',
summary: 'Create Ollama embeddings',
'x-optional-surface': true,
responses: { '200': { description: 'Ollama embedding vectors.' }, '404': { description: 'Emulation disabled.' } },
},
},
'/api/embeddings': {
post: {
tags: ['Ollama'],
operationId: 'ollamaLegacyEmbed',
summary: 'Create a legacy Ollama embedding',
description: 'A valid dashboard session falls through to the dashboard embeddings API.',
'x-optional-surface': true,
responses: { '200': { description: 'Legacy Ollama embedding.' }, '404': { description: 'Emulation disabled.' } },
},
},
'/v1/t/{token}/models': {
get: {
tags: ['URL tokens'],
operationId: 'listModelsWithUrlToken',
summary: 'Headerless model discovery',
parameters: [{ name: 'token', in: 'path', required: true, schema: { type: 'string' } }],
security: [],
responses: { '200': { description: 'OpenAI-shaped model list.' }, '401': { description: 'Invalid or revoked URL token.' } },
},
},
'/v1/t/{token}/chat/completions': {
post: {
tags: ['URL tokens'],
operationId: 'chatWithUrlToken',
summary: 'Headerless OpenAI chat completions',
description: 'URL tokens are separately revocable and are never the unified API key. URLs can leak into history and logs.',
parameters: [{ name: 'token', in: 'path', required: true, schema: { type: 'string' } }],
security: [],
responses: { '200': { description: 'OpenAI chat completion.' }, '401': { description: 'Invalid or revoked URL token.' } },
},
},
'/v1/t/{token}/responses': {
post: {
tags: ['URL tokens'],
operationId: 'responsesWithUrlToken',
summary: 'Headerless OpenAI Responses API',
parameters: [{ name: 'token', in: 'path', required: true, schema: { type: 'string' } }],
security: [],
responses: { '200': { description: 'OpenAI Responses response.' }, '401': { description: 'Invalid or revoked URL token.' } },
},
},
'/v1/t/{token}/api/chat': {
post: {
tags: ['URL tokens'],
operationId: 'ollamaChatWithUrlToken',
summary: 'Headerless Ollama chat',
parameters: [{ name: 'token', in: 'path', required: true, schema: { type: 'string' } }],
security: [],
responses: { '200': { description: 'Ollama response or NDJSON stream.' }, '401': { description: 'Invalid or revoked URL token.' } },
},
},
'/v1/t/{token}/api/tags': {
get: {
tags: ['URL tokens'],
operationId: 'ollamaTagsWithUrlToken',
summary: 'Headerless Ollama model discovery',
parameters: [{ name: 'token', in: 'path', required: true, schema: { type: 'string' } }],
security: [],
responses: { '200': { description: 'Ollama model list.' }, '401': { description: 'Invalid or revoked URL token.' } },
},
},
},
components: {
securitySchemes: {
// The unified API key from the Keys page. Send it as either an OpenAI-style
// bearer token or an Anthropic-style x-api-key header — both are accepted.
bearerAuth: {
type: 'http',
scheme: 'bearer',
description: 'Unified API key as `Authorization: Bearer <key>`.',
},
apiKeyAuth: {
type: 'apiKey',
in: 'header',
name: 'x-api-key',
description: 'Unified API key as `x-api-key: <key>` (Anthropic-style clients).',
},
googleApiKeyHeader: {
type: 'apiKey',
in: 'header',
name: 'x-goog-api-key',
description: 'Unified API key in Gemini SDK format.',
},
googleApiKeyQuery: {
type: 'apiKey',
in: 'query',
name: 'key',
description: 'Gemini compatibility fallback. Prefer the header because URLs leak into history and logs.',
},
},
responses: {
BadRequest: {
description: 'The request was malformed.',
content: { 'application/json': { schema: { $ref: '#/components/schemas/Error' } } },
},
Unauthorized: {
description: 'Missing or invalid API key.',
content: { 'application/json': { schema: { $ref: '#/components/schemas/Error' } } },
},
RateLimited: {
description: 'Rate limit exceeded.',
content: { 'application/json': { schema: { $ref: '#/components/schemas/Error' } } },
},
UpstreamError: {
description: 'Every candidate provider failed to serve the request.',
content: { 'application/json': { schema: { $ref: '#/components/schemas/Error' } } },
},
},
schemas: {
GeminiGenerateRequest: {
type: 'object',
required: ['contents'],
properties: {
contents: {
type: 'array',
minItems: 1,
items: {
type: 'object',
properties: {
role: { type: 'string', enum: ['user', 'model'] },
parts: {
type: 'array',
items: {
type: 'object',
description: 'A text, inlineData, functionCall, or functionResponse part.',
},
},
},
},
},
systemInstruction: { type: 'object' },
tools: { type: 'array', items: { type: 'object' } },
toolConfig: { type: 'object' },
generationConfig: {
type: 'object',
properties: {
temperature: { type: 'number' },
topP: { type: 'number' },
topK: { type: 'integer' },
maxOutputTokens: { type: 'integer' },
stopSequences: { type: 'array', items: { type: 'string' } },
responseMimeType: { type: 'string' },
responseSchema: { type: 'object' },
thinkingConfig: { type: 'object' },
},
},
},
},
ChatCompletionRequest: {
type: 'object',
required: ['messages'],
properties: {
model: { type: 'string', description: "Model id, or 'auto' for automatic routing.", default: 'auto' },
messages: { type: 'array', minItems: 1, items: { $ref: '#/components/schemas/Message' } },
temperature: { type: 'number', minimum: 0, maximum: 2 },
max_tokens: { type: 'integer', description: 'Values <= 0 are treated as "no limit".' },
top_p: { type: 'number', minimum: 0, maximum: 1 },
stop: {
description: 'Up to a few stop sequences.',
oneOf: [{ type: 'string' }, { type: 'array', items: { type: 'string' } }],
},
stream: { type: 'boolean', default: false },
tools: { type: 'array', items: { $ref: '#/components/schemas/Tool' }, nullable: true },
tool_choice: {
nullable: true,
oneOf: [
{ type: 'string', enum: ['none', 'auto', 'required', 'any'] },
{ $ref: '#/components/schemas/ToolChoiceObject' },
],
},
parallel_tool_calls: { type: 'boolean', nullable: true },
},
},
Message: {
type: 'object',
required: ['role'],
properties: {
role: { type: 'string', enum: ['system', 'developer', 'user', 'assistant', 'tool', 'function'] },
content: {
description: 'A string, or an array of content parts (text and image_url) for vision.',
oneOf: [{ type: 'string' }, { type: 'array', items: { type: 'object' } }],
nullable: true,
},
name: { type: 'string' },
tool_calls: { type: 'array', items: { $ref: '#/components/schemas/ToolCall' } },
tool_call_id: { type: 'string' },
},
},
Tool: {
type: 'object',
required: ['type', 'function'],
properties: {
type: { type: 'string', enum: ['function'] },
function: {
type: 'object',
required: ['name'],
properties: {
name: { type: 'string' },
description: { type: 'string' },
parameters: { type: 'object', description: 'JSON Schema for the function arguments.' },
strict: { type: 'boolean' },
},
},
},
},
ToolChoiceObject: {
type: 'object',
required: ['type', 'function'],
properties: {
type: { type: 'string', enum: ['function'] },
function: { type: 'object', required: ['name'], properties: { name: { type: 'string' } } },
},
},
ToolCall: {
type: 'object',
properties: {
id: { type: 'string' },
type: { type: 'string', enum: ['function'] },
function: {
type: 'object',
properties: {
name: { type: 'string' },
arguments: { type: 'string', description: 'JSON-encoded arguments.' },
},
},
},
},
ChatCompletionResponse: {
type: 'object',
properties: {
id: { type: 'string' },
object: { type: 'string', example: 'chat.completion' },
created: { type: 'integer' },
model: { type: 'string' },
choices: {
type: 'array',
items: {
type: 'object',
properties: {
index: { type: 'integer' },
message: { $ref: '#/components/schemas/Message' },
finish_reason: { type: 'string', nullable: true },
},
},
},
usage: { $ref: '#/components/schemas/Usage' },
},
},
CompletionRequest: {
type: 'object',
required: ['prompt'],
properties: {
model: { type: 'string', default: 'auto' },
prompt: { type: 'string' },
suffix: { type: 'string', description: 'Text after the cursor, for fill-in-the-middle clients.' },
temperature: { type: 'number', minimum: 0, maximum: 2 },
max_tokens: { type: 'integer' },
top_p: { type: 'number', minimum: 0, maximum: 1 },
stop: { oneOf: [{ type: 'string' }, { type: 'array', items: { type: 'string' } }] },
stream: { type: 'boolean', default: false },
},
},
CompletionResponse: {
type: 'object',
properties: {
id: { type: 'string' },
object: { type: 'string', example: 'text_completion' },
created: { type: 'integer' },
model: { type: 'string' },
choices: {
type: 'array',
items: {
type: 'object',
properties: {
text: { type: 'string' },
index: { type: 'integer' },
logprobs: { nullable: true },
finish_reason: { type: 'string', nullable: true },
},
},
},
},
},
EmbeddingRequest: {
type: 'object',
required: ['input'],
properties: {
model: { type: 'string', default: 'auto' },
input: { oneOf: [{ type: 'string' }, { type: 'array', items: { type: 'string' } }] },
dimensions: { type: 'integer', minimum: 1, description: 'Requested output dimensionality, if the model supports it.' },
},
},
EmbeddingResponse: {
type: 'object',
properties: {
object: { type: 'string', enum: ['list'] },
data: {
type: 'array',
items: {
type: 'object',
properties: {
object: { type: 'string', enum: ['embedding'] },
index: { type: 'integer' },
embedding: { type: 'array', items: { type: 'number' } },
},
},
},
model: { type: 'string' },
provider: { type: 'string' },
usage: { $ref: '#/components/schemas/Usage' },
},
},
ImageRequest: {
type: 'object',
required: ['prompt'],
properties: {
model: { type: 'string', default: 'auto' },
prompt: { type: 'string', minLength: 1 },
n: { type: 'integer', minimum: 1, maximum: 4 },
size: { type: 'string', example: '1024x1024' },
response_format: { type: 'string', enum: ['url', 'b64_json'] },
},
},
ImageResponse: {
type: 'object',
properties: {
created: { type: 'integer' },
data: {
type: 'array',
items: {
type: 'object',
properties: {
url: { type: 'string' },
b64_json: { type: 'string' },
},
},
},
model: { type: 'string' },
provider: { type: 'string' },
},
},
VideoRequest: {
type: 'object',
required: ['prompt'],
properties: {
model: { type: 'string', default: 'auto' },
prompt: { type: 'string', minLength: 1 },
duration: {
type: 'integer',
minimum: 1,
maximum: 120,
description: 'Requested duration in seconds. Supported values are model-specific; nova-reel accepts multiples of 6.',
},
aspect_ratio: { type: 'string', enum: ['16:9', '9:16'] },
image: { type: 'string', format: 'uri', description: 'Optional starting-frame image URL.' },
seed: { type: 'integer', minimum: -1, maximum: 2147483647 },
audio: { type: 'boolean', description: 'Request generated audio when the selected model supports it.' },
},
},
SpeechRequest: {
type: 'object',
required: ['input'],
properties: {
model: { type: 'string', default: 'auto' },
input: { type: 'string', minLength: 1 },
voice: {
type: 'string',
description:
'OpenAI voice names are translated to the selected provider voice. Native Gemini and SiliconFlow names are also accepted; unknown names use the provider default.',
},
response_format: { type: 'string', example: 'mp3' },
},
},
TranscriptionRequest: {
type: 'object',
required: ['file', 'model'],
properties: {
file: { type: 'string', format: 'binary', description: 'The audio file to transcribe (max 25 MB).' },
model: {
type: 'string',
description: "'whisper-1' or 'auto' lets the router pick; a provider model id (e.g. 'whisper-large-v3-turbo', '@cf/openai/whisper') pins to that deployment.",
},
language: { type: 'string', description: 'ISO-639-1 hint forwarded to the provider.' },
prompt: { type: 'string', description: 'Optional context/spelling hint forwarded to the provider.' },
temperature: { type: 'number', minimum: 0, maximum: 1 },
response_format: {
type: 'string',
enum: ['json', 'text', 'verbose_json', 'vtt'],
default: 'json',
description:
"'verbose_json' includes segments when the provider returns them (falls back to the plain json shape otherwise). " +
"'vtt' is only served by providers that produce it natively (Cloudflare Workers AI whisper). " +
"'srt' is not supported and returns 400 unsupported_format.",
},
},
},
ResponseRequest: {
type: 'object',
required: ['input'],
properties: {
model: { type: 'string', default: 'auto' },
instructions: { type: 'string', nullable: true, description: 'System-level guidance, sent as a system message.' },
input: {
description: 'A string, or an array of Responses input items.',
oneOf: [{ type: 'string' }, { type: 'array', items: { type: 'object' } }],
},
stream: { type: 'boolean', default: false },
max_output_tokens: { type: 'integer', minimum: 1, nullable: true },
tools: { type: 'array', items: { type: 'object' } },
},
},
ResponseObject: {
type: 'object',
properties: {
id: { type: 'string' },
object: { type: 'string', example: 'response' },
created_at: { type: 'integer' },
model: { type: 'string' },
status: { type: 'string', example: 'completed' },
output: { type: 'array', items: { type: 'object' } },
output_text: { type: 'string' },
usage: { type: 'object' },
},
},
AnthropicMessageRequest: {
type: 'object',
required: ['messages'],
properties: {
model: { type: 'string', description: 'Anthropic model name; mapped to your free pool. Defaults to `auto`.' },
max_tokens: { type: 'integer', description: 'Anthropic-required; non-positive values fall back to a default.' },
messages: {
type: 'array',
minItems: 1,
items: {
type: 'object',
required: ['role', 'content'],
properties: {
role: { type: 'string', enum: ['user', 'assistant', 'system'] },
content: {
oneOf: [{ type: 'string' }, { type: 'array', items: { type: 'object' } }],
},
},
},
},
system: {
description: 'System prompt, as a string or an array of content blocks.',
oneOf: [{ type: 'string' }, { type: 'array', items: { type: 'object' } }],
},
temperature: { type: 'number', minimum: 0, maximum: 2 },
top_p: { type: 'number', minimum: 0, maximum: 1 },
stream: { type: 'boolean', default: false },
stop_sequences: { type: 'array', items: { type: 'string' } },
tools: {
type: 'array',
items: {
type: 'object',
required: ['name'],
properties: {
name: { type: 'string' },
description: { type: 'string' },
input_schema: { type: 'object' },
},
},
},
tool_choice: {
type: 'object',
properties: {
type: { type: 'string', enum: ['auto', 'any', 'tool', 'none'] },
name: { type: 'string' },
},
},
},
},
AnthropicMessageResponse: {
type: 'object',
properties: {
id: { type: 'string' },
type: { type: 'string', enum: ['message'] },
role: { type: 'string', enum: ['assistant'] },
model: { type: 'string' },
content: { type: 'array', items: { type: 'object' } },
stop_reason: {
type: 'string',
nullable: true,
enum: ['end_turn', 'max_tokens', 'stop_sequence', 'tool_use'],
},
stop_sequence: { type: 'string', nullable: true },
usage: {
type: 'object',
properties: {
input_tokens: { type: 'integer' },
output_tokens: { type: 'integer' },
},
},
},
},
CountTokensResponse: {
type: 'object',
properties: {
input_tokens: { type: 'integer' },
},
},
Usage: {
type: 'object',
properties: {
prompt_tokens: { type: 'integer' },
completion_tokens: { type: 'integer' },
total_tokens: { type: 'integer' },
},
},
ModelList: {
type: 'object',
properties: {
object: { type: 'string', enum: ['list'] },
data: { type: 'array', items: { $ref: '#/components/schemas/Model' } },
},
},
Model: {
type: 'object',
properties: {
id: { type: 'string' },
object: { type: 'string', enum: ['model'] },
created: { type: 'integer' },
owned_by: { type: 'string' },
},
},
Error: {
type: 'object',
properties: {
error: {
type: 'object',
properties: {
message: { type: 'string' },
type: { type: 'string' },
param: { type: 'string', nullable: true },
code: { type: 'string', nullable: true },
},
},
},
},
},
},
} as const;
export type OpenApiSpec = typeof openapiSpec;
|