Documents

Get a temporary download link

A signed URL to the original file, valid for 300 seconds. Use it only when the USER asked for the file itself — to read what a document says, use documents_get_content, which costs nothing and needs no download. Handing out a link is recorded in the activity log.

Examples

  • Send me the PDF GET /api/v1/rest/documents/11111111-2222-4333-8444-555555555555/download-link
get/api/v1/rest/documents/{id}/download-link

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/documents/{id}/download-link
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

version_idstring uuid

A specific version. Omit for the current one.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

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