v1

Revoke the active public URL for a file. The underlying file remains available through the authenticated content endpoint. Revoke is idempotent — calling it on a file without an active public URL returns `revoked: false` without an error.

post/v1/files/{file_id}/public-url/revoke

Request

  • Base URL: https://docs.x.ai (the document declares no server; this is the origin it was published from)
  • URL: https://docs.x.ai/v1/files/{file_id}/public-url/revoke
  • Auth: HTTP bearer

Path parameters

file_idstring required

The file's id.

Response

Success

idstring required

The file ID whose public URL was revoked.

public_urlstring nullable

The full public URL that was revoked. Only present when revoked is true.

revokedboolean required

Whether a public URL was actually revoked. false if the file had no active public URL (no-op).

Changes

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