API Reference

Embeddings

POST https://api.tu-zi.com/v1/embeddings

Preview guide

Paste into an AI assistant to help with integration. Documentation and examples only; no real credentials.

# Embeddings

Embeddings

## Endpoint and authentication

`POST https://api.tu-zi.com/v1/embeddings`

Transport: json

Use an inference API key. Examples contain placeholders; read credentials from environment variables.

```http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
```

## Body parameters

| Field | Type | Required | Description / constraints |
| --- | --- | --- | --- |
| model | string | Yes | Embedding model identifier. Example: text-embedding-3-small |
| input | string \| array | Yes | Text or an array of texts to embed. Example: 退款申请通常会在三个工作日内原路退回。 |
| encoding_format | string | No | Embedding encoding, typically float or base64. Form initial value (not an upstream default): "float" Values: "float", "base64" Example: float |
| dimensions | number | No | Output vector dimensions; custom dimensions require model support. Range in this definition: 1 ~ 8192 Example: 1536 |

## Minimal request example

```json
{
  "model": "YOUR_MODEL",
  "input": [
    "Hello"
  ]
}
```

## Before running

Replace https://api.tu-zi.com with this site origin (do not append /v1 twice), and YOUR_MODEL with the exact marketplace model ID. Install requests for Python; use Node.js 20+ and save JavaScript as .mjs. WebSocket samples list their own dependencies.

Create an inference key on the site and set API_KEY in the environment; replace YOUR_API_KEY in cURL. Prepare local input.png/input.wav files for upload examples.

Start with a minimal request, then read the result using the response fields below. For async APIs, a returned task ID requires polling; acceptance does not mean generation has finished.

## Code examples

### curl

```bash
curl --request POST 'https://api.tu-zi.com/v1/embeddings' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "YOUR_MODEL",
  "input": [
    "Hello"
  ]
}'
```

### python

```python
import json
import os
import requests

url = "https://api.tu-zi.com/v1/embeddings"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_API_KEY\",\"Content-Type\":\"application/json\"}")
headers["Authorization"] = "Bearer " + os.environ["API_KEY"]
payload = json.loads("{\"model\":\"YOUR_MODEL\",\"input\":[\"Hello\"]}")
response = requests.request("POST", url, headers=headers, json=payload, timeout=120)
response.raise_for_status()
result = response.json()
if isinstance(result, dict) and (result.get("success") is False or result.get("error")):
    raise RuntimeError(json.dumps(result, ensure_ascii=False))
print(result)  # Also inspect protocol-specific status/code fields.
```

### javascript

```javascript
// Node.js 20+
const url = "https://api.tu-zi.com/v1/embeddings";
const headers = {
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
};
headers.Authorization = 'Bearer ' + process.env.API_KEY;
const response = await fetch(url, { method: "POST", headers, body: JSON.stringify({
  "model": "YOUR_MODEL",
  "input": [
    "Hello"
  ]
}) });
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
if (result?.success === false || result?.error) throw new Error(JSON.stringify(result));
console.log(result); // Also inspect protocol-specific status/code fields.
```

## Response fields

| Field | Type | Description / constraints |
| --- | --- | --- |
| data[].embedding | number[] | Embedding vector. |
| data[].index | integer | Input index. |
| usage | object | Input usage. |

Illustrative response; some endpoints show essential fields only. Optional fields may be absent.

```json
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0.1,
        0.2
      ]
    }
  ],
  "model": "YOUR_MODEL",
  "usage": {
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}
```

## Errors and retries

Check HTTP status and protocol-specific errors; do not mix error formats across protocols. For 401/403 check credentials and permissions, for 429 back off, and for 5xx check gateway/upstream status. Error bodies may contain error/message/code depending on the protocol.

Use bounded exponential backoff for reads. Do not blindly retry task creation, generation, or key mutations, to avoid duplicate billing or execution.

## Constraints

This page describes the base protocol. Use the selected model quick start for supported fields, enums, limits and asynchronous behavior. Replace YOUR_MODEL. Form initial values are not upstream defaults.

## Documentation source

Definition version: 1

Reviewed: 2026-11-02

