Files

Upload a file

POST/v1/files

Uploads a file to be used with batch operations or other features.

Query Parameters

provider?string

Provider to upload file to (can also use x-model-provider header)

Value in"openai" | "azure" | "anthropic" | "bedrock" | "cohere" | "vertex" | "vllm" | "mistral" | "ollama" | "groq" | "sgl" | "parasail" | "perplexity" | "replicate" | "cerebras" | "gemini" | "openrouter" | "elevenlabs" | "huggingface" | "nebius" | "xai" | "runway" | "fireworks"

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:8080/v1/files" \  -F file="string" \  -F purpose="batch"
{
  "id": "string",
  "object": "string",
  "bytes": 0,
  "created_at": 0,
  "filename": "string",
  "purpose": "batch",
  "status": "uploaded",
  "status_details": "string",
  "expires_at": 0,
  "storage_backend": "string",
  "storage_uri": "string",
  "extra_fields": {
    "request_type": "string",
    "provider": "openai",
    "model_requested": "string",
    "model_deployment": "string",
    "latency": 0,
    "chunk_index": 0,
    "raw_request": {},
    "raw_response": {},
    "cache_debug": {
      "cache_hit": true,
      "cache_id": "string",
      "hit_type": "string",
      "requested_provider": "string",
      "requested_model": "string",
      "provider_used": "string",
      "model_used": "string",
      "input_tokens": 0,
      "threshold": 0,
      "similarity": 0
    }
  }
}
{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}
{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}