Saltar al contenido

Create a document version

Módulo Knowledge

POST/document-versionsdocumentVersions.create

An immutable version of a document. Creates a document version. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad knowledge.document.write.
  • Alcances de OAuth: knowledge.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: DocumentVersionCreate

documentVersions.create: DocumentVersionCreate
CampoTipoObligatorioDescripción
document_idstring (uuid)SíIdentifier of the document.
storage_uristringSíWhere the file is stored.Restricciones: length 1 to 2000
checksum_sha256stringSíSHA-256 of the file, lowercase hex.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "storage_uri": "https://files.example.com/site-plan-v3.pdf",
  "checksum_sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"
}

Respuesta 201: DocumentVersion

documentVersions.create: DocumentVersion
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the document version.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
document_idstring (uuid)SíIdentifier of the document.
version_numberintegerSíVersion number.Restricciones: range 1 to any
storage_uristringSíWhere the file is stored.Restricciones: length 1 to 2000
checksum_sha256stringSíSHA-256 of the file, lowercase hex.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "version_number": 3,
  "storage_uri": "https://files.example.com/site-plan-v3.pdf",
  "checksum_sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/document-versions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"document_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","storage_uri":"https://files.example.com/site-plan-v3.pdf","checksum_sha256":"9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"}'
const { data } = await xos.documentVersions.create({
    "document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "storage_uri": "https://files.example.com/site-plan-v3.pdf",
    "checksum_sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"
  });
response = xos.document_versions.create({"document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "storage_uri": "https://files.example.com/site-plan-v3.pdf", "checksum_sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"})
xos document-versions create --data '{"document_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","storage_uri":"https://files.example.com/site-plan-v3.pdf","checksum_sha256":"9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"}'