uploadFile Management

Upload and manage elemental files and images

Upload images, documents, and other files to enhance your elementals.

Get Elemental File

get

Retrieves a specific file attached to an elemental.

Authorizations
x-api-keystringRequired

API Key authentication. Get your key at snackprompt.com/api-keys.

Example: x-api-key: sk-your-api-key-here

Path parameters
elemental_idstringRequired

Elemental ID

file_idintegerRequired

File ID

Responses
chevron-right
200

File data

application/json
get
/v1/elemental/{elemental_id}/file/{file_id}
cURL

Upload Files to Elemental

post

Uploads files to an elemental.

File Limits

Type
Max Count
Description

images

4

Regular images

cover_images

4

Featured/cover images

avatar

1

Main avatar/icon

files

3 per request, 15 total

Document attachments

Authorizations
x-api-keystringRequired

API Key authentication. Get your key at snackprompt.com/api-keys.

Example: x-api-key: sk-your-api-key-here

Path parameters
elemental_idstringRequired
Body
Responses
post
/v1/user/elemental/{elemental_id}/files
cURL

No content

Delete Files from Elemental

delete

Deletes specific files from an elemental by their IDs.

Authorizations
x-api-keystringRequired

API Key authentication. Get your key at snackprompt.com/api-keys.

Example: x-api-key: sk-your-api-key-here

Path parameters
elemental_idstringRequired
Body
imagesinteger[]Optional
cover_imagesinteger[]Optional
avatarbooleanOptional
filesinteger[]Optional
Responses
delete
/v1/user/elemental/{elemental_id}/files
cURL
204

Files deleted successfully

No content

Last updated

Was this helpful?