> ## Documentation Index > Fetch the complete documentation index at: https://docs.wisepim.com/llms.txt > Use this file to discover all available pages before exploring further. # Read knowledge-libraries > GET /knowledge-libraries/{resource_id}. Required scopes: knowledge-libraries:read. ## OpenAPI ````yaml openapi.json GET /api/public/v1/knowledge-libraries/{resource_id} openapi: 3.1.0 info: title: WISEPIM Public API version: 1.0.0 description: >- Manage your WisePIM catalogue, prompts and knowledge, and launch enrichment, translation and bulk jobs. Authenticate with `Authorization: Bearer wpk_…`; create keys under Settings → API keys. Each key is bound to one project and to the scopes it was created with. summary: >- Manage catalog entities, prompts and knowledge; launch enrichment, translation and bulk actions and track jobs. termsOfService: https://wisepim.com/terms contact: name: WISEPIM support url: https://wisepim.com/contact email: info@wisepim.com x-logo: url: >- https://docs.wisepim.com/logo/wisepim-logo-horizontal-transparant-lightmode.png altText: WISEPIM servers: - url: https://wisepim.com description: Production. Every path below already starts with /api/public/v1. security: - ProjectApiKeyAuth: [] tags: - name: Key and project description: Key and project endpoints for the project bound to your API key. - name: Products description: Products endpoints for the project bound to your API key. - name: Categories description: Categories endpoints for the project bound to your API key. - name: Attributes description: Attributes endpoints for the project bound to your API key. - name: Dictionary Entries description: Dictionary Entries endpoints for the project bound to your API key. - name: Keywords description: Keywords endpoints for the project bound to your API key. - name: Import Templates description: Import Templates endpoints for the project bound to your API key. - name: Export Templates description: Export Templates endpoints for the project bound to your API key. - name: Attribute Groups description: Attribute Groups endpoints for the project bound to your API key. - name: Product Families description: Product Families endpoints for the project bound to your API key. - name: Value Code Sets description: Value Code Sets endpoints for the project bound to your API key. - name: Code Set Values description: Code Set Values endpoints for the project bound to your API key. - name: Uom Code Sets description: Uom Code Sets endpoints for the project bound to your API key. - name: Uom Values description: Uom Values endpoints for the project bound to your API key. - name: Prompts description: Prompts endpoints for the project bound to your API key. - name: Knowledge Libraries description: Knowledge Libraries endpoints for the project bound to your API key. - name: Enrichments description: Enrichments endpoints for the project bound to your API key. - name: Translations description: Translations endpoints for the project bound to your API key. - name: Bulk Actions description: Bulk Actions endpoints for the project bound to your API key. - name: Jobs description: Jobs endpoints for the project bound to your API key. - name: Family Attributes description: Family Attributes endpoints for the project bound to your API key. - name: Product Categories description: Product Categories endpoints for the project bound to your API key. externalDocs: description: WISEPIM API reference and guides url: https://docs.wisepim.com/en/api-reference/introduction paths: /api/public/v1/knowledge-libraries/{resource_id}: get: tags: - Knowledge Libraries summary: Read knowledge-libraries description: Read one project-owned resource by its id. operationId: public_v1_get_knowledge_libraries parameters: - in: path name: resource_id schema: title: Resource Id type: integer required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PublicKnowledgeLibrariesOut' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorOut' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorOut' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorOut' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/ErrorOut' '413': description: Content Too Large content: application/json: schema: $ref: '#/components/schemas/ErrorOut' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ValidationErrorOut' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErrorOut' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorOut' security: - ProjectApiKeyAuth: [] components: schemas: PublicKnowledgeLibrariesOut: properties: customer_types: description: >- Who the business sells to, main market first (products.industries.CUSTOMER_TYPES). title: Customer Types assortment: description: >- What the business sells: industry taxonomy nodes at any level (products/industries). title: Assortment origin_story: anyOf: - type: string - type: 'null' description: Tell us about how your brand came to be and its key milestones... title: Origin Story original_problem: anyOf: - type: string - type: 'null' description: What problem or need did your brand set out to address? title: Original Problem personality_characteristics: anyOf: - type: string - type: 'null' description: What personality traits best describe your brand? title: Personality Characteristics communication_style: anyOf: - type: string - type: 'null' description: How would you describe your brand's communication style? title: Communication Style unique_phrases: anyOf: - type: string - type: 'null' description: What phrases or expressions are unique to your brand? title: Unique Phrases avoided_phrases: anyOf: - type: string - type: 'null' description: What phrases or expressions should be avoided? title: Avoided Phrases core_values: anyOf: - type: string - type: 'null' description: What are your brand's core values and their importance? title: Core Values values_translation: anyOf: - type: string - type: 'null' description: How do these values translate into your products? title: Values Translation emotions_evoked: anyOf: - type: string - type: 'null' description: What emotions do your visual elements evoke? title: Emotions Evoked visual_elements: anyOf: - type: string - type: 'null' description: Describe your key colors, symbols, and visual elements... title: Visual Elements age_location: anyOf: - type: string - type: 'null' description: >- What are the key demographic characteristics of your target customers? title: Age Location lifestyle: anyOf: - type: string - type: 'null' description: What lifestyle characteristics define your target customers? title: Lifestyle problems_solved: anyOf: - type: string - type: 'null' description: What specific problems do your products solve for customers? title: Problems Solved market_frustrations: anyOf: - type: string - type: 'null' description: >- What frustrations do customers have with current market alternatives? title: Market Frustrations success_definitions: anyOf: - type: string - type: 'null' description: How do your customers define success when using your products? title: Success Definitions emotional_benefits: anyOf: - type: string - type: 'null' description: What emotional benefits do customers seek from your products? title: Emotional Benefits purchase_criteria: anyOf: - type: string - type: 'null' description: What factors influence customers' purchase decisions? title: Purchase Criteria objections_hesitations: anyOf: - type: string - type: 'null' description: What objections or hesitations do customers have before purchasing? title: Objections Hesitations intended_feelings: anyOf: - type: string - type: 'null' description: >- What feelings do you want customers to experience when using your products? title: Intended Feelings emotional_problem_solving: anyOf: - type: string - type: 'null' description: How do your products solve emotional problems for customers? title: Emotional Problem Solving excitement_vocabulary: anyOf: - type: string - type: 'null' description: >- What words and phrases do customers use when excited about your products? title: Excitement Vocabulary self_perception: anyOf: - type: string - type: 'null' description: How do your products change customers' self-perception? title: Self Perception community_identification: anyOf: - type: string - type: 'null' description: How do your products help customers identify with a community? title: Community Identification value_expression: anyOf: - type: string - type: 'null' description: How do your products express customers' values or lifestyle? title: Value Expression social_signaling: anyOf: - type: string - type: 'null' description: How do your products serve as social signals for customers? title: Social Signaling larger_purpose: anyOf: - type: string - type: 'null' description: How do your products connect customers to a larger purpose? title: Larger Purpose guiding_principles: anyOf: - type: string - type: 'null' description: What principles guide your product development? title: Guiding Principles unique_approach: anyOf: - type: string - type: 'null' description: How does your approach differ from others in the industry? title: Unique Approach distinguishing_features: anyOf: - type: string - type: 'null' description: What features and qualities make your products unique? title: Distinguishing Features signature_elements: anyOf: - type: string - type: 'null' description: What elements are consistently present across your product line? title: Signature Elements typical_environments: anyOf: - type: string - type: 'null' description: In what environments do customers typically use your products? title: Typical Environments creative_uses: anyOf: - type: string - type: 'null' description: What unexpected or creative ways have customers used your products? title: Creative Uses improvements: anyOf: - type: string - type: 'null' description: How have your products evolved and improved? title: Improvements customer_feedback: anyOf: - type: string - type: 'null' description: How has customer feedback influenced product development? title: Customer Feedback co_purchased: anyOf: - type: string - type: 'null' description: Which products are frequently purchased together? title: Co Purchased unexpected_pairings: anyOf: - type: string - type: 'null' description: What unexpected product combinations have customers created? title: Unexpected Pairings complementary_accessories: anyOf: - type: string - type: 'null' description: What accessories complement your products? title: Complementary Accessories problem_solving_combinations: anyOf: - type: string - type: 'null' description: What product combinations solve specific customer problems? title: Problem Solving Combinations system_integration: anyOf: - type: string - type: 'null' description: How do your products integrate into larger systems or collections? title: System Integration texture_sound_smell: anyOf: - type: string - type: 'null' description: What sensory aspects make your products distinctive? title: Texture Sound Smell first_impressions: anyOf: - type: string - type: 'null' description: What are the most striking physical aspects of your products? title: First Impressions user_experience: anyOf: - type: string - type: 'null' description: How would you describe the user experience? title: User Experience delightful_aspects: anyOf: - type: string - type: 'null' description: What sensory aspects delight customers? title: Delightful Aspects satisfying_qualities: anyOf: - type: string - type: 'null' description: What physical qualities do customers find satisfying? title: Satisfying Qualities tactile_qualities: anyOf: - type: string - type: 'null' description: What tactile qualities make your products unique? title: Tactile Qualities sounds_scents_tastes: anyOf: - type: string - type: 'null' description: What sounds, scents, or tastes are relevant to your products? title: Sounds Scents Tastes visual_details: anyOf: - type: string - type: 'null' description: What visual details might customers overlook? title: Visual Details unboxing_experience: anyOf: - type: string - type: 'null' description: How does the unboxing experience enhance the product? title: Unboxing Experience environmental_factors: anyOf: - type: string - type: 'null' description: What environmental factors affect product usage? title: Environmental Factors specialized_terms: anyOf: - type: string - type: 'null' description: What specialized terms and jargon are important in your industry? title: Specialized Terms technical_terms: anyOf: - type: string - type: 'null' description: Which technical terms need to be simplified for customers? title: Technical Terms significant_trends: anyOf: - type: string - type: 'null' description: What are the current significant trends in your industry? title: Significant Trends company_response: anyOf: - type: string - type: 'null' description: How is your company responding to or leading these trends? title: Company Response applicable_standards: anyOf: - type: string - type: 'null' description: What standards or certifications apply to your products? title: Applicable Standards certification_benefits: anyOf: - type: string - type: 'null' description: What benefits do these certifications provide to customers? title: Certification Benefits pain_points: anyOf: - type: string - type: 'null' description: What pain points in your industry do your products address? title: Pain Points technology_impact: anyOf: - type: string - type: 'null' description: How is technology changing your industry? title: Technology Impact high_response_colors: anyOf: - type: string - type: 'null' description: Which colors generate the strongest customer response? title: High Response Colors attention_grabbing: anyOf: - type: string - type: 'null' description: What visual elements grab customer attention? title: Attention Grabbing sales_impact: anyOf: - type: string - type: 'null' description: What visual changes have impacted sales? title: Sales Impact background_preference: anyOf: - type: string - type: 'null' description: Do customers prefer lifestyle or plain backgrounds? title: Background Preference first_notice: anyOf: - type: string - type: 'null' description: What visual elements do customers notice first? title: First Notice target_keywords: anyOf: - type: string - type: 'null' description: What are your main target keywords and phrases? title: Target Keywords long_tail_keywords: anyOf: - type: string - type: 'null' description: What long-tail keywords are important for your products? title: Long Tail Keywords marketing_priorities: anyOf: - type: string - type: 'null' description: What information should be prioritized in marketing? title: Marketing Priorities required_sections: anyOf: - type: string - type: 'null' description: What sections must be included in product descriptions? title: Required Sections top_competitors: anyOf: - type: string - type: 'null' description: Who are your top competitors and how do you position against them? title: Top Competitors differentiated_language: anyOf: - type: string - type: 'null' description: What language sets you apart from competitors? title: Differentiated Language purchase_phrases: anyOf: - type: string - type: 'null' description: What phrases trigger purchases? title: Purchase Phrases testimonial_themes: anyOf: - type: string - type: 'null' description: What themes in testimonials drive conversions? title: Testimonial Themes emotional_drivers: anyOf: - type: string - type: 'null' description: What emotional factors drive customer searches? title: Emotional Drivers immediate_problem_solving: anyOf: - type: string - type: 'null' description: What immediate problems do your products solve? title: Immediate Problem Solving aspirational_outcomes: anyOf: - type: string - type: 'null' description: What outcomes do customers aspire to achieve? title: Aspirational Outcomes convincing_info: anyOf: - type: string - type: 'null' description: What information finally convinces customers to buy? title: Convincing Info time_sensitive: anyOf: - type: string - type: 'null' description: What factors create urgency in purchasing? title: Time Sensitive quality_reassurance: anyOf: - type: string - type: 'null' description: What proof points reassure customers about quality? title: Quality Reassurance expertise_validation: anyOf: - type: string - type: 'null' description: What credentials validate your expertise? title: Expertise Validation guarantees_policies: anyOf: - type: string - type: 'null' description: What guarantees and policies build trust? title: Guarantees Policies reassurance_areas: anyOf: - type: string - type: 'null' description: Which areas need the most customer reassurance? title: Reassurance Areas social_proof: anyOf: - type: string - type: 'null' description: What formats of social proof are most effective? title: Social Proof premium_objections: anyOf: - type: string - type: 'null' description: What objections do customers have about premium products? title: Premium Objections category_misconceptions: anyOf: - type: string - type: 'null' description: What misconceptions exist about your product category? title: Category Misconceptions competitor_confusion: anyOf: - type: string - type: 'null' description: What confusion do competitors create in the market? title: Competitor Confusion transparency_limitations: anyOf: - type: string - type: 'null' description: What limitations should be transparently communicated? title: Transparency Limitations durability_concerns: anyOf: - type: string - type: 'null' description: What concerns do customers have about durability? title: Durability Concerns urgent_motivations: anyOf: - type: string - type: 'null' description: What creates urgency in purchasing? title: Urgent Motivations limited_time_offers: anyOf: - type: string - type: 'null' description: What limited-time offers drive sales? title: Limited Time Offers exclusivity: anyOf: - type: string - type: 'null' description: What aspects of exclusivity do customers value? title: Exclusivity social_trends: anyOf: - type: string - type: 'null' description: How do social trends influence purchases? title: Social Trends seasonal_patterns: anyOf: - type: string - type: 'null' description: What seasonal patterns affect purchasing? title: Seasonal Patterns customer_value: anyOf: - type: string - type: 'null' description: How do customers describe your product's value? title: Customer Value price_justification: anyOf: - type: string - type: 'null' description: What aspects justify your product's price? title: Price Justification surprising_features: anyOf: - type: string - type: 'null' description: What features surprise and delight customers? title: Surprising Features missed_aspects: anyOf: - type: string - type: 'null' description: What aspects of your products are often overlooked? title: Missed Aspects value_problem_solving: anyOf: - type: string - type: 'null' description: What problems do customers frequently mention your products solving? title: Value Problem Solving sustainability_practices: anyOf: - type: string - type: 'null' description: What sustainability practices have you implemented? title: Sustainability Practices environmental_impact: anyOf: - type: string - type: 'null' description: How do you minimize environmental impact? title: Environmental Impact ethical_practices: anyOf: - type: string - type: 'null' description: What ethical practices guide your sourcing and manufacturing? title: Ethical Practices supply_chain: anyOf: - type: string - type: 'null' description: How do you ensure fair treatment in your supply chain? title: Supply Chain social_causes: anyOf: - type: string - type: 'null' description: What social causes do you support? title: Social Causes community_giving: anyOf: - type: string - type: 'null' description: How do you give back to the community? title: Community Giving transparency_areas: anyOf: - type: string - type: 'null' description: What areas require transparency? title: Transparency Areas communication_methods: anyOf: - type: string - type: 'null' description: How do you communicate about origins and processes? title: Communication Methods sensory_experiences: anyOf: - type: string - type: 'null' description: What sensory experiences define your products? title: Sensory Experiences origin_sourcing: anyOf: - type: string - type: 'null' description: What origin and sourcing details are important? title: Origin Sourcing seasonal_ingredients: anyOf: - type: string - type: 'null' description: How do seasonal ingredients affect availability? title: Seasonal Ingredients dietary_accommodations: anyOf: - type: string - type: 'null' description: What dietary accommodations do you offer? title: Dietary Accommodations serving_suggestions: anyOf: - type: string - type: 'null' description: What serving suggestions and pairings work well? title: Serving Suggestions preparation_storage: anyOf: - type: string - type: 'null' description: What preparation and storage information is important? title: Preparation Storage holistic_benefits: anyOf: - type: string - type: 'null' description: What holistic benefits do your products offer? title: Holistic Benefits wellness_integration: anyOf: - type: string - type: 'null' description: How do your products integrate into wellness routines? title: Wellness Integration efficacy_validation: anyOf: - type: string - type: 'null' description: How do you validate product efficacy? title: Efficacy Validation benefit_timing: anyOf: - type: string - type: 'null' description: What are the immediate and long-term benefits? title: Benefit Timing sensory_qualities: anyOf: - type: string - type: 'null' description: What sensory and experiential qualities matter? title: Sensory Qualities complementary_practices: anyOf: - type: string - type: 'null' description: How do your products complement other practices? title: Complementary Practices environmental_performance: anyOf: - type: string - type: 'null' description: What environmental performance advantages do you offer? title: Environmental Performance activity_enhancement: anyOf: - type: string - type: 'null' description: How do your products enhance activities? title: Activity Enhancement durability_conditions: anyOf: - type: string - type: 'null' description: How do your products perform in challenging conditions? title: Durability Conditions skill_level: anyOf: - type: string - type: 'null' description: How do your products accommodate different skill levels? title: Skill Level safety_considerations: anyOf: - type: string - type: 'null' description: What safety considerations are important? title: Safety Considerations equipment_integration: anyOf: - type: string - type: 'null' description: How do your products integrate with other equipment? title: Equipment Integration species_needs: anyOf: - type: string - type: 'null' description: What needs are specific to different species? title: Species Needs life_stage: anyOf: - type: string - type: 'null' description: How do your products accommodate different life stages? title: Life Stage safety_durability: anyOf: - type: string - type: 'null' description: What safety and durability features are important? title: Safety Durability owner_pet_bond: anyOf: - type: string - type: 'null' description: How do your products strengthen the owner-pet bond? title: Owner Pet Bond pet_health: anyOf: - type: string - type: 'null' description: What health and wellbeing benefits do you offer? title: Pet Health care_simplification: anyOf: - type: string - type: 'null' description: How do your products simplify pet care? title: Care Simplification developmental_adaptation: anyOf: - type: string - type: 'null' description: How do your products adapt to development stages? title: Developmental Adaptation safety_standards: anyOf: - type: string - type: 'null' description: What safety standards and certifications do you meet? title: Safety Standards learning_support: anyOf: - type: string - type: 'null' description: How do your products support learning and development? title: Learning Support parental_pain_points: anyOf: - type: string - type: 'null' description: What parental pain points do your products solve? title: Parental Pain Points family_situation: anyOf: - type: string - type: 'null' description: How do your products accommodate different family situations? title: Family Situation child_engagement: anyOf: - type: string - type: 'null' description: What elements engage children? title: Child Engagement performance_efficiency: anyOf: - type: string - type: 'null' description: What performance and efficiency benefits do you offer? title: Performance Efficiency travel_safety: anyOf: - type: string - type: 'null' description: How do your products enhance travel safety and comfort? title: Travel Safety durability_reliability: anyOf: - type: string - type: 'null' description: What durability and reliability features are important? title: Durability Reliability vehicle_accommodation: anyOf: - type: string - type: 'null' description: How do your products accommodate different vehicles? title: Vehicle Accommodation installation_maintenance: anyOf: - type: string - type: 'null' description: What installation and maintenance considerations are important? title: Installation Maintenance auto_system_integration: anyOf: - type: string - type: 'null' description: How do your products integrate with other systems? title: Auto System Integration climate_performance: anyOf: - type: string - type: 'null' description: How do your products perform in different climates? title: Climate Performance space_optimization: anyOf: - type: string - type: 'null' description: How do your products optimize space? title: Space Optimization aesthetic_functional: anyOf: - type: string - type: 'null' description: How do your products enhance aesthetics and functionality? title: Aesthetic Functional maintenance_durability: anyOf: - type: string - type: 'null' description: What maintenance and durability considerations are important? title: Maintenance Durability sustainable_practices: anyOf: - type: string - type: 'null' description: How do your products support sustainable practices? title: Sustainable Practices outdoor_sensory: anyOf: - type: string - type: 'null' description: What sensory experiences do your products create outdoors? title: Outdoor Sensory skill_level_support: anyOf: - type: string - type: 'null' description: How do your products support different skill levels? title: Skill Level Support creative_possibilities: anyOf: - type: string - type: 'null' description: What unique creative possibilities do your products offer? title: Creative Possibilities tool_integration: anyOf: - type: string - type: 'null' description: How do your products integrate with other tools? title: Tool Integration quality_performance: anyOf: - type: string - type: 'null' description: What quality and performance attributes matter? title: Quality Performance project_preservation: anyOf: - type: string - type: 'null' description: How do your products help preserve projects? title: Project Preservation learning_resources: anyOf: - type: string - type: 'null' description: What learning and community resources do you offer? title: Learning Resources productivity_efficiency: anyOf: - type: string - type: 'null' description: How do your products enhance productivity? title: Productivity Efficiency ergonomic_comfort: anyOf: - type: string - type: 'null' description: What ergonomic and comfort features are important? title: Ergonomic Comfort collaboration: anyOf: - type: string - type: 'null' description: How do your products facilitate collaboration? title: Collaboration professional_durability: anyOf: - type: string - type: 'null' description: What durability features matter in professional settings? title: Professional Durability workplace_setting: anyOf: - type: string - type: 'null' description: How do your products adapt to workplace settings? title: Workplace Setting organizational_improvements: anyOf: - type: string - type: 'null' description: How do your products improve organization? title: Organizational Improvements travel_scenarios: anyOf: - type: string - type: 'null' description: How do your products accommodate different travel scenarios? title: Travel Scenarios travel_durability: anyOf: - type: string - type: 'null' description: What durability features are important for travel? title: Travel Durability travel_convenience: anyOf: - type: string - type: 'null' description: How do your products enhance travel convenience? title: Travel Convenience travel_space_optimization: anyOf: - type: string - type: 'null' description: How do your products optimize space for travel? title: Travel Space Optimization regulation_compliance: anyOf: - type: string - type: 'null' description: How do your products comply with travel regulations? title: Regulation Compliance destination_adaptability: anyOf: - type: string - type: 'null' description: How do your products adapt to different destinations? title: Destination Adaptability craftsmanship: anyOf: - type: string - type: 'null' description: What craftsmanship details are important? title: Craftsmanship styling_versatility: anyOf: - type: string - type: 'null' description: How versatile are your products in styling? title: Styling Versatility material_quality: anyOf: - type: string - type: 'null' description: What material and quality attributes matter? title: Material Quality trend_timeless: anyOf: - type: string - type: 'null' description: How do your products balance trends and timelessness? title: Trend Timeless design_symbolism: anyOf: - type: string - type: 'null' description: What symbolism is incorporated into your designs? title: Design Symbolism body_type: anyOf: - type: string - type: 'null' description: How do your products accommodate different body types? title: Body Type unique_perspective: anyOf: - type: string - type: 'null' description: What unique perspective or voice do your products offer? title: Unique Perspective experience_level: anyOf: - type: string - type: 'null' description: How do your products accommodate different experience levels? title: Experience Level emotional_responses: anyOf: - type: string - type: 'null' description: What emotional responses and insights do your products evoke? title: Emotional Responses current_events: anyOf: - type: string - type: 'null' description: How do your products connect to current events? title: Current Events complementary_content: anyOf: - type: string - type: 'null' description: What complementary content enhances your products? title: Complementary Content format_experience: anyOf: - type: string - type: 'null' description: How do different formats affect the experience? title: Format Experience memorable_moments: anyOf: - type: string - type: 'null' description: How do your products create memorable moments? title: Memorable Moments emotional_connection: anyOf: - type: string - type: 'null' description: How do your products foster emotional connections? title: Emotional Connection occasion_accommodation: anyOf: - type: string - type: 'null' description: How do your products accommodate different occasions? title: Occasion Accommodation presentation_enhancement: anyOf: - type: string - type: 'null' description: How do your products enhance presentation? title: Presentation Enhancement novelty_practicality: anyOf: - type: string - type: 'null' description: How do your products balance novelty and practicality? title: Novelty Practicality cultural_gifting: anyOf: - type: string - type: 'null' description: How do your products align with cultural gifting practices? title: Cultural Gifting apparel_styling_versatility: anyOf: - type: string - type: 'null' description: How versatile are your products in styling? title: Apparel Styling Versatility occasion_season: anyOf: - type: string - type: 'null' description: How do your products transition between occasions and seasons? title: Occasion Season flattering_body_types: anyOf: - type: string - type: 'null' description: How do your products flatter different body types? title: Flattering Body Types learning_curve: anyOf: - type: string - type: 'null' description: What learning curve should customers expect? title: Learning Curve future_proofing: anyOf: - type: string - type: 'null' description: How do your products future-proof? title: Future Proofing frustration_elimination: anyOf: - type: string - type: 'null' description: How do your products eliminate common frustrations? title: Frustration Elimination above_fold: anyOf: - type: string - type: 'null' description: What content should be prioritized above the fold on mobile? title: Above Fold mobile_structure: anyOf: - type: string - type: 'null' description: How should content be structured for mobile browsing? title: Mobile Structure journey_importance: anyOf: - type: string - type: 'null' description: What information is important at each journey stage? title: Journey Importance funnel_strategies: anyOf: - type: string - type: 'null' description: How can content support the sales funnel? title: Funnel Strategies content_requirements: anyOf: - type: string - type: 'null' description: What content requirements exist for each sales channel? title: Content Requirements platform_limitations: anyOf: - type: string - type: 'null' description: What limitations exist for each platform? title: Platform Limitations regional_adaptations: anyOf: - type: string - type: 'null' description: How should descriptions be adapted for different regions? title: Regional Adaptations cultural_considerations: anyOf: - type: string - type: 'null' description: What cultural considerations affect different markets? title: Cultural Considerations cultural_references: anyOf: - type: string - type: 'null' description: What cultural references need to be localized? title: Cultural References seasonal_relevance: anyOf: - type: string - type: 'null' description: How does seasonal relevance vary by region? title: Seasonal Relevance terminology_adjustments: anyOf: - type: string - type: 'null' description: What terminology needs to be adjusted internationally? title: Terminology Adjustments symbol_significance: anyOf: - type: string - type: 'null' description: What symbols have different significance in different cultures? title: Symbol Significance purchasing_drivers: anyOf: - type: string - type: 'null' description: What regional events drive purchasing? title: Purchasing Drivers first_time_vs_repeat: anyOf: - type: string - type: 'null' description: How does content differ for first-time vs. repeat buyers? title: First Time Vs Repeat consideration_questions: anyOf: - type: string - type: 'null' description: What questions arise during the consideration process? title: Consideration Questions return_prevention: anyOf: - type: string - type: 'null' description: What information helps prevent returns? title: Return Prevention gift_buyer_support: anyOf: - type: string - type: 'null' description: What information helps gift buyers? title: Gift Buyer Support seasonal_presentation: anyOf: - type: string - type: 'null' description: How should content be presented seasonally? title: Seasonal Presentation customer_important_specs: anyOf: - type: string - type: 'null' description: Which specifications are most important to customers? title: Customer Important Specs features_needing_explanation: anyOf: - type: string - type: 'null' description: Which features need additional explanation? title: Features Needing Explanation performance_benchmarks: anyOf: - type: string - type: 'null' description: What performance benchmarks are helpful for customers? title: Performance Benchmarks industry_standards: anyOf: - type: string - type: 'null' description: How do your products compare to industry standards? title: Industry Standards everyday_benefits: anyOf: - type: string - type: 'null' description: How do features benefit customers in everyday use? title: Everyday Benefits technical_innovations: anyOf: - type: string - type: 'null' description: What technical innovations should be highlighted? title: Technical Innovations common_questions: anyOf: - type: string - type: 'null' description: What technical questions do customers commonly ask? title: Common Questions support_reduction: anyOf: - type: string - type: 'null' description: What information helps reduce support needs? title: Support Reduction resonant_origins: anyOf: - type: string - type: 'null' description: What origin stories resonate with customers? title: Resonant Origins unexpected_uses: anyOf: - type: string - type: 'null' description: What unexpected ways have customers used your products? title: Unexpected Uses before_after: anyOf: - type: string - type: 'null' description: What before/after scenarios effectively show impact? title: Before After craftsmanship_details: anyOf: - type: string - type: 'null' description: What craftsmanship or development details impress customers? title: Craftsmanship Details year_round_narratives: anyOf: - type: string - type: 'null' description: What narratives are relevant throughout the year? title: Year Round Narratives positive_reviews: anyOf: - type: string - type: 'null' description: What phrases appear in positive reviews? title: Positive Reviews pre_purchase_questions: anyOf: - type: string - type: 'null' description: What questions do customers ask before purchasing? title: Pre Purchase Questions post_use_descriptions: anyOf: - type: string - type: 'null' description: >- How do customers describe their experience after using your products? title: Post Use Descriptions terminology_levels: anyOf: - type: string - type: 'null' description: How does terminology differ between beginners and experts? title: Terminology Levels helpful_metaphors: anyOf: - type: string - type: 'null' description: >- What metaphors or comparisons help customers understand your products? title: Helpful Metaphors pre_purchase_hesitations: anyOf: - type: string - type: 'null' description: What hesitations do customers have before purchasing? title: Pre Purchase Hesitations browser_to_buyer: anyOf: - type: string - type: 'null' description: What information helps convert browsers to buyers? title: Browser To Buyer confidence_building: anyOf: - type: string - type: 'null' description: What guarantees build customer confidence? title: Confidence Building value_comparison: anyOf: - type: string - type: 'null' description: What points help customers compare value? title: Value Comparison universal_questions: anyOf: - type: string - type: 'null' description: What questions do all customers ask before purchasing? title: Universal Questions category_clarification: anyOf: - type: string - type: 'null' description: How can category confusion be clarified? title: Category Clarification benefit_comparisons: anyOf: - type: string - type: 'null' description: What comparisons help explain benefits? title: Benefit Comparisons product_bundles: anyOf: - type: string - type: 'null' description: What product bundles make decisions easier? title: Product Bundles quick_filters: anyOf: - type: string - type: 'null' description: What filters help customers find products quickly? title: Quick Filters critical_info: anyOf: - type: string - type: 'null' description: What information is critical for upfront decisions? title: Critical Info product_occasions: anyOf: - type: string - type: 'null' description: What occasions are associated with your products? title: Product Occasions memorable_aspects: anyOf: - type: string - type: 'null' description: What aspects of the experience are most memorable? title: Memorable Aspects memory_role: anyOf: - type: string - type: 'null' description: How do your products create or preserve memories? title: Memory Role special_moments: anyOf: - type: string - type: 'null' description: How do your products integrate into special moments? title: Special Moments product_traditions: anyOf: - type: string - type: 'null' description: What traditions center around your products? title: Product Traditions id: title: Id type: integer required: - customer_types - assortment - origin_story - original_problem - personality_characteristics - communication_style - unique_phrases - avoided_phrases - core_values - values_translation - emotions_evoked - visual_elements - age_location - lifestyle - problems_solved - market_frustrations - success_definitions - emotional_benefits - purchase_criteria - objections_hesitations - intended_feelings - emotional_problem_solving - excitement_vocabulary - self_perception - community_identification - value_expression - social_signaling - larger_purpose - guiding_principles - unique_approach - distinguishing_features - signature_elements - typical_environments - creative_uses - improvements - customer_feedback - co_purchased - unexpected_pairings - complementary_accessories - problem_solving_combinations - system_integration - texture_sound_smell - first_impressions - user_experience - delightful_aspects - satisfying_qualities - tactile_qualities - sounds_scents_tastes - visual_details - unboxing_experience - environmental_factors - specialized_terms - technical_terms - significant_trends - company_response - applicable_standards - certification_benefits - pain_points - technology_impact - high_response_colors - attention_grabbing - sales_impact - background_preference - first_notice - target_keywords - long_tail_keywords - marketing_priorities - required_sections - top_competitors - differentiated_language - purchase_phrases - testimonial_themes - emotional_drivers - immediate_problem_solving - aspirational_outcomes - convincing_info - time_sensitive - quality_reassurance - expertise_validation - guarantees_policies - reassurance_areas - social_proof - premium_objections - category_misconceptions - competitor_confusion - transparency_limitations - durability_concerns - urgent_motivations - limited_time_offers - exclusivity - social_trends - seasonal_patterns - customer_value - price_justification - surprising_features - missed_aspects - value_problem_solving - sustainability_practices - environmental_impact - ethical_practices - supply_chain - social_causes - community_giving - transparency_areas - communication_methods - sensory_experiences - origin_sourcing - seasonal_ingredients - dietary_accommodations - serving_suggestions - preparation_storage - holistic_benefits - wellness_integration - efficacy_validation - benefit_timing - sensory_qualities - complementary_practices - environmental_performance - activity_enhancement - durability_conditions - skill_level - safety_considerations - equipment_integration - species_needs - life_stage - safety_durability - owner_pet_bond - pet_health - care_simplification - developmental_adaptation - safety_standards - learning_support - parental_pain_points - family_situation - child_engagement - performance_efficiency - travel_safety - durability_reliability - vehicle_accommodation - installation_maintenance - auto_system_integration - climate_performance - space_optimization - aesthetic_functional - maintenance_durability - sustainable_practices - outdoor_sensory - skill_level_support - creative_possibilities - tool_integration - quality_performance - project_preservation - learning_resources - productivity_efficiency - ergonomic_comfort - collaboration - professional_durability - workplace_setting - organizational_improvements - travel_scenarios - travel_durability - travel_convenience - travel_space_optimization - regulation_compliance - destination_adaptability - craftsmanship - styling_versatility - material_quality - trend_timeless - design_symbolism - body_type - unique_perspective - experience_level - emotional_responses - current_events - complementary_content - format_experience - memorable_moments - emotional_connection - occasion_accommodation - presentation_enhancement - novelty_practicality - cultural_gifting - apparel_styling_versatility - occasion_season - flattering_body_types - learning_curve - future_proofing - frustration_elimination - above_fold - mobile_structure - journey_importance - funnel_strategies - content_requirements - platform_limitations - regional_adaptations - cultural_considerations - cultural_references - seasonal_relevance - terminology_adjustments - symbol_significance - purchasing_drivers - first_time_vs_repeat - consideration_questions - return_prevention - gift_buyer_support - seasonal_presentation - customer_important_specs - features_needing_explanation - performance_benchmarks - industry_standards - everyday_benefits - technical_innovations - common_questions - support_reduction - resonant_origins - unexpected_uses - before_after - craftsmanship_details - year_round_narratives - positive_reviews - pre_purchase_questions - post_use_descriptions - terminology_levels - helpful_metaphors - pre_purchase_hesitations - browser_to_buyer - confidence_building - value_comparison - universal_questions - category_clarification - benefit_comparisons - product_bundles - quick_filters - critical_info - product_occasions - memorable_aspects - memory_role - special_moments - product_traditions - id title: PublicKnowledgeLibrariesOut type: object ErrorOut: description: |- The shared error envelope every NinjaAPI instance renders. `code` is present for :class:`user_app.ninja_api.errors.ApiError` (`insufficient_scope`, `rate_limited`, `invalid_cursor`, …) so machine clients can branch without parsing `error`. properties: error: title: Error type: string code: anyOf: - type: string - type: 'null' title: Code request_id: title: Request Id type: string required: - error - request_id title: ErrorOut type: object ValidationErrorOut: description: 'HTTP 422: `detail` carries Ninja''s per-field validation errors.' properties: error: title: Error type: string code: anyOf: - type: string - type: 'null' title: Code request_id: title: Request Id type: string detail: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Detail required: - error - request_id title: ValidationErrorOut type: object securitySchemes: ProjectApiKeyAuth: type: http scheme: bearer x-scopes: project:read: Read the project's identity, locales and limits. products:read: >- List and read products, including attribute values and category membership. products:write: Create and update products and their catalogue content. products:delete: Delete products from this project. categories:read: List the project's category tree. categories:write: Create and update the project's categories. categories:delete: Delete the project's categories. attributes:read: List the project's attribute definitions. attributes:write: Create and update the project's attribute definitions. attributes:delete: Delete the project's attribute definitions. attribute-groups:read: Read the project's attribute groups. attribute-groups:write: Create and update the project's attribute groups. attribute-groups:delete: Delete the project's attribute groups. product-families:read: Read the project's product families. product-families:write: Create and update the project's product families. product-families:delete: Delete the project's product families. family-attributes:read: Read the project's family attribute bindings. family-attributes:write: Create and update the project's family attribute bindings. family-attributes:delete: Delete the project's family attribute bindings. product-categories:read: Read the project's product category memberships. product-categories:write: Create and update the project's product category memberships. product-categories:delete: Delete the project's product category memberships. value-code-sets:read: Read the project's controlled vocabularies. value-code-sets:write: Create and update the project's controlled vocabularies. value-code-sets:delete: Delete the project's controlled vocabularies. code-set-values:read: Read values in the project's controlled vocabularies. code-set-values:write: Create and update values in the project's controlled vocabularies. code-set-values:delete: Delete values in the project's controlled vocabularies. uom-code-sets:read: Read the project's unit-of-measure sets. uom-code-sets:write: Create and update the project's unit-of-measure sets. uom-code-sets:delete: Delete the project's unit-of-measure sets. uom-values:read: Read units in the project's unit-of-measure sets. uom-values:write: Create and update units in the project's unit-of-measure sets. uom-values:delete: Delete units in the project's unit-of-measure sets. prompts:read: Read prompts visible to the key issuer in this project. prompts:write: >- Create prompts and update the key issuer's own prompts in this project. prompts:delete: Delete the key issuer's own prompts in this project. knowledge-libraries:read: Read this project's knowledge library. knowledge-libraries:write: Create and update this project's knowledge library. knowledge-libraries:delete: Delete this project's knowledge library. keywords:read: Read the project's keywords. keywords:write: Create and update the project's keywords. keywords:delete: Delete the project's keywords. dictionary-entries:read: Read the project's translation dictionary entries. dictionary-entries:write: Create and update the project's translation dictionary entries. dictionary-entries:delete: Delete the project's translation dictionary entries. import-templates:read: Read the project's reusable import templates. import-templates:write: Create and update the project's reusable import templates. import-templates:delete: Delete the project's reusable import templates. export-templates:read: Read the project's reusable export templates. export-templates:write: Create and update the project's reusable export templates. export-templates:delete: Delete the project's reusable export templates. enrichment:execute: >- Start product enrichment using this project's native pipelines and credit limits. translations:execute: >- Start product translation using this project's native pipelines and credit limits. bulk-actions:execute: Start bulk actions against this project's products. jobs:read: Read this project's background job status and progress. jobs:cancel: Request cooperative cancellation of this project's background jobs. bearerFormat: Project API key (wpk_...) description: >- Use a project API key from **Settings > API Access**. Send it as `Authorization: Bearer wpk_...`. See [authentication and scopes](/en/api-reference/authentication) for setup and permissions. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.