Source: https://api.tu-zi.com/en/docs/api/reference-relay-embeddings

Related protocol guide: https://api.tu-zi.com/docs/api/retrieval

This export contains documentation and examples only, without real credentials, account data or user requests.

Updated 2026-11-02 · Reviewed 2026-11-02

Endpoint and authentication

POST https://api.tu-zi.com/v1/embeddings

Transport: json

Use an inference API key. Examples contain placeholders; read credentials from environment variables.

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Minimal request example

{
  "model": "YOUR_MODEL",
  "input": [
    "Hello"
  ]
}

Before running

Replace https://api.tu-zi.com with this site origin (do not append /v1 twice), and YOUR_MODEL with the exact marketplace model ID. Install requests for Python; use Node.js 20+ and save JavaScript as .mjs. WebSocket samples list their own dependencies.

Create an inference key on the site and set API_KEY in the environment; replace YOUR_API_KEY in cURL. Prepare local input.png/input.wav files for upload examples.

Start with a minimal request, then read the result using the response fields below. For async APIs, a returned task ID requires polling; acceptance does not mean generation has finished.

Constraints

This page describes the base protocol. Use the selected model quick start for supported fields, enums, limits and asynchronous behavior. Replace YOUR_MODEL. Form initial values are not upstream defaults.

Body parameters

Field	Type	Required	Description / constraints
model	string	Yes	Embedding model identifier. Example: text-embedding-3-small
input	string \| array	Yes	Text or an array of texts to embed. Example: 退款申请通常会在三个工作日内原路退回。
encoding_format	string	No	Embedding encoding, typically float or base64. Form initial value (not an upstream default): "float" Values: "float", "base64" Example: float
dimensions	number	No	Output vector dimensions; custom dimensions require model support. Range in this definition: 1 ~ 8192 Example: 1536

Response fields

Field	Type	Description / constraints
data[].embedding	number[]	Embedding vector.
data[].index	integer	Input index.
usage	object	Input usage.

Illustrative response; some endpoints show essential fields only. Optional fields may be absent.

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0.1,
        0.2
      ]
    }
  ],
  "model": "YOUR_MODEL",
  "usage": {
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}

Errors and retries

Check HTTP status and protocol-specific errors; do not mix error formats across protocols. For 401/403 check credentials and permissions, for 429 back off, and for 5xx check gateway/upstream status. Error bodies may contain error/message/code depending on the protocol.

Use bounded exponential backoff for reads. Do not blindly retry task creation, generation, or key mutations, to avoid duplicate billing or execution.

Document information and sources

Documentation source

Definition version: 1

Reviewed: 2026-11-02

Source: https://api.tu-zi.com/en/docs/api/reference-relay-embeddings

Related protocol guide: https://api.tu-zi.com/docs/api/retrieval

This export contains documentation and examples only, without real credentials, account data or user requests.

Request examples

curl --request POST 'https://api.tu-zi.com/v1/embeddings' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "YOUR_MODEL",
  "input": [
    "Hello"
  ]
}'

import json
import os
import requests

url = "https://api.tu-zi.com/v1/embeddings"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_API_KEY\",\"Content-Type\":\"application/json\"}")
headers["Authorization"] = "Bearer " + os.environ["API_KEY"]
payload = json.loads("{\"model\":\"YOUR_MODEL\",\"input\":[\"Hello\"]}")
response = requests.request("POST", url, headers=headers, json=payload, timeout=120)
response.raise_for_status()
result = response.json()
if isinstance(result, dict) and (result.get("success") is False or result.get("error")):
    raise RuntimeError(json.dumps(result, ensure_ascii=False))
print(result)  # Also inspect protocol-specific status/code fields.

// Node.js 20+
const url = "https://api.tu-zi.com/v1/embeddings";
const headers = {
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
};
headers.Authorization = 'Bearer ' + process.env.API_KEY;
const response = await fetch(url, { method: "POST", headers, body: JSON.stringify({
  "model": "YOUR_MODEL",
  "input": [
    "Hello"
  ]
}) });
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
if (result?.success === false || result?.error) throw new Error(JSON.stringify(result));
console.log(result); // Also inspect protocol-specific status/code fields.