Usage & API | LocalAI

Quick Start

The service is available at http://localhost:8080. You can use standard HTTP requests to interact with it.

curl http://localhost:8080/v1/chat/completions \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-3.5-turbo",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

import openai

openai.api_base = "http://localhost:8080/v1"
openai.api_key = "sx-xxx" # Not required but often checked

completion = openai.ChatCompletion.create(
  model="gpt-3.5-turbo",
  messages=[{"role": "user", "content": "Hello world!"}]
)

print(completion.choices[0].message.content)

const { Configuration, OpenAIApi } = require("openai");

const configuration = new Configuration({
  basePath: "http://localhost:8080/v1",
});
const openai = new OpenAIApi(configuration);

const completion = await openai.createChatCompletion({
  model: "gpt-3.5-turbo",
  messages: [{role: "user", content: "Hello world!"}],
});

console.log(completion.data.choices[0].message);

Available Endpoints

POST /v1/chat/completions

Chat generation

POST /v1/images/generations

Image generation

POST /v1/audio/speech

Text to Speech