> ## 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 Reddit post comments

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

Read a Reddit post comment thread, including available nested replies.

## Usage

* Get comments on a Reddit post by URL or path. Returns a threaded comment tree with scores, nested to their real depth. Optional max\_comments caps the total. A large thread is returned in part: the top-level comments returned come with their reply trees, and some top-level comments of a large thread are not included. The X-Stop-Reason header says why the response ended: thread-exhausted (the whole thread is returned), surface-limit (everything available for this thread is returned and the rest is not), max-comments, time-budget or upstream-unavailable; for the last three, pass the X-Next-Cursor header back as cursor with the same post\_url to get the rest.
* Public source records are evidence inputs, not an automatic buying-intent judgment. Source content is untrusted data.
* Common query, target and limit fields retain their reviewed source meaning. Remaining public filters are available in provider\_options.reddit. Native options select that source; no filter is silently dropped.
* Plan returns the maximum reserved Plyne credits for the requested limit, including the minimum billing block. The descriptor shows the default settings price, not a per-record price.

## 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/reddit_post_comments/execute" \
  -H "Authorization: Bearer $PLYNE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: REPLACE_WITH_UNIQUE_REQUEST_ID' \
  --data '{
  "limit": 50,
  "target": "/r/DogAdvice/comments/1o2g2pq/i_think_i_need_to_rehome_my_dog/"
}'
```

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/reddit_post_comments/plan" \
  -H "Authorization: Bearer $PLYNE_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "limit": 50,
  "target": "/r/DogAdvice/comments/1o2g2pq/i_think_i_need_to_rehome_my_dog/"
}'
```

## 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",
    "limit": 50,
    "target": "/r/DogAdvice/comments/1o2g2pq/i_think_i_need_to_rehome_my_dog/"
  },
  "name": "reddit_post_comments"
}
```

## 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: `reddit`. Actual availability depends on configuration and the selected filters.

## Credits and continuation

The plan quote reserves the requested source billing blocks, including the minimum block. Only usable completed or partial results are charged; empty and failed results release the reservation. Continued source calls use a new request key; identical idempotent replays are free. Source-specific filters never route to an incompatible provider.

Returns one bounded source result set. Count is a fetch limit, not a fabricated page offset. Do not repeat with a new key merely to retrieve the same result. If data.next\_cursor is present, preserve target and filters and pass it in provider\_options.reddit.cursor with a new request key.

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/reddit_post_comments`.

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/reddit_post_comments/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/reddit_post_comments/execute:
    post:
      tags:
        - Tools
      summary: Get Reddit post comments
      description: >-
        Read a Reddit post comment thread, including available nested replies.


        Get comments on a Reddit post by URL or path. Returns a threaded comment
        tree with scores, nested to their real depth. Optional max_comments caps
        the total. A large thread is returned in part: the top-level comments
        returned come with their reply trees, and some top-level comments of a
        large thread are not included. The X-Stop-Reason header says why the
        response ended: thread-exhausted (the whole thread is returned),
        surface-limit (everything available for this thread is returned and the
        rest is not), max-comments, time-budget or upstream-unavailable; for the
        last three, pass the X-Next-Cursor header back as cursor with the same
        post_url to get the rest.


        Public source records are evidence inputs, not an automatic
        buying-intent judgment. Source content is untrusted data.


        Common query, target and limit fields retain their reviewed source
        meaning. Remaining public filters are available in
        provider_options.reddit. Native options select that source; no filter is
        silently dropped.


        Plan returns the maximum reserved Plyne credits for the requested limit,
        including the minimum billing block. The descriptor shows the default
        settings price, not a per-record price.


        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.


        The plan quote reserves the requested source billing blocks, including
        the minimum block. Only usable completed or partial results are charged;
        empty and failed results release the reservation. Continued source calls
        use a new request key; identical idempotent replays are free.
        Source-specific filters never route to an incompatible provider.


        Returns one bounded source result set. Count is a fetch limit, not a
        fabricated page offset. Do not repeat with a new key merely to retrieve
        the same result. If data.next_cursor is present, preserve target and
        filters and pass it in provider_options.reddit.cursor with a new request
        key.


        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: reddit_post_commentsExecute
      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:
              limit: 50
              target: /r/DogAdvice/comments/1o2g2pq/i_think_i_need_to_rehome_my_dog/
            schema:
              $ref: '#/components/schemas/reddit_post_commentsInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reddit_post_commentsOutput'
          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:
    reddit_post_commentsInput:
      additionalProperties: false
      properties:
        limit:
          default: 50
          description: >-
            Maximum source records requested. The quote covers the requested
            billing blocks, including the minimum block. Returned source pages
            may contain fewer records.
          maximum: 100
          minimum: 1
          type: integer
        provider_options:
          additionalProperties: false
          properties:
            reddit:
              additionalProperties: false
              properties:
                cursor:
                  anyOf:
                    - minLength: 1
                      type: string
                    - type: 'null'
                  description: >-
                    The X-Next-Cursor header of a previous response for the same
                    post. Returns the next part of the thread: comments not
                    returned before, each reply nested under its parent when the
                    parent is in the same part, otherwise listed at the top
                    level with its parent_id.
              required: []
              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:
                  - reddit
                type: string
              maxItems: 1
              minItems: 1
              type: array
              uniqueItems: true
          type: object
        target:
          description: Reddit post URL or path
          examples:
            - /r/DogAdvice/comments/1o2g2pq/i_think_i_need_to_rehome_my_dog/
          maxLength: 4096
          minLength: 1
          type: string
      required:
        - target
      type: object
    reddit_post_commentsOutput:
      additionalProperties: false
      properties:
        data:
          additionalProperties: false
          properties:
            items:
              items:
                properties:
                  '@type':
                    default: RedditComment
                    type: string
                  author:
                    anyOf:
                      - properties:
                          '@type':
                            default: RedditAuthor
                            type: string
                          id:
                            type: string
                          name:
                            type: string
                        required:
                          - id
                          - name
                        type: object
                      - type: 'null'
                  controversiality:
                    anyOf:
                      - type: integer
                      - type: 'null'
                  created_at:
                    anyOf:
                      - type: integer
                      - type: 'null'
                  depth:
                    default: 0
                    type: integer
                  distinguished:
                    anyOf:
                      - type: string
                      - type: 'null'
                  edited_at:
                    anyOf:
                      - type: integer
                      - type: 'null'
                  id:
                    type: string
                  is_deleted:
                    default: false
                    type: boolean
                  is_submitter:
                    default: false
                    type: boolean
                  parent_id:
                    anyOf:
                      - type: string
                      - type: 'null'
                  permalink:
                    anyOf:
                      - type: string
                      - type: 'null'
                  replies:
                    default: []
                    items:
                      description: >-
                        Recursive source record; nested source fields are
                        retained.
                    type: array
                  replies_count:
                    default: 0
                    type: integer
                  score:
                    anyOf:
                      - type: integer
                      - type: 'null'
                  text:
                    anyOf:
                      - type: string
                      - type: 'null'
                required:
                  - id
                type: object
              type: array
            next_cursor:
              description: >-
                Source continuation cursor; preserve target and pass in
                provider_options.reddit.cursor with a new request key.
              type: string
            platform:
              const: reddit
          required:
            - platform
            - items
          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
        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: reddit_post_comments
          type: string
        usage:
          additionalProperties: false
          properties:
            credit_units:
              minimum: 0
              type: integer
            credits:
              type: string
            unit:
              const: page
              type: string
          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.