Skip to content

common_api

Classes

fastvideo.entrypoints.openai.common_api.ModelCard

Bases: BaseModel

OpenAI-compatible model card

Functions:

fastvideo.entrypoints.openai.common_api.available_models async

available_models()

Show available models

Source code in fastvideo/entrypoints/openai/common_api.py
@router.get("/models", response_class=ORJSONResponse)
async def available_models():
    """Show available models"""
    args = get_server_args()
    cards = [ModelCard(id=get_served_model_name(), root=args.model_path)]
    return {"object": "list", "data": [card.model_dump() for card in cards]}

fastvideo.entrypoints.openai.common_api.model_info async

model_info()

Get basic model information

Source code in fastvideo/entrypoints/openai/common_api.py
@router.get("/model_info")
async def model_info():
    """Get basic model information"""
    args = get_server_args()
    return {
        "model_path":
        args.model_path,
        "served_model_name":
        get_served_model_name(),
        "lora": ({
            "name": args.lora_nickname,
            "path": args.lora_path,
            "scale": args.lora_strength,
        } if args.lora_path else None),
    }

fastvideo.entrypoints.openai.common_api.retrieve_model async

retrieve_model(model: str)

Retrieve a model by name

Source code in fastvideo/entrypoints/openai/common_api.py
@router.get("/models/{model:path}", response_class=ORJSONResponse)
async def retrieve_model(model: str):
    """Retrieve a model by name"""
    args = get_server_args()
    served_model_name = get_served_model_name()
    available = {served_model_name}
    if model not in available:
        return ORJSONResponse(
            status_code=404,
            content={
                "error": {
                    "message": f"The model '{model}' does not exist",
                    "type": "invalid_request_error",
                    "param": "model",
                    "code": "model_not_found",
                }
            },
        )
    card = ModelCard(id=model, root=args.model_path)
    return card.model_dump()