HealthApi.md

trieve_py_client.HealthApi

All URIs are relative to https://api.trieve.ai

Method	HTTP request	Description
health_check	GET /api/health	Health Check

health_check

health_check()

Health Check

Health Check Confirmation that the service is healthy and can make embedding vectors

Example

import trieve_py_client
from trieve_py_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.trieve.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = trieve_py_client.Configuration(
    host = "https://api.trieve.ai"
)


# Enter a context with an instance of the API client
with trieve_py_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = trieve_py_client.HealthApi(api_client)

    try:
        # Health Check
        api_instance.health_check()
    except Exception as e:
        print("Exception when calling HealthApi->health_check: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Confirmation that the service is healthy and can make embedding vectors	-
400	Service error relating to making an embedding or overall service health	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]