Documentation Index

Fetch the complete documentation index at: https://docs.relaynetwork.com/llms.txt

Use this file to discover all available pages before exploring further.

Download a single file/photo submission file

Prev
Get
/rn-powerups-api/1.0/api/{client_id}/submissions/{id}/files/{unique_name}/{attachment_index}

This API retrieves a single file or image uploaded by a patient associated with a specific submission, identified by its unique name and index. Use this instead of the base /files endpoint when you only need one file rather than the full ZIP archive.

Header parameters
xx-relay-api-key
stringRequired

Contains the API key needed.

Path parameters
client_id
stringRequired

Client ID

Minimum1
id
stringRequired

The unique ID of a Power-Ups form submission by a specific Customer or Patient.

Max length100
Example54dda2a2-a1fd-4122-876e-56c20ac81af88
unique_name
stringRequired

The unique name of the file to retrieve. This information is found in the powerups_data.artifact_available event.

attachment_index
integerRequired

The index of the file, used to distinguish between files sharing the same unique_name. This information is found in the powerups_data.artifact_available event.

Responses
200

The requested individual file.

string (binary)
400

Invalid request

401

Unauthorized

404

Not Found - The requested resource was not found. Please verify the route parameter.

409

Conflict - Indicates the request could not be processed. A common reason is when attempting to create a new Journey object, but the ID already exists in the system.

500

An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request.