La référence de l'API est publiée en anglais.

Declare a chunked organization import transfer

POST/api/companies/import/transfers
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Declare a chunked organization import transfer.

Declares the caller's existing organization package .zip as content-addressed byte-range parts (whole-file plus per-part sha256). Re-declaring the same zip resumes the prior transfer with its uploaded parts intact; the response carries the transfer id and the part indexes still missing.

Autorisation

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Fonctionnement des clés.

Corps de la requête

application/json · obligatoire

totalBytesintegerObligatoire≥ 1
zipSha256stringObligatoirepattern: ^[0-9a-f]{64}$
partSizeBytesintegerObligatoire≥ 1
partsarray<object>Obligatoire
parts[].indexintegerObligatoire≥ 0
parts[].byteSizeintegerObligatoire≥ 1
parts[].sha256stringObligatoirepattern: ^[0-9a-f]{64}$

Réponses

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Organizations