> ## Documentation Index
> Fetch the complete documentation index at: https://docs.enginy.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get AI playbook

> Retrieve the company AI playbook for the workspace, including company context, products, ICPs, competitors, testimonials, FAQs, and ideal companies.

    > **Required scope:** `WORKSPACE_READ`
    >
    > **Rate limit:** 100 requests per minute



## OpenAPI

````yaml https://openapi.enginy.ai/definitions.json get /v1/ai-playbook
openapi: 3.1.0
info:
  title: Enginy API
  version: 1.0.0
  description: Public API for Enginy platform
servers:
  - url: https://openapi.enginy.ai
    description: Configured server
security: []
tags:
  - name: AI Variables
    description: >-
      Manage AI variables and discover the entity fields you can reference in
      prompts and entity requests.
  - name: Inbox
    description: >-
      Inbox endpoints for listing contact threads, reading thread messages,
      managing tags, and sending manual replies.
  - name: Workflows
    description: >-
      Build, validate, publish, run, and inspect advanced (graph) workflows,
      plus the block/condition catalog needed to author a workflow plan.
paths:
  /v1/ai-playbook:
    get:
      tags:
        - AI Playbook
      summary: Get AI playbook
      description: >-
        Retrieve the company AI playbook for the workspace, including company
        context, products, ICPs, competitors, testimonials, FAQs, and ideal
        companies.

            > **Required scope:** `WORKSPACE_READ`
            >
            > **Rate limit:** 100 requests per minute
      responses:
        '200':
          description: Successful response with the complete AI playbook
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      company:
                        type: object
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            description: Workspace name.
                          company:
                            type:
                              - string
                              - 'null'
                            description: Company name used in the AI playbook.
                          companyIndustry:
                            type:
                              - string
                              - 'null'
                            description: Company industry.
                          companyNumberOfEmployees:
                            type:
                              - string
                              - 'null'
                            description: Company size or number of employees.
                          companyHeadquartersLocation:
                            type:
                              - string
                              - 'null'
                            description: Company headquarters location.
                          companyFoundingYear:
                            type:
                              - string
                              - 'null'
                            description: Company founding year.
                          companyWebsite:
                            type:
                              - string
                              - 'null'
                            description: Company website URL.
                          companyLinkedinUrl:
                            type:
                              - string
                              - 'null'
                            description: Company LinkedIn URL.
                          companyOverview:
                            type:
                              - string
                              - 'null'
                            description: Company overview used for AI personalization.
                          companyProductsServices:
                            type:
                              - string
                              - 'null'
                            description: Legacy company products and services description.
                        required:
                          - name
                          - company
                          - companyIndustry
                          - companyNumberOfEmployees
                          - companyHeadquartersLocation
                          - companyFoundingYear
                          - companyWebsite
                          - companyLinkedinUrl
                          - companyOverview
                          - companyProductsServices
                        description: Company-level AI playbook information.
                      allCompanyProductsServices:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                              description: Product or service ID.
                            name:
                              type: string
                              description: Product or service name.
                            description:
                              type: string
                              description: Product or service description.
                            valueProposition:
                              type:
                                - string
                                - 'null'
                              description: Value proposition for this product or service.
                            minPrice:
                              type:
                                - number
                                - 'null'
                              description: Minimum price, when configured.
                            maxPrice:
                              type:
                                - number
                                - 'null'
                              description: Maximum price, when configured.
                            currency:
                              type:
                                - string
                                - 'null'
                              description: Currency for configured prices.
                            isMainProduct:
                              type: boolean
                              description: Whether this is the main product or service.
                          required:
                            - id
                            - name
                            - description
                            - valueProposition
                            - minPrice
                            - maxPrice
                            - currency
                            - isMainProduct
                        description: Products and services configured in the AI playbook.
                      idealCustomerProfiles:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                              description: Ideal customer profile ID.
                            name:
                              type: string
                              description: Ideal customer profile name.
                            jobTitles:
                              type: array
                              items:
                                type: string
                              description: Target job titles.
                            locations:
                              type: array
                              items:
                                type: string
                              description: Target locations.
                            companyIndustry:
                              type: string
                              description: Target company industries.
                            companySize:
                              type: string
                              description: Target company sizes.
                            keyPainPoints:
                              type: string
                              description: Key pain points for this profile.
                            additionalInfo:
                              type:
                                - string
                                - 'null'
                              description: Additional profile context.
                            revenue:
                              type: array
                              items:
                                type: string
                              description: Target revenue ranges.
                            disqualifyingFactors:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Factors that disqualify prospects from this
                                profile.
                            linkedInFilters:
                              description: >-
                                LinkedIn search filters associated with this
                                profile.
                          required:
                            - id
                            - name
                            - jobTitles
                            - locations
                            - companyIndustry
                            - companySize
                            - keyPainPoints
                            - additionalInfo
                            - revenue
                            - disqualifyingFactors
                        description: Ideal customer profiles configured in the AI playbook.
                      idealCompanies:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                              description: Ideal company ID.
                            name:
                              type: string
                              description: Ideal company name.
                            industry:
                              type:
                                - string
                                - 'null'
                              description: Ideal company industry.
                            imageUrl:
                              type:
                                - string
                                - 'null'
                              description: Ideal company image URL.
                            description:
                              type:
                                - string
                                - 'null'
                              description: Ideal company description.
                            linkedInUrl:
                              type:
                                - string
                                - 'null'
                              description: Ideal company LinkedIn URL.
                            companyUrn:
                              type: string
                              description: LinkedIn company URN.
                          required:
                            - id
                            - name
                            - industry
                            - imageUrl
                            - description
                            - linkedInUrl
                            - companyUrn
                        description: Ideal companies configured in the AI playbook.
                      competitors:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                              description: Competitor ID.
                            name:
                              type: string
                              description: Competitor name.
                            productDifferentiator:
                              type: string
                              description: >-
                                How this workspace differentiates from the
                                competitor.
                            linkedInUrl:
                              type:
                                - string
                                - 'null'
                              description: Competitor LinkedIn URL.
                          required:
                            - id
                            - name
                            - productDifferentiator
                            - linkedInUrl
                        description: Competitors configured in the AI playbook.
                      testimonials:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                              description: Testimonial ID.
                            companyName:
                              type: string
                              description: Customer company name.
                            promoterName:
                              type: string
                              description: Promoter name.
                            jobPosition:
                              type: string
                              description: Promoter job position.
                            mainBenefit:
                              type: string
                              description: Main benefit from the testimonial.
                          required:
                            - id
                            - companyName
                            - promoterName
                            - jobPosition
                            - mainBenefit
                        description: Testimonials configured in the AI playbook.
                      faqs:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                              description: FAQ ID.
                            question:
                              type: string
                              description: Question.
                            answer:
                              type: string
                              description: Answer.
                          required:
                            - id
                            - question
                            - answer
                        description: FAQs configured in the AI playbook.
                    required:
                      - company
                      - allCompanyProductsServices
                      - idealCustomerProfiles
                      - idealCompanies
                      - competitors
                      - testimonials
                      - faqs
                required:
                  - status
                  - message
                  - data
        '404':
          description: Workspace not found
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````