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

# Prospector Agent

> Find relevant people at a company or lookalike companies



## OpenAPI

````yaml post /api/v2/agents/prospector/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/prospector/run:
    post:
      tags:
        - Agents
      summary: Prospector Agent
      description: Find relevant people at a company or lookalike companies
      operationId: runProspectorAgent
      requestBody:
        description: Prospector input
        content:
          application/json:
            schema:
              type: object
              properties:
                companyDomain:
                  type: string
                  description: Company to find prospects or use as lookalike source
                  example: example.com
                limit:
                  type: number
                  nullable: true
                  description: Override the Agent's configured limit
                  example: 10
                  minimum: 1
                  maximum: 1000
                minimal:
                  type: boolean
                  default: true
                  description: >-
                    Minimize the output. If set to true, `positions`,
                    `internalPictureUrl`, and the nested `company` object will
                    be omitted from the output.
                  example: true
                searchContext:
                  type: object
                  properties:
                    playbookOId:
                      type: string
                      nullable: true
                    personaOIds:
                      type: array
                      nullable: true
                      items:
                        type: string
                    fuzzyTitles:
                      type: array
                      nullable: true
                      items:
                        type: string
                    exactTitles:
                      type: array
                      nullable: true
                      items:
                        type: string
                    excludeTitles:
                      type: array
                      nullable: true
                      items:
                        type: string
                    personCountry:
                      type: object
                      nullable: true
                      properties:
                        matches:
                          type: object
                          properties:
                            exact:
                              type: array
                              items:
                                type: string
                            contains:
                              type: array
                              items:
                                type: string
                            prefix:
                              type: array
                              items:
                                type: string
                        excludes:
                          type: object
                          properties:
                            exact:
                              type: array
                              items:
                                type: string
                            contains:
                              type: array
                              items:
                                type: string
                            prefix:
                              type: array
                              items:
                                type: string
                    personLocation:
                      type: object
                      nullable: true
                      properties:
                        countryCode:
                          type: object
                          properties:
                            matches:
                              type: object
                              properties:
                                exact:
                                  type: array
                                  items:
                                    type: string
                                contains:
                                  type: array
                                  items:
                                    type: string
                                prefix:
                                  type: array
                                  items:
                                    type: string
                            excludes:
                              type: object
                              properties:
                                exact:
                                  type: array
                                  items:
                                    type: string
                                contains:
                                  type: array
                                  items:
                                    type: string
                                prefix:
                                  type: array
                                  items:
                                    type: string
                        city:
                          type: object
                          properties:
                            matches:
                              type: object
                              properties:
                                exact:
                                  type: array
                                  items:
                                    type: string
                                contains:
                                  type: array
                                  items:
                                    type: string
                                prefix:
                                  type: array
                                  items:
                                    type: string
                            excludes:
                              type: object
                              properties:
                                exact:
                                  type: array
                                  items:
                                    type: string
                                contains:
                                  type: array
                                  items:
                                    type: string
                                prefix:
                                  type: array
                                  items:
                                    type: string
                        text:
                          type: object
                          properties:
                            matches:
                              type: object
                              properties:
                                exact:
                                  type: array
                                  items:
                                    type: string
                                contains:
                                  type: array
                                  items:
                                    type: string
                                prefix:
                                  type: array
                                  items:
                                    type: string
                            excludes:
                              type: object
                              properties:
                                exact:
                                  type: array
                                  items:
                                    type: string
                                contains:
                                  type: array
                                  items:
                                    type: string
                                prefix:
                                  type: array
                                  items:
                                    type: string
                  description: >-
                    Optional search context to override agent's configured
                    search context. If provided, the two objects will be merged.
                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
              required:
                - companyDomain
                - agentOId
      responses:
        '200':
          description: Prospector 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/ProspectorAgentData'
                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
    ProspectorAgentData:
      type: object
      nullable: true
      properties:
        contacts:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/ProspectorContact'
        count:
          type: number
          nullable: true
    ProspectorContact:
      type: object
      properties:
        contact:
          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
        lookalikeSource:
          type: string
          nullable: true
        personas:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/NameAndOId'
    NameAndOId:
      type: object
      properties:
        name:
          type: string
          nullable: true
        oId:
          type: string
          nullable: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````