Loading ...

REST API: Download File | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Files » REST API: Download File
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Download File

0 
 /5
0 (0votes)
Open API Guide
GET/api/content/{ContentID}/stream

Download the binary file associated with a content item. This endpoint uses the standard WebAPI authentication pipeline, making it the recommended method for headless or server-to-server file downloads where browser session cookies are not available.

When to use this endpoint

The ContentMediaUrl property returned by other content API responses points to an HTTP handler that does not process Authorization headers. While ContentMediaUrl works for logged-in browser users (via session cookies), headless API consumers will receive a 401 Unauthorized error. Use /api/content/{ContentID}/stream instead for reliable, token-authenticated file downloads.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
ContentIDIntegerYESPathUnique identifier of the content item whose file you want to download. The content must be a file-type entity (e.g., a document uploaded to a file directory).

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/content/4523/stream

Success Response

A successful request returns the raw binary file content with an HTTP 200 OK status. The Content-Type header is set dynamically based on the file extension (e.g., application/pdf, image/png, application/vnd.openxmlformats-officedocument.wordprocessingml.document).

HTTP/1.1 200 OK
Content-Type: application/pdf

[Raw binary file data]

This endpoint does not return a JSON response envelope. The response body is the file itself.

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestMissing or invalid ContentID in the URL path.Ensure the ContentID is a valid positive integer.
401 UnauthorizedMissing or invalid Bearer token.Verify your Authorization header. Learn how to create Bearer tokens →
403 ForbiddenThe authenticated user does not have download permission for this file in its space.Confirm the user has both View and Download permissions for the file's space.
404 Not FoundNo content exists with the specified ContentID, or the content is not a downloadable file.Verify the ContentID is correct and refers to a file-type content item.
500 Server ErrorInternal failure, possibly due to missing physical file on the server.Retry later. If persistent, verify that the file has not been deleted from the media server.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages