Quickstart

Create a key

Create an account and an API key. Store the key in an environment variable namedSHOREHELD_API_KEY.

Pick a region

Use the endpoint for the region you want the request processed in.

RegionRequests are processed inEndpoint
UK (London)The United Kingdomhttps://uk.api.shoreheld.com/v1
EUThe European Unionhttps://eu.api.shoreheld.com/v1
SwitzerlandSwitzerlandhttps://ch.api.shoreheld.com/v1
SingaporeSingaporehttps://sg.api.shoreheld.com/v1

Make a request

curl
curl https://uk.api.shoreheld.com/v1/chat/completions \
  -H "Authorization: Bearer $SHOREHELD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "kimi-k3.1-pro",
    "messages": [{"role": "user", "content": "Summarise this contract clause."}]
  }'
Python
import os
from openai import OpenAI

client = OpenAI(
    base_url="https://uk.api.shoreheld.com/v1",
    api_key=os.environ["SHOREHELD_API_KEY"],
)

response = client.chat.completions.create(
    model="kimi-k3.1-pro",
    messages=[{"role": "user", "content": "Summarise this contract clause."}],
)
print(response.choices[0].message.content)
TypeScript
import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://uk.api.shoreheld.com/v1",
  apiKey: process.env.SHOREHELD_API_KEY,
});

const response = await client.chat.completions.create({
  model: "kimi-k3.1-pro",
  messages: [{ role: "user", content: "Summarise this contract clause." }],
});
console.log(response.choices[0].message.content);

List the models

GET /models on any endpoint returns the models served there.