Texte
Créer une réponse
Crée une réponse en utilisant le format de l'API OpenAI Responses
Utilisez ce point de terminaison lorsque les accepted_request_formats d'un modèle incluent openai_responses. Les requêtes et les réponses utilisent le format de l'API Responses et ne sont pas converties : un modèle ne prenant pas en charge ce format renverra une erreur 400 ici ; utilisez donc Chat Completions pour celui-ci. Les champs optionnels et les valeurs prises en charge dépendent du modèle sélectionné.
Corps de la requête
ID du modèle à utiliser. Voir Modèles pour les options disponibles.
Entrée pour la réponse. Elle est optionnelle lorsque la requête utilise plutôt un prompt réutilisable ou poursuit une réponse stockée avec previous_response_id.
Chaque élément est un objet avec un type. Les types courants sont :
message: Un message de conversation avec un rôle et un contenufunction_call: Une requête d'appel de fonctionfunction_call_output: Résultat d'un appel de fonctionreasoning: Un élément de réflexion provenant d'une réponse précédente. Renvoyez-le tel quel
Les autres types d'éléments dépendent du modèle sélectionné.
Pour une entrée multimodale, message.content peut être soit une chaîne de caractères simple, soit un tableau de blocs de contenu. Pour les modèles capables de traiter des images, transmettez les images sous forme de blocs input_image au lieu d'intégrer directement des URL ou des chaînes Base64 dans le texte brut.
Exemples de blocs de contenu :
{ "type": "input_text", "text": "Décris cette image" }{ "type": "input_image", "image_url": "https://example.com/image.jpg" }{ "type": "input_image", "image_url": "data:image/png;base64,..." }
Instructions système pour le modèle (équivalent au message système).
Nombre maximum de jetons à générer.
Température d'échantillonnage. Les valeurs prises en charge et les valeurs par défaut dépendent du modèle sélectionné.
Outils que le modèle peut appeler. Les types et combinaisons pris en charge dépendent du modèle sélectionné.
falseSi défini sur true, renvoie un flux d'événements. Voir Streaming.
ID d'une réponse précédente pour poursuivre la conversation. La réponse doit appartenir à votre compte et être toujours stockée ; sinon, la requête renvoie 404 avec le code response_not_found. Poursuivez avec le modèle qui a généré cette réponse. Si le service ayant produit la réponse est temporairement indisponible, la requête peut renvoyer 503.
trueIndique s'il faut stocker la réponse pour une récupération ultérieure et pour previous_response_id. Avec false, TokenLab ne conserve pas la réponse et GET /v1/responses/{id} ne pourra pas la renvoyer.
falseDemande une exécution asynchrone. La prise en charge dépend du modèle sélectionné. L'appel de création renvoie immédiatement, généralement avec un status queued ou in_progress. Interrogez Récupérer une réponse jusqu'à ce que le status soit completed, incomplete, failed ou cancelled. Une requête en arrière-plan peut renvoyer 503 si le traitement en arrière-plan est temporairement indisponible.
Politique de choix d'outil, telle que auto, none, required, ou un objet nommant un outil spécifique. Les valeurs prises en charge dépendent du modèle sélectionné.
Sections de sortie supplémentaires à renvoyer, lorsque le modèle sélectionné les prend en charge.
Options de streaming. include_obfuscation est transmis lorsque le modèle sélectionné le prend en charge.
Stratégie de troncature pour les longues conversations, lorsque le modèle sélectionné la prend en charge.
TokenLab sert et facture les requêtes Responses au niveau de service standard. auto et default sont acceptés. Les autres valeurs, telles que flex ou priority, sont supprimées de la requête et celle-ci est facturée au tarif standard.
Référence à un modèle de prompt réutilisable et ses variables.
Métadonnées personnalisées stockées avec la réponse.
Paramètres de sortie de texte. La prise en charge de text.format dépend du modèle sélectionné.
Indique s'il faut autoriser plusieurs appels d'outils en parallèle, lorsque le modèle sélectionné le prend en charge.
Paramètre d'échantillonnage Nucleus (0-1).
Les options de raisonnement, y compris effort, dépendent du modèle sélectionné.
Réponse
Identifiant unique de la réponse.
Toujours response.
Horodatage Unix de la création de la réponse.
État de la réponse : queued, in_progress, completed, incomplete, failed ou cancelled. Vérifiez ce champ même lorsque la requête HTTP réussit.
Liste des éléments de sortie générés par le modèle.
Statistiques d'utilisation des jetons.
Points de terminaison associés
GET /v1/responses/{id}récupère une réponse stockée.DELETE /v1/responses/{id}supprime une réponse stockée. Cela n'annule pas la génération.POST /v1/responses/compactcompresse une conversation et renvoie un objetresponse.compaction.wss://api.tokenlab.sh/v1/responsescrée des réponses via WebSocket. Voir Streaming.- Les points de terminaison d'annulation, d'éléments d'entrée et de jetons d'entrée ne sont pas disponibles actuellement.
Requête
curl -X POST "https://api.tokenlab.sh/v1/responses" \
-H "Authorization: Bearer sk-your-api-key" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-5.6-terra",
"input": [
{"type": "message", "role": "user", "content": "Hello!"}
],
"max_output_tokens": 1000
}'from openai import OpenAI
client = OpenAI(
api_key="sk-your-api-key",
base_url="https://api.tokenlab.sh/v1"
)
response = client.responses.create(
model="gpt-5.6-terra",
input=[
{"type": "message", "role": "user", "content": "Hello!"}
],
max_output_tokens=1000
)
print(response.output)import OpenAI from 'openai';
const client = new OpenAI({
apiKey: 'sk-your-api-key',
baseURL: 'https://api.tokenlab.sh/v1'
});
const response = await client.responses.create({
model: 'gpt-5.6-terra',
input: [
{ type: 'message', role: 'user', content: 'Hello!' }
],
max_output_tokens: 1000
});
console.log(response.output);package main
import (
"bytes"
"encoding/json"
"fmt"
"net/http"
)
func main() {
payload := map[string]interface{}{
"model": "gpt-5.6-terra",
"input": []map[string]interface{}{
{"type": "message", "role": "user", "content": "Hello!"},
},
"max_output_tokens": 1000,
}
body, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.tokenlab.sh/v1/responses", bytes.NewBuffer(body))
req.Header.Set("Authorization", "Bearer sk-your-api-key")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
var result map[string]interface{}
json.NewDecoder(resp.Body).Decode(&result)
fmt.Println(result["output"])
}<?php
$ch = curl_init('https://api.tokenlab.sh/v1/responses');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'Authorization: Bearer sk-your-api-key'
],
CURLOPT_POSTFIELDS => json_encode([
'model' => 'gpt-5.6-terra',
'input' => [
['type' => 'message', 'role' => 'user', 'content' => 'Hello!']
],
'max_output_tokens' => 1000
])
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data['output']);Exemple d'entrée Vision
Utilisez des modèles capables de traiter des images en plaçant les images dans message.content sous forme de blocs input_image. La valeur image_url peut être une URL publique ou une URL de données Base64.
{
"model": "gpt-5.6-terra",
"input": [
{
"type": "message",
"role": "user",
"content": [
{
"type": "input_text",
"text": "Please describe this image."
},
{
"type": "input_image",
"image_url": "https://example.com/demo.jpg"
}
]
}
]
}{
"model": "gpt-5.6-terra",
"input": [
{
"type": "message",
"role": "user",
"content": [
{
"type": "input_text",
"text": "Please describe this image."
},
{
"type": "input_image",
"image_url": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ..."
}
]
}
]
}Réponse
{
"id": "resp_abc123",
"object": "response",
"created_at": 1706000000,
"status": "completed",
"model": "gpt-5.6-terra",
"output": [
{
"id": "msg_abc123",
"type": "message",
"status": "completed",
"role": "assistant",
"content": [
{"type": "output_text", "text": "Hello! How can I help you today?", "annotations": []}
]
}
],
"usage": {
"input_tokens": 10,
"output_tokens": 12,
"total_tokens": 22
}
}Erreurs
Les erreurs utilisent l'objet error de style OpenAI. Cas courants : 400 pour un champ invalide ou un modèle sans le format Responses, 401 pour une clé invalide, 402 pour un solde insuffisant, 404 pour un previous_response_id inconnu, 429 pour la limite de débit, et 503 lorsque le modèle ne peut pas traiter la requête pour le moment. Voir Gérer les erreurs API.
Autorisation
BearerAuth Authentification par clé API. Créez ou gérez vos clés API dans Dashboard > API > API Keys.
Emplacement: header
En-têtes
Politique de livraison par requête. Remplace les valeurs par défaut de la clé API et de l'espace de travail. Tente automatiquement TokenLab Verified en premier et peut basculer une fois vers Official uniquement avant la sortie, l'acceptation de la requête ou la création de ressource persistante.
Valeurs possibles
- "auto"
- "verified"
- "official"
Clé optionnelle qui empêche une seconde exécution de la même requête. Envoyez une nouvelle valeur unique, telle qu'un UUID, pour chaque requête, et conservez-la pour les tentatives après un délai d'attente. Une tentative avec la même clé ne s'exécute pas à nouveau : elle renvoie 409 avec idempotency_replay_unavailable, ou généralement idempotency_conflict si le corps a changé. Exception : lorsqu'un résultat sans flux se termine après la déconnexion du client, une tentative avec la même clé et le même corps dans les 24 heures renvoie ce résultat (jusqu'à 1 Mo) avec l'en-tête Idempotent-Replayed: true sans facturation supplémentaire. Une clé de plus de 255 caractères est ignorée et la requête n'a alors aucune protection d'idempotence. Avec background: true, une tentative avec la même clé et le même corps renvoie l'objet de réponse original sans créer ni facturer une seconde réponse ; un corps différent est rejeté et son code de statut n'est pas garanti. Voir Retry safely with an idempotency key.
1 <= length <= 255Corps de la requête
application/json
Réponse
application/json
application/json
application/json
application/json
application/json