folderManage Lists

Organize content with lists and folders

Lists

Lists are collections that organize elementals. Use them to group related prompts, snippets, or documents together.

Get List by ID

get

Retrieves a specific list with optional expanded items.

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
list_idstringRequired
Query parameters
formatstring · enumOptionalPossible values:
expand_itemsbooleanOptional

Include full elemental details

Responses
chevron-right
200

List details

application/json
get
/v1/list/{list_id}
cURL

Get List Items

get

Retrieves paginated items from a list.

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
list_idstringRequired
Query parameters
pageintegerOptionalDefault: 1
sizeinteger · max: 100OptionalDefault: 4
Responses
chevron-right
200

List items

application/json
codeintegerOptionalExample: 200
get
/v1/list/{list_id}/items
cURL
200

List items

Search Lists

get

Search for lists across the platform.

Authorizations
x-api-keystringRequired

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

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

Query parameters
searchstringOptional
sizeintegerOptionalDefault: 4
pageintegerOptionalDefault: 1
Responses
chevron-right
200

Search results

No content

get
/v1/lists
cURL
200

Search results

No content

Get User Lists

get

Retrieves all lists belonging to the authenticated user.

Authorizations
x-api-keystringRequired

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

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

Responses
chevron-right
200

User's lists

No content

get
/v1/user/lists
cURL
200

User's lists

No content

Create List

post

Creates a new list for organizing elementals.

Authorizations
x-api-keystringRequired

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

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

Body
idstringOptional
titlestringRequired
descriptionstringOptional
templatestringOptional
template_overwritebooleanOptional
content_typeintegerOptional
visibilityintegerOptionalDefault: 1
modestringOptional
is_premiumbooleanOptional
is_fixed_pricebooleanOptional
priceintegerOptional
price_originalintegerOptional
video_urlstringOptional
Responses
post
/v1/user/list
cURL

No content

Update List

put

Updates an existing list.

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
list_idstringRequired
Body
idstringOptional
titlestringRequired
descriptionstringOptional
templatestringOptional
template_overwritebooleanOptional
content_typeintegerOptional
visibilityintegerOptionalDefault: 1
modestringOptional
is_premiumbooleanOptional
is_fixed_pricebooleanOptional
priceintegerOptional
price_originalintegerOptional
video_urlstringOptional
Responses
chevron-right
200

List updated

No content

put
/v1/user/list/{list_id}
cURL

No content

Remove Elementals from List

delete

Removes specified elementals from a list.

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
list_idstringRequired
Body
Responses
delete
/v1/user/list/{list_id}/elementals
cURL
204

Elementals removed from list

No content

Last updated

Was this helpful?