Diagrams

Make a diagram public or private

public makes the diagram readable by anyone at https://zindex.ai/d/{id}: its scene, title, description and every version's image. private stops those links at once; share links keep working until revoked. Copies people already saved stay with them.

put/v1/diagrams/{id}/sharing

Request

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

Path parameters

idstring required

The diagram's ID or key

Request body

visibility'public' | 'private' required

Response

{ id, visibility, url?, madePublicAt? }; url is the diagram's version link, https://zindex.ai/d/{id}, and madePublicAt when the diagram was first published. Making it private stops its links by ID at once; its share links keep working until revoked.

Changes

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