Diagrams

Download the whole history

Every version in one file, as JSON Lines: a header line ({ format: "zindex-history/1", chain: "zindex-chain/1", id, key, title, revisions, note?, exportedAt }), then one line per version, oldest first: { revision, at, by, actor, client, message, hash, chain, scene, image }, where by is as in the history, actor is { userId, credential, credentialId } (credentialId is the key's or connected app's ID, null for a session), and image is the version's stored picture: { hash, engine, renderedAt, backfilled, svg }, left out when the server stores no images. hash is the SHA-256 of scene's RFC 8785 form, image.hash of svg's UTF-8 bytes, and chain links each version to the one before, so the file can be checked without Zindex: https://zindex.ai/docs/concepts/#verifying. Sent as a download (Content-Disposition: attachment).

get/v1/diagrams/{id}/export

Request

  • Base URL: https://api.zindex.ai
  • URL: https://api.zindex.ai/v1/diagrams/{id}/export
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

The diagram's ID or key

Response

The history as JSON Lines

Changes

No recorded changes to this operation across all 1 revision of this API.