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

# Qualify Company Agent

> Determine if a company is qualified for a given Product and/or Segment



## OpenAPI

````yaml post /api/v2/agents/qualify-company/run
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/agents/qualify-company/run:
    post:
      tags:
        - Agents
      summary: Qualify Company Agent
      description: Determine if a company is qualified for a given Product and/or Segment
      operationId: runQualifyCompanyAgent
      requestBody:
        description: Qualify input
        content:
          application/json:
            schema:
              type: object
              properties:
                companyDomain:
                  type: string
                  nullable: true
                  description: Company domain to qualify
                  example: example.com
                companyName:
                  type: string
                  nullable: true
                  description: Company name to qualify
                crmAccountId:
                  type: string
                  nullable: true
                runtimeContext:
                  nullable: true
                  description: Runtime context for qualification
                agentOId:
                  type: string
                  description: >-
                    AgentOId is required when creating an agent in the
                    application. You can find it in the Agents section of your
                    dashboard.
                  example: agent_123
                includeFullAnnotation:
                  type: boolean
                  description: >-
                    If true, returns full annotation data including metadata. If
                    false or omitted (default), returns minimal annotations to
                    reduce response size.
              required:
                - agentOId
      responses:
        '200':
          description: Qualification successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  found:
                    type: boolean
                    description: Whether the operation was successful
                    example: true
                  message:
                    type: string
                    nullable: true
                    description: Message
                    example: Additional information
                  data:
                    $ref: '#/components/schemas/QualifyCompanyAgentData'
                required:
                  - _metadata
                  - found
        '400':
          description: Bad request
          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
    QualifyCompanyAgentData:
      type: object
      nullable: true
      properties:
        company:
          type: object
          nullable: true
          properties:
            name:
              type: string
              nullable: true
            description:
              type: string
              nullable: true
            domain:
              type: string
              nullable: true
            website:
              type: string
              nullable: true
            founded:
              type: number
              nullable: true
            location:
              type: object
              nullable: true
              properties:
                region:
                  type: string
                  nullable: true
                locality:
                  type: string
                  nullable: true
                postalCode:
                  type: string
                  nullable: true
                countryCode:
                  type: string
                  nullable: true
                streetAddress:
                  type: string
                  nullable: true
            employeeCount:
              type: number
              nullable: true
            followerCount:
              type: number
              nullable: true
            type:
              type: string
              nullable: true
            slug:
              type: string
              nullable: true
            logoUrl:
              type: string
              nullable: true
            countryCode:
              type: string
              nullable: true
            specialties:
              type: array
              nullable: true
              items:
                type: string
            industry:
              type: string
              nullable: true
            crunchBaseFunding:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  fundingRoundCount:
                    type: number
                    nullable: true
                  roundDate:
                    type: string
                    nullable: true
                    format: date-time
                  roundName:
                    type: string
                    nullable: true
                  investorNames:
                    type: array
                    nullable: true
                    items:
                      type: string
                  investorCount:
                    type: number
                    nullable: true
                  roundAmount:
                    type: number
                    nullable: true
                  roundCurrency:
                    type: string
                    nullable: true
        score:
          type: number
          nullable: true
        rationale:
          type: string
          nullable: true
        product:
          type: object
          nullable: true
          properties:
            message:
              type: string
              nullable: true
            oId:
              type: string
              nullable: true
            name:
              type: string
              nullable: true
            description:
              type: string
              nullable: true
            qualification:
              type: object
              nullable: true
              properties:
                answers:
                  type: array
                  nullable: true
                  items:
                    type: object
                    properties:
                      answer:
                        type: string
                        description: The answer to the question
                      rationale:
                        type: string
                        description: The rationale for the answer
                      confidence:
                        type: string
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - INSTANT_QUALIFIER
                          - INSTANT_DISQUALIFIER
                        description: The confidence in the answer
                      question:
                        type: string
                        description: The question to ask to qualify the entity
                      weight:
                        type: string
                        nullable: true
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - INSTANT_QUALIFIER
                          - INSTANT_DISQUALIFIER
                          - null
                        description: >-
                          The weight of the qualifying question (e.g.,
                          INSTANT_DISQUALIFIER)
                    required:
                      - answer
                      - rationale
                      - confidence
                      - question
                score:
                  type: number
                  nullable: true
                rationale:
                  type: string
                  nullable: true
        service:
          type: object
          nullable: true
          properties:
            message:
              type: string
              nullable: true
            oId:
              type: string
              nullable: true
            name:
              type: string
              nullable: true
            description:
              type: string
              nullable: true
            qualification:
              type: object
              nullable: true
              properties:
                answers:
                  type: array
                  nullable: true
                  items:
                    type: object
                    properties:
                      answer:
                        type: string
                        description: The answer to the question
                      rationale:
                        type: string
                        description: The rationale for the answer
                      confidence:
                        type: string
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - INSTANT_QUALIFIER
                          - INSTANT_DISQUALIFIER
                        description: The confidence in the answer
                      question:
                        type: string
                        description: The question to ask to qualify the entity
                      weight:
                        type: string
                        nullable: true
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - INSTANT_QUALIFIER
                          - INSTANT_DISQUALIFIER
                          - null
                        description: >-
                          The weight of the qualifying question (e.g.,
                          INSTANT_DISQUALIFIER)
                    required:
                      - answer
                      - rationale
                      - confidence
                      - question
                score:
                  type: number
                  nullable: true
                rationale:
                  type: string
                  nullable: true
        solution:
          type: object
          nullable: true
          properties:
            message:
              type: string
              nullable: true
            oId:
              type: string
              nullable: true
            name:
              type: string
              nullable: true
            description:
              type: string
              nullable: true
            qualification:
              type: object
              nullable: true
              properties:
                answers:
                  type: array
                  nullable: true
                  items:
                    type: object
                    properties:
                      answer:
                        type: string
                        description: The answer to the question
                      rationale:
                        type: string
                        description: The rationale for the answer
                      confidence:
                        type: string
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - INSTANT_QUALIFIER
                          - INSTANT_DISQUALIFIER
                        description: The confidence in the answer
                      question:
                        type: string
                        description: The question to ask to qualify the entity
                      weight:
                        type: string
                        nullable: true
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - INSTANT_QUALIFIER
                          - INSTANT_DISQUALIFIER
                          - null
                        description: >-
                          The weight of the qualifying question (e.g.,
                          INSTANT_DISQUALIFIER)
                    required:
                      - answer
                      - rationale
                      - confidence
                      - question
                score:
                  type: number
                  nullable: true
                rationale:
                  type: string
                  nullable: true
        segment:
          type: object
          nullable: true
          properties:
            message:
              type: string
              nullable: true
            oId:
              type: string
              nullable: true
            name:
              type: string
              nullable: true
            description:
              type: string
              nullable: true
            qualification:
              type: object
              nullable: true
              properties:
                answers:
                  type: array
                  nullable: true
                  items:
                    type: object
                    properties:
                      answer:
                        type: string
                        description: The answer to the question
                      rationale:
                        type: string
                        description: The rationale for the answer
                      confidence:
                        type: string
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - INSTANT_QUALIFIER
                          - INSTANT_DISQUALIFIER
                        description: The confidence in the answer
                      question:
                        type: string
                        description: The question to ask to qualify the entity
                      weight:
                        type: string
                        nullable: true
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - INSTANT_QUALIFIER
                          - INSTANT_DISQUALIFIER
                          - null
                        description: >-
                          The weight of the qualifying question (e.g.,
                          INSTANT_DISQUALIFIER)
                    required:
                      - answer
                      - rationale
                      - confidence
                      - question
                score:
                  type: number
                  nullable: true
                rationale:
                  type: string
                  nullable: true
        playbook:
          type: object
          nullable: true
          properties:
            message:
              type: string
              nullable: true
            oId:
              type: string
              nullable: true
            name:
              type: string
              nullable: true
            description:
              type: string
              nullable: true
            qualification:
              type: object
              nullable: true
              properties:
                answers:
                  type: array
                  nullable: true
                  items:
                    type: object
                    properties:
                      answer:
                        type: string
                        description: The answer to the question
                      rationale:
                        type: string
                        description: The rationale for the answer
                      confidence:
                        type: string
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - INSTANT_QUALIFIER
                          - INSTANT_DISQUALIFIER
                        description: The confidence in the answer
                      question:
                        type: string
                        description: The question to ask to qualify the entity
                      weight:
                        type: string
                        nullable: true
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - INSTANT_QUALIFIER
                          - INSTANT_DISQUALIFIER
                          - null
                        description: >-
                          The weight of the qualifying question (e.g.,
                          INSTANT_DISQUALIFIER)
                    required:
                      - answer
                      - rationale
                      - confidence
                      - question
                score:
                  type: number
                  nullable: true
                rationale:
                  type: string
                  nullable: true
        annotations:
          type: object
          nullable: true
          properties:
            annotations:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  type:
                    type: string
                  meta:
                    nullable: true
                  title:
                    type: string
                  description:
                    type: string
                    nullable: true
                  url:
                    type: string
                    nullable: true
                required:
                  - type
                  - title
            metadata:
              nullable: true
        customTask:
          type: object
          nullable: true
          properties:
            content:
              nullable: true
              description: Structured JSON output from the custom task
            error:
              type: string
              nullable: true
              description: Error message if the custom task failed
        disqualifierSummary:
          type: object
          nullable: true
          properties:
            triggered:
              type: boolean
            firstQuestion:
              type: string
              nullable: true
            firstRationale:
              type: string
              nullable: true
            totalCount:
              type: number
          required:
            - triggered
            - firstQuestion
            - firstRationale
            - totalCount
      required:
        - score
        - rationale
        - product
        - service
        - solution
        - segment
        - playbook
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````