searchRead & Search

Retrieve and search elementals

Retrieve individual elementals or search across your collection.

Get Elemental by ID

get

Retrieves a specific elemental by its unique identifier.

Query Parameters

Parameter
Type
Description

format

string

Output format: text, markdown, or json

group_by

string

Group results by: row or column

fields

string

Comma-separated list of fields to return

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

Unique identifier of the elemental

Query parameters
formatstring · enumOptional

Output format

Possible values:
group_bystring · enumOptional

Group results by row or column

Possible values:
fieldsstringOptional

Comma-separated list of fields to return

Responses
chevron-right
200

Elemental retrieved successfully

application/json
get
/v1/elemental/{elemental_id}

Search Elementals

get

Search for elementals across the platform.

circle-info

Use the search parameter to find elementals by title, description, or template content.

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

Search query string

sizeinteger · max: 100Optional

Number of results per page (default 4, max 100)

Default: 4
pageintegerOptional

Page number (default 1)

Default: 1
order_bystringOptional

Field to order by

Default: created_at
order_dirstring · enumOptional

Order direction

Default: descPossible values:
Responses
chevron-right
200

Search results

application/json
codeintegerOptionalExample: 200
get
/v1/elementals
cURL
200

Search results

Get User Elementals

get

Retrieves all elementals belonging to the authenticated user, filtered by type.

Elemental Types

Type
Description

prompt

AI prompt templates with variable tags

snippet

Reusable text blocks

document

Long-form content

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
typestring · enumRequired

Filter by elemental type

Possible values:
sizeinteger · max: 100OptionalDefault: 4
pageintegerOptionalDefault: 1
Responses
chevron-right
200

List of user elementals

application/json
codeintegerOptionalExample: 200
get
/v1/user/elementals
cURL
200

List of user elementals

Get User Elementals Summary

get

Returns a summary/key-value list of the user's elementals by type.

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
typestring · enumRequiredPossible values:
Responses
chevron-right
200

Summary of user elementals

No content

get
/v1/user/elementals/summary
cURL
200

Summary of user elementals

No content

Last updated

Was this helpful?