Rest APIAPI ReferenceOllama

Test 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

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