Logotipo de PDFHQ

Documentos

DocumentaciónPrimeros pasos

Inicio Rápido de API

Tu primera tarea de procesamiento PDFHQ usando carga firmada, archivo verificado y tarea asincrónica.

Claves de API del lado del servidor Cargas de almacenamiento firmadas

Primera solicitud exitosa#

Genera una clave API del proyecto HQTools en el servidor. Inicia una tarea, carga un PDF real con su recuento de bytes correcto y SHA-256, completa la carga, adjunta su ID y pone en cola la operación.

Programming language: cURL

Elige un idioma · desplázate horizontalmente para los 10 idiomas de SDK

API example · cURL
# Server-side API calls. Save the returned task_id.
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks' \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"tool":"compress"}'

# Upload and verify 1 PDF(s), then obtain and approve a credit quote:
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID/quote' -H 'x-api-key: YOUR_API_KEY'

# ONLY after explicit customer approval:
test "$PDFHQ_APPROVE_QUOTE" = yes || { echo "Approval required" >&2; exit 1; }
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks/TASK_ID/process' \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"options":{"compression_level":"recommended"}}'

curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID' -H 'x-api-key: YOUR_API_KEY'

After starting a task, upload and verify PDFs, review the credit quote, and get explicit approval before processing. API keys belong on your server, never on signed storage uploads.

All 10 SDKs ↓Tutorial completo de Python ↓ Tutorial completo de Bash/cURL ↓ Todos los endpoints → Cargas directas → Manejo de errores →

Los paquetes descargables generados cubren solo el flujo de tareas. Los SDK de servicio completo requieren una especificación OpenAPI de tiempo de ejecución verificada; los SDK de tareas de Python, JavaScript y TypeScript transmiten cargas de archivos; los otros idiomas requieren cargas multiparte firmadas implementadas por el llamador.

Reintentos seguros e idempotentes en la creación de tareas →

Ejemplos completos listos para descargar: CLI de Python y Bash/cURL . Se detienen después de presupuestar a menos que apruebe explícitamente el procesamiento y admitan reanudar una tarea existente después de una respuesta incierta.

Secuencia cURL de firma y carga completada
# 1. Start a task. Save the task_id from its JSON response.
curl -X POST https://api.pdfhq.io/v1/tasks \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"tool":"compress"}'

# 2. Start a task-scoped upload. Use real file size and SHA-256 values.
curl -X POST https://api.pdfhq.io/v1/tasks/TASK_ID/uploads \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"filename":"report.pdf","size_bytes":12345,"sha256":"ACTUAL_64_CHAR_DIGEST","content_type":"application/pdf"}'

# 3. POST signed "fields" plus binary file directly to returned S3 "url".
#    Then complete it; PDFHQ automatically attaches the verified file.
curl -X POST https://api.pdfhq.io/v1/tasks/TASK_ID/uploads/UPLOAD_ID/complete -H 'x-api-key: YOUR_API_KEY'

# 4. Queue work (safe to retry with IDENTICAL options), then poll until succeeded.
curl -X POST https://api.pdfhq.io/v1/tasks/TASK_ID/process \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"options":{"compression_level":"recommended"}}'
curl https://api.pdfhq.io/v1/tasks/TASK_ID -H 'x-api-key: YOUR_API_KEY'

# 5. Once succeeded, get a short-lived signed URL.
curl https://api.pdfhq.io/v1/tasks/TASK_ID/download-url -H 'x-api-key: YOUR_API_KEY'

Resultado exitoso#

Respuesta de inicio de tarea 201 (IDs ilustrativos)
{
  "task_id": "uuid",
  "tool": "compress",
  "status": "waiting",
  "upload_ids": [],
  "job_id": null,
  "progress": 0,
  "output_ready": false,
  "links": {
    "self": "/v1/tasks/uuid",
    "files": "/v1/tasks/uuid/files",
    "process": "/v1/tasks/uuid/process"
  }
}

La tarea avanza de espera a en cola/en ejecución/completada o fallida. Lee su estado antes de solicitar una URL de descarga.

Logotipo de PDFHQ

Herramientas PDF y análisis de documentos. Prepara, comprende y trabaja con tus documentos.

© 2026 PDFHQ. Todos los derechos reservados.