# Models ## The ApiResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ApiResponse":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code"},"meta":{"$ref":"#/components/schemas/Meta"},"response":{"description":"Response data (varies by endpoint)"}}},"Meta":{"type":"object","properties":{"version":{"type":"string"},"is_authenticaded":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}}}}}} ``` ## The PaginatedResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"PaginatedResponse":{"type":"object","properties":{"code":{"type":"integer"},"meta":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"type":"object","properties":{"size":{"type":"integer","description":"Items per page"},"page":{"type":"integer","description":"Current page"},"total":{"type":"integer","description":"Total items"}}}]},"response":{"type":"array","items":{}}}},"Meta":{"type":"object","properties":{"version":{"type":"string"},"is_authenticaded":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}}}}}} ``` ## The Meta object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"Meta":{"type":"object","properties":{"version":{"type":"string"},"is_authenticaded":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}}}}}} ``` ## The ErrorResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"meta":{"$ref":"#/components/schemas/Meta"},"error_message":{"type":"string","description":"Human-readable error message"}}},"Meta":{"type":"object","properties":{"version":{"type":"string"},"is_authenticaded":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}}}}}} ``` ## The NotFoundResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"NotFoundResponse":{"type":"object","description":"Resource not found error response","properties":{"code":{"type":"integer"},"meta":{"$ref":"#/components/schemas/Meta"},"error_message":{"type":"string","description":"Human-readable error message"}}},"Meta":{"type":"object","properties":{"version":{"type":"string"},"is_authenticaded":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}}}}}} ``` ## The HealthResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"HealthResponse":{"type":"object","description":"Health check response indicating system status","properties":{"status":{"type":"string","description":"Current health status of the system","enum":["UP","DOWN"]}},"required":["status"]}}}} ``` ## The TokenValidationResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"TokenValidationResponse":{"type":"object","properties":{"code":{"type":"integer"},"meta":{"$ref":"#/components/schemas/Meta"},"response":{"type":"object","properties":{"id":{"type":"string","description":"User's unique identifier"},"name":{"type":"string","description":"User's display name"},"username":{"type":"string","description":"User's username"},"email":{"type":"string","description":"User's email address"},"avatar":{"type":"string","description":"URL to user's avatar image"}}}}},"Meta":{"type":"object","properties":{"version":{"type":"string"},"is_authenticaded":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}}}}}} ``` ## The UserResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"UserResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}}}}}} ``` ## The ElementalResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ElementalResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier"},"is_list":{"type":"boolean","description":"Whether this is a list"},"type":{"$ref":"#/components/schemas/ElementalType"},"category":{"$ref":"#/components/schemas/ElementalCategory"},"topics":{"type":"array","items":{"$ref":"#/components/schemas/Topic"}},"title":{"type":"string"},"body_content":{"type":"string","description":"Template/content text"},"body_content_html":{"type":"string"},"body_content_plaintext":{"type":"string"},"body_content_json":{"type":"object"},"body_content_placeholders":{"$ref":"#/components/schemas/PlaceholdersResponse"},"description":{"type":"string"},"description_plaintext":{"type":"string"},"visibility":{"$ref":"#/components/schemas/VisibilityType"},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImageResponse"}},"cover_images":{"type":"array","items":{"$ref":"#/components/schemas/ImageResponse"}},"avatar_image":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/ElementalFileResponse"}},"tutorial_steps":{"type":"array","items":{"$ref":"#/components/schemas/TutorialStep"}},"url":{"type":"string"},"is_premium":{"type":"boolean"},"price":{"type":"integer"},"average_rate":{"type":"number","format":"float"},"video_url":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"user":{"$ref":"#/components/schemas/UserResponse"},"comments":{"type":"array","items":{"$ref":"#/components/schemas/CommentResponse"}},"total_comments":{"type":"integer"},"rates":{"type":"array","items":{"$ref":"#/components/schemas/RateResponse"}},"total_rates":{"type":"integer"},"total_sales":{"type":"integer"},"total_upvotes":{"type":"integer"},"total_uses":{"type":"integer"},"total_saves":{"type":"integer"},"command":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ListResponse"}},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListResponse"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResponse"}},"knowledge_base":{"type":"object"},"knowledge_base_json":{"type":"object"},"settings":{"type":"object","description":"Elemental settings and flags","properties":{"is_knowledge_base":{"type":"boolean","description":"Whether this elemental is used as a knowledge base"},"is_template":{"type":"boolean","description":"Whether this elemental is a template"},"is_system":{"type":"boolean","description":"Whether this is a system elemental"}}}}},"ElementalType":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"ElementalCategory":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"Topic":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"PlaceholdersResponse":{"type":"object","properties":{"list":{"type":"array","items":{"type":"string"},"description":"Array of placeholder tags"},"plaintext":{"type":"string","description":"All placeholders as space-separated string"}}},"VisibilityType":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"ImageResponse":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"blur":{"type":"string"}}},"ElementalFileResponse":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"size":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"url":{"type":"string"},"data":{"type":"array","items":{"type":"integer"},"description":"File data as byte array"}}},"TutorialStep":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"description":{"type":"string"},"video_url":{"type":"string"}}},"UserResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}}},"CommentResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"total_votes":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"},"replies":{"type":"array","items":{"$ref":"#/components/schemas/CommentReplyResponse"}}}},"CommentReplyResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"},"parent_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"total_votes":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"}}},"RateResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"},"rating":{"type":"integer","minimum":1,"maximum":5},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"total_votes":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"}}},"ListResponse":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"description_plaintext":{"type":"string"},"visibility":{"$ref":"#/components/schemas/VisibilityType"},"type":{"$ref":"#/components/schemas/ListType"},"topics":{"type":"array","items":{"$ref":"#/components/schemas/Topic"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/ElementalResponse"}},"total_items":{"type":"integer"},"cover_images":{"type":"array","items":{"$ref":"#/components/schemas/ImageResponse"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImageResponse"}},"files":{"type":"array","items":{"$ref":"#/components/schemas/ElementalFileResponse"}},"avatar_image":{"type":"string"},"video_url":{"type":"string"},"tutorial_steps":{"type":"array","items":{"$ref":"#/components/schemas/TutorialStep"}},"url":{"type":"string"},"is_premium":{"type":"boolean"},"price":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"is_saved":{"type":"boolean"},"is_favorite":{"type":"boolean"},"is_voted":{"type":"boolean"},"average_rate":{"type":"number","format":"float"},"rates":{"type":"array","items":{"$ref":"#/components/schemas/RateResponse"}},"total_rates":{"type":"integer"},"total_saves":{"type":"integer"},"total_upvotes":{"type":"integer"},"total_uses":{"type":"integer"},"total_sales":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"},"last_saves":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}},"table_id":{"type":"string"},"table_orientation":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResponse"}},"knowledge_base":{"type":"object"},"knowledge_base_json":{"type":"object"},"settings":{"type":"object","description":"List settings and flags","properties":{"is_knowledge_base":{"type":"boolean"},"is_template":{"type":"boolean"},"is_system":{"type":"boolean"}}}}},"ListType":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"TagResponse":{"type":"object","properties":{"id":{"type":"string","description":"Tag unique identifier"},"title":{"type":"string","description":"Tag title/name"},"color":{"type":"string","description":"Hex color code for the tag"},"description":{"type":"string","description":"Optional tag description"},"user_id":{"type":"string","description":"ID of the user who created the tag"},"created_at":{"type":"string","format":"date-time","description":"Tag creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Tag last update timestamp"}}}}}} ``` ## The ElementalPayload object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ElementalPayload":{"type":"object","required":["title","type_id","template","category_id"],"properties":{"id":{"type":"string"},"title":{"type":"string","description":"Title (10-100 characters)","minLength":10,"maxLength":100},"type_id":{"type":"integer","description":"1=Prompt, 2=Snippet, 3=Document","enum":[1,2,3]},"template":{"type":"string","description":"Content/template text with optional"},"template_overwrite_content":{"type":"boolean"},"description":{"type":"string"},"command":{"type":"string"},"visibility":{"type":"integer","description":"1=Public, 2=Unlisted","default":1},"category_id":{"type":"integer"},"topic_ids":{"type":"array","items":{"type":"integer"},"description":"Required for prompts (type_id=1)"},"lists_to_save":{"type":"array","items":{"type":"object","properties":{"list_id":{"type":"string"}}}},"is_premium":{"type":"boolean"},"is_fixed_price":{"type":"boolean"},"price":{"type":"integer"},"price_original":{"type":"integer"},"avatar":{"$ref":"#/components/schemas/FileRequest"},"cover_images":{"type":"array","items":{"$ref":"#/components/schemas/FileRequest"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/FileRequest"}},"files":{"type":"array","items":{"$ref":"#/components/schemas/FileRequest"}},"video_url":{"type":"string"},"tutorial_steps":{"type":"array","items":{"$ref":"#/components/schemas/TutorialStepPayload"}}}},"FileRequest":{"type":"object","properties":{"file_name":{"type":"string"},"file_buffer":{"$ref":"#/components/schemas/FileBuffer"}}},"FileBuffer":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"array","items":{"type":"integer"},"description":"File data as byte array"}}},"TutorialStepPayload":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"video_url":{"type":"string"}}}}}} ``` ## The ElementalType object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ElementalType":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}} ``` ## The ElementalCategory object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ElementalCategory":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}} ``` ## The Topic object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"Topic":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}} ``` ## The PlaceholdersResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"PlaceholdersResponse":{"type":"object","properties":{"list":{"type":"array","items":{"type":"string"},"description":"Array of placeholder tags"},"plaintext":{"type":"string","description":"All placeholders as space-separated string"}}}}}} ``` ## The ElementalFileResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ElementalFileResponse":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"size":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"url":{"type":"string"},"data":{"type":"array","items":{"type":"integer"},"description":"File data as byte array"}}}}}} ``` ## The FileRequest object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"FileRequest":{"type":"object","properties":{"file_name":{"type":"string"},"file_buffer":{"$ref":"#/components/schemas/FileBuffer"}}},"FileBuffer":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"array","items":{"type":"integer"},"description":"File data as byte array"}}}}}} ``` ## The FileBuffer object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"FileBuffer":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"array","items":{"type":"integer"},"description":"File data as byte array"}}}}}} ``` ## The FileUploadRequest object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"FileUploadRequest":{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/components/schemas/FileRequest"},"maxItems":4},"cover_images":{"type":"array","items":{"$ref":"#/components/schemas/FileRequest"},"maxItems":4},"avatar":{"$ref":"#/components/schemas/FileRequest"},"files":{"type":"array","items":{"$ref":"#/components/schemas/FileRequest"},"maxItems":3}}},"FileRequest":{"type":"object","properties":{"file_name":{"type":"string"},"file_buffer":{"$ref":"#/components/schemas/FileBuffer"}}},"FileBuffer":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"array","items":{"type":"integer"},"description":"File data as byte array"}}}}}} ``` ## The FileDeleteRequest object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"FileDeleteRequest":{"type":"object","properties":{"images":{"type":"array","items":{"type":"integer"}},"cover_images":{"type":"array","items":{"type":"integer"}},"avatar":{"type":"boolean"},"files":{"type":"array","items":{"type":"integer"}}}}}}} ``` ## The ImageResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ImageResponse":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"blur":{"type":"string"}}}}}} ``` ## The TutorialStep object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"TutorialStep":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"description":{"type":"string"},"video_url":{"type":"string"}}}}}} ``` ## The TutorialStepPayload object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"TutorialStepPayload":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"video_url":{"type":"string"}}}}}} ``` ## The ListResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ListResponse":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"description_plaintext":{"type":"string"},"visibility":{"$ref":"#/components/schemas/VisibilityType"},"type":{"$ref":"#/components/schemas/ListType"},"topics":{"type":"array","items":{"$ref":"#/components/schemas/Topic"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/ElementalResponse"}},"total_items":{"type":"integer"},"cover_images":{"type":"array","items":{"$ref":"#/components/schemas/ImageResponse"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImageResponse"}},"files":{"type":"array","items":{"$ref":"#/components/schemas/ElementalFileResponse"}},"avatar_image":{"type":"string"},"video_url":{"type":"string"},"tutorial_steps":{"type":"array","items":{"$ref":"#/components/schemas/TutorialStep"}},"url":{"type":"string"},"is_premium":{"type":"boolean"},"price":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"is_saved":{"type":"boolean"},"is_favorite":{"type":"boolean"},"is_voted":{"type":"boolean"},"average_rate":{"type":"number","format":"float"},"rates":{"type":"array","items":{"$ref":"#/components/schemas/RateResponse"}},"total_rates":{"type":"integer"},"total_saves":{"type":"integer"},"total_upvotes":{"type":"integer"},"total_uses":{"type":"integer"},"total_sales":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"},"last_saves":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}},"table_id":{"type":"string"},"table_orientation":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResponse"}},"knowledge_base":{"type":"object"},"knowledge_base_json":{"type":"object"},"settings":{"type":"object","description":"List settings and flags","properties":{"is_knowledge_base":{"type":"boolean"},"is_template":{"type":"boolean"},"is_system":{"type":"boolean"}}}}},"VisibilityType":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"ListType":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"Topic":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"ElementalResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier"},"is_list":{"type":"boolean","description":"Whether this is a list"},"type":{"$ref":"#/components/schemas/ElementalType"},"category":{"$ref":"#/components/schemas/ElementalCategory"},"topics":{"type":"array","items":{"$ref":"#/components/schemas/Topic"}},"title":{"type":"string"},"body_content":{"type":"string","description":"Template/content text"},"body_content_html":{"type":"string"},"body_content_plaintext":{"type":"string"},"body_content_json":{"type":"object"},"body_content_placeholders":{"$ref":"#/components/schemas/PlaceholdersResponse"},"description":{"type":"string"},"description_plaintext":{"type":"string"},"visibility":{"$ref":"#/components/schemas/VisibilityType"},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImageResponse"}},"cover_images":{"type":"array","items":{"$ref":"#/components/schemas/ImageResponse"}},"avatar_image":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/ElementalFileResponse"}},"tutorial_steps":{"type":"array","items":{"$ref":"#/components/schemas/TutorialStep"}},"url":{"type":"string"},"is_premium":{"type":"boolean"},"price":{"type":"integer"},"average_rate":{"type":"number","format":"float"},"video_url":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"user":{"$ref":"#/components/schemas/UserResponse"},"comments":{"type":"array","items":{"$ref":"#/components/schemas/CommentResponse"}},"total_comments":{"type":"integer"},"rates":{"type":"array","items":{"$ref":"#/components/schemas/RateResponse"}},"total_rates":{"type":"integer"},"total_sales":{"type":"integer"},"total_upvotes":{"type":"integer"},"total_uses":{"type":"integer"},"total_saves":{"type":"integer"},"command":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ListResponse"}},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListResponse"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResponse"}},"knowledge_base":{"type":"object"},"knowledge_base_json":{"type":"object"},"settings":{"type":"object","description":"Elemental settings and flags","properties":{"is_knowledge_base":{"type":"boolean","description":"Whether this elemental is used as a knowledge base"},"is_template":{"type":"boolean","description":"Whether this elemental is a template"},"is_system":{"type":"boolean","description":"Whether this is a system elemental"}}}}},"ElementalType":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"ElementalCategory":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"PlaceholdersResponse":{"type":"object","properties":{"list":{"type":"array","items":{"type":"string"},"description":"Array of placeholder tags"},"plaintext":{"type":"string","description":"All placeholders as space-separated string"}}},"ImageResponse":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"blur":{"type":"string"}}},"ElementalFileResponse":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"size":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"url":{"type":"string"},"data":{"type":"array","items":{"type":"integer"},"description":"File data as byte array"}}},"TutorialStep":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"description":{"type":"string"},"video_url":{"type":"string"}}},"UserResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}}},"CommentResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"total_votes":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"},"replies":{"type":"array","items":{"$ref":"#/components/schemas/CommentReplyResponse"}}}},"CommentReplyResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"},"parent_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"total_votes":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"}}},"RateResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"},"rating":{"type":"integer","minimum":1,"maximum":5},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"total_votes":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"}}},"TagResponse":{"type":"object","properties":{"id":{"type":"string","description":"Tag unique identifier"},"title":{"type":"string","description":"Tag title/name"},"color":{"type":"string","description":"Hex color code for the tag"},"description":{"type":"string","description":"Optional tag description"},"user_id":{"type":"string","description":"ID of the user who created the tag"},"created_at":{"type":"string","format":"date-time","description":"Tag creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Tag last update timestamp"}}}}}} ``` ## The ListRequest object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ListRequest":{"type":"object","required":["title"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"template":{"type":"string"},"template_overwrite":{"type":"boolean"},"content_type":{"type":"integer"},"visibility":{"type":"integer","default":1},"item_ids":{"type":"array","items":{"$ref":"#/components/schemas/ListPromptRequest"}},"mode":{"type":"string"},"is_premium":{"type":"boolean"},"is_fixed_price":{"type":"boolean"},"price":{"type":"integer"},"price_original":{"type":"integer"},"avatar":{"$ref":"#/components/schemas/FileRequest"},"video_url":{"type":"string"},"tutorial_steps":{"type":"array","items":{"$ref":"#/components/schemas/TutorialStepPayload"}},"table":{"type":"object","additionalProperties":true},"cover_images":{"type":"array","items":{"$ref":"#/components/schemas/FileRequest"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/FileRequest"}},"files":{"type":"array","items":{"$ref":"#/components/schemas/FileRequest"}}}},"ListPromptRequest":{"type":"object","properties":{"id":{"type":"integer"},"list_id":{"type":"integer"},"prompt_id":{"type":"string"},"orderIndex":{"type":"integer"},"list_item_id":{"type":"string"}}},"FileRequest":{"type":"object","properties":{"file_name":{"type":"string"},"file_buffer":{"$ref":"#/components/schemas/FileBuffer"}}},"FileBuffer":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"array","items":{"type":"integer"},"description":"File data as byte array"}}},"TutorialStepPayload":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"video_url":{"type":"string"}}}}}} ``` ## The ListPromptRequest object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ListPromptRequest":{"type":"object","properties":{"id":{"type":"integer"},"list_id":{"type":"integer"},"prompt_id":{"type":"string"},"orderIndex":{"type":"integer"},"list_item_id":{"type":"string"}}}}}} ``` ## The ListType object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"ListType":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}} ``` ## The TagResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"TagResponse":{"type":"object","properties":{"id":{"type":"string","description":"Tag unique identifier"},"title":{"type":"string","description":"Tag title/name"},"color":{"type":"string","description":"Hex color code for the tag"},"description":{"type":"string","description":"Optional tag description"},"user_id":{"type":"string","description":"ID of the user who created the tag"},"created_at":{"type":"string","format":"date-time","description":"Tag creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Tag last update timestamp"}}}}}} ``` ## The CreateTagRequest object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"CreateTagRequest":{"type":"object","required":["title","color","elementalTypeId"],"properties":{"title":{"type":"string"},"color":{"type":"string","description":"Hex color code (e.g., \"#FF5733\")"},"description":{"type":"string"},"elementalTypeId":{"type":"integer","description":"Elemental type this tag applies to"},"source_user_id":{"type":"string"},"source_tag_id":{"type":"string"}}}}}} ``` ## The VisibilityType object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"VisibilityType":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}} ``` ## The CommentResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"CommentResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"total_votes":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"},"replies":{"type":"array","items":{"$ref":"#/components/schemas/CommentReplyResponse"}}}},"UserResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}}},"CommentReplyResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"},"parent_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"total_votes":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"}}}}}} ``` ## The CommentReplyResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"CommentReplyResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"},"parent_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"total_votes":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"}}},"UserResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}}}}}} ``` ## The RateResponse object ```json {"openapi":"3.0.3","info":{"title":"Snack Prompt Integration API","version":"v1.0.2"},"components":{"schemas":{"RateResponse":{"type":"object","properties":{"id":{"type":"integer"},"message":{"type":"string"},"rating":{"type":"integer","minimum":1,"maximum":5},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"total_votes":{"type":"integer"},"user":{"$ref":"#/components/schemas/UserResponse"}}},"UserResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.snackprompt.com/api-reference/api-reference/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.