Download OpenAPI specification:
Public HTTP contract derived from the current route signatures and Pydantic request models. Internal /api/private routes are excluded. Dynamic controller results remain an open JSON schema.
The configured max_documents limits the number of input documents per request. When exceeded, returns HTTP 400 with code ModelFactory.ExternalSmallModel.Used.InvalidParameter before calling the provider. Documents are never truncated or split. Unconfigured limits retain the previous behavior. The registered model type must be reranker; a mismatch returns HTTP 400 with code ModelFactory.ExternalSmallModel.Used.InvalidParameter before any provider or adapter call. Successful results are returned without a FastAPI response_model.
JSON request accepted by the implemented handler signature. Dictionary fields are validated by the controller.
| model | string (Model) Model name |
| query required | string (Query) Query to rank against |
| documents required | Array of any (Documents) Documents to rank |
| model_id | string (Model Id) Default: "" Model ID |
{- "model": "string",
- "query": "string",
- "documents": [
- null
], - "model_id": ""
}nullThe registered model type must be embedding; a mismatch returns HTTP 400 with code ModelFactory.ExternalSmallModel.Used.InvalidParameter before any provider or adapter call. Successful provider and adapter responses must contain a non-empty data array of non-empty numeric embedding vectors. Invalid output returns HTTP 502 with code ModelFactory.ExternalSmallModel.Used.InvalidResponse. Provider extension fields are preserved.
JSON request accepted by the implemented handler signature. Dictionary fields are validated by the controller.
| model | string (Model) Model name |
| input required | Array of any (Input) Content to embed |
| model_id | string (Model Id) Default: "" Model ID |
{- "model": "string",
- "input": [
- null
], - "model_id": ""
}nullThe registered model type must be embedding; a mismatch returns HTTP 400 with code ModelFactory.ExternalSmallModel.Used.InvalidParameter before any provider or adapter call. Successful provider and adapter responses must contain a non-empty data array of non-empty numeric embedding vectors. Invalid output returns HTTP 502 with code ModelFactory.ExternalSmallModel.Used.InvalidResponse. Provider extension fields are preserved.
JSON request accepted by the implemented handler signature. Dictionary fields are validated by the controller.
| model | string (Model) Model name |
| input required | Array of any (Input) Content to embed |
| model_id | string (Model Id) Default: "" Model ID |
{- "model": "string",
- "input": [
- null
], - "model_id": ""
}null