Skip to main content
POST
/
api
/
v2
/
agents
/
prospector
/
run
Prospector Agent
curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/prospector/run \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "companyDomain": "example.com",
  "agentOId": "agent_123",
  "limit": 10,
  "minimal": true,
  "searchContext": {
    "playbookOId": "<string>",
    "personaOIds": [
      "<string>"
    ],
    "fuzzyTitles": [
      "<string>"
    ],
    "exactTitles": [
      "<string>"
    ],
    "excludeTitles": [
      "<string>"
    ],
    "personCountry": {
      "matches": {
        "exact": [
          "<string>"
        ],
        "contains": [
          "<string>"
        ],
        "prefix": [
          "<string>"
        ]
      },
      "excludes": {
        "exact": [
          "<string>"
        ],
        "contains": [
          "<string>"
        ],
        "prefix": [
          "<string>"
        ]
      }
    },
    "personLocation": {
      "countryCode": {
        "matches": {
          "exact": [
            "<string>"
          ],
          "contains": [
            "<string>"
          ],
          "prefix": [
            "<string>"
          ]
        },
        "excludes": {
          "exact": [
            "<string>"
          ],
          "contains": [
            "<string>"
          ],
          "prefix": [
            "<string>"
          ]
        }
      },
      "city": {
        "matches": {
          "exact": [
            "<string>"
          ],
          "contains": [
            "<string>"
          ],
          "prefix": [
            "<string>"
          ]
        },
        "excludes": {
          "exact": [
            "<string>"
          ],
          "contains": [
            "<string>"
          ],
          "prefix": [
            "<string>"
          ]
        }
      },
      "text": {
        "matches": {
          "exact": [
            "<string>"
          ],
          "contains": [
            "<string>"
          ],
          "prefix": [
            "<string>"
          ]
        },
        "excludes": {
          "exact": [
            "<string>"
          ],
          "contains": [
            "<string>"
          ],
          "prefix": [
            "<string>"
          ]
        }
      }
    }
  }
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "found": true,
  "message": "Additional information",
  "data": {
    "contacts": [
      {
        "contact": {
          "firstName": "<string>",
          "lastName": "<string>",
          "title": "<string>",
          "profileUrl": "<string>",
          "company": {
            "name": "<string>",
            "description": "<string>",
            "domain": "<string>",
            "website": "<string>",
            "founded": 123,
            "location": {
              "region": "<string>",
              "locality": "<string>",
              "postalCode": "<string>",
              "countryCode": "<string>",
              "streetAddress": "<string>"
            },
            "employeeCount": 123,
            "followerCount": 123,
            "type": "<string>",
            "slug": "<string>",
            "logoUrl": "<string>",
            "countryCode": "<string>",
            "specialties": [
              "<string>"
            ],
            "industry": "<string>",
            "crunchBaseFunding": [
              {
                "fundingRoundCount": 123,
                "roundDate": "<string>",
                "roundName": "<string>",
                "investorNames": [
                  "<string>"
                ],
                "investorCount": 123,
                "roundAmount": 123,
                "roundCurrency": "<string>"
              }
            ]
          },
          "companyName": "<string>",
          "companyDomain": "<string>",
          "companyFoundedYear": 123,
          "companyEmployeeCount": 123,
          "companyDescription": "<string>",
          "headline": "<string>",
          "summary": "<string>",
          "slug": "<string>",
          "internalPictureUrl": "<string>",
          "countryCode": "<string>",
          "location": "<string>",
          "city": "<string>",
          "currentJobFunction": "<string>",
          "currentSeniority": "<string>",
          "followers": 123,
          "allPositionsCount": 123,
          "currentPositionsCount": 123,
          "positions": [
            {
              "companyName": "<string>",
              "title": "<string>",
              "summary": "<string>",
              "is_current": false,
              "startDate": "<string>",
              "endDate": "<string>",
              "seniority": "<string>",
              "jobFunction": "<string>",
              "company": {
                "name": "<string>",
                "domain": "<string>",
                "founded": 123,
                "employeeCount": 123,
                "description": "<string>",
                "location": {
                  "region": "<string>",
                  "locality": "<string>",
                  "postalCode": "<string>",
                  "countryCode": "<string>",
                  "streetAddress": "<string>"
                },
                "slug": "<string>"
              }
            }
          ]
        },
        "lookalikeSource": "<string>",
        "personas": [
          {
            "name": "<string>",
            "oId": "<string>"
          }
        ]
      }
    ],
    "count": 123
  }
}

Authorizations

​
api_key
string
header
required

Body

application/json

Prospector input

​
companyDomain
string
required

Company to find prospects or use as lookalike source

Example:

"example.com"

​
agentOId
string
required

AgentOId is required when creating an agent in the application. You can find it in the Agents section of your dashboard.

Example:

"agent_123"

​
limit
number | null

Override the Agent's configured limit

Required range: 1 <= x <= 1000
Example:

10

​
minimal
boolean
default:true

Minimize the output. If set to true, positions, internalPictureUrl, and the nested company object will be omitted from the output.

Example:

true

​
searchContext
object

Optional search context to override agent's configured search context. If provided, the two objects will be merged.

Response

Prospector successful

​
_metadata
object
required
​
found
boolean
required

Whether the operation was successful

Example:

true

​
message
string | null

Message

Example:

"Additional information"

​
data
object