Get converter status

Checks whether the document converter binary can be resolved. Requires L0 authorization.

GET /api/v1/knowledge/converter/status

Get converter binary status

cURL

curl --request GET \
  --url http://127.0.0.1:4000/api/v1/knowledge/converter/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://127.0.0.1:4000/api/v1/knowledge/converter/status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://127.0.0.1:4000/api/v1/knowledge/converter/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4000",
  CURLOPT_URL => "http://127.0.0.1:4000/api/v1/knowledge/converter/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://127.0.0.1:4000/api/v1/knowledge/converter/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://127.0.0.1:4000/api/v1/knowledge/converter/status")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:4000/api/v1/knowledge/converter/status")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "installed": true,
  "path": "<string>"
}

This endpoint verifies whether the Knowledge converter binary is available to the server runtime.

The converter is familyco-py, downloaded from:

• Repository: omaicode/familyco-py
• Release assets: latest release downloads

About familyco-py:

• It is a Python toolkit CLI used by FamilyCo for document preprocessing.
• Its current core module is doc-convert (Docling-based conversion and OCR).
• FamilyCo uses the converter output as the input for chunking and knowledge indexing.

Expected response shape:

{
	"installed": true,
	"path": "/absolute/path/to/familyco-py"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Converter status

installed · boolean · required

path · string | null · required