Skip to main content
POST
/
api
/
providers
Add a new provider
curl --request POST \
  --url http://localhost:8080/api/providers \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "openai",
  "keys": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": {
        "value": "<string>",
        "env_var": "<string>",
        "from_env": true
      },
      "models": [
        "<string>"
      ],
      "weight": 123,
      "azure_key_config": {
        "endpoint": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "deployments": {},
        "api_version": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "client_id": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "client_secret": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "tenant_id": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "scopes": [
          "<string>"
        ]
      },
      "vertex_key_config": {
        "project_id": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "project_number": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "region": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "auth_credentials": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "deployments": {}
      },
      "bedrock_key_config": {
        "access_key": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "secret_key": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "session_token": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "region": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "arn": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "deployments": {},
        "batch_s3_config": {
          "buckets": [
            {
              "bucket_name": "<string>",
              "prefix": "<string>",
              "is_default": true
            }
          ]
        }
      },
      "huggingface_key_config": {
        "deployments": {}
      },
      "enabled": true,
      "use_for_batch_api": true
    }
  ],
  "network_config": {
    "base_url": "<string>",
    "extra_headers": {},
    "default_request_timeout_in_seconds": 123,
    "max_retries": 123,
    "retry_backoff_initial": 123,
    "retry_backoff_max": 123
  },
  "concurrency_and_buffer_size": {
    "concurrency": 123,
    "buffer_size": 123
  },
  "proxy_config": {
    "type": "none",
    "url": "<string>",
    "username": "<string>",
    "password": "<string>",
    "ca_cert_pem": "<string>"
  },
  "send_back_raw_request": true,
  "send_back_raw_response": true,
  "custom_provider_config": {
    "is_key_less": true,
    "base_provider_type": "openai",
    "allowed_requests": {
      "list_models": true,
      "text_completion": true,
      "text_completion_stream": true,
      "chat_completion": true,
      "chat_completion_stream": true,
      "responses": true,
      "responses_stream": true,
      "count_tokens": true,
      "embedding": true,
      "speech": true,
      "speech_stream": true,
      "transcription": true,
      "transcription_stream": true,
      "image_generation": true,
      "image_generation_stream": true,
      "batch_create": true,
      "batch_list": true,
      "batch_retrieve": true,
      "batch_cancel": true,
      "batch_results": true,
      "file_upload": true,
      "file_list": true,
      "file_retrieve": true,
      "file_delete": true,
      "file_content": true
    },
    "request_path_overrides": {}
  }
}
'
{
  "name": "openai",
  "keys": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": {
        "value": "<string>",
        "env_var": "<string>",
        "from_env": true
      },
      "models": [
        "<string>"
      ],
      "weight": 123,
      "azure_key_config": {
        "endpoint": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "deployments": {},
        "api_version": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "client_id": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "client_secret": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "tenant_id": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "scopes": [
          "<string>"
        ]
      },
      "vertex_key_config": {
        "project_id": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "project_number": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "region": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "auth_credentials": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "deployments": {}
      },
      "bedrock_key_config": {
        "access_key": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "secret_key": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "session_token": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "region": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "arn": {
          "value": "<string>",
          "env_var": "<string>",
          "from_env": true
        },
        "deployments": {},
        "batch_s3_config": {
          "buckets": [
            {
              "bucket_name": "<string>",
              "prefix": "<string>",
              "is_default": true
            }
          ]
        }
      },
      "huggingface_key_config": {
        "deployments": {}
      },
      "enabled": true,
      "use_for_batch_api": true
    }
  ],
  "network_config": {
    "base_url": "<string>",
    "extra_headers": {},
    "default_request_timeout_in_seconds": 123,
    "max_retries": 123,
    "retry_backoff_initial": 123,
    "retry_backoff_max": 123
  },
  "concurrency_and_buffer_size": {
    "concurrency": 123,
    "buffer_size": 123
  },
  "proxy_config": {
    "type": "none",
    "url": "<string>",
    "username": "<string>",
    "password": "<string>",
    "ca_cert_pem": "<string>"
  },
  "send_back_raw_request": true,
  "send_back_raw_response": true,
  "custom_provider_config": {
    "is_key_less": true,
    "base_provider_type": "openai",
    "allowed_requests": {
      "list_models": true,
      "text_completion": true,
      "text_completion_stream": true,
      "chat_completion": true,
      "chat_completion_stream": true,
      "responses": true,
      "responses_stream": true,
      "count_tokens": true,
      "embedding": true,
      "speech": true,
      "speech_stream": true,
      "transcription": true,
      "transcription_stream": true,
      "image_generation": true,
      "image_generation_stream": true,
      "batch_create": true,
      "batch_list": true,
      "batch_retrieve": true,
      "batch_cancel": true,
      "batch_results": true,
      "file_upload": true,
      "file_list": true,
      "file_retrieve": true,
      "file_delete": true,
      "file_content": true
    },
    "request_path_overrides": {}
  },
  "status": "active",
  "config_hash": "<string>"
}

Body

application/json

Add provider request

​
provider
enum<string>
required

AI model provider identifier

Available options:
openai,
azure,
anthropic,
bedrock,
cohere,
vertex,
mistral,
ollama,
groq,
sgl,
parasail,
perplexity,
cerebras,
gemini,
openrouter,
elevenlabs,
huggingface,
nebius,
xai
​
keys
object[]
​
network_config
object

Network configuration for provider connections

​
concurrency_and_buffer_size
object

Concurrency settings

​
proxy_config
object

Proxy configuration

​
send_back_raw_request
boolean
​
send_back_raw_response
boolean
​
custom_provider_config
object

Custom provider configuration

Response

Provider added successfully

Provider configuration response

​
name
enum<string>

AI model provider identifier

Available options:
openai,
azure,
anthropic,
bedrock,
cohere,
vertex,
mistral,
ollama,
groq,
sgl,
parasail,
perplexity,
cerebras,
gemini,
openrouter,
elevenlabs,
huggingface,
nebius,
xai
​
keys
object[]
​
network_config
object

Network configuration for provider connections

​
concurrency_and_buffer_size
object

Concurrency settings

​
proxy_config
object

Proxy configuration

​
send_back_raw_request
boolean
​
send_back_raw_response
boolean
​
custom_provider_config
object

Custom provider configuration

​
status
enum<string>

Status of the provider

Available options:
active,
error,
deleted
​
config_hash
string

Hash of config.json version, used for change detection