Crear solicitud de conversación

curl --request POST \
  --url https://api.highwayapi.ai/openai/v1/completions \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "model": "<string>",
  "prompt": "<string>",
  "max_tokens": 123,
  "stream": {},
  "stream_options": {
    "include_usage": true
  },
  "n": {},
  "seed": {},
  "frequency_penalty": {},
  "presence_penalty": {},
  "repetition_penalty": {},
  "stop": {},
  "temperature": {},
  "top_p": {},
  "top_k": {},
  "min_p": {},
  "logit_bias": {},
  "logprobs": {},
  "best_of": 123
}
'

import requests

url = "https://api.highwayapi.ai/openai/v1/completions"

payload = {
    "model": "<string>",
    "prompt": "<string>",
    "max_tokens": 123,
    "stream": {},
    "stream_options": { "include_usage": True },
    "n": {},
    "seed": {},
    "frequency_penalty": {},
    "presence_penalty": {},
    "repetition_penalty": {},
    "stop": {},
    "temperature": {},
    "top_p": {},
    "top_k": {},
    "min_p": {},
    "logit_bias": {},
    "logprobs": {},
    "best_of": 123
}
headers = {
    "Content-Type": "<content-type>",
    "Authorization": "<authorization>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', Authorization: '<authorization>'},
  body: JSON.stringify({
    model: '<string>',
    prompt: '<string>',
    max_tokens: 123,
    stream: {},
    stream_options: {include_usage: true},
    n: {},
    seed: {},
    frequency_penalty: {},
    presence_penalty: {},
    repetition_penalty: {},
    stop: {},
    temperature: {},
    top_p: {},
    top_k: {},
    min_p: {},
    logit_bias: {},
    logprobs: {},
    best_of: 123
  })
};

fetch('https://api.highwayapi.ai/openai/v1/completions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.highwayapi.ai/openai/v1/completions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => '<string>',
    'prompt' => '<string>',
    'max_tokens' => 123,
    'stream' => [
        
    ],
    'stream_options' => [
        'include_usage' => true
    ],
    'n' => [
        
    ],
    'seed' => [
        
    ],
    'frequency_penalty' => [
        
    ],
    'presence_penalty' => [
        
    ],
    'repetition_penalty' => [
        
    ],
    'stop' => [
        
    ],
    'temperature' => [
        
    ],
    'top_p' => [
        
    ],
    'top_k' => [
        
    ],
    'min_p' => [
        
    ],
    'logit_bias' => [
        
    ],
    'logprobs' => [
        
    ],
    'best_of' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.highwayapi.ai/openai/v1/completions"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"max_tokens\": 123,\n  \"stream\": {},\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"n\": {},\n  \"seed\": {},\n  \"frequency_penalty\": {},\n  \"presence_penalty\": {},\n  \"repetition_penalty\": {},\n  \"stop\": {},\n  \"temperature\": {},\n  \"top_p\": {},\n  \"top_k\": {},\n  \"min_p\": {},\n  \"logit_bias\": {},\n  \"logprobs\": {},\n  \"best_of\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.highwayapi.ai/openai/v1/completions")
  .header("Content-Type", "<content-type>")
  .header("Authorization", "<authorization>")
  .body("{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"max_tokens\": 123,\n  \"stream\": {},\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"n\": {},\n  \"seed\": {},\n  \"frequency_penalty\": {},\n  \"presence_penalty\": {},\n  \"repetition_penalty\": {},\n  \"stop\": {},\n  \"temperature\": {},\n  \"top_p\": {},\n  \"top_k\": {},\n  \"min_p\": {},\n  \"logit_bias\": {},\n  \"logprobs\": {},\n  \"best_of\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.highwayapi.ai/openai/v1/completions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = '<authorization>'
request.body = "{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"max_tokens\": 123,\n  \"stream\": {},\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"n\": {},\n  \"seed\": {},\n  \"frequency_penalty\": {},\n  \"presence_penalty\": {},\n  \"repetition_penalty\": {},\n  \"stop\": {},\n  \"temperature\": {},\n  \"top_p\": {},\n  \"top_k\": {},\n  \"min_p\": {},\n  \"logit_bias\": {},\n  \"logprobs\": {},\n  \"best_of\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "choices": [
    {
      "finish_reason": "<string>",
      "index": 123,
      "logprobs": {
        "text_offset": [
          123
        ],
        "token_logprobs": [
          123
        ],
        "tokens": [
          "<string>"
        ],
        "top_logprobs": [
          {
            "{key}": 123
          }
        ]
      },
      "text": "<string>"
    }
  ],
  "created": 123,
  "id": "<string>",
  "model": "<string>",
  "object": "<string>",
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123
  }
}

