For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • POSTList available Ollama models
        • POSTTest connection to Ollama instance
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceOllama

Test connection to Ollama instance

POST
/v1/private/ollama/test-connection
POST
/api/v1/private/ollama/test-connection
$curl -X POST http://localhost:5173/api/v1/private/ollama/test-connection \
> -H "Content-Type: application/json" \
> -d '{
> "base_url": "http://localhost:11434/v1"
>}'
1{
2 "connected": true,
3 "version": "string",
4 "error_message": "string"
5}
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.
Was this page helpful?
Previous

Download ollie state

Next
Built with

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

This endpoint expects an object.
base_urlstringRequired>=1 character

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.

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

Response

Connection test successful
connectedboolean
Whether the connection was successful
versionstring

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

error_messagestring
Error message if connection failed

Errors

422
Unprocessable Entity Error
502
Bad Gateway Error
503
Service Unavailable Error