Referencia de la API
Detección de texto
Detecta las etiquetas de texto de una imagen antes de modificarlas mediante una edición `replace_text`.
Solicitud y respuesta#
POST /images/text-detections con {"image": "<file_id>"} y un Idempotency-Key. Ámbito requerido: figures:generate. Gratis. Responde de forma síncrona con 200:
{
"id": "c222cd46-d923-4abf-aa28-cdc72ad06623",
"object": "text_detection",
"width": 2048,
"height": 1536,
"texts": [
{ "index": 0, "text": "Nucleus", "corners": [{ "x": 75, "y": 260 }, { "x": 241, "y": 260 }, { "x": 241, "y": 295 }, { "x": 75, "y": 295 }] }
]
}textssigue el orden de lectura;cornerscontiene las coordenadas en píxeles de cada etiqueta en la imagen.- Repetir la misma clave devuelve la misma detección sin ejecutarla de nuevo; la misma clave con otra imagen devuelve
409 IDEMPOTENCY_CONFLICT. - Las detecciones comparten con el sitio web el límite de 20 cada 15 minutos por cuenta; al superarlo, la respuesta es
429 RATE_LIMITED. - Pasa el
idcon la misma imagen a una ediciónreplace_text. Solo funciona con esa imagen y tu cuenta. - La imagen es un
file_idde PNG, JPEG o WebP. Un fallo temporal del reconocimiento de texto devuelve503 SERVICE_UNAVAILABLEconRetry-After: reintenta con la misma clave. Una detección ejecutada sin resultado devuelve502 TASK_FAILEDconTEXT_DETECTION_FAILED: envíala de nuevo con una clave nueva.
cURL#
curl -X POST https://scifig.ai/api/v1/images/text-detections \
-H "Authorization: Bearer $SCIFIG_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Prefer: wait=25" \
-H "Content-Type: application/json" \
-d '{
"image": "<file_id>"
}'JavaScript#
const response = await fetch('https://scifig.ai/api/v1/images/text-detections', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.SCIFIG_API_KEY}`,
'Idempotency-Key': crypto.randomUUID(),
Prefer: 'wait=25',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"image": "<file_id>"
}),
});
const result = await response.json();
console.log(response.status, result);Python#
import os
import uuid
import requests
headers = {
"Authorization": f"Bearer {os.environ['SCIFIG_API_KEY']}",
"Idempotency-Key": str(uuid.uuid4()),
"Prefer": "wait=25",
}
response = requests.post(
"https://scifig.ai/api/v1/images/text-detections",
headers=headers,
json={
"image": "<file_id>"
},
timeout=60,
)
print(response.status_code, response.json())