POST

openai

completions

Crear solicitud de conversación

curl --request POST \
  --url https://api.highwayapi.ai/openai/v1/completions \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "model": "<string>",
  "prompt": "<string>",
  "max_tokens": 123,
  "stream": {},
  "stream_options": {
    "include_usage": true
  },
  "n": {},
  "seed": {},
  "frequency_penalty": {},
  "presence_penalty": {},
  "repetition_penalty": {},
  "stop": {},
  "temperature": {},
  "top_p": {},
  "top_k": {},
  "min_p": {},
  "logit_bias": {},
  "logprobs": {},
  "best_of": 123
}
'

import requests

url = "https://api.highwayapi.ai/openai/v1/completions"

payload = {
    "model": "<string>",
    "prompt": "<string>",
    "max_tokens": 123,
    "stream": {},
    "stream_options": { "include_usage": True },
    "n": {},
    "seed": {},
    "frequency_penalty": {},
    "presence_penalty": {},
    "repetition_penalty": {},
    "stop": {},
    "temperature": {},
    "top_p": {},
    "top_k": {},
    "min_p": {},
    "logit_bias": {},
    "logprobs": {},
    "best_of": 123
}
headers = {
    "Content-Type": "<content-type>",
    "Authorization": "<authorization>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', Authorization: '<authorization>'},
  body: JSON.stringify({
    model: '<string>',
    prompt: '<string>',
    max_tokens: 123,
    stream: {},
    stream_options: {include_usage: true},
    n: {},
    seed: {},
    frequency_penalty: {},
    presence_penalty: {},
    repetition_penalty: {},
    stop: {},
    temperature: {},
    top_p: {},
    top_k: {},
    min_p: {},
    logit_bias: {},
    logprobs: {},
    best_of: 123
  })
};

fetch('https://api.highwayapi.ai/openai/v1/completions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.highwayapi.ai/openai/v1/completions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => '<string>',
    'prompt' => '<string>',
    'max_tokens' => 123,
    'stream' => [
        
    ],
    'stream_options' => [
        'include_usage' => true
    ],
    'n' => [
        
    ],
    'seed' => [
        
    ],
    'frequency_penalty' => [
        
    ],
    'presence_penalty' => [
        
    ],
    'repetition_penalty' => [
        
    ],
    'stop' => [
        
    ],
    'temperature' => [
        
    ],
    'top_p' => [
        
    ],
    'top_k' => [
        
    ],
    'min_p' => [
        
    ],
    'logit_bias' => [
        
    ],
    'logprobs' => [
        
    ],
    'best_of' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.highwayapi.ai/openai/v1/completions"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"max_tokens\": 123,\n  \"stream\": {},\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"n\": {},\n  \"seed\": {},\n  \"frequency_penalty\": {},\n  \"presence_penalty\": {},\n  \"repetition_penalty\": {},\n  \"stop\": {},\n  \"temperature\": {},\n  \"top_p\": {},\n  \"top_k\": {},\n  \"min_p\": {},\n  \"logit_bias\": {},\n  \"logprobs\": {},\n  \"best_of\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.highwayapi.ai/openai/v1/completions")
  .header("Content-Type", "<content-type>")
  .header("Authorization", "<authorization>")
  .body("{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"max_tokens\": 123,\n  \"stream\": {},\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"n\": {},\n  \"seed\": {},\n  \"frequency_penalty\": {},\n  \"presence_penalty\": {},\n  \"repetition_penalty\": {},\n  \"stop\": {},\n  \"temperature\": {},\n  \"top_p\": {},\n  \"top_k\": {},\n  \"min_p\": {},\n  \"logit_bias\": {},\n  \"logprobs\": {},\n  \"best_of\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.highwayapi.ai/openai/v1/completions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = '<authorization>'
request.body = "{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"max_tokens\": 123,\n  \"stream\": {},\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"n\": {},\n  \"seed\": {},\n  \"frequency_penalty\": {},\n  \"presence_penalty\": {},\n  \"repetition_penalty\": {},\n  \"stop\": {},\n  \"temperature\": {},\n  \"top_p\": {},\n  \"top_k\": {},\n  \"min_p\": {},\n  \"logit_bias\": {},\n  \"logprobs\": {},\n  \"best_of\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "choices": [
    {
      "finish_reason": "<string>",
      "index": 123,
      "logprobs": {
        "text_offset": [
          123
        ],
        "token_logprobs": [
          123
        ],
        "tokens": [
          "<string>"
        ],
        "top_logprobs": [
          {
            "{key}": 123
          }
        ]
      },
      "text": "<string>"
    }
  ],
  "created": 123,
  "id": "<string>",
  "model": "<string>",
  "object": "<string>",
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123
  }
}

