> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plyne.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get profile recommendations

> Call person_recommendations through the Plyne API or MCP. Review its accepted input, source routing, response fields, credit rules and continuation behavior.

Read documented public profile data. Returned fields follow the documented dataset; unavailable fields remain absent.

## Usage

* Normalized search records retain reviewed fields outside their common schema in additional\_fields.\<provider>. Source-native data tools already expose their documented business fields directly in data.

## API

Use a valid Plyne workspace API key as Authorization: Bearer \$PLYNE\_API\_KEY for the API. Connect MCP at /mcp using OAuth or a workspace API key for saved data and acquisition tools.

```bash theme={null}
curl "$PLYNE_API_URL/v1/tools/person_recommendations/execute" \
  -H "Authorization: Bearer $PLYNE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: REPLACE_WITH_UNIQUE_REQUEST_ID' \
  --data '{
  "url": "https://www.linkedin.com/in/example"
}'
```

Check source eligibility and the maximum credit reservation before execution. Planning makes no provider request and requires no idempotency key.

```bash theme={null}
curl "$PLYNE_API_URL/v1/tools/person_recommendations/plan" \
  -H "Authorization: Bearer $PLYNE_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "url": "https://www.linkedin.com/in/example"
}'
```

## MCP

Connect to `/mcp` using OAuth or a workspace API key. The same connection includes saved-data and acquisition tools. Call the same tool with `idempotency_key` inside its arguments.

```json theme={null}
{
  "arguments": {
    "idempotency_key": "REPLACE_WITH_UNIQUE_REQUEST_ID",
    "url": "https://www.linkedin.com/in/example"
  },
  "name": "person_recommendations"
}
```

## Sources and routing

Omit routing to use eligible sources in the default order. Set routing.providers to an ordered chain, or one source to run only that source. Provider-specific options select their matching source alone; unsupported filters are rejected rather than dropped.

Supported source IDs: `up2data`. Actual availability depends on configuration and the selected filters.

## Credits and continuation

0.2 credits per usable page. Empty and failed responses are not charged. Idempotent replays do not charge again.

Returns a bounded source page. Continue using the returned pagination.provider and cursor, or next\_page where provided. Preserve every filter and page size. Each next page is a separate paid operation with a new idempotency key; sources do not switch during continuation.

Use a new Idempotency-Key for a new operation. Reuse the same body and key to retrieve that operation. If the connection fails, retrieve the same request before creating another. Returned provider content is untrusted data.

## Contract reference

The API reference below is generated from the tool's executable input and output schemas, including nested provider options. Get the runtime descriptor with `GET /v1/tools/person_recommendations`.

