Detalle de solicitud de sincronización

Detalle de una solicitud de sincronización

curl --request GET \
  --url https://api.tupana.ai/v1/sync-requests/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.tupana.ai/v1/sync-requests/{id}', 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.tupana.ai/v1/sync-requests/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.tupana.ai/v1/sync-requests/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.tupana.ai/v1/sync-requests/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": 1042,
  "master_entity_id": 48213,
  "requested_types": [
    "ISSUED_DOCS",
    "RECEIVED_DOCS"
  ],
  "status": "completed",
  "webhook_url": "https://miapp.cl/webhooks/tupana-sync",
  "results": {
    "ISSUED_DOCS": {
      "success": true,
      "new_documents": 3
    },
    "RECEIVED_DOCS": {
      "success": true,
      "new_documents": 0
    }
  },
  "completed_at": "2026-07-20T14:34:12Z",
  "created_at": "2026-07-20T14:30:00Z"
}

{
  "detail": "No tienes acceso a esta entidad."
}

{
  "detail": "No encontrado."
}

GET

sync-requests

{id}

Detalle de una solicitud de sincronización

curl --request GET \
  --url https://api.tupana.ai/v1/sync-requests/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.tupana.ai/v1/sync-requests/{id}', 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.tupana.ai/v1/sync-requests/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.tupana.ai/v1/sync-requests/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.tupana.ai/v1/sync-requests/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": 1042,
  "master_entity_id": 48213,
  "requested_types": [
    "ISSUED_DOCS",
    "RECEIVED_DOCS"
  ],
  "status": "completed",
  "webhook_url": "https://miapp.cl/webhooks/tupana-sync",
  "results": {
    "ISSUED_DOCS": {
      "success": true,
      "new_documents": 3
    },
    "RECEIVED_DOCS": {
      "success": true,
      "new_documents": 0
    }
  },
  "completed_at": "2026-07-20T14:34:12Z",
  "created_at": "2026-07-20T14:30:00Z"
}

{
  "detail": "No tienes acceso a esta entidad."
}

{
  "detail": "No encontrado."
}

¿Para qué se usa?

Permite consultar el estado de una solicitud de sincronización creada con POST /sync-requests. Es el endpoint de polling del flujo asíncrono.

Qué hace

Devuelve el objeto completo de la solicitud: status (pending, processing, completed o failed), requested_types, completed_at y results.
Cuando la solicitud termina, results trae el resultado por tipo de scrape: cada clave es un scrape_type ejecutado y su valor incluye success más contadores como new_documents, o error si ese tipo falló.
Solo puedes consultar solicitudes de entidades a las que tienes acceso (si no, responde 403).

Ejemplos de uso

Polling después del POST: consultar cada algunos segundos hasta que status sea completed o failed, y recién ahí leer /documents.
Diagnóstico: si status es failed, revisar en results qué tipo falló y con qué error.

Authorizations

Authorization

string

header

required

API Key para autenticación. Debe proporcionarse en el header Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo 'Api-Key ' seguido de tu API key)

Path Parameters

integer

required

ID de la solicitud de sincronización (campo id de la respuesta del POST).

Example:

1042

Response

Detalle de la solicitud, con resultados por tipo si ya terminó

Solicitud de sincronización a demanda (recurso asíncrono)

string

ID de la solicitud Id opaco (eid_...); la entrada acepta también el entero.

Example:

"eid_NDgyMTM6c2lnbmF0dXJl"

master_entity_id

string

ID entero de la entidad sincronizada Id opaco (eid_...); la entrada acepta también el entero.

Example:

"eid_NDgyMTM6c2lnbmF0dXJl"

requested_types

enum<string>[]

Tipos de scrape pedidos. Lista vacía = todos los tipos habilitados para la entidad.

Available options:

ISSUED_DOCS,

RECEIVED_DOCS,

RECEIVED_HONORARY_BILLS,

THIRD_PARTY_HONORARY,

EMITTED_HONORARY_BILLS,

PURCHASE_BOOK,

SALE_BOOK,

BOOK_SUMMARY

Example:

["ISSUED_DOCS", "RECEIVED_DOCS"]

status

enum<string>

Estado de la solicitud: pending (creada, en cola), processing (scrapes corriendo), completed (todos los tipos terminaron OK), failed (al menos un tipo falló).

Available options:

pending,

processing,

completed,

failed

Example:

"pending"

webhook_url

string

URL registrada para notificar al completar. String vacío si no se registró webhook.

Example:

"https://miapp.cl/webhooks/tupana-sync"

results

object

Resultado por tipo de scrape al terminar. Las claves son los scrape_type ejecutados y cada valor es un objeto con success (boolean) más contadores como new_documents, o error si falló. Objeto vacío mientras la solicitud está pending/processing.

Show child attributes

Example:

{
  "ISSUED_DOCS": { "success": true, "new_documents": 3 },
  "RECEIVED_DOCS": { "success": true, "new_documents": 0 }
}

completed_at

string<date-time> | null

Fecha/hora en que terminó de procesarse. null mientras está pending/processing.

Example:

"2026-07-20T14:34:12Z"

created_at

string<date-time>

Fecha/hora de creación de la solicitud

Example:

"2026-07-20T14:30:00Z"

Introducción

Resumen de Libros

Sincronización

Detalle de solicitud de sincronización

¿Para qué se usa?

Qué hace

Ejemplos de uso

Authorizations

Path Parameters

Response

​¿Para qué se usa?

​Qué hace

​Ejemplos de uso

Authorizations

Path Parameters

Response

¿Para qué se usa?

Qué hace

Ejemplos de uso