Create embeddings

/api/v1/embeddings

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

Example: "openai/text-embedding-3-small"

inputanyrequired

A string, or an array of strings

Example: "The quick brown fox jumps over the lazy dog"

Response

Embeddings result

application/json

objectstringrequired

dataobject[]required

modelstringrequired

usageobject

invalid_json — body is not valid JSON

application/json

errorobjectrequired

Show child attributes

codeintegerrequired

The HTTP status

messagestringrequired

metadataobjectrequired

Show child attributes

error_typestringrequired

OpenRouter's error type: authentication, payment_required, rate_limit_exceeded, not_found, invalid_request, …

ocean_codestringrequired

The /v1 envelope's string error.code

ocean_typestring

request_idstringrequired

Equals the x-request-id header

Missing or invalid API key

application/json

errorobjectrequired

Show child attributes

codeintegerrequired

The HTTP status

messagestringrequired

metadataobjectrequired

Show child attributes

error_typestringrequired

OpenRouter's error type: authentication, payment_required, rate_limit_exceeded, not_found, invalid_request, …

ocean_codestringrequired

The /v1 envelope's string error.code

ocean_typestring

request_idstringrequired

Equals the x-request-id header

byok_required

application/json

errorobjectrequired

Show child attributes

codeintegerrequired

The HTTP status

messagestringrequired

metadataobjectrequired

Show child attributes

error_typestringrequired

OpenRouter's error type: authentication, payment_required, rate_limit_exceeded, not_found, invalid_request, …

ocean_codestringrequired

The /v1 envelope's string error.code

ocean_typestring

request_idstringrequired

Equals the x-request-id header

model_not_allowed or content_blocked

application/json

errorobjectrequired

Show child attributes

codeintegerrequired

The HTTP status

messagestringrequired

metadataobjectrequired

Show child attributes

error_typestringrequired

OpenRouter's error type: authentication, payment_required, rate_limit_exceeded, not_found, invalid_request, …

ocean_codestringrequired

The /v1 envelope's string error.code

ocean_typestring

request_idstringrequired

Equals the x-request-id header

model_not_found — no such model in the catalog

application/json

errorobjectrequired

Show child attributes

codeintegerrequired

The HTTP status

messagestringrequired

metadataobjectrequired

Show child attributes

error_typestringrequired

OpenRouter's error type: authentication, payment_required, rate_limit_exceeded, not_found, invalid_request, …

ocean_codestringrequired

The /v1 envelope's string error.code

ocean_typestring

request_idstringrequired

Equals the x-request-id header

method_not_allowed — the path serves one method: the Allow header names it, plus OPTIONS

application/json

Response headers

Allowstring

The method this path serves, plus OPTIONS

errorobjectrequired

Show child attributes

codeintegerrequired

The HTTP status

messagestringrequired

metadataobjectrequired

Show child attributes

error_typestringrequired

OpenRouter's error type: authentication, payment_required, rate_limit_exceeded, not_found, invalid_request, …

ocean_codestringrequired

The /v1 envelope's string error.code

ocean_typestring

request_idstringrequired

Equals the x-request-id header

rate_limit_exceeded or spend_cap_exceeded

application/json

errorobjectrequired

Show child attributes

codeintegerrequired

The HTTP status

messagestringrequired

metadataobjectrequired

Show child attributes

error_typestringrequired

OpenRouter's error type: authentication, payment_required, rate_limit_exceeded, not_found, invalid_request, …

ocean_codestringrequired

The /v1 envelope's string error.code

ocean_typestring

request_idstringrequired

Equals the x-request-id header

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": "openai/text-embedding-3-small", "input": "The quick brown fox jumps over the lazy dog", }, ) 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": "openai/text-embedding-3-small", "input": "The quick brown fox jumps over the lazy dog" }), }) 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\":\"openai/text-embedding-3-small\",\"input\":\"The quick brown fox jumps over the lazy dog\"}")) .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":"openai/text-embedding-3-small","input":"The quick brown fox jumps over the lazy dog"}'

{ "error": { "code": 0, "message": "<string>", "metadata": { "error_type": "<string>", "ocean_code": "<string>", "ocean_type": "<string>", "request_id": "<string>" } } }

Create embeddings

Authorizations

Body

Response

Response headers

Planned: TI-33

Planned: TI-34