> ## 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 Person Agent

> Determine if a person is qualified for a given Product, Persona, and/or Segment



## OpenAPI

````yaml post /api/v2/agents/qualify-person/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-person/run:
    post:
      tags:
        - Agents
      summary: Qualify Person Agent
      description: >-
        Determine if a person is qualified for a given Product, Persona, and/or
        Segment
      operationId: runQualifyPersonAgent
      requestBody:
        description: Qualify input
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  nullable: true
                  description: Email of the person to qualify
                  example: john.doe@example.com
                firstName:
                  type: string
                  nullable: true
                  description: First name of the person to qualify
                lastName:
                  type: string
                  nullable: true
                jobTitle:
                  type: string
                  nullable: true
                  description: Job title of the person to qualify
                companyDomain:
                  type: string
                  nullable: true
                  description: Company domain of the person to qualify
                  example: example.com
                companyName:
                  type: string
                  nullable: true
                  description: Company name of the person to qualify
                linkedInProfile:
                  type: string
                  nullable: true
                  description: LinkedIn profile of the person to qualify
                crmContactId:
                  type: string
                  nullable: true
                crmLeadId:
                  type: string
                  nullable: true
                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/QualifyPersonAgentData'
                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
    QualifyPersonAgentData:
      type: object
      nullable: true
      properties:
        person:
          type: object
          nullable: true
          properties:
            firstName:
              type: string
              nullable: true
            lastName:
              type: string
              nullable: true
            title:
              type: string
              nullable: true
            profileUrl:
              type: string
              nullable: true
            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
            companyName:
              type: string
              nullable: true
            companyDomain:
              type: string
              nullable: true
            companyFoundedYear:
              type: number
              nullable: true
            companyEmployeeCount:
              type: number
              nullable: true
            companyDescription:
              type: string
              nullable: true
            headline:
              type: string
              nullable: true
            summary:
              type: string
              nullable: true
            slug:
              type: string
              nullable: true
            internalPictureUrl:
              type: string
              nullable: true
            countryCode:
              type: string
              nullable: true
            location:
              type: string
              nullable: true
            city:
              type: string
              nullable: true
            currentJobFunction:
              type: string
              nullable: true
            currentSeniority:
              type: string
              nullable: true
            followers:
              type: number
              nullable: true
            allPositionsCount:
              type: number
              nullable: true
            currentPositionsCount:
              type: number
              nullable: true
            positions:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  companyName:
                    type: string
                    nullable: true
                  title:
                    type: string
                    nullable: true
                  summary:
                    type: string
                    nullable: true
                  is_current:
                    type: boolean
                    default: false
                  startDate:
                    type: string
                    nullable: true
                    format: date-time
                  endDate:
                    type: string
                    nullable: true
                    format: date-time
                  seniority:
                    type: string
                    nullable: true
                  jobFunction:
                    type: string
                    nullable: true
                  company:
                    type: object
                    nullable: true
                    properties:
                      name:
                        type: string
                        nullable: true
                      domain:
                        type: string
                        nullable: true
                      founded:
                        type: number
                        nullable: true
                      employeeCount:
                        type: number
                        nullable: true
                      description:
                        type: string
                        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
                      slug:
                        type: string
                        nullable: true
        seniority:
          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
        persona:
          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
        - persona
        - segment
        - playbook
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````