Files

Get a file download link

GET/v1/files/{fileId}

One file uploaded to a file_upload question, with a download link that works for 5 minutes. Call again for a fresh link. Once the response is deleted, it answers 404. See Files.

curl "$AYEFORM_API/v1/files/$FILE_ID" \
  -H "Authorization: Bearer $AYEFORM_KEY"

200 Response

{
  "fileId": "bbhe1dcr2m48fxf1assy56ehx428qgry",
  "submissionId": "tyq2cjsz9j5bxge22ky5pppfsggct0xe",
  "fieldId": "y7ewwzttjnavxq96ctvtn0mg52c91jey",
  "name": "Luigi's Pizza",
  "size": 184320,
  "type": "image/jpeg",
  "url": "https://luigispizza.com",
  "expiresAt": 1790879400000
}

Path parameters

fileIdstringrequired
The file's id. You find it in the answer, next to its apiUrl, and at the end of the file's link in an export, <app>/files/<fileId>.

Response

fileIdstringrequired
The file's id.
submissionIdstringrequired
The response it was uploaded with.
fieldIdstringrequired
The file_upload question it answers.
namestringrequired
The file's name.
sizenumberrequired
The file's size in bytes.
typestringrequired
The file's MIME type, as uploaded.
urlstringrequired
A download link that works for 5 minutes and needs no API key. It stops working when it expires or the response is deleted.
expiresAtnumberrequired
When url stops working, in milliseconds since the epoch.

Errors answer with a status and the error shape.