Genera una respuesta del modelo según el prompt y los parámetros especificados

Encabezados de solicitud

Content-Type

string

requerido

Valores enumerados: application/json

Authorization

string

requerido

Formato de autenticación Bearer: Bearer {{API Key}}.

Cuerpo de la solicitud

model

string

requerido

Nombre del modelo correspondiente. Para consultar los nombres de modelos disponibles, consulta la biblioteca de modelos en JieKou AI.

prompt

string

requerido

Prompt utilizado para generar la conversación (el prompt puede ser una cadena, un array de cadenas, un array de tokens o un array de arrays de tokens).

max_tokens

integer

Número máximo de tokens que se pueden generar al crear la conversación.
La cantidad de tokens del prompt más max_tokens no puede superar la longitud de contexto del modelo.

stream

boolean | null

Indica si se usa transmisión en streaming. El valor predeterminado es false; si se establece, los tokens se enviarán como data-only server-sent events (SSE) y el flujo finalizará con un mensaje data: [DONE].

stream_options

object

Opciones de respuesta en streaming. Solo se establece cuando stream está configurado como true.

Mostrar propiedades

include_usage

boolean

Si se establece, se transmitirá un chunk adicional antes del mensaje data: [DONE]. El campo usage de este chunk muestra las estadísticas de uso de tokens de toda la solicitud, mientras que el campo choices siempre es un array vacío. Todos los demás chunks también incluirán un campo usage, pero su valor será null.

integer | null

Cuántas conversaciones generar para cada prompt. El valor predeterminado es 1.

Nota: dado que este parámetro genera varias conversaciones, puede consumir rápidamente tu cuota de facturación de tokens. Úsalo con precaución y asegúrate de establecer valores razonables para max_tokens y stop.
Rango requerido: 1 < x < 128

seed

integer | null

Si se especifica, nuestro sistema hará todo lo posible para realizar un muestreo determinista, de modo que las solicitudes repetidas con la misma seed y los mismos parámetros deberían devolver el mismo resultado.

frequency_penalty

number | null

El valor predeterminado es 0. Los valores positivos penalizan los nuevos tokens según su frecuencia de aparición en el texto actual, reduciendo así la probabilidad de que el modelo repita el mismo contenido.

Si el objetivo es simplemente reducir muestras repetitivas, los valores razonables están aproximadamente entre 0.1 y 1. Si el objetivo es inhibir fuertemente la repetición, el coeficiente puede aumentarse hasta 2, pero esto puede reducir notablemente la calidad de las muestras. Los valores negativos pueden usarse para aumentar la probabilidad de repetición.

Consulta también presence_penalty, que penaliza a una tasa fija los tokens que aparecen al menos una vez
Rango requerido: -2 < x < 2

presence_penalty

number | null

El valor predeterminado es 0. Los valores positivos penalizan los nuevos tokens según si aparecen en el texto actual, aumentando así la probabilidad de que el modelo hable de temas nuevos.

Si el objetivo es reducir ligeramente las muestras repetitivas, los valores razonables están aproximadamente entre 0.1 y 1. Si el objetivo es inhibir fuertemente la repetición, el coeficiente puede aumentarse hasta 2, pero esto puede reducir significativamente la calidad de las muestras. Los valores negativos pueden usarse para aumentar la probabilidad de repetición.

Consulta también frequency_penalty, que penaliza a una tasa incremental según la frecuencia con la que aparecen los tokens
Rango requerido: -2 < x < 2

repetition_penalty

number | null

Aplica una penalización a los tokens repetidos para inhibir o fomentar la repetición. Un valor de 1.0 significa que no hay penalización y permite la repetición libre. Los valores mayores que 1.0 penalizan la repetición, reduciendo la probabilidad de tokens repetidos. Los valores entre 0.0 y 1.0 recompensan la repetición, aumentando la probabilidad de tokens repetidos. Para lograr un buen equilibrio, normalmente se recomienda usar 1.2. Ten en cuenta que, en modelos solo decodificadores, la penalización se aplica tanto a la salida generada como al prompt.
Rango requerido: 0 < x < 2

stop

string | null

Hasta 4 secuencias en las que la API dejará de generar más tokens. El texto devuelto incluye la secuencia de parada.

temperature

number | null

