Test connection to Ollama instance

POST/v1/private/ollama/test-connectionTest connection to Ollama instance

Validates that the provided Ollama URL is reachable. URL may be provided with or without /v1 suffix (e.g., http://localhost:11434 or http://localhost:11434/v1). The /v1 suffix will be automatically removed for connection testing. For inference, use the URL with /v1 suffix.

Request body

required

application/json

objectOllamaInstanceBaseUrlRequest

Request with Ollama instance base URL for connection testing or model discovery.

api_keystring

Optional API key for authenticated Ollama instances. If provided, will be sent as Bearer token in Authorization header.

base_urlstringrequired

Base URL of the Ollama instance. May include /v1 suffix which will be automatically removed for connection testing. For inference, use the URL with /v1 suffix for OpenAI-compatible endpoints.

minLength 1

Example request

{
  "api_key": "",
  "base_url": "http://localhost:11434/v1"
}

Responses

objectOllamaConnectionTestResponse

Response from Ollama connection test.

connectedboolean

Whether the connection was successful

error_messagestring

Error message if connection failed

versionstring

Server version (returned even if connection failed or version is incompatible)

Example response

{
  "connected": true,
  "error_message": "string",
  "version": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectOllamaConnectionTestResponse

Response from Ollama connection test.

connectedboolean

Whether the connection was successful

error_messagestring

Error message if connection failed

versionstring

Server version (returned even if connection failed or version is incompatible)

Example response

{
  "connected": true,
  "error_message": "string",
  "version": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

curl -X POST 'https://www.comet.com/opik/api/v1/private/ollama/test-connection' \
  -H 'Content-Type: application/json' \
  -d '{"api_key":"","base_url":"http://localhost:11434/v1"}'

const response = await fetch('http://localhost:5173/api/v1/private/ollama/test-connection', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"api_key":"[REDACTED]","base_url":"http://localhost:11434/v1"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/ollama/test-connection', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"api_key\":[REDACTED]" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://www.comet.com/opik/api/v1/private/ollama/test-connection",
    headers={"Content-Type": "application/json"},
    data='{"api_key":"","base_url":"http://localhost:11434/v1"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"api_key":"","base_url":"http://localhost:11434/v1"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://www.comet.com/opik/api/v1/private/ollama/test-connection", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/ollama/test-connection");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"api_key\":[REDACTED]");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/ollama/test-connection"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"api_key\":[REDACTED]"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://www.comet.com/opik/api/v1/private/ollama/test-connection")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"api_key\":\"\",\"base_url\":\"http://localhost:11434/v1\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://www.comet.com/opik/api/v1/private/ollama/test-connection");
request.Content = new StringContent("{\"api_key\":\"\",\"base_url\":\"http://localhost:11434/v1\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "connected": true,
  "error_message": "string",
  "version": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "connected": true,
  "error_message": "string",
  "version": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}