Skip to content

Endpoints

Endpoints

Name

Download link

A temporary link to download a file.

HTTP method and path

GET/api/v6/storage/objects/{id}/download-url

https://developers.hablame.co/api/v6/storage/objects/{id}/download-url

What happens when you run it

  • Read only: it does not change your organization’s data.
  • The call is not charged.
  • Your organization’s audit log records that a download link was requested for that file.

What it does

Returns a signed link to download the file, valid until expiresAt (15 minutes by default, 60 at most) and never beyond when the file is deleted. Each link is recorded with the API key that asked for it and the IP you called from. A file being deleted cannot be downloaded: it answers 404.

The link is a short-lived secret: do not store or share it. Ask for a new one every time you need it.

Availability and prerequisites

  • Published and available in the production API v6.
  • Every path starts at https://developers.hablame.co.
  • You need a Hablame API key to call it.

Create your API key

Authentication and permissions

  • Send your API key in the Authorization header with the Bearer scheme.

Who can call it: An API key with the storage service enabled.

Limits and operational notes

Usage limit: 2 requests per second.

  • Its own per-organization quota, separate from the queries.

Path parameters

NameTypeDescription and rules
idRequiredstring

File identifier, as it comes in the list.

Pattern:^obj_[0-9A-HJKMNP-TV-Z]{26}$Example:obj_01JABCDEFGHJKMNPQRSTVWXYZ0

Query parameters

NameTypeDescription and rules
minutesOptionalinteger

Minutes the link is valid.

Default value:15Minimum:1Maximum:60

HTTP headers

NameTypeDescription and rules
AuthorizationRequiredstring

Your API key with the Bearer scheme.

Example:Bearer hk_TU_API_KEY

Request body

This endpoint takes no request body.

Successful responses

200

The link and its expiry.

Response example
{
  "success": true,
  "data": {
    "url": "https://storage.hablame.co/cloud/v1/...?Expires=1790000000&KeyName=...&Signature=...",
    "expiresAt": "2026-10-19T10:45:00.000-05:00"
  },
  "meta": {
    "requestId": "5d0f3a9c7b2e41a8",
    "clientIp": "203.0.113.10",
    "timestamp": "2026-10-19T15:30:00+00:00",
    "responseTimeMs": 12.4
  }
}

The example values are illustrative.

Response fields

NameTypeDescription and rules
successAlways presentboolean

dataAlways presentobject

data.urlAlways presentstring

Signed download link.

Format:uri

data.expiresAtAlways presentstring

Until when it works.

Format:date-time

metaAlways presentobject

Response metadata.

meta.requestIdAlways presentstring

Unique request identifier (16 hexadecimal characters). It matches the X-Request-Id header. Quote it when contacting support.

Example:b9b1704baffab211

meta.clientIpAlways presentstring

IP the API saw your request come from. Useful if your API key only accepts certain networks.

Example:203.0.113.45

meta.timestampAlways presentstring

Date and time the response was built (ISO 8601 with offset).

Format:date-timeExample:2026-06-04T19:43:59+00:00

meta.responseTimeMsAlways presentnumber

Time (ms) the server took to process the request.

Example:4.24

Error codes

Every error response has the same shape: success set to false and an error object whose code says what happened. They are grouped here by kind, with the codes this endpoint can return.

Shape of an error response
NameTypeDescription and rules
successAlways presentboolean

Fixed value:false

metaAlways presentobject

Response metadata.

meta.requestIdAlways presentstring

Unique request identifier (16 hexadecimal characters). It matches the X-Request-Id header. Quote it when contacting support.

Example:b9b1704baffab211

meta.clientIpAlways presentstring

IP the API saw your request come from. Useful if your API key only accepts certain networks.

Example:203.0.113.45

meta.timestampAlways presentstring

Date and time the response was built (ISO 8601 with offset).

Format:date-timeExample:2026-06-04T19:43:59+00:00

meta.responseTimeMsAlways presentnumber

Time (ms) the server took to process the request.

Example:4.24

errorAlways presentobject

error.codeAlways presentstring

Stable UPPER_SNAKE_CASE identifier. Clients branch on this value.

Example:AUTH_REQUIRED

error.legacyCodeinteger

Legacy v5 numeric code, only when a bridge exists. Omitted for codes born in v6.

Example:40002

error.typeAlways presentstring

URL to the error documentation.

Format:uriExample:https://developers.hablame.co/docs/v6/errors/auth-required

error.messageAlways presentstring

Human readable text, in English. It is for the developer log, not the end user: do not parse it.

error.detailsAlways presentarray<object>

Structured context (validation issues, affected resource). Empty array when there is no extra context.

Validation

  • 400A parameter is not valid.

Authentication

  • 401Invalid or missing credentials.
  • 401AUTH_REQUIRED

    No Bearer token was sent, and every call requires one.

    Message the API returns: Authentication is required. Send your API key as `Authorization: Bearer <token>`.

  • 401AUTH_INVALID_KEY

    The API key is not recognized: wrong format, revoked or expired.

    Message the API returns: The provided API key is invalid or has expired. Please verify the value sent in the `Authorization: Bearer` header.

Permissions

  • 403The API key does not have the Storage service (storage), cannot be used from the request network, or the organization is not active.
  • 403AUTH_SERVICE_NOT_ALLOWED

    The key is not allowed to use the service behind this endpoint.

    Message the API returns: This API key is not authorized to use the requested service.

  • 403AUTH_IP_NOT_ALLOWED

    The key only works from certain networks and your IP is not one of them.

    Message the API returns: This API key cannot be used from this IP address. The address we saw is in `meta.clientIp`: call from one of the networks allowed for the key, or use a key that allows this one.

  • 403ACCOUNT_NOT_ACTIVE

    Your organization is suspended or closed.

    Message the API returns: The organization associated with this API key is not active. Please contact support.

Usage limits

  • 429Request limit exceeded.
  • 429RATE_TPS_EXCEEDED

    You exceeded your organization quota for this endpoint.

    Message the API returns: You have exceeded the allowed request rate for this endpoint. Please wait before retrying.

Resource not found

  • 404The file does not exist for your organization. It is the same answer for a file that never existed, one from another organization, one already deleted or a malformed id.

Internal errors and availability

  • 503Storage is not responding right now. Retry after Retry-After.

Other responses

This endpoint does not declare responses of this kind.

See it in the error catalog

Special considerations

Files require a key with Storage

Files may be call recordings, audio or documents of your organization. Any API key with the Storage service (storage) can see them, and only the owner of your organization creates keys. Without the service, the key gets 403 AUTH_SERVICE_NOT_ALLOWED here and on every other Storage endpoint.

Related documentation

Need help?

Was this page helpful?

See all support channels

Ask for help about this: this endpoint

We build a message with the details that help us look into your case. Read it, complete it and send it yourself: nothing is sent on its own.

The message never carries your API key or passwords.