Grado de aleatoriedad en la conversación; el valor predeterminado es 1 y está entre 0 y 2. Los valores más altos (como 0.8) hacen que la salida sea más aleatoria, mientras que los valores más bajos (como 0.2) hacen que la salida sea más enfocada y determinista.

Por lo general, recomendamos ajustar solo este parámetro o top_p, pero no ambos al mismo tiempo.
Rango requerido: 0 < x < 2

top_p

number | null

Como alternativa a temperature, llamada nucleus sampling, el modelo considera los resultados de los tokens con una masa de probabilidad top_p. Por lo tanto, 0.1 significa que solo se consideran los tokens que constituyen el 10% superior de la masa de probabilidad. Por lo general, recomendamos ajustar solo este parámetro o temperature, pero no ambos al mismo tiempo.
Rango requerido: 0 < x ≤ 1

top_k

integer | null

El muestreo Top-k es otro método de muestreo en el que se filtran los k tokens siguientes más probables y la masa de probabilidad se redistribuye únicamente entre esos k tokens. El valor de k controla la cantidad de candidatos para el siguiente token en cada paso de generación de texto.
Rango requerido: 1 < x < 128

min_p

number | null

Valor flotante que representa la probabilidad mínima para que un token sea considerado, en relación con la probabilidad del token más probable.
Rango requerido: 0 ≤ x ≤ 1

logit_bias

map[string, integer]

El valor predeterminado es null. Modifica la probabilidad de que los tokens especificados aparezcan en la conversación. Acepta un objeto JSON que asigna tokens a un valor de sesgo asociado de -100 a 100.

logprobs

integer | null

Devuelve las probabilidades logarítmicas de los logprobs tokens de salida más probables, incluyendo también la probabilidad del token seleccionado. Por ejemplo, si logprobs se establece en 5, la API devolverá una lista de las probabilidades logarítmicas de los 5 tokens más probables en cada paso de generación.
El valor máximo de logprobs es 5.

best_of

integer

El valor predeterminado es 1. Genera best_of conversaciones y las procesa en el servidor, devolviendo la “mejor” (es decir, la que tiene la probabilidad logarítmica más alta por token). Los resultados no se pueden transmitir en streaming.

Cuando se usa junto con n, best_of controla el número de conversaciones candidatas y n especifica cuántas conversaciones se devuelven. best_of debe ser mayor que n.

Nota: dado que este parámetro genera varias conversaciones, puede consumir rápidamente tu cuota de facturación de tokens. Úsalo con precaución y asegúrate de establecer valores razonables para max_tokens y stop.

Información de respuesta

choices

object[]

requerido

Lista de opciones de conversación generadas.

Ocultar propiedades

finish_reason

string

requerido

Motivo por el que el modelo dejó de generar tokens. Será ‘stop’ si el modelo encontró un punto de parada natural o una secuencia de parada proporcionada; será ‘length’ si se alcanzó el número máximo de tokens especificado en la solicitud. Valores enumerados: stop,length.

index

integer

requerido

Índice de la opción de conversación.

logprobs

object

requerido

Probabilidades logarítmicas de los tokens más probables.

Ocultar propiedades

text_offset

integer[]

Array de enteros de desplazamiento de texto.

token_logprobs

number[]

Array de números de probabilidades logarítmicas de tokens.

tokens

string[]

Array de cadenas de tokens.

top_logprobs

object[]

Array de objetos que contienen las probabilidades logarítmicas top.

Mostrar propiedades

{key}

integer

requerido

Valor de probabilidad logarítmica para la clave dada.

text

string

requerido

Contenido devuelto por la conversación.

created

integer

requerido

Marca de tiempo Unix en la que se generó la respuesta (en segundos).

string

requerido

Identificador único de la respuesta.

model

string

requerido

Modelo utilizado para la conversación.

object

string

requerido

Tipo de objeto, siempre text_completion.

usage

object

requerido

Estadísticas de uso.
Para respuestas en streaming, el campo usage se incluye en el último bloque de respuesta devuelto.

Ocultar propiedades

completion_tokens

integer

requerido

Número de tokens generados por la conversación.

prompt_tokens

integer

requerido

Número de tokens en el prompt.

total_tokens

integer

requerido

Número total de tokens usados en la solicitud (prompt + completion).

Crear solicitud de conversación de chat

FLUX.1 Kontext Dev

Conceptos básicos de API

Modelos de lenguaje

Imágenes

Vídeo

Audio

Crear solicitud de conversación

Encabezados de solicitud

Cuerpo de la solicitud

Información de respuesta

​Encabezados de solicitud

​Cuerpo de la solicitud

​Información de respuesta

Encabezados de solicitud

Cuerpo de la solicitud

Información de respuesta