Embeddings (proxied to inference-gateway).

/api/v1/embeddings

Not yet described in the overlay (TI-20).

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer sk-ocean-…. Legacy sk-ocean- inference key: still accepted on the money plane until the sk-ocean- sunset; new integrations use the ozk_ key

Body

application/json

Money plane, ozk_ auth. Same guardrail/cache enforcement as chat completions.

modelstringrequired

inputanyrequired

A string, or an array of strings

Response

Embeddings result

application/json

objectstringrequired

dataobject[]required

modelstringrequired

usageobject

Missing or invalid API key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

byok_required

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

model_not_allowed or content_blocked

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

rate_limit_exceeded or spend_cap_exceeded

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

money_plane_unavailable — INFERENCE_GATEWAY_SERVICE not bound on this tier

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

import os
import requests

response = requests.post(
    "https://api.plungeai.com/api/v1/embeddings",
    headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"},
    json={
        "model": "<string>",
        "input": None,
    },
)
if not response.ok:
    raise SystemExit(f"{response.status_code} {response.json()['error']['code']}")
print(response.json())

const response = await fetch('https://api.plungeai.com/api/v1/embeddings', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "model": "<string>",
    "input": null
  }),
})
if (!response.ok) throw new Error(`${response.status} ${(await response.json()).error?.code}`)
console.log(await response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.plungeai.com/api/v1/embeddings"))
            .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY"))
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("{\"model\":\"<string>\",\"input\":null}"))
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 400) {
            // Models plane: the machine code is error.code in the JSON body.
            System.out.println(response.statusCode() + " " + response.body());
            return;
        }
        System.out.println(response.body());
    }
}

curl -X POST 'https://api.plungeai.com/api/v1/embeddings' \
  -H "Authorization: Bearer $PLUNGE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"model":"<string>","input":null}'

Example generated from schema

{
  "object": "<string>",
  "data": [
    {}
  ],
  "model": "<string>",
  "usage": {}
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Embeddings (proxied to inference-gateway).

Authorizations

Body

Response

Planned: TI-33

Planned: TI-34