Skip to main content
Obiguard API has first-class support for monitoring and routing your requests to 10+ provider endpoints, like /chat/completions, /audio, /embeddings, etc. We also make these endpoints work across 250+ different LLMs. However, there are still many endpoints like Cohere’s /rerank or Deepgram’s /listen that are uncommon or have niche use cases. With the Gateway to Other APIs feature, you can route to any custom provider endpoint using Obiguard (including the ones hosted on your private setups) and get complete logging & monitoring for all your requests.

Supported HTTP Methods

POST

GET

PUT

DELETE

Both the REST API and Obiguard SDKs (Python, NodeJS) support all of these HTTP methods.

How to Integrate

  1. Get your Obiguard API key
  2. Add your provider details to Obiguard
  3. Make your request using Obiguard’s API or SDK

1. Get Obiguard API Key

Create or log in to your Obiguard account. Grab your account’s API key from the “Virtual Keys” page.

2. Add Provider Details

Choose one of these authentication methods:
Set the provider name from one of Obiguard’s 40+ supported providers list and use your provider credentials directly with each request.
  • Python SDK
  • cURL
Python
from obiguard import Obiguard

client = Obiguard(
  obiguard_api_key="sk-obg***",  # Your Obiguard API key
)
Route to your privately hosted model endpoints.
  • Choose a compatible provider type (e.g., openai, cohere)
  • Provide your endpoint URL with customHost
  • Include Authentication if needed
  • Python SDK
  • cURL
Python
from obiguard import Obiguard

client = Obiguard(
  obiguard_api_key="sk-obg***",  # Your Obiguard API key
  provider = "cohere",
  custom_host = "https://182.145.24.5:8080/v1",
  Authorization = "Bearer COHERE_API_KEY"
)

3. Make Requests

  • cURL
  • Python SDK
Construct your request URL:
  1. Obiguard Gateway base URL remains same: https://gateway.obiguard.ai/v1
  2. Append your custom endpoint at the end of the URL: https://gateway.obiguard.ai/v1/{provider - endpoint}
curl --request POST \
  --url https://gateway.obiguard.ai/v1/rerank \
  -H 'Content-Type: application/json' \
  -H "x-obiguard-api-key: $OBIGUARD_API_KEY" \
  --data '{
    "model": "rerank-english-v2.0",
    "query": "What is machine learning?",
    "documents": [
      "Machine learning is a branch of AI focused on building systems that learn from data.",
      "Data science involves analyzing and interpreting complex data sets."
    ]
  }'

End-to-end Example

A complete example showing document reranking with Cohere:
from obiguard import Obiguard

client = Obiguard(
  obiguard_api_key="vk-obg***",  # Your Obiguard virtual key
)

response = client.post(
  '/rerank',
  return_documents=False,
  max_chunks_per_doc=10,
  model="rerank-english-v2.0",
  query="What is the capital of the United States?",
  documents=[
    "Carson City is the capital city of the American state of Nevada.",
    "Washington, D.C. is the capital of the United States.",
    "Capital punishment has existed in the United States since before its founding."
  ]
)

Caveats & Considerations

  • Response objects are returned exactly as received from the provider, without Obiguard transformations
  • REST API supports all HTTP methods: POST, GET, PUT, and DELETE
  • SDK supports all HTTP methods: POST, GET, PUT, and DELETE
  • There are no limitations on which provider endpoints can be proxied
  • All requests are logged and monitored through your Obiguard dashboard

Next Steps

The complete list of features supported in the SDK are available on the link below.

Obiguard SDK Client

Learn more about the Obiguard SDK Client