first commit
This commit is contained in:
Beyhan Oğur
230
docs/openapi/paths/integrations/anthropic/batch.yaml
Normal file
230
docs/openapi/paths/integrations/anthropic/batch.yaml
Normal file
@@ -0,0 +1,230 @@
|
||||
# Anthropic Integration - Batch API Endpoints
|
||||
|
||||
batches:
|
||||
post:
|
||||
operationId: anthropicCreateBatch
|
||||
summary: Create batch job (Anthropic format)
|
||||
description: |
|
||||
Creates a batch processing job using Anthropic format.
|
||||
Use x-model-provider header to specify the provider.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: x-model-provider
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
description: Provider to use (defaults to anthropic)
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/batch.yaml#/AnthropicBatchCreateRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/batch.yaml#/AnthropicBatchCreateResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
get:
|
||||
operationId: anthropicListBatches
|
||||
summary: List batch jobs (Anthropic format)
|
||||
description: |
|
||||
Lists batch processing jobs.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: x-model-provider
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
description: Provider to use (defaults to anthropic)
|
||||
- name: page_size
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
default: 20
|
||||
description: Maximum number of batches to return
|
||||
- name: page_token
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Cursor for pagination
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/batch.yaml#/AnthropicBatchListResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
batches-by-id:
|
||||
get:
|
||||
operationId: anthropicRetrieveBatch
|
||||
summary: Retrieve batch job (Anthropic format)
|
||||
description: |
|
||||
Retrieves details of a batch processing job.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: batch_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Batch job ID
|
||||
- name: x-model-provider
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the batch
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/batch.yaml#/AnthropicBatchRetrieveResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
batches-cancel:
|
||||
post:
|
||||
operationId: anthropicCancelBatch
|
||||
summary: Cancel batch job (Anthropic format)
|
||||
description: |
|
||||
Cancels a batch processing job.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: batch_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Batch job ID to cancel
|
||||
- name: x-model-provider
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the batch
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/batch.yaml#/AnthropicBatchCancelResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
batches-results:
|
||||
get:
|
||||
operationId: anthropicGetBatchResults
|
||||
summary: Get batch results (Anthropic format)
|
||||
description: |
|
||||
Retrieves results of a completed batch job.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: batch_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Batch job ID
|
||||
- name: x-model-provider
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the batch
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response (JSONL stream)
|
||||
content:
|
||||
application/x-ndjson:
|
||||
schema:
|
||||
type: string
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
40
docs/openapi/paths/integrations/anthropic/count-tokens.yaml
Normal file
40
docs/openapi/paths/integrations/anthropic/count-tokens.yaml
Normal file
@@ -0,0 +1,40 @@
|
||||
# Anthropic Integration - Count Tokens Endpoints
|
||||
|
||||
count-tokens:
|
||||
post:
|
||||
operationId: anthropicCountTokens
|
||||
summary: Count tokens (Anthropic format)
|
||||
description: |
|
||||
Counts the number of tokens in a message request.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/count-tokens.yaml#/AnthropicCountTokensRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/count-tokens.yaml#/AnthropicCountTokensResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
209
docs/openapi/paths/integrations/anthropic/files.yaml
Normal file
209
docs/openapi/paths/integrations/anthropic/files.yaml
Normal file
@@ -0,0 +1,209 @@
|
||||
# Anthropic Integration - Files API Endpoints
|
||||
|
||||
files:
|
||||
post:
|
||||
operationId: anthropicUploadFile
|
||||
summary: Upload file (Anthropic format)
|
||||
description: |
|
||||
Uploads a file. Use x-model-provider header to specify the provider.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: x-model-provider
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
description: Provider to use (defaults to anthropic)
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/files.yaml#/AnthropicFileUploadRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/files.yaml#/AnthropicFileUploadResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
get:
|
||||
operationId: anthropicListFiles
|
||||
summary: List files (Anthropic format)
|
||||
description: |
|
||||
Lists uploaded files.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: x-model-provider
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
description: Provider to use (defaults to anthropic)
|
||||
- name: limit
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
default: 30
|
||||
description: Maximum files to return
|
||||
- name: after_id
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Cursor for pagination
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/files.yaml#/AnthropicFileListResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
files-content:
|
||||
get:
|
||||
operationId: anthropicGetFileContent
|
||||
summary: Get file content (Anthropic format)
|
||||
description: |
|
||||
Retrieves file content. Returns raw binary file data when Accept header is set to application/octet-stream,
|
||||
or file metadata as JSON when Accept header is set to application/json.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: file_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: File ID
|
||||
- name: x-model-provider
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the file
|
||||
- name: Accept
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
enum: [application/json, application/octet-stream]
|
||||
default: application/json
|
||||
description: Response content type - use application/octet-stream for binary download
|
||||
responses:
|
||||
'200':
|
||||
description: |
|
||||
Successful response. Returns file metadata as JSON or raw binary file content.
|
||||
When returning binary content, the Content-Type header indicates the file's MIME type
|
||||
and Content-Disposition header may include the filename.
|
||||
headers:
|
||||
Content-Type:
|
||||
schema:
|
||||
type: string
|
||||
description: MIME type of the file (e.g., application/pdf, image/png, text/plain)
|
||||
Content-Disposition:
|
||||
schema:
|
||||
type: string
|
||||
description: Attachment filename directive (e.g., attachment; filename="document.pdf")
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/files.yaml#/AnthropicFileRetrieveResponse'
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
description: Raw binary file content
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
files-by-id:
|
||||
delete:
|
||||
operationId: anthropicDeleteFile
|
||||
summary: Delete file (Anthropic format)
|
||||
description: |
|
||||
Deletes an uploaded file.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: file_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: File ID to delete
|
||||
- name: x-model-provider
|
||||
in: header
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the file
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/files.yaml#/AnthropicFileDeleteResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
119
docs/openapi/paths/integrations/anthropic/messages.yaml
Normal file
119
docs/openapi/paths/integrations/anthropic/messages.yaml
Normal file
@@ -0,0 +1,119 @@
|
||||
# Anthropic Integration - Messages API Endpoints
|
||||
|
||||
messages:
|
||||
post:
|
||||
operationId: anthropicCreateMessage
|
||||
summary: Create message (Anthropic format)
|
||||
description: |
|
||||
Creates a message using Anthropic Messages API format.
|
||||
Supports streaming via SSE.
|
||||
|
||||
**Async inference:** Send `x-bf-async: true` to submit the request as a background job and receive a job ID immediately. Poll with `x-bf-async-id: <job-id>` to retrieve the result. When the job is still processing, the response will have an empty `content` array. When completed, `content` will contain the full result. See [Async Inference](/features/async-inference) for details.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: x-bf-async
|
||||
in: header
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: ["true"]
|
||||
description: Set to `true` to submit this request as an async job. Returns immediately with a job ID. Not
|
||||
compatible with streaming.
|
||||
- name: x-bf-async-id
|
||||
in: header
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
description: Poll for results of a previously submitted async job by providing the job ID returned from the
|
||||
initial async request.
|
||||
- name: x-bf-async-job-result-ttl
|
||||
in: header
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
default: 3600
|
||||
description: Override the default result TTL in seconds. Results expire after this duration from completion time.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicMessageRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicMessageResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
|
||||
# Wildcard path for extended messages endpoints (e.g., /v1/messages/batches)
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
messages-wildcard:
|
||||
post:
|
||||
operationId: anthropicCreateMessageWildcard
|
||||
summary: Create message (Anthropic format) - wildcard
|
||||
description: |
|
||||
Handles extended messages API paths.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: path
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Extended path
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicMessageRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicMessageResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
50
docs/openapi/paths/integrations/anthropic/models.yaml
Normal file
50
docs/openapi/paths/integrations/anthropic/models.yaml
Normal file
@@ -0,0 +1,50 @@
|
||||
# Anthropic Integration - Models Endpoints
|
||||
|
||||
models:
|
||||
get:
|
||||
operationId: anthropicListModels
|
||||
summary: List models (Anthropic format)
|
||||
description: |
|
||||
Lists available models in Anthropic format.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
parameters:
|
||||
- name: limit
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
description: Maximum number of models to return
|
||||
- name: before_id
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Return models before this ID
|
||||
- name: after_id
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Return models after this ID
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicListModelsResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
44
docs/openapi/paths/integrations/anthropic/text.yaml
Normal file
44
docs/openapi/paths/integrations/anthropic/text.yaml
Normal file
@@ -0,0 +1,44 @@
|
||||
# Anthropic Integration - Legacy Complete API Endpoints
|
||||
|
||||
complete:
|
||||
post:
|
||||
operationId: anthropicCreateComplete
|
||||
summary: Create completion (Anthropic legacy format)
|
||||
description: |
|
||||
Creates a text completion using Anthropic's legacy Complete API.
|
||||
Supports streaming via SSE.
|
||||
tags:
|
||||
- Anthropic Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/text.yaml#/AnthropicTextRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/text.yaml#/AnthropicTextResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/text.yaml#/AnthropicTextResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
174
docs/openapi/paths/integrations/bedrock/batch.yaml
Normal file
174
docs/openapi/paths/integrations/bedrock/batch.yaml
Normal file
@@ -0,0 +1,174 @@
|
||||
# AWS Bedrock - Batch Inference Endpoints
|
||||
|
||||
batch-jobs:
|
||||
post:
|
||||
operationId: bedrockCreateBatchJob
|
||||
summary: Create batch inference job (Bedrock format)
|
||||
description: |
|
||||
Creates a batch inference job using AWS Bedrock format.
|
||||
tags:
|
||||
- Bedrock Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/batch.yaml#/BedrockBatchJobRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/batch.yaml#/BedrockBatchJobResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
get:
|
||||
operationId: bedrockListBatchJobs
|
||||
summary: List batch inference jobs (Bedrock format)
|
||||
description: |
|
||||
Lists batch inference jobs using AWS Bedrock format.
|
||||
tags:
|
||||
- Bedrock Integration
|
||||
parameters:
|
||||
- name: maxResults
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
description: Maximum number of results to return
|
||||
- name: nextToken
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Token for pagination
|
||||
- name: statusEquals
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
enum: [Submitted, InProgress, Completed, Failed, Stopping, Stopped, PartiallyCompleted, Expired, Validating,
|
||||
Scheduled]
|
||||
description: Filter by status
|
||||
- name: nameContains
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Filter by job name containing this string
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/batch.yaml#/BedrockBatchListResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
batch-job-by-id:
|
||||
get:
|
||||
operationId: bedrockRetrieveBatchJob
|
||||
summary: Retrieve batch inference job (Bedrock format)
|
||||
description: |
|
||||
Retrieves a batch inference job using AWS Bedrock format.
|
||||
tags:
|
||||
- Bedrock Integration
|
||||
parameters:
|
||||
- name: jobIdentifier
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Job identifier
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/batch.yaml#/BedrockBatchJobResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
batch-job-cancel:
|
||||
post:
|
||||
operationId: bedrockCancelBatchJob
|
||||
summary: Cancel batch inference job (Bedrock format)
|
||||
description: |
|
||||
Cancels a batch inference job using AWS Bedrock format.
|
||||
tags:
|
||||
- Bedrock Integration
|
||||
parameters:
|
||||
- name: jobIdentifier
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Job identifier to cancel
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/batch.yaml#/BedrockBatchCancelResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
93
docs/openapi/paths/integrations/bedrock/converse.yaml
Normal file
93
docs/openapi/paths/integrations/bedrock/converse.yaml
Normal file
@@ -0,0 +1,93 @@
|
||||
# AWS Bedrock - Converse Endpoints
|
||||
|
||||
converse:
|
||||
post:
|
||||
operationId: bedrockConverse
|
||||
summary: Converse with model (Bedrock format)
|
||||
description: |
|
||||
Sends messages to a model using AWS Bedrock Converse API format.
|
||||
tags:
|
||||
- Bedrock Integration
|
||||
parameters:
|
||||
- name: modelId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model ID (e.g., anthropic.claude-3-sonnet-20240229-v1:0)
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
converse-stream:
|
||||
post:
|
||||
operationId: bedrockConverseStream
|
||||
summary: Stream converse with model (Bedrock format)
|
||||
description: |
|
||||
Streams messages from a model using AWS Bedrock Converse API format.
|
||||
tags:
|
||||
- Bedrock Integration
|
||||
parameters:
|
||||
- name: modelId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model ID (e.g., anthropic.claude-3-sonnet-20240229-v1:0)
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful streaming response
|
||||
content:
|
||||
application/x-amz-eventstream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
95
docs/openapi/paths/integrations/bedrock/invoke.yaml
Normal file
95
docs/openapi/paths/integrations/bedrock/invoke.yaml
Normal file
@@ -0,0 +1,95 @@
|
||||
# AWS Bedrock - Invoke Endpoints
|
||||
|
||||
invoke:
|
||||
post:
|
||||
operationId: bedrockInvokeModel
|
||||
summary: Invoke model (Bedrock format)
|
||||
description: |
|
||||
Invokes a model using AWS Bedrock InvokeModel API format.
|
||||
Accepts raw model-specific request body.
|
||||
tags:
|
||||
- Bedrock Integration
|
||||
parameters:
|
||||
- name: modelId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model ID (e.g., anthropic.claude-3-sonnet-20240229-v1:0)
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/invoke.yaml#/BedrockInvokeRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/invoke.yaml#/BedrockInvokeResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
invoke-stream:
|
||||
post:
|
||||
operationId: bedrockInvokeModelStream
|
||||
summary: Invoke model with streaming (Bedrock format)
|
||||
description: |
|
||||
Invokes a model with streaming using AWS Bedrock InvokeModelWithResponseStream API format.
|
||||
tags:
|
||||
- Bedrock Integration
|
||||
parameters:
|
||||
- name: modelId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model ID (e.g., anthropic.claude-3-sonnet-20240229-v1:0)
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/invoke.yaml#/BedrockInvokeRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful streaming response
|
||||
content:
|
||||
application/x-amz-eventstream:
|
||||
schema:
|
||||
type: object
|
||||
description: AWS event stream format
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
43
docs/openapi/paths/integrations/cohere/chat.yaml
Normal file
43
docs/openapi/paths/integrations/cohere/chat.yaml
Normal file
@@ -0,0 +1,43 @@
|
||||
# Cohere - Chat Endpoints
|
||||
|
||||
chat:
|
||||
post:
|
||||
operationId: cohereChatV2
|
||||
summary: Chat with model (Cohere v2 format)
|
||||
description: |
|
||||
Sends a chat request using Cohere v2 API format.
|
||||
tags:
|
||||
- Cohere Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
40
docs/openapi/paths/integrations/cohere/embed.yaml
Normal file
40
docs/openapi/paths/integrations/cohere/embed.yaml
Normal file
@@ -0,0 +1,40 @@
|
||||
# Cohere - Embed Endpoints
|
||||
|
||||
embed:
|
||||
post:
|
||||
operationId: cohereEmbedV2
|
||||
summary: Create embeddings (Cohere v2 format)
|
||||
description: |
|
||||
Creates embeddings using Cohere v2 API format.
|
||||
tags:
|
||||
- Cohere Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/embed.yaml#/CohereEmbeddingRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/embed.yaml#/CohereEmbeddingResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
40
docs/openapi/paths/integrations/cohere/tokenize.yaml
Normal file
40
docs/openapi/paths/integrations/cohere/tokenize.yaml
Normal file
@@ -0,0 +1,40 @@
|
||||
# Cohere - Tokenize Endpoints
|
||||
|
||||
tokenize:
|
||||
post:
|
||||
operationId: cohereTokenize
|
||||
summary: Tokenize text (Cohere format)
|
||||
description: |
|
||||
Tokenizes text using Cohere v1 API format.
|
||||
tags:
|
||||
- Cohere Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/tokenize.yaml#/CohereCountTokensRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/tokenize.yaml#/CohereCountTokensResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
176
docs/openapi/paths/integrations/genai/files.yaml
Normal file
176
docs/openapi/paths/integrations/genai/files.yaml
Normal file
@@ -0,0 +1,176 @@
|
||||
# Google GenAI (Gemini) - Files Endpoints
|
||||
|
||||
files-upload:
|
||||
post:
|
||||
operationId: geminiUploadFile
|
||||
summary: Upload file (Gemini format)
|
||||
description: |
|
||||
Uploads a file using Google Gemini API format.
|
||||
|
||||
This is a multipart upload with two parts:
|
||||
- "metadata": JSON object containing file metadata
|
||||
- "file": Binary file content
|
||||
|
||||
Note: Direct file content download is not supported by Gemini Files API.
|
||||
Use the file.uri field from the response to access uploaded files.
|
||||
tags:
|
||||
- GenAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/files.yaml#/GeminiFileUploadRequest'
|
||||
encoding:
|
||||
metadata:
|
||||
contentType: application/json
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/files.yaml#/GeminiFileUploadResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
files:
|
||||
get:
|
||||
operationId: geminiListFiles
|
||||
summary: List files (Gemini format)
|
||||
description: |
|
||||
Lists uploaded files in Google Gemini API format.
|
||||
tags:
|
||||
- GenAI Integration
|
||||
parameters:
|
||||
- name: pageSize
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
description: Maximum number of files to return
|
||||
- name: pageToken
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Page token for pagination
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/files.yaml#/GeminiFileListResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
files-by-id:
|
||||
get:
|
||||
operationId: geminiRetrieveFile
|
||||
summary: Retrieve file (Gemini format)
|
||||
description: |
|
||||
Retrieves file metadata in Google Gemini API format.
|
||||
|
||||
Note: This endpoint returns file metadata only. Direct file content
|
||||
download is not supported by Gemini Files API. Use the file.uri
|
||||
field from the response to access the file content.
|
||||
tags:
|
||||
- GenAI Integration
|
||||
parameters:
|
||||
- name: file_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: File ID
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/files.yaml#/GeminiFileRetrieveResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
delete:
|
||||
operationId: geminiDeleteFile
|
||||
summary: Delete file (Gemini format)
|
||||
description: |
|
||||
Deletes a file in Google Gemini API format.
|
||||
tags:
|
||||
- GenAI Integration
|
||||
parameters:
|
||||
- name: file_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: File ID to delete
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response (empty)
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/files.yaml#/GeminiFileDeleteResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
241
docs/openapi/paths/integrations/genai/generation.yaml
Normal file
241
docs/openapi/paths/integrations/genai/generation.yaml
Normal file
@@ -0,0 +1,241 @@
|
||||
# Google GenAI (Gemini) - Generation Endpoints
|
||||
|
||||
generate-content:
|
||||
post:
|
||||
operationId: geminiGenerateContent
|
||||
summary: Generate content (Gemini format)
|
||||
description: |
|
||||
Generates content using Google Gemini API format.
|
||||
The model is specified in the URL path.
|
||||
tags:
|
||||
- GenAI Integration
|
||||
parameters:
|
||||
- name: model
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model name with action (e.g., gemini-pro:generateContent)
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
stream-generate-content:
|
||||
post:
|
||||
operationId: geminiStreamGenerateContent
|
||||
summary: Stream generate content (Gemini format)
|
||||
description: |
|
||||
Streams content generation using Google Gemini API format.
|
||||
The model is specified in the URL path.
|
||||
tags:
|
||||
- GenAI Integration
|
||||
parameters:
|
||||
- name: model
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model name with action (e.g., gemini-pro:streamGenerateContent)
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful streaming response
|
||||
content:
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
embed-content:
|
||||
post:
|
||||
operationId: geminiEmbedContent
|
||||
summary: Embed content (Gemini format)
|
||||
description: |
|
||||
Creates embeddings using Google Gemini API format.
|
||||
tags:
|
||||
- GenAI Integration
|
||||
parameters:
|
||||
- name: model
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model name with action (e.g., embedding-001:embedContent)
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiEmbeddingRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiEmbeddingResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
count-tokens:
|
||||
post:
|
||||
operationId: geminiCountTokens
|
||||
summary: Count tokens (Gemini format)
|
||||
description: |
|
||||
Counts tokens using Google Gemini API format.
|
||||
tags:
|
||||
- GenAI Integration
|
||||
parameters:
|
||||
- name: model
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model name with action (e.g., gemini-pro:countTokens)
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiCountTokensRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiCountTokensResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
image-generation:
|
||||
post:
|
||||
operationId: geminiGenerateImage
|
||||
summary: Generate image (Gemini format)
|
||||
description: |
|
||||
For Imagen models, use the `:predict` suffix (e.g., `imagen-3.0-generate-001:predict`).
|
||||
For Gemini models, use `:generateContent` with `generationConfig.responseModalities: ["IMAGE"]` in the request body.
|
||||
tags:
|
||||
- GenAI Integration
|
||||
parameters:
|
||||
- name: model
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: |
|
||||
Model name with action suffix. For Imagen models, use `:predict` (e.g., `imagen-3.0-generate-001:predict`).
|
||||
For Gemini models with image generation, use `:generateContent` (e.g., `gemini-1.5-pro:generateContent`).
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: |
|
||||
Successful response. Returns JSON with generated image data in `candidates[0].content.parts[0].inlineData`.
|
||||
When streaming, events are sent via Server-Sent Events (SSE).
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
45
docs/openapi/paths/integrations/genai/models.yaml
Normal file
45
docs/openapi/paths/integrations/genai/models.yaml
Normal file
@@ -0,0 +1,45 @@
|
||||
# Google GenAI (Gemini) - Models Endpoints
|
||||
|
||||
models:
|
||||
get:
|
||||
operationId: geminiListModels
|
||||
summary: List models (Gemini format)
|
||||
description: |
|
||||
Lists available models in Google Gemini API format.
|
||||
tags:
|
||||
- GenAI Integration
|
||||
parameters:
|
||||
- name: pageSize
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
description: Maximum number of models to return
|
||||
- name: pageToken
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Page token for pagination
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiListModelsResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
83
docs/openapi/paths/integrations/langchain/anthropic.yaml
Normal file
83
docs/openapi/paths/integrations/langchain/anthropic.yaml
Normal file
@@ -0,0 +1,83 @@
|
||||
# LangChain - Anthropic-compatible Endpoints
|
||||
# Reuses Anthropic integration schemas
|
||||
|
||||
messages:
|
||||
post:
|
||||
operationId: langchainAnthropicMessages
|
||||
summary: Create message (LangChain - Anthropic format)
|
||||
description: |
|
||||
Creates a message using Anthropic-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicMessageRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicMessageResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
count-tokens:
|
||||
post:
|
||||
operationId: langchainAnthropicCountTokens
|
||||
summary: Count tokens (LangChain - Anthropic format)
|
||||
description: |
|
||||
Counts tokens using Anthropic-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/count-tokens.yaml#/AnthropicCountTokensRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/count-tokens.yaml#/AnthropicCountTokensResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
94
docs/openapi/paths/integrations/langchain/bedrock.yaml
Normal file
94
docs/openapi/paths/integrations/langchain/bedrock.yaml
Normal file
@@ -0,0 +1,94 @@
|
||||
# LangChain - Bedrock-compatible Endpoints
|
||||
# Reuses Bedrock integration schemas
|
||||
|
||||
converse:
|
||||
post:
|
||||
operationId: langchainBedrockConverse
|
||||
summary: Converse with model (LangChain - Bedrock format)
|
||||
description: |
|
||||
Sends messages using AWS Bedrock Converse-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
parameters:
|
||||
- name: modelId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model ID
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
converse-stream:
|
||||
post:
|
||||
operationId: langchainBedrockConverseStream
|
||||
summary: Stream converse with model (LangChain - Bedrock format)
|
||||
description: |
|
||||
Streams messages using AWS Bedrock Converse-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
parameters:
|
||||
- name: modelId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model ID
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful streaming response
|
||||
content:
|
||||
application/x-amz-eventstream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
122
docs/openapi/paths/integrations/langchain/cohere.yaml
Normal file
122
docs/openapi/paths/integrations/langchain/cohere.yaml
Normal file
@@ -0,0 +1,122 @@
|
||||
# LangChain - Cohere-compatible Endpoints
|
||||
# Reuses Cohere integration schemas
|
||||
|
||||
chat:
|
||||
post:
|
||||
operationId: langchainCohereChat
|
||||
summary: Chat with model (LangChain - Cohere format)
|
||||
description: |
|
||||
Sends a chat request using Cohere-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
embed:
|
||||
post:
|
||||
operationId: langchainCohereEmbed
|
||||
summary: Create embeddings (LangChain - Cohere format)
|
||||
description: |
|
||||
Creates embeddings using Cohere-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/embed.yaml#/CohereEmbeddingRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/embed.yaml#/CohereEmbeddingResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
tokenize:
|
||||
post:
|
||||
operationId: langchainCohereTokenize
|
||||
summary: Tokenize text (LangChain - Cohere format)
|
||||
description: |
|
||||
Tokenizes text using Cohere-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/tokenize.yaml#/CohereCountTokensRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/tokenize.yaml#/CohereCountTokensResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
138
docs/openapi/paths/integrations/langchain/genai.yaml
Normal file
138
docs/openapi/paths/integrations/langchain/genai.yaml
Normal file
@@ -0,0 +1,138 @@
|
||||
# LangChain - GenAI (Gemini) compatible Endpoints
|
||||
# Reuses GenAI integration schemas
|
||||
|
||||
models:
|
||||
get:
|
||||
operationId: langchainGeminiListModels
|
||||
summary: List models (LangChain - Gemini format)
|
||||
description: |
|
||||
Lists available models in Google Gemini API format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
parameters:
|
||||
- name: pageSize
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
description: Maximum number of models to return
|
||||
- name: pageToken
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Page token for pagination
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiListModelsResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
generate-content:
|
||||
post:
|
||||
operationId: langchainGeminiGenerateContent
|
||||
summary: Generate content (LangChain - Gemini format)
|
||||
description: |
|
||||
Generates content using Google Gemini-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
parameters:
|
||||
- name: model
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model name with action
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
stream-generate-content:
|
||||
post:
|
||||
operationId: langchainGeminiStreamGenerateContent
|
||||
summary: Stream generate content (LangChain - Gemini format)
|
||||
description: |
|
||||
Streams content generation using Google Gemini-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
parameters:
|
||||
- name: model
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model name with action
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful streaming response
|
||||
content:
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
262
docs/openapi/paths/integrations/langchain/openai.yaml
Normal file
262
docs/openapi/paths/integrations/langchain/openai.yaml
Normal file
@@ -0,0 +1,262 @@
|
||||
# LangChain - OpenAI-compatible Endpoints
|
||||
# Reuses OpenAI integration schemas
|
||||
|
||||
text-completions:
|
||||
post:
|
||||
operationId: langchainOpenAITextCompletions
|
||||
summary: Text completions (LangChain - OpenAI format)
|
||||
description: |
|
||||
Creates a text completion using OpenAI-compatible format via LangChain.
|
||||
This is the legacy completions API.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
chat-completions:
|
||||
post:
|
||||
operationId: langchainOpenAIChatCompletions
|
||||
summary: Chat completions (LangChain - OpenAI format)
|
||||
description: |
|
||||
Creates a chat completion using OpenAI-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/chat.yaml#/OpenAIChatRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/chat.yaml#/ChatCompletionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/chat.yaml#/ChatCompletionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
embeddings:
|
||||
post:
|
||||
operationId: langchainOpenAIEmbeddings
|
||||
summary: Create embeddings (LangChain - OpenAI format)
|
||||
description: |
|
||||
Creates embeddings using OpenAI-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/embeddings.yaml#/OpenAIEmbeddingRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/embeddings.yaml#/EmbeddingResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
models:
|
||||
get:
|
||||
operationId: langchainOpenAIListModels
|
||||
summary: List models (LangChain - OpenAI format)
|
||||
description: |
|
||||
Lists available models using OpenAI-compatible format via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/common.yaml#/OpenAIListModelsResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
responses:
|
||||
post:
|
||||
operationId: langchainOpenAIResponses
|
||||
summary: Create response (LangChain - OpenAI Responses API)
|
||||
description: |
|
||||
Creates a response using OpenAI Responses API format via LangChain.
|
||||
Supports streaming via SSE.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
responses-input-tokens:
|
||||
post:
|
||||
operationId: langchainOpenAICountInputTokens
|
||||
summary: Count input tokens (LangChain - OpenAI format)
|
||||
description: |
|
||||
Counts the number of tokens in a Responses API request via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/count-tokens.yaml#/CountTokensResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
speech:
|
||||
post:
|
||||
operationId: langchainOpenAISpeech
|
||||
summary: Create speech (LangChain - OpenAI TTS)
|
||||
description: |
|
||||
Generates audio from text using OpenAI TTS via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAISpeechRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
audio/mpeg:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAISpeechStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
transcriptions:
|
||||
post:
|
||||
operationId: langchainOpenAITranscriptions
|
||||
summary: Create transcription (LangChain - OpenAI Whisper)
|
||||
description: |
|
||||
Transcribes audio into text using OpenAI Whisper via LangChain.
|
||||
tags:
|
||||
- LangChain Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
44
docs/openapi/paths/integrations/litellm/anthropic.yaml
Normal file
44
docs/openapi/paths/integrations/litellm/anthropic.yaml
Normal file
@@ -0,0 +1,44 @@
|
||||
# LiteLLM - Anthropic-compatible Endpoints
|
||||
# Reuses Anthropic integration schemas
|
||||
|
||||
messages:
|
||||
post:
|
||||
operationId: litellmAnthropicMessages
|
||||
summary: Create message (LiteLLM - Anthropic format)
|
||||
description: |
|
||||
Creates a message using Anthropic-compatible format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicMessageRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicMessageResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
94
docs/openapi/paths/integrations/litellm/bedrock.yaml
Normal file
94
docs/openapi/paths/integrations/litellm/bedrock.yaml
Normal file
@@ -0,0 +1,94 @@
|
||||
# LiteLLM - Bedrock-compatible Endpoints
|
||||
# Reuses Bedrock integration schemas
|
||||
|
||||
converse:
|
||||
post:
|
||||
operationId: litellmBedrockConverse
|
||||
summary: Converse with model (LiteLLM - Bedrock format)
|
||||
description: |
|
||||
Sends messages using AWS Bedrock Converse-compatible format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
parameters:
|
||||
- name: modelId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model ID
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
converse-stream:
|
||||
post:
|
||||
operationId: litellmBedrockConverseStream
|
||||
summary: Stream converse with model (LiteLLM - Bedrock format)
|
||||
description: |
|
||||
Streams messages using AWS Bedrock Converse-compatible format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
parameters:
|
||||
- name: modelId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model ID
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful streaming response
|
||||
content:
|
||||
application/x-amz-eventstream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
122
docs/openapi/paths/integrations/litellm/cohere.yaml
Normal file
122
docs/openapi/paths/integrations/litellm/cohere.yaml
Normal file
@@ -0,0 +1,122 @@
|
||||
# LiteLLM - Cohere-compatible Endpoints
|
||||
# Reuses Cohere integration schemas
|
||||
|
||||
chat:
|
||||
post:
|
||||
operationId: litellmCohereChat
|
||||
summary: Chat with model (LiteLLM - Cohere format)
|
||||
description: |
|
||||
Sends a chat request using Cohere-compatible format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
embed:
|
||||
post:
|
||||
operationId: litellmCohereEmbed
|
||||
summary: Create embeddings (LiteLLM - Cohere format)
|
||||
description: |
|
||||
Creates embeddings using Cohere-compatible format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/embed.yaml#/CohereEmbeddingRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/embed.yaml#/CohereEmbeddingResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
tokenize:
|
||||
post:
|
||||
operationId: litellmCohereTokenize
|
||||
summary: Tokenize text (LiteLLM - Cohere format)
|
||||
description: |
|
||||
Tokenizes text using Cohere-compatible format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/tokenize.yaml#/CohereCountTokensRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/tokenize.yaml#/CohereCountTokensResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
138
docs/openapi/paths/integrations/litellm/genai.yaml
Normal file
138
docs/openapi/paths/integrations/litellm/genai.yaml
Normal file
@@ -0,0 +1,138 @@
|
||||
# LiteLLM - GenAI (Gemini) compatible Endpoints
|
||||
# Reuses GenAI integration schemas
|
||||
|
||||
models:
|
||||
get:
|
||||
operationId: litellmGeminiListModels
|
||||
summary: List models (LiteLLM - Gemini format)
|
||||
description: |
|
||||
Lists available models in Google Gemini API format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
parameters:
|
||||
- name: pageSize
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
description: Maximum number of models to return
|
||||
- name: pageToken
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Page token for pagination
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiListModelsResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
generate-content:
|
||||
post:
|
||||
operationId: litellmGeminiGenerateContent
|
||||
summary: Generate content (LiteLLM - Gemini format)
|
||||
description: |
|
||||
Generates content using Google Gemini-compatible format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
parameters:
|
||||
- name: model
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model name with action
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
stream-generate-content:
|
||||
post:
|
||||
operationId: litellmGeminiStreamGenerateContent
|
||||
summary: Stream generate content (LiteLLM - Gemini format)
|
||||
description: |
|
||||
Streams content generation using Google Gemini-compatible format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
parameters:
|
||||
- name: model
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model name with action
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful streaming response
|
||||
content:
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
262
docs/openapi/paths/integrations/litellm/openai.yaml
Normal file
262
docs/openapi/paths/integrations/litellm/openai.yaml
Normal file
@@ -0,0 +1,262 @@
|
||||
# LiteLLM - OpenAI-compatible Endpoints
|
||||
# Reuses OpenAI integration schemas
|
||||
|
||||
text-completions:
|
||||
post:
|
||||
operationId: litellmOpenAITextCompletions
|
||||
summary: Text completions (LiteLLM - OpenAI format)
|
||||
description: |
|
||||
Creates a text completion using OpenAI-compatible format via LiteLLM.
|
||||
This is the legacy completions API.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
chat-completions:
|
||||
post:
|
||||
operationId: litellmOpenAIChatCompletions
|
||||
summary: Chat completions (LiteLLM - OpenAI format)
|
||||
description: |
|
||||
Creates a chat completion using OpenAI-compatible format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/chat.yaml#/OpenAIChatRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/chat.yaml#/ChatCompletionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/chat.yaml#/ChatCompletionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
embeddings:
|
||||
post:
|
||||
operationId: litellmOpenAIEmbeddings
|
||||
summary: Create embeddings (LiteLLM - OpenAI format)
|
||||
description: |
|
||||
Creates embeddings using OpenAI-compatible format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/embeddings.yaml#/OpenAIEmbeddingRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/embeddings.yaml#/EmbeddingResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
models:
|
||||
get:
|
||||
operationId: litellmOpenAIListModels
|
||||
summary: List models (LiteLLM - OpenAI format)
|
||||
description: |
|
||||
Lists available models using OpenAI-compatible format via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/common.yaml#/OpenAIListModelsResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
responses:
|
||||
post:
|
||||
operationId: litellmOpenAIResponses
|
||||
summary: Create response (LiteLLM - OpenAI Responses API)
|
||||
description: |
|
||||
Creates a response using OpenAI Responses API format via LiteLLM.
|
||||
Supports streaming via SSE.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
responses-input-tokens:
|
||||
post:
|
||||
operationId: litellmOpenAICountInputTokens
|
||||
summary: Count input tokens (LiteLLM - OpenAI format)
|
||||
description: |
|
||||
Counts the number of tokens in a Responses API request via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/count-tokens.yaml#/CountTokensResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
speech:
|
||||
post:
|
||||
operationId: litellmOpenAISpeech
|
||||
summary: Create speech (LiteLLM - OpenAI TTS)
|
||||
description: |
|
||||
Generates audio from text using OpenAI TTS via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAISpeechRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
audio/mpeg:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAISpeechStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
transcriptions:
|
||||
post:
|
||||
operationId: litellmOpenAITranscriptions
|
||||
summary: Create transcription (LiteLLM - OpenAI Whisper)
|
||||
description: |
|
||||
Transcribes audio into text using OpenAI Whisper via LiteLLM.
|
||||
tags:
|
||||
- LiteLLM Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
188
docs/openapi/paths/integrations/openai/audio.yaml
Normal file
188
docs/openapi/paths/integrations/openai/audio.yaml
Normal file
@@ -0,0 +1,188 @@
|
||||
# OpenAI Integration - Audio Endpoints (Speech and Transcription)
|
||||
|
||||
speech:
|
||||
post:
|
||||
operationId: openaiCreateSpeech
|
||||
summary: Create speech (OpenAI TTS)
|
||||
description: |
|
||||
Generates audio from text using OpenAI TTS.
|
||||
Supports streaming via SSE when stream_format is set to 'sse'.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/audio/speech`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAISpeechRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
audio/mpeg:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
audio/opus:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
audio/aac:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
audio/flac:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAISpeechStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
azure-speech:
|
||||
post:
|
||||
operationId: azureCreateSpeech
|
||||
summary: Create speech (Azure OpenAI TTS)
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
- Azure Integration
|
||||
parameters:
|
||||
- name: deployment-id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Azure deployment ID
|
||||
- name: api-version
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAISpeechRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
audio/mpeg:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
audio/opus:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
audio/aac:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
audio/flac:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAISpeechStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
transcriptions:
|
||||
post:
|
||||
operationId: openaiCreateTranscription
|
||||
summary: Create transcription (OpenAI Whisper)
|
||||
description: |
|
||||
Transcribes audio into text using OpenAI Whisper.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/audio/transcriptions`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
azure-transcriptions:
|
||||
post:
|
||||
operationId: azureCreateTranscription
|
||||
summary: Create transcription (Azure OpenAI)
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
- Azure Integration
|
||||
parameters:
|
||||
- name: deployment-id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Azure deployment ID
|
||||
- name: api-version
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
154
docs/openapi/paths/integrations/openai/batch.yaml
Normal file
154
docs/openapi/paths/integrations/openai/batch.yaml
Normal file
@@ -0,0 +1,154 @@
|
||||
# OpenAI Integration - Batch API Endpoints
|
||||
|
||||
batches:
|
||||
post:
|
||||
operationId: openaiCreateBatch
|
||||
summary: Create batch job (OpenAI format)
|
||||
description: |
|
||||
Creates a batch processing job.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/batches`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/batch.yaml#/OpenAIBatchCreateRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/batch.yaml#/OpenAIBatchCreateResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
get:
|
||||
operationId: openaiListBatches
|
||||
summary: List batch jobs (OpenAI format)
|
||||
description: |
|
||||
Lists batch processing jobs.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/batches`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: limit
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
default: 30
|
||||
description: Maximum number of batches to return
|
||||
- name: after
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Cursor for pagination
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Filter by provider
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/batch.yaml#/OpenAIBatchListResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
batches-by-id:
|
||||
get:
|
||||
operationId: openaiRetrieveBatch
|
||||
summary: Retrieve batch job (OpenAI format)
|
||||
description: |
|
||||
Retrieves details of a batch processing job.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/batches/{batch_id}`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: batch_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Batch job ID
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the batch
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/batch.yaml#/OpenAIBatchRetrieveResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
batches-cancel:
|
||||
post:
|
||||
operationId: openaiCancelBatch
|
||||
summary: Cancel batch job (OpenAI format)
|
||||
description: |
|
||||
Cancels a batch processing job.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/batches/{batch_id}/cancel`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: batch_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Batch job ID to cancel
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the batch
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/batch.yaml#/OpenAIBatchCancelResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
111
docs/openapi/paths/integrations/openai/chat.yaml
Normal file
111
docs/openapi/paths/integrations/openai/chat.yaml
Normal file
@@ -0,0 +1,111 @@
|
||||
# OpenAI Integration - Chat Completions Endpoints
|
||||
|
||||
chat-completions:
|
||||
post:
|
||||
operationId: openaiCreateChatCompletion
|
||||
summary: Create chat completion (OpenAI format)
|
||||
description: |
|
||||
Creates a chat completion using OpenAI-compatible format.
|
||||
Supports streaming via SSE.
|
||||
|
||||
**Async inference:** Send `x-bf-async: true` to submit the request as a background job and receive a job ID immediately. Poll with `x-bf-async-id: <job-id>` to retrieve the result. When the job is still processing, the response will have an empty `choices` array. When completed, `choices` will contain the full result. See [Async Inference](/features/async-inference) for details.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/chat/completions`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: x-bf-async
|
||||
in: header
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: ["true"]
|
||||
description: Set to `true` to submit this request as an async job. Returns immediately with a job ID. Not
|
||||
compatible with streaming.
|
||||
- name: x-bf-async-id
|
||||
in: header
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
description: Poll for results of a previously submitted async job by providing the job ID returned from the
|
||||
initial async request.
|
||||
- name: x-bf-async-job-result-ttl
|
||||
in: header
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
default: 3600
|
||||
description: Override the default result TTL in seconds. Results expire after this duration from completion time.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/chat.yaml#/OpenAIChatRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/chat.yaml#/OpenAIChatResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/chat.yaml#/OpenAIChatStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
# Azure deployment path
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
azure-chat-completions:
|
||||
post:
|
||||
operationId: azureCreateChatCompletion
|
||||
summary: Create chat completion (Azure OpenAI)
|
||||
description: |
|
||||
Creates a chat completion using Azure OpenAI deployment.
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
- Azure Integration
|
||||
parameters:
|
||||
- name: deployment-id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Azure deployment ID
|
||||
- name: api-version
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Azure API version
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/chat.yaml#/OpenAIChatRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/chat.yaml#/OpenAIChatResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/chat.yaml#/OpenAIChatStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
397
docs/openapi/paths/integrations/openai/containers.yaml
Normal file
397
docs/openapi/paths/integrations/openai/containers.yaml
Normal file
@@ -0,0 +1,397 @@
|
||||
# OpenAI Integration - Containers API Endpoints
|
||||
|
||||
containers:
|
||||
post:
|
||||
operationId: openaiCreateContainer
|
||||
summary: Create container (OpenAI format)
|
||||
description: |
|
||||
Creates a new container for storing files and data.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/containers`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/containers.yaml#/ContainerCreateRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/containers.yaml#/ContainerCreateResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
get:
|
||||
operationId: openaiListContainers
|
||||
summary: List containers (OpenAI format)
|
||||
description: |
|
||||
Lists containers for a provider.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/containers`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider to list containers for (defaults to openai)
|
||||
- name: limit
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
description: Maximum containers to return
|
||||
- name: after
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Cursor for pagination
|
||||
- name: order
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
enum: [asc, desc]
|
||||
description: Sort order
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/containers.yaml#/ContainerListResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
containers-by-id:
|
||||
get:
|
||||
operationId: openaiRetrieveContainer
|
||||
summary: Retrieve container (OpenAI format)
|
||||
description: |
|
||||
Retrieves a specific container by ID.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/containers/{container_id}`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: container_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Container ID
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the container (defaults to openai)
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/containers.yaml#/ContainerRetrieveResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
delete:
|
||||
operationId: openaiDeleteContainer
|
||||
summary: Delete container (OpenAI format)
|
||||
description: |
|
||||
Deletes a container.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/containers/{container_id}`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: container_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Container ID to delete
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the container (defaults to openai)
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/containers.yaml#/ContainerDeleteResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
# =============================================================================
|
||||
# CONTAINER FILES ENDPOINTS
|
||||
# =============================================================================
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
container-files:
|
||||
post:
|
||||
operationId: openaiCreateContainerFile
|
||||
summary: Create file in container (OpenAI format)
|
||||
description: |
|
||||
Creates a new file in a container. You can either upload file content directly
|
||||
via multipart/form-data or reference an existing file by its ID.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/containers/{container_id}/files`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: container_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Container ID
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the container (defaults to openai)
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/containers.yaml#/ContainerFileCreateMultipartRequest'
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/containers.yaml#/ContainerFileCreateJsonRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/containers.yaml#/ContainerFileCreateResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
get:
|
||||
operationId: openaiListContainerFiles
|
||||
summary: List files in container (OpenAI format)
|
||||
description: |
|
||||
Lists all files in a container.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/containers/{container_id}/files`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: container_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Container ID
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the container (defaults to openai)
|
||||
- name: limit
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
description: Maximum files to return
|
||||
- name: after
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Cursor for pagination
|
||||
- name: order
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
enum: [asc, desc]
|
||||
description: Sort order
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/containers.yaml#/ContainerFileListResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
container-files-by-id:
|
||||
get:
|
||||
operationId: openaiRetrieveContainerFile
|
||||
summary: Retrieve file from container (OpenAI format)
|
||||
description: |
|
||||
Retrieves metadata for a specific file in a container.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/containers/{container_id}/files/{file_id}`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: container_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Container ID
|
||||
- name: file_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: File ID
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the container (defaults to openai)
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/containers.yaml#/ContainerFileRetrieveResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
delete:
|
||||
operationId: openaiDeleteContainerFile
|
||||
summary: Delete file from container (OpenAI format)
|
||||
description: |
|
||||
Deletes a file from a container.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/containers/{container_id}/files/{file_id}`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: container_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Container ID
|
||||
- name: file_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: File ID to delete
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the container (defaults to openai)
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/containers.yaml#/ContainerFileDeleteResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
container-files-content:
|
||||
get:
|
||||
operationId: openaiGetContainerFileContent
|
||||
summary: Get file content from container (OpenAI format)
|
||||
description: |
|
||||
Downloads the content of a file from a container.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/containers/{container_id}/files/{file_id}/content`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: container_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Container ID
|
||||
- name: file_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: File ID
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the container (defaults to openai)
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
75
docs/openapi/paths/integrations/openai/embeddings.yaml
Normal file
75
docs/openapi/paths/integrations/openai/embeddings.yaml
Normal file
@@ -0,0 +1,75 @@
|
||||
# OpenAI Integration - Embeddings Endpoints
|
||||
|
||||
embeddings:
|
||||
post:
|
||||
operationId: openaiCreateEmbedding
|
||||
summary: Create embeddings (OpenAI format)
|
||||
description: |
|
||||
Creates embedding vectors for the input text.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/embeddings`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/embeddings.yaml#/OpenAIEmbeddingRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/embeddings.yaml#/OpenAIEmbeddingResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
azure-embeddings:
|
||||
post:
|
||||
operationId: azureCreateEmbedding
|
||||
summary: Create embeddings (Azure OpenAI)
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
- Azure Integration
|
||||
parameters:
|
||||
- name: deployment-id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Azure deployment ID
|
||||
- name: api-version
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/embeddings.yaml#/OpenAIEmbeddingRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/embeddings.yaml#/OpenAIEmbeddingResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
201
docs/openapi/paths/integrations/openai/files.yaml
Normal file
201
docs/openapi/paths/integrations/openai/files.yaml
Normal file
@@ -0,0 +1,201 @@
|
||||
# OpenAI Integration - Files API Endpoints
|
||||
|
||||
files:
|
||||
post:
|
||||
operationId: openaiUploadFile
|
||||
summary: Upload file (OpenAI format)
|
||||
description: |
|
||||
Uploads a file for use with batch processing or other features.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/files`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/files.yaml#/OpenAIFileUploadRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/files.yaml#/OpenAIFileUploadResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
get:
|
||||
operationId: openaiListFiles
|
||||
summary: List files (OpenAI format)
|
||||
description: |
|
||||
Lists uploaded files.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/files`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: purpose
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Filter by purpose
|
||||
- name: limit
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
description: Maximum files to return
|
||||
- name: after
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Cursor for pagination
|
||||
- name: order
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
enum: [asc, desc]
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Filter by provider
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/files.yaml#/OpenAIFileListResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
files-by-id:
|
||||
get:
|
||||
operationId: openaiRetrieveFile
|
||||
summary: Retrieve file metadata (OpenAI format)
|
||||
description: |
|
||||
Retrieves metadata for an uploaded file.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/files/{file_id}`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: file_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: File ID
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the file
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/files.yaml#/OpenAIFileRetrieveResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
delete:
|
||||
operationId: openaiDeleteFile
|
||||
summary: Delete file (OpenAI format)
|
||||
description: |
|
||||
Deletes an uploaded file.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/files/{file_id}`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: file_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: File ID to delete
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the file
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/files.yaml#/OpenAIFileDeleteResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
files-content:
|
||||
get:
|
||||
operationId: openaiGetFileContent
|
||||
summary: Get file content (OpenAI format)
|
||||
description: |
|
||||
Retrieves the content of an uploaded file.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/files/{file_id}/content`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: file_id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: File ID
|
||||
- name: provider
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Provider for the file
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
88
docs/openapi/paths/integrations/openai/images.yaml
Normal file
88
docs/openapi/paths/integrations/openai/images.yaml
Normal file
@@ -0,0 +1,88 @@
|
||||
# OpenAI Integration - Image Generation Endpoints
|
||||
|
||||
image-generation:
|
||||
post:
|
||||
operationId: openaiCreateImage
|
||||
summary: Create image
|
||||
description: |
|
||||
Generates images from text prompts using OpenAI-compatible format.
|
||||
|
||||
**Note:** Azure OpenAI deployments are also supported via the Azure integration endpoint.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/images/generations`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/images.yaml#/OpenAIImageGenerationRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: |
|
||||
Successful response. Returns JSON for non-streaming requests, or Server-Sent Events (SSE) stream when `stream=true`.
|
||||
When streaming, each event contains a chunk of the image as base64 data, with the final event having type `image_generation.completed`.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/images.yaml#/OpenAIImageGenerationResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/images.yaml#/OpenAIImageStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
azure-image-generation:
|
||||
post:
|
||||
operationId: azureCreateImage
|
||||
summary: Create image (Azure OpenAI)
|
||||
description: |
|
||||
Generates images from text prompts using Azure OpenAI deployment.
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
- Azure Integration
|
||||
parameters:
|
||||
- name: deployment-id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Azure deployment ID
|
||||
- name: api-version
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Azure API version
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/images.yaml#/OpenAIImageGenerationRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/images.yaml#/OpenAIImageGenerationResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/images.yaml#/OpenAIImageStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
63
docs/openapi/paths/integrations/openai/models.yaml
Normal file
63
docs/openapi/paths/integrations/openai/models.yaml
Normal file
@@ -0,0 +1,63 @@
|
||||
# OpenAI Integration - Models Endpoints
|
||||
|
||||
models:
|
||||
get:
|
||||
operationId: openaiListModels
|
||||
summary: List models (OpenAI format)
|
||||
description: |
|
||||
Lists available models in OpenAI format.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/models`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/common.yaml#/OpenAIListModelsResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
azure-models:
|
||||
get:
|
||||
operationId: azureListModels
|
||||
summary: List models (Azure OpenAI)
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
- Azure Integration
|
||||
parameters:
|
||||
- name: deployment-id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Azure deployment ID
|
||||
- name: api-version
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/common.yaml#/OpenAIListModelsResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
139
docs/openapi/paths/integrations/openai/responses.yaml
Normal file
139
docs/openapi/paths/integrations/openai/responses.yaml
Normal file
@@ -0,0 +1,139 @@
|
||||
# OpenAI Integration - Responses API Endpoints
|
||||
|
||||
responses:
|
||||
post:
|
||||
operationId: openaiCreateResponse
|
||||
summary: Create response (OpenAI Responses API)
|
||||
description: |
|
||||
Creates a response using OpenAI Responses API format.
|
||||
Supports streaming via SSE.
|
||||
|
||||
**Async inference:** Send `x-bf-async: true` to submit the request as a background job and receive a job ID immediately. Poll with `x-bf-async-id: <job-id>` to retrieve the result. When the job is still processing, the response `status` will not be `completed`. When completed, the full response with `output_text` will be returned. See [Async Inference](/features/async-inference) for details.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/responses`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
parameters:
|
||||
- name: x-bf-async
|
||||
in: header
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: ["true"]
|
||||
description: Set to `true` to submit this request as an async job. Returns immediately with a job ID. Not
|
||||
compatible with streaming.
|
||||
- name: x-bf-async-id
|
||||
in: header
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
description: Poll for results of a previously submitted async job by providing the job ID returned from the
|
||||
initial async request.
|
||||
- name: x-bf-async-job-result-ttl
|
||||
in: header
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
default: 3600
|
||||
description: Override the default result TTL in seconds. Results expire after this duration from completion time.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
azure-responses:
|
||||
post:
|
||||
operationId: azureCreateResponse
|
||||
summary: Create response (Azure OpenAI)
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
- Azure Integration
|
||||
parameters:
|
||||
- name: deployment-id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Azure deployment ID
|
||||
- name: api-version
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
# Input tokens endpoint (count tokens for Responses API format)
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
responses-input-tokens:
|
||||
post:
|
||||
operationId: openaiCountInputTokens
|
||||
summary: Count input tokens
|
||||
description: |
|
||||
Counts the number of tokens in a Responses API request.
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/count-tokens.yaml#/CountTokensResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
82
docs/openapi/paths/integrations/openai/text.yaml
Normal file
82
docs/openapi/paths/integrations/openai/text.yaml
Normal file
@@ -0,0 +1,82 @@
|
||||
# OpenAI Integration - Text Completions Endpoints (Legacy)
|
||||
|
||||
text-completions:
|
||||
post:
|
||||
operationId: openaiCreateTextCompletion
|
||||
summary: Create text completion (OpenAI format)
|
||||
description: |
|
||||
Creates a text completion using OpenAI-compatible format.
|
||||
This is the legacy completions API.
|
||||
|
||||
**Note:** This endpoint also works without the `/v1` prefix (e.g., `/openai/completions`).
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
azure-text-completions:
|
||||
post:
|
||||
operationId: azureCreateTextCompletion
|
||||
summary: Create text completion (Azure OpenAI)
|
||||
tags:
|
||||
- OpenAI Integration
|
||||
- Azure Integration
|
||||
parameters:
|
||||
- name: deployment-id
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Azure deployment ID
|
||||
- name: api-version
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
44
docs/openapi/paths/integrations/pydanticai/anthropic.yaml
Normal file
44
docs/openapi/paths/integrations/pydanticai/anthropic.yaml
Normal file
@@ -0,0 +1,44 @@
|
||||
# PydanticAI - Anthropic-compatible Endpoints
|
||||
# Reuses Anthropic integration schemas
|
||||
|
||||
messages:
|
||||
post:
|
||||
operationId: pydanticaiAnthropicMessages
|
||||
summary: Create message (PydanticAI - Anthropic format)
|
||||
description: |
|
||||
Creates a message using Anthropic-compatible format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicMessageRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicMessageResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/messages.yaml#/AnthropicStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/anthropic/common.yaml#/AnthropicError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
94
docs/openapi/paths/integrations/pydanticai/bedrock.yaml
Normal file
94
docs/openapi/paths/integrations/pydanticai/bedrock.yaml
Normal file
@@ -0,0 +1,94 @@
|
||||
# PydanticAI - Bedrock-compatible Endpoints
|
||||
# Reuses Bedrock integration schemas
|
||||
|
||||
converse:
|
||||
post:
|
||||
operationId: pydanticaiBedrockConverse
|
||||
summary: Converse with model (PydanticAI - Bedrock format)
|
||||
description: |
|
||||
Sends messages using AWS Bedrock Converse-compatible format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
parameters:
|
||||
- name: modelId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model ID
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
converse-stream:
|
||||
post:
|
||||
operationId: pydanticaiBedrockConverseStream
|
||||
summary: Stream converse with model (PydanticAI - Bedrock format)
|
||||
description: |
|
||||
Streams messages using AWS Bedrock Converse-compatible format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
parameters:
|
||||
- name: modelId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model ID
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockConverseRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful streaming response
|
||||
content:
|
||||
application/x-amz-eventstream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/converse.yaml#/BedrockStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/bedrock/common.yaml#/BedrockError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
122
docs/openapi/paths/integrations/pydanticai/cohere.yaml
Normal file
122
docs/openapi/paths/integrations/pydanticai/cohere.yaml
Normal file
@@ -0,0 +1,122 @@
|
||||
# PydanticAI - Cohere-compatible Endpoints
|
||||
# Reuses Cohere integration schemas
|
||||
|
||||
chat:
|
||||
post:
|
||||
operationId: pydanticaiCohereChat
|
||||
summary: Chat with model (PydanticAI - Cohere format)
|
||||
description: |
|
||||
Sends a chat request using Cohere-compatible format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/chat.yaml#/CohereChatStreamEvent'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
embed:
|
||||
post:
|
||||
operationId: pydanticaiCohereEmbed
|
||||
summary: Create embeddings (PydanticAI - Cohere format)
|
||||
description: |
|
||||
Creates embeddings using Cohere-compatible format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/embed.yaml#/CohereEmbeddingRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/embed.yaml#/CohereEmbeddingResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
tokenize:
|
||||
post:
|
||||
operationId: pydanticaiCohereTokenize
|
||||
summary: Tokenize text (PydanticAI - Cohere format)
|
||||
description: |
|
||||
Tokenizes text using Cohere v1 API format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/tokenize.yaml#/CohereCountTokensRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/tokenize.yaml#/CohereCountTokensResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/cohere/common.yaml#/CohereError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
138
docs/openapi/paths/integrations/pydanticai/genai.yaml
Normal file
138
docs/openapi/paths/integrations/pydanticai/genai.yaml
Normal file
@@ -0,0 +1,138 @@
|
||||
# PydanticAI - GenAI (Gemini) compatible Endpoints
|
||||
# Reuses GenAI integration schemas
|
||||
|
||||
models:
|
||||
get:
|
||||
operationId: pydanticaiGeminiListModels
|
||||
summary: List models (PydanticAI - Gemini format)
|
||||
description: |
|
||||
Lists available models in Google Gemini API format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
parameters:
|
||||
- name: pageSize
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
description: Maximum number of models to return
|
||||
- name: pageToken
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
description: Page token for pagination
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiListModelsResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
generate-content:
|
||||
post:
|
||||
operationId: pydanticaiGeminiGenerateContent
|
||||
summary: Generate content (PydanticAI - Gemini format)
|
||||
description: |
|
||||
Generates content using Google Gemini-compatible format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
parameters:
|
||||
- name: model
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model name with action
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
stream-generate-content:
|
||||
post:
|
||||
operationId: pydanticaiGeminiStreamGenerateContent
|
||||
summary: Stream generate content (PydanticAI - Gemini format)
|
||||
description: |
|
||||
Streams content generation using Google Gemini-compatible format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
parameters:
|
||||
- name: model
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Model name with action
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful streaming response
|
||||
content:
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/generation.yaml#/GeminiGenerationResponse'
|
||||
'400':
|
||||
description: Bad request
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/genai/common.yaml#/GeminiError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
262
docs/openapi/paths/integrations/pydanticai/openai.yaml
Normal file
262
docs/openapi/paths/integrations/pydanticai/openai.yaml
Normal file
@@ -0,0 +1,262 @@
|
||||
# PydanticAI - OpenAI-compatible Endpoints
|
||||
# Reuses OpenAI integration schemas
|
||||
|
||||
text-completions:
|
||||
post:
|
||||
operationId: pydanticaiOpenAITextCompletions
|
||||
summary: Text completions (PydanticAI - OpenAI format)
|
||||
description: |
|
||||
Creates a text completion using OpenAI-compatible format via PydanticAI.
|
||||
This is the legacy completions API.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/text.yaml#/OpenAITextCompletionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
chat-completions:
|
||||
post:
|
||||
operationId: pydanticaiOpenAIChatCompletions
|
||||
summary: Chat completions (PydanticAI - OpenAI format)
|
||||
description: |
|
||||
Creates a chat completion using OpenAI-compatible format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/chat.yaml#/OpenAIChatRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/chat.yaml#/ChatCompletionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/chat.yaml#/ChatCompletionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
embeddings:
|
||||
post:
|
||||
operationId: pydanticaiOpenAIEmbeddings
|
||||
summary: Create embeddings (PydanticAI - OpenAI format)
|
||||
description: |
|
||||
Creates embeddings using OpenAI-compatible format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/embeddings.yaml#/OpenAIEmbeddingRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/embeddings.yaml#/EmbeddingResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
models:
|
||||
get:
|
||||
operationId: pydanticaiOpenAIListModels
|
||||
summary: List models (PydanticAI - OpenAI format)
|
||||
description: |
|
||||
Lists available models using OpenAI-compatible format via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/common.yaml#/OpenAIListModelsResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
responses:
|
||||
post:
|
||||
operationId: pydanticaiOpenAIResponses
|
||||
summary: Create response (PydanticAI - OpenAI Responses API)
|
||||
description: |
|
||||
Creates a response using OpenAI Responses API format via PydanticAI.
|
||||
Supports streaming via SSE.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
responses-input-tokens:
|
||||
post:
|
||||
operationId: pydanticaiOpenAICountInputTokens
|
||||
summary: Count input tokens (PydanticAI - OpenAI format)
|
||||
description: |
|
||||
Counts the number of tokens in a Responses API request via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/responses.yaml#/OpenAIResponsesRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/inference/count-tokens.yaml#/CountTokensResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
speech:
|
||||
post:
|
||||
operationId: pydanticaiOpenAISpeech
|
||||
summary: Create speech (PydanticAI - OpenAI TTS)
|
||||
description: |
|
||||
Generates audio from text using OpenAI TTS via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAISpeechRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
audio/mpeg:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAISpeechStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
transcriptions:
|
||||
post:
|
||||
operationId: pydanticaiOpenAITranscriptions
|
||||
summary: Create transcription (PydanticAI - OpenAI Whisper)
|
||||
description: |
|
||||
Transcribes audio into text using OpenAI Whisper via PydanticAI.
|
||||
tags:
|
||||
- PydanticAI Integration
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionResponse'
|
||||
text/event-stream:
|
||||
schema:
|
||||
$ref: '../../../schemas/integrations/openai/audio.yaml#/OpenAITranscriptionStreamResponse'
|
||||
'400':
|
||||
$ref: '../../../openapi.yaml#/components/responses/BadRequest'
|
||||
'500':
|
||||
$ref: '../../../openapi.yaml#/components/responses/InternalError'
|
||||
security:
|
||||
- BearerAuth: []
|
||||
- BasicAuth: []
|
||||
- VirtualKeyAuth: []
|
||||
- ApiKeyAuth: []
|
||||
Reference in New Issue
Block a user