Saltar a contenido

Exportaciones por la API

Esta página es para quien toma una exportación con un programa propio o desde la línea de comandos: pedirla, esperar a que esté lista, descargar sus partes y reanudar una descarga interrumpida. Qué es una exportación y qué contiene está en Exportaciones. Cómo haces una solicitud a OS (dirección, inicio de sesión, páginas, errores) está en La API de acceso.

Pedir una exportación de tu organización

curl -s -X POST "$OS/api/v1/organisations/$ORG/exports" \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{}'
{"id": "xpt_...", "scope": "organisation", "membership_id": null, "include_core": false,
 "status": "queued", "size_bytes": null, "sha256": null, "counts": {}, "withheld": {},
 "core": null, "downloads": 0, "created_at": "2026-10-17T09:14:03Z", "completed_at": null,
 "expires_at": null, "allowed_actions": ["see", "use", "write"], "...": "..."}
  • Indica "membership_id": "mem_..." para la exportación de un miembro.
  • "include_core": true pide también la parte de las funciones de IA; solo Artific puede, para cualquier otro OS responde 403.
Respuesta Significado
202 Pedida, o la misma sigue en curso; Location apunta a ella.
404 No puedes ver exportaciones aquí, o el miembro no es de esta organización.
409 La organización se está creando o eliminando.
429 Se pidieron cinco exportaciones en el último día.

Esperar a que esté lista

curl -s "$OS/api/v1/organisations/$ORG/exports/$EXPORT" -H "Authorization: Bearer $TOKEN"

Pregunta de nuevo cada minuto más o menos hasta que status sea ready. Quien la pidió también recibe una notificación. Una exportación failed dice por qué en error, como too_large (pregunta a Artific) o requester_lost_access; pide una nueva. GET .../exports lista las exportaciones de la organización, la más reciente primero.

Descargar una parte

curl -s -o export-os.zip "$OS/api/v1/organisations/$ORG/exports/$EXPORT/parts/os" \
  -H "Authorization: Bearer $TOKEN" -D headers.txt
  • Las partes son os y, si se pidió, core.
  • Digest: sha-256=<hex> es el SHA-256 de la parte entera: compáralo con el de tu archivo.
  • Necesitas use sobre export; sin él OS responde 403.
Respuesta Significado
200 La parte entera.
206 La parte desde el byte que indicaste.
409 Aún no está lista, o ha caducado.
416 El byte indicado está más allá del final; Content-Range da la longitud.

Reanudar una descarga interrumpida

size=$(wc -c < export-os.zip)
curl -s "$OS/api/v1/organisations/$ORG/exports/$EXPORT/parts/os" \
  -H "Authorization: Bearer $TOKEN" -H "Range: bytes=$size-" >> export-os.zip

Una descarga puede durar hasta seis horas, y se detiene cuando pasa un minuto sin ningún byte. Reanúdala tantas veces como necesites hasta que caduque la exportación.

Tu propia exportación

curl -s -X POST "$OS/api/v1/me/exports" -H "Authorization: Bearer $TOKEN"
curl -s "$OS/api/v1/me/exports/$EXPORT" -H "Authorization: Bearer $TOKEN"
{"id": "pxp_...", "status": "ready", "size_bytes": 18230, "sha256": "...",
 "parts": [{"organisation_id": "org_...", "include_core": true, "ready": true}],
 "expires_at": "2026-10-20T09:21:40Z", "...": "..."}
Parte Descarga
tu cuenta GET /api/v1/me/exports/$EXPORT/parts/account
los registros de OS sobre ti en una organización GET /api/v1/me/exports/$EXPORT/parts/os/$ORG
tu trabajo en las funciones de IA allí GET /api/v1/me/exports/$EXPORT/parts/core/$ORG, donde include_core es true

Mientras te están eliminando, OS responde 409, y no pides una exportación nueva.