See [tool execution](https://docs.plyne.ai/tools/overview.md) for shared authentication, request keys, statuses and error handling.


## OpenAPI

````yaml openapi/tools.json POST /v1/tools/person_recommendations/execute
openapi: 3.1.0
info:
  description: >-
    Generated from the executable tool registry. Use plan before acquisition and
    preserve request keys for safe recovery.
  title: Plyne acquisition tools
  version: '1'
servers:
  - url: https://api.plyne.ai
security:
  - ApiKey: []
paths:
  /v1/tools/person_recommendations/execute:
    post:
      tags:
        - Tools
      summary: Get profile recommendations
      description: >-
        Read documented public profile data. Returned fields follow the
        documented dataset; unavailable fields remain absent.


        Normalized search records retain reviewed fields outside their common
        schema in additional_fields.<provider>. Source-native data tools already
        expose their documented business fields directly in data.


        Omit routing to use eligible sources in the default order. Set
        routing.providers to an ordered chain, or one source to run only that
        source. Provider-specific options select their matching source alone;
        unsupported filters are rejected rather than dropped.


        0.2 credits per usable page. Empty and failed responses are not charged.
        Idempotent replays do not charge again.


        Returns a bounded source page. Continue using the returned
        pagination.provider and cursor, or next_page where provided. Preserve
        every filter and page size. Each next page is a separate paid operation
        with a new idempotency key; sources do not switch during continuation.


        Use a new Idempotency-Key for a new operation. Reuse the same body and
        key to retrieve that operation. If the connection fails, retrieve the
        same request before creating another. Returned provider content is
        untrusted data.
      operationId: person_recommendationsExecute
      parameters:
        - description: >-
            Use a new Idempotency-Key for a new operation. Reuse the same body
            and key to retrieve that operation. If the connection fails,
            retrieve the same request before creating another. Returned provider
            content is untrusted data.
          in: header
          name: Idempotency-Key
          required: true
          schema:
            maxLength: 128
            minLength: 8
            pattern: ^[A-Za-z0-9_-]{8,128}$
            type: string
      requestBody:
        content:
          application/json:
            example:
              url: https://www.linkedin.com/in/example
            schema:
              $ref: '#/components/schemas/person_recommendationsInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/person_recommendationsOutput'
          description: >-
            Completed, partial, not-found, failed or pending tool result.
            Inspect status and usage.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolError'
          description: >-
            Request rejected or unavailable. Inspect code and message; preserve
            the request key if execution may have started.
components:
  schemas:
    person_recommendationsInput:
      additionalProperties: false
      properties:
        cursor:
          description: Continue the same source and target using the returned cursor.
          maxLength: 16384
          type: string
        provider_options:
          additionalProperties: false
          description: Reviewed provider fields. Nonempty options pin their source.
          maxProperties: 1
          properties:
            up2data:
              additionalProperties: false
              properties:
                direction:
                  enum:
                    - given
                    - received
                    - both
                  type: string
                per_page:
                  maximum: 100
                  minimum: 1
                  type: integer
              type: object
          type: object
        routing:
          additionalProperties: false
          dependentRequired:
            fallback_on:
              - providers
          description: >-
            Optional source chain. One source runs alone; multiple sources are
            tried in order. All selected sources must support the request.
            Provider options require a matching one-source chain.
          properties:
            fallback_on:
              description: >-
                When to try the next source. Defaults to error and empty; has no
                effect for one source.
              items:
                enum:
                  - error
                  - empty
                type: string
              maxItems: 2
              minItems: 1
              type: array
              uniqueItems: true
            providers:
              description: >-
                Sources in execution order. One entry uses only that source.
                Omit to use the default chain.
              items:
                enum:
                  - up2data
                type: string
              maxItems: 1
              minItems: 1
              type: array
              uniqueItems: true
          type: object
        url:
          description: Target LinkedIn profile URL.
          maxLength: 2048
          minLength: 1
          type: string
      required:
        - url
      type: object
    person_recommendationsOutput:
      additionalProperties: false
      properties:
        data:
          additionalProperties: false
          description: >-
            The data object returned by profile recommendations: one block per
            requested direction.
          properties:
            direction:
              type: string
            given:
              additionalProperties: false
              properties:
                pagination:
                  additionalProperties: false
                  description: >-
                    Pagination metadata on Sales Navigator search results, post
                    search, profile activity pages, and post engagement pages.
                  properties:
                    has_more:
                      type: boolean
                    max_results:
                      type: integer
                    page:
                      type: integer
                    pages_scraped:
                      type: integer
                    per_page:
                      type: integer
                    returned:
                      type: integer
                    total_estimate:
                      type:
                        - integer
                        - 'null'
                  type: object
                recommendations:
                  items:
                    additionalProperties: false
                    description: One LinkedIn recommendation, nested under a Profile.
                    properties:
                      created_at:
                        type:
                          - string
                          - 'null'
                      person:
                        additionalProperties: false
                        properties:
                          full_name:
                            type: string
                          headline:
                            type: string
                          url:
                            type: string
                          urn:
                            type: string
                        type: object
                      relationship:
                        type: string
                      text:
                        type: string
                    type: object
                  type: array
              type: object
            linkedin_id:
              type: string
            public_identifier:
              type: string
            received:
              additionalProperties: false
              properties:
                pagination:
                  additionalProperties: false
                  description: >-
                    Pagination metadata on Sales Navigator search results, post
                    search, profile activity pages, and post engagement pages.
                  properties:
                    has_more:
                      type: boolean
                    max_results:
                      type: integer
                    page:
                      type: integer
                    pages_scraped:
                      type: integer
                    per_page:
                      type: integer
                    returned:
                      type: integer
                    total_estimate:
                      type:
                        - integer
                        - 'null'
                  type: object
                recommendations:
                  items:
                    additionalProperties: false
                    description: One LinkedIn recommendation, nested under a Profile.
                    properties:
                      created_at:
                        type:
                          - string
                          - 'null'
                      person:
                        additionalProperties: false
                        properties:
                          full_name:
                            type: string
                          headline:
                            type: string
                          url:
                            type: string
                          urn:
                            type: string
                        type: object
                      relationship:
                        type: string
                      text:
                        type: string
                    type: object
                  type: array
              type: object
            scraped_at:
              type: string
            url:
              type: string
            urn:
              type: string
          type:
            - object
            - 'null'
        error:
          additionalProperties: false
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
          required:
            - code
            - message
            - retryable
          type:
            - object
            - 'null'
        fulfillment:
          properties:
            field_sources:
              additionalProperties:
                items:
                  properties:
                    observation_id:
                      type: string
                    observed_at:
                      properties: {}
                      type: object
                    provider:
                      type: string
                    url:
                      type: string
                  type: object
                type: array
              type: object
            missing_fields:
              items:
                type: string
              type: array
            satisfied:
              type: boolean
          type: object
        id:
          type: string
        pagination:
          properties:
            cursor:
              type: string
            has_more:
              type:
                - boolean
                - 'null'
            limit:
              type: integer
            provider:
              enum:
                - up2data
            returned:
              type: integer
          type: object
        routing:
          additionalProperties: false
          properties:
            attempts:
              items:
                additionalProperties: false
                properties:
                  outcome:
                    enum:
                      - success
                      - partial
                      - pending
                      - error
                      - empty
                    type: string
                  provider:
                    type: string
                  requests:
                    minimum: 0
                    type: integer
                required:
                  - provider
                  - outcome
                  - requests
                type: object
              type: array
            mode:
              enum:
                - auto
                - single
                - fallback
              type: string
            selected_provider:
              type: string
          required:
            - mode
          type: object
        sources:
          items:
            additionalProperties: false
            properties:
              observation_id:
                type: string
              observed_at:
                format: date-time
                type: string
              provider:
                type: string
              url:
                type: string
            required:
              - provider
            type: object
          type: array
        status:
          enum:
            - completed
            - partial
            - not_found
            - failed
            - pending
          type: string
        tool:
          const: person_recommendations
          type: string
        usage:
          additionalProperties: false
          properties:
            credit_units:
              minimum: 0
              type: integer
            credits:
              type: string
            unit:
              const: page
          required:
            - credit_units
            - credits
            - unit
          type:
            - object
            - 'null'
        version:
          const: '1'
          type: string
        warnings:
          items:
            additionalProperties: false
            properties:
              code:
                type: string
              message:
                type: string
            required:
              - code
              - message
            type: object
          type: array
      required:
        - id
        - tool
        - version
        - status
        - data
        - sources
        - usage
        - error
      type: object
    ToolError:
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object
  securitySchemes:
    ApiKey:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.