> ## 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 References

> Generate customer references from source materials using AI. Each input array generates one reference. Supports text, URLs, and generative names as sources.



## OpenAPI

````yaml post /api/v2/reference/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/reference/generate:
    post:
      tags:
        - Reference
      summary: Generate References
      description: >-
        Generate customer references from source materials using AI. Each input
        array generates one reference. Supports text, URLs, and generative names
        as sources.
      operationId: generateReferences
      requestBody:
        description: Reference generation input with source materials
        content:
          application/json:
            schema:
              type: object
              properties:
                primaryOfferingOId:
                  type: string
                  description: >-
                    Primary Offering to use as context when generating
                    references. If not provided, the primary company attached to
                    the Workspace will be used.
                  example: o_123456
                linkingStrategy:
                  allOf:
                    - $ref: '#/components/schemas/LinkingStrategy'
                    - description: >-
                        Strategy for linking generated references to offerings
                        (products/services)
                references:
                  $ref: '#/components/schemas/ReferenceGenerationInputs'
                brandVoiceOId:
                  type: string
                  description: Brand voice oId to apply to generated references
                  example: bv_123456
              required:
                - references
      responses:
        '200':
          description: References generated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        oId:
                          type: string
                          minLength: 1
                          description: The ID of the reference
                          example: r_1234
                        name:
                          type: string
                          nullable: true
                          description: The external facing name of the reference
                          example: Large filesharing service
                        internalName:
                          type: string
                          nullable: true
                          description: The internal name of the reference
                          example: Dropbox
                        createdAt:
                          type: string
                          format: date-time
                          description: The date and time the reference was created
                          example: '2021-01-01'
                        updatedAt:
                          type: string
                          nullable: true
                          format: date-time
                          description: The date and time the reference was updated
                          example: '2021-01-01'
                        deletedAt:
                          type: string
                          nullable: true
                          format: date-time
                          description: The date and time the reference was deleted
                          example: '2021-01-01'
                        archivedAt:
                          type: string
                          nullable: true
                          format: date-time
                          description: The date and time the reference was archived
                          example: '2021-01-01'
                        description:
                          type: string
                          nullable: true
                          description: The description of the reference
                          example: Description of the reference
                        active:
                          type: boolean
                          default: true
                          description: Whether the reference is active and can be used
                          example: true
                        data:
                          $ref: '#/components/schemas/ReferenceData'
                        user:
                          type: object
                          properties:
                            oId:
                              type: string
                              nullable: true
                              description: The ID of the user
                              example: u_1234
                            firstName:
                              type: string
                              nullable: true
                              description: >-
                                The first name of the user who created the
                                reference
                              example: John
                            lastName:
                              type: string
                              nullable: true
                              description: >-
                                The last name of the user who created the
                                reference
                              example: Doe
                        workspace:
                          type: object
                          properties:
                            oId:
                              type: string
                              nullable: true
                              description: The ID of the workspace
                              example: w_1234
                        unrecognized:
                          type: boolean
                          nullable: true
                          description: Whether the reference is unrecognized
                          example: false
                      required:
                        - oId
                        - createdAt
                        - data
                        - user
                        - workspace
                required:
                  - _metadata
                  - data
        '400':
          description: Bad request - invalid sources or unable to process
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
        '404':
          description: Offering not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
      deprecated: false
components:
  schemas:
    LinkingStrategy:
      oneOf:
        - $ref: '#/components/schemas/LinkingStrategyAll'
        - $ref: '#/components/schemas/LinkingStrategySpecific'
      discriminator:
        propertyName: mode
        mapping:
          ALL:
            $ref: '#/components/schemas/LinkingStrategyAll'
          SPECIFIC:
            $ref: '#/components/schemas/LinkingStrategySpecific'
      default:
        mode: ALL
      description: Strategy for linking this persona to offerings (products/services)
    ReferenceGenerationInputs:
      type: array
      items:
        type: object
        properties:
          name:
            type: string
            description: >-
              Optional name for the reference - if provided, will be used as the
              entity name
            example: Large filesharing service
          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: Source materials to generate the reference from
        required:
          - sources
      minItems: 1
      description: >-
        Array of reference generation requests - each object generates one
        reference
      example:
        - name: Large filesharing service
          sources:
            - type: TEXT
              value: Leading cloud storage company with 500+ million users
        - sources:
            - type: URL
              value: https://example.com/case-study
    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
    ReferenceData:
      type: object
      nullable: true
      properties:
        businessModel:
          type: array
          nullable: true
          items:
            type: string
        theirChallenge:
          type: array
          nullable: true
          items:
            type: string
        howTheyUseUs:
          type: array
          nullable: true
          items:
            type: string
        whyTheyChoseUs:
          type: array
          nullable: true
          items:
            type: string
        impactTheySaw:
          type: array
          nullable: true
          items:
            type: string
        stakeholdersInvolved:
          type: array
          nullable: true
          items:
            type: string
        customFields:
          $ref: '#/components/schemas/CustomDataFields'
        additionalProperties:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
              - type: number
              - type: boolean
    LinkingStrategyAll:
      type: object
      properties:
        mode:
          type: string
          enum:
            - ALL
          description: >-
            Link to all active offerings in the workspace (products, services,
            and solutions)
          example: ALL
      required:
        - mode
    LinkingStrategySpecific:
      type: object
      properties:
        mode:
          type: string
          enum:
            - SPECIFIC
          description: >-
            Link to specific offerings by their IDs (products, services, and
            solutions)
          example: SPECIFIC
        offeringOIds:
          type: array
          items:
            type: string
            minLength: 1
          minItems: 1
          description: >-
            Array of offering IDs to link to (supports product, service, and
            solution oIds)
          example:
            - px_123
            - sc_456
            - sv_789
      required:
        - mode
        - offeringOIds
    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

````