Get Elemental by ID
Get an elemental by its ID.
GET/v1/elemental/{id}- Param
- Response
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | ✅ | ID of the elemental |
| format | string | ❌ | Output format (text, markdown, json, default (json and markdown)) |
| group_by | string | ❌ | Group data by row or column |
| fields | string | ❌ | Fields for the knowledge return (id, title, type, description, content, url, images, video, tutorial and files) |
Example
/v1/elemental/your-elemental-id
Properties
| Name | Type | Description |
|---|---|---|
| id | string | ID of the elemental |
| is_list | boolean | Indicates if the elemental is a list |
| type | Object | Type of the elemental |
| category | Object | Category of the elemental |
| category.id | number | ID of the category |
| category.name | string | Name of the category |
| topics | array | Topics related to the elemental |
| topics.id | number | ID of the topic |
| topics.name | string | Name of the topic |
| title | string | Title of the elemental |
| body_content | string | Body content of the elemental |
| body_content_plaintext | string | Body content of the elemental in plain text |
| body_content_json | string | Body content of the elemental in JSON format |
| body_content_placeholders | Object | Placeholders for the body content |
| body_content_placeholders.list | string[] | Placeholders for the body content in list |
| body_content_placeholders.plaintext | string | Placeholders for the body content in plain text |
| description | string | Description of the elemental |
| description_plaintext | string | Description of the elemental in plain text |
| visibility | Object | Visibility of the elemental |
| visibility.id | number | ID of the visibility |
| visibility.name | string | Name of the visibility |
| images | array | Images related to the elemental |
| images.id | number | ID of the image |
| images.url | string | URL of the image |
| cover_images | array | Cover images related to the elemental |
| cover_images.id | number | ID of the cover image |
| cover_images.url | string | URL of the cover image |
| files | array | Files related to the elemental. (Up to 3 files) |
| files.id | number | ID of the file |
| files.name | string | Name of the file |
| files.size | number | Size of the file |
| files.created_at | string | Timestamp of when the file was created |
| files.url | string | URL of the file |
| avatar_image | string | Avatar image of the elemental |
| tags | array | Tags related to the elemental |
| tutorial_steps | array | Tutorial steps related to the elemental |
| tutorial_steps.id | number | ID of the tutorial step |
| tutorial_steps.title | string | Title of the tutorial step |
| tutorial_steps.description | string | Description of the tutorial step |
| tutorial_steps.video_url | string | Video URL of the tutorial step |
| url | string | URL of the elemental |
| is_premium | boolean | Indicates if the elemental is premium |
| price | number | Price of the elemental |
| average_rate | number | Average rate of the elemental |
| video_url | string | Video URL of the elemental |
| created_at | string | Timestamp of when the elemental was created |
| updated_at | string | Timestamp of when the elemental was updated |
| user | Object | User owner of the elemental |
| user.id | string | ID of the user |
| user.name | string | Name of the user |
| user.username | string | Username of the user |
| user.avatar | string | Avatar of the user |
| total_upvotes | number | Total number of upvotes |
| total_uses | number | Total number of uses |
| total_saves | number | Total number of saves |
| command | string | Command of the elemental |
| columns | array | Columns of the table |
| rows | array | Rows of the table |
| knowledge_base | string | Knowledge base of the elemental |
| knowledge_base_json | Object | Knowledge base in JSON format |
| settings | Object | Settings of the elemental |
| settings.is_knowledge_base | boolean | Indicates if the elemental is a knowledge base |
| settings.is_template | boolean | Indicates if the elemental is a template |
| settings.is_system | boolean | Indicates if the elemental is a system |
Example
{
"response": {
"id": "82f9dc27-5e0c-4bbc-a9bb-3c2f1be8a2ac",
"is_list": false,
"type": {
"id": 1,
"name": "Prompt"
},
"category": {
"id": 1,
"name": "Text"
},
"topics": [
{
"id": 27,
"name": "AI"
}
],
"title": "My First Prompt",
"body_content": "I Love Snack Prompt ❤️ #[aweasome]",
"body_content_plaintext": "I Love Snack Prompt ❤️ #[aweasome]",
"body_content_json": null,
"body_content_placeholders": {
"list": [
"#[aweasome]"
],
"plaintext": "#[aweasome]"
},
"description": "<p>Snack Prompt is awesome!</p>",
"description_plaintext": "Snack Prompt is awesome!",
"visibility": {
"id": 2,
"name": "Unlisted"
},
"images": [
{
"id": 4156,
"url": "http://..."
}
],
"cover_images": [
{
"id": 4155,
"url": "http://..."
}
],
"avatar_image": "http://...",
"files": [
{
"id": 1014,
"name": "cat-code-lhY.png",
"size": 1131291,
"created_at": "2025-01-14T16:47:07.091668Z",
"url": "https://..."
}
],
"tags": [
{
"id": 1,
"title": "Tag 1",
"color": "#000000",
"description": "Tag 1 description",
"userId": "Ak2o2WP6xrU8EqSLpmtwO4fEwlC3"
}
],
"tutorial_steps": [
{
"id": 11645,
"title": "First",
"description": "<p>Follow us</p>",
"video_url": ""
},
{
"id": 11646,
"title": "End",
"description": "",
"video_url": ""
}
],
"url": "https://snackprompt.com/prompt/my-first-prompt",
"is_premium": false,
"price": null,
"average_rate": 0,
"video_url": "https://www.youtube.com/watch?v=9yhGMj8Ygvc&t=1s",
"created_at": "2025-01-14T16:47:01.565479Z",
"updated_at": "2025-01-14T16:47:03.203537Z",
"user": {
"id": "Ak2o2WP6xrU8EqSLpmtwO4fEwlC3",
"name": "Leonardo Sola",
"username": "sola",
"avatar": "http://..."
},
"total_upvotes": 0,
"total_uses": 0,
"total_saves": 1,
"command": "",
"columns": [
{
"id": 1,
"title": "Name",
"visibility": {
"id": 0,
"name": ""
},
"cover_images": null,
"avatar_image": null,
"video_url": null,
"is_premium": false,
"price": 0,
"created_at": "0001-01-01T00:00:00Z",
"updated_at": null,
"topics": null,
"total_items": 0,
"total_saves": 0,
"total_upvotes": 0,
"total_uses": 0
},
{
"id": 2,
"title": "Company",
"visibility": {
"id": 0,
"name": ""
},
"cover_images": null,
"avatar_image": null,
"video_url": null,
"is_premium": false,
"price": 0,
"created_at": "0001-01-01T00:00:00Z",
"updated_at": null,
"topics": null,
"total_items": 0,
"total_saves": 0,
"total_upvotes": 0,
"total_uses": 0
},
{
"id": 3,
"title": "Service",
"visibility": {
"id": 0,
"name": ""
},
"cover_images": null,
"avatar_image": null,
"video_url": null,
"is_premium": false,
"price": 0,
"created_at": "0001-01-01T00:00:00Z",
"updated_at": null,
"topics": null,
"total_items": 0,
"total_saves": 0,
"total_upvotes": 0,
"total_uses": 0
}
],
"rows": [
{
"id": 4,
"title": "Leonardo Sola",
"visibility": {
"id": 0,
"name": ""
},
"cover_images": null,
"avatar_image": null,
"video_url": null,
"is_premium": false,
"price": 0,
"created_at": "0001-01-01T00:00:00Z",
"updated_at": null,
"topics": null,
"total_items": 0,
"total_saves": 0,
"total_upvotes": 0,
"total_uses": 0
},
{
"id": 6,
"title": "Snack Prompt",
"visibility": {
"id": 0,
"name": ""
},
"cover_images": null,
"avatar_image": null,
"video_url": null,
"is_premium": false,
"price": 0,
"created_at": "0001-01-01T00:00:00Z",
"updated_at": null,
"topics": null,
"total_items": 0,
"total_saves": 0,
"total_upvotes": 0,
"total_uses": 0
},
{
"id": 7,
"title": "FullStack Developer",
"visibility": {
"id": 0,
"name": ""
},
"cover_images": null,
"avatar_image": null,
"video_url": null,
"is_premium": false,
"price": 0,
"created_at": "0001-01-01T00:00:00Z",
"updated_at": null,
"topics": null,
"total_items": 0,
"total_saves": 0,
"total_upvotes": 0,
"total_uses": 0
}
],
"knowledge_base": "Title: My First Prompt\nDescription: Snack Prompt is awesome!\n\nBody: I Love Snack Prompt ❤️ #[aweasome]\n\n",
"knowledge_base_json": {
"title": "My First Prompt",
"Description": "Snack Prompt is awesome!",
"Body": "I Love Snack Prompt ❤️ #[aweasome]"
},
"settings": {
"is_knowledge_base": false,
"is_template": false,
"is_system": false
}
}
}
CURL Example
curl -X GET "https://api-integrations.snackprompt.com/v1/elemental/{id}" \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY"