Pular para o conteúdo
Referência de API
Referência de API

OpenAI Embeddings

Enviar uma requisição pela operação Embeddings compatível com OpenAI do RunAPI.

Ver Markdown
01

Visão geral

Use a operação Embeddings compatível com OpenAI do RunAPI com um modelo compatível e os formatos de requisição e resposta do protocolo.

Início rápido

  1. Crie uma Chave de API e defina-a como RUNAPI_API_KEY.
  2. Escolha um modelo compatível, depois envie os parâmetros de caminho e o corpo JSON documentados.
  3. Leia a resposta JSON ou os eventos enviados pelo servidor exibidos para esta operação e trate os erros de protocolo.

Endpoint

POST /v1/embeddings
URL base
https://runapi.ai
Versão do contrato
v1
Autenticação preferida
Authorization: Bearer YOUR_API_TOKEN
02

Portadores de autenticação

O RunAPI aceita cada carrier listado abaixo. Os exemplos gerados usam o cabeçalho preferido do protocolo.

header - Preferido
Authorization: Bearer YOUR_API_TOKEN
header
x-api-key: YOUR_API_TOKEN
header
x-goog-api-key: YOUR_API_TOKEN
query
?key=YOUR_API_TOKEN
03

Modelos compatíveis

Abra uma página de modelo para ver preços atuais, limites de taxa e detalhes de uso comercial.

Mostrar 3 modelos compatíveis
04

Contrato de solicitação

Corpo JSON

Apenas os campos com evidências de suporte tanto no protocolo público quanto no RunAPI são listados. Campos adicionais no corpo JSON são repassados diretamente.

Corpo JSON4 campos
dimensionsinteger
Opcional

Dimensões de vetor de saída solicitadas para modelos que oferecem suporte a esse recurso.

encoding_formatstring
Opcional

Formato usado para os vetores de embedding retornados.

input["string", "array"]
Obrigatório

Texto ou arrays de tokens para incorporar.

modelstring
Obrigatório

Identificador de modelo de embedding do RunAPI.

Exemplo de solicitação

JSON 
{
  "input": "The quick brown fox.",
  "model": "text-embedding-3-small"
}
05

Resposta síncrona

HTTP 200

Esquema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "data": {
      "type": "array"
    },
    "model": {
      "type": "string"
    },
    "object": {
      "const": "list",
      "type": "string"
    },
    "usage": {
      "additionalProperties": true,
      "properties": {
        "prompt_tokens": {
          "type": "integer"
        },
        "total_tokens": {
          "type": "integer"
        }
      },
      "required": [
        "prompt_tokens",
        "total_tokens"
      ],
      "type": "object"
    }
  },
  "required": [
    "object",
    "data",
    "model",
    "usage"
  ],
  "type": "object"
}

Exemplo

JSON 
{
  "data": [
    {
      "embedding": [
        0.0023,
        -0.0093,
        0.0151
      ],
      "index": 0,
      "object": "embedding"
    }
  ],
  "model": "text-embedding-3-small",
  "object": "list",
  "usage": {
    "prompt_tokens": 5,
    "total_tokens": 5
  }
}
06

Erro de protocolo: invalid_request

HTTP 400

Esquema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "error": {
      "additionalProperties": true,
      "properties": {
        "code": {
          "type": [
            "string",
            "null"
          ]
        },
        "message": {
          "type": "string"
        },
        "param": {
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "message",
        "type"
      ],
      "type": "object"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}

Exemplo

JSON 
{
  "error": {
    "code": null,
    "message": "input is required",
    "param": "input",
    "type": "invalid_request_error"
  }
}
07

Uso

Esquema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "prompt_tokens": {
      "type": "integer"
    },
    "total_tokens": {
      "type": "integer"
    }
  },
  "required": [
    "prompt_tokens",
    "total_tokens"
  ],
  "type": "object"
}

Exemplo

JSON 
{
  "prompt_tokens": 5,
  "total_tokens": 5
}
08

Exemplos de Código Gerados

Cada exemplo em cURL, JavaScript e Python envia a requisição validada deste contrato sem exigir um SDK específico do protocolo.

Instalar

Shell 
pip install requests
PYTHON 
import requests

response = requests.post(
    "https://runapi.ai/v1/embeddings",
    headers={"Authorization": "Bearer YOUR_API_TOKEN", "Content-Type": "application/json"},
    json={"model": "text-embedding-3-small", "input": "The quick brown fox."}
)
response.raise_for_status()
print(response.json())