Server info (GET /) · Local API Guide

Local API Guide contents

Overview

Returns a small description of the server. It is outside /v1, so it never needs the API key: use it to check that the Local API server is running before you send real requests.

Request

No parameters.

Response

Field	Description
`name`string	Always `5090Ai local API`.
`openai_compatible`boolean	Always `true`.
`endpoints`string[]	The endpoints this version serves.

Example

curl http://localhost:1234/

import requests

print(requests.get("http://localhost:1234/").json())

const info = await (await fetch("http://localhost:1234/")).json();
console.log(info.endpoints);

Response

{
  "name": "5090Ai local API",
  "openai_compatible": true,
  "endpoints": ["/v1/models", "/v1/chat/completions", "/v1/completions", "/v1/embeddings", "/v1/web/search",
                "/v1/knowledge/collections", "/v1/knowledge/documents", "/v1/knowledge/search"]
}

Errors

None: if the server is off, the connection is refused.