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

# Generate Workspace Company

> Generate workspace company content from a domain, free-form source materials (text, URLs, or Resource references), or both. At least one of `domain` or `sources` is required. When `domain` is provided it is scraped; when `sources` are provided they are expanded; both feed the workspace builder LLM. The result is persisted: the existing workspace company is updated in place, or one is created if it does not exist.



## OpenAPI

````yaml post /api/v2/workspace-company/generate
openapi: 3.0.0
info:
  version: 1.0.0
  title: Octave API
  description: API for Octave workspace management and AI-powered content generation
servers:
  - url: https://app.octavehq.com
security:
  - ApiKeyAuth: []
paths:
  /api/v2/workspace-company/generate:
    post:
      tags:
        - Workspace Company
      summary: Generate Workspace Company
      description: >-
        Generate workspace company content from a domain, free-form source
        materials (text, URLs, or Resource references), or both. At least one of
        `domain` or `sources` is required. When `domain` is provided it is
        scraped; when `sources` are provided they are expanded; both feed the
        workspace builder LLM. The result is persisted: the existing workspace
        company is updated in place, or one is created if it does not exist.
      operationId: generateWorkspaceCompany
      requestBody:
        description: Workspace Company generation input
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: string
                  minLength: 1
                  description: >-
                    The domain or URL to scrape and generate the workspace
                    company from. Optional if `sources` is provided.
                  example: acme.com
                sources:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - TEXT
                          - URL
                          - RESOURCE
                        description: The type of source material
                        example: TEXT
                      value:
                        type: string
                        minLength: 1
                        description: The source content (text, URL, or name)
                        example: Lead generation and qualification for enterprise sales
                    required:
                      - type
                      - value
                  description: >-
                    Optional source materials (text or URLs) to feed into the
                    workspace company generation. At least one of `domain` or
                    `sources` must be provided. When both are provided, the
                    scraped domain content and the expanded sources are
                    combined.
                  example:
                    - type: TEXT
                      value: >-
                        We are a stealth-mode B2B platform helping mid-market
                        RevOps teams unify pipeline data.
      responses:
        '200':
          description: Workspace Company generated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  data:
                    $ref: '#/components/schemas/WorkspaceCompany'
                required:
                  - _metadata
                  - data
        '400':
          description: Bad request - unable to scrape domain or generate content
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
      deprecated: false
components:
  schemas:
    Metadata:
      type: object
      properties:
        usage:
          type: number
          default: 0
          example: 0
          description: API usage
        requestId:
          type: string
          example: requestId
          description: Request ID
        message:
          type: string
          example: message
          description: Message
        timestamp:
          type: string
          example: '2021-01-01T00:00:00.000Z'
          description: Timestamp
      required:
        - requestId
        - timestamp
    WorkspaceCompany:
      type: object
      properties:
        oId:
          type: string
          description: Workspace Company OId
        createdAt:
          type: string
          nullable: true
          format: date-time
          description: Creation date
        updatedAt:
          type: string
          nullable: true
          format: date-time
          description: Updated date
        data:
          $ref: '#/components/schemas/WorkspaceCompanyData'
        description:
          type: string
          description: Workspace Company description
        name:
          type: string
          description: Workspace Company name
        url:
          type: string
          description: Workspace Company website URL
        internalName:
          type: string
          nullable: true
          description: Internal name for the workspace company
        user:
          type: object
          nullable: true
          properties:
            oId:
              type: string
          required:
            - oId
          description: User who owns the workspace company
        workspace:
          type: object
          nullable: true
          properties:
            oId:
              type: string
              nullable: true
          description: Workspace the company belongs to
        intelOverride:
          type: object
          nullable: true
          properties:
            enabled:
              type: boolean
            cadence:
              type: string
              enum:
                - weekly
                - biweekly
                - monthly
            guidance:
              type: string
              nullable: true
      required:
        - oId
        - createdAt
        - updatedAt
        - description
        - name
        - url
    WorkspaceCompanyData:
      type: object
      nullable: true
      properties:
        whatWeDo:
          type: string
          nullable: true
        whyWeExist:
          type: array
          items:
            type: string
        howWePositionOurselves:
          type: array
          items:
            type: string
        whoWeHelp:
          type: array
          items:
            type: string
        whatMakesUsUnique:
          type: array
          items:
            type: string
        businessModel:
          type: array
          items:
            type: string
        marketDynamics:
          type: array
          items:
            type: string
        whyCustomersBuy:
          type: array
          nullable: true
          items:
            type: string
        whyCustomersCare:
          type: array
          nullable: true
          items:
            type: string
        customFields:
          $ref: '#/components/schemas/CustomDataFields'
        customMarketFields:
          $ref: '#/components/schemas/CustomDataFields'
      required:
        - whyWeExist
        - howWePositionOurselves
        - whoWeHelp
        - whatMakesUsUnique
        - businessModel
        - marketDynamics
    CustomDataFields:
      type: array
      items:
        $ref: '#/components/schemas/CustomDataFieldItem'
    CustomDataFieldItem:
      type: object
      properties:
        title:
          type: string
        value:
          type: array
          items:
            type: string
      required:
        - title
        - value
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````