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

# Makes a private link to a checked report that holds nothing read through a team’s own licence. Its address comes back this once. A sign-in only

> Makes a private link to a checked report, for someone outside the team to read it at app.poddata.ai: `days`, 7, 30 or 90, or null for a link that never expires, and `label`, who it's for. Its address comes back this once. A report holding a figure read through your team's own licence can't be shared until it's taken out. No MCP tool makes one, and a key gets a `403`.

**Before:** A person signed in to the workspace. A key and an assistant are refused with a `403`, and no MCP tool does it, since a link's address is shown only once. The report is checked.

**Next:** Send the address to the person it’s for. `GET /diligence-reports/{id}/links` shows how often it’s opened.

**Limits:** A report that isn’t checked is a `409`.



## OpenAPI

````yaml /openapi.json post /diligence-reports/{id}/links
openapi: 3.1.0
info:
  title: PodData API
  version: 1.0.0
  description: >-
    PodData is competitive intelligence from the record: what leaders said on
    podcasts, in interviews and at their own events, as quotes with the speaker,
    the source, the day and the second; and, for a diligence, what public
    sources say about a company and its rivals, read through links a person on
    your team has confirmed.


    ## Quick start


    1. **A key.** Someone on your team makes one in the workspace, Settings ›
    API keys. Send it on every call as `Authorization: Bearer pd_live_…`. Keep
    it in an environment variable, such as `PODDATA_API_KEY`, and never print it
    or write it to a file.

    2. **A target.** `POST /targets` with a company's `name` and `domain`, an id
    from `GET /companies?q=`, or its SEC `ticker`.

    3. **Its links and rivals.** `POST /targets/{company}/find` and `POST
    /targets/{company}/rivals/find` propose them, each with the page that shows
    it. Show each one to a person, and confirm it only on their yes.

    4. **A read.** `POST /targets/{company}/read` with `{"rivals": true}` asks
    PodData to read the target and its confirmed rivals now. `GET
    /targets/{company}/coverage` says what has been read, source by source.

    5. **The files.** `GET /targets/{company}/folder` lists a file for each
    source, for the target and each confirmed rival. `?format=zip` is all of
    them at once.

    6. **A report.** `POST /diligence-reports` makes one with five empty pages.
    Write each with `PUT /diligence-reports/{id}/pages/{page}`, check it with
    `POST /diligence-reports/{id}/check`, and read it with every figure filled
    with `GET /diligence-reports/{id}`. Or have PodData's own agent write it,
    `POST /diligence-reports/{id}/runs`, and follow the run with `GET
    /diligence-runs/{id}`.


    The tags below are in that order. Each operation says what has to be true
    first, what to call next and its limits, with a made-up example of the call
    and its answer.


    **For an assistant,** start from `https://api.poddata.ai/llms.txt`, which
    needs no key: the same steps, the MCP server, and PodData's diligence skill
    with its puller, which saves a target's folder, its rivals' and its reports
    to disk. The MCP server does what the API does:
    `https://api.poddata.ai/mcp`, with the same key or by signing in to PodData,
    and each operation here names its tool in `x-mcp-tool`. To add it to Claude
    Code with the key read from the environment each time it starts, never
    written down, run this as it is, in single quotes: `claude mcp add
    --transport http --scope project poddata https://api.poddata.ai/mcp --header
    'Authorization: Bearer ${PODDATA_API_KEY}'`.


    **Limits.** 120 requests a minute a key, then a `429` with `Retry-After`. A
    team's plan sets how many reads, rival finds and filers it may ask for a
    day, and a call past one is a `403` with the code `plan` that says the
    limit. A list or a file holds at most 80 words in a row of a source's own
    text; a whole document or transcript comes from its own route, one at a
    time, under a daily limit.


    **Errors** are `{"error": {"code": "…", "message": "…"}}`, the message a
    sentence that says what to do.
servers:
  - url: https://api.poddata.ai/v1
security:
  - key: []
tags:
  - name: Targets
    description: >-
      Start here. The companies your team looks at: add one by its name and
      domain, by an id from `GET /companies`, or by its SEC ticker. A target is
      your team's alone, and nothing says another team looks at it.
  - name: Links
    description: >-
      A target's own domain, listings and accounts. PodData proposes them from
      its own site, and reads only through a link a person on your team has
      confirmed.
  - name: Rivals
    description: >-
      The companies a target competes with. PodData finds and tests candidates
      and proposes only the rivals; a person confirms each, and then it is read
      beside the target.
  - name: Reads
    description: >-
      Ask PodData to read a target and its confirmed rivals now, and see what
      has been read for it, source by source, and what is missing and why.
  - name: Records and signals
    description: >-
      What PodData read about a company through its confirmed links: records,
      such as filings, licences, cases and stories, and signals, such as reviews
      and ratings, each with its own day and its page on the source's site. And
      the figures your team's own data licences read.
  - name: Ads and site
    description: >-
      A brand's ads in Meta's US ad library, from PodData's weekly reads, and
      the pages of a company's own site as PodData read them.
  - name: Number tools
    description: >-
      Figures computed on the server, so an assistant never pages through
      thousands of reviews or does the sums itself: ratings, complaints, a
      series, a timeline, ads and a site, for a company beside its confirmed
      rivals. Each answers the figures, the rows behind them, the evidence and
      how they were built.
  - name: Folder
    description: >-
      Everything PodData holds for a target and its confirmed rivals, as files:
      an index, a CSV a source and kind, and one zip.
  - name: Reports
    description: >-
      A diligence report: an overview and five pages, each figure filled by a
      number tool when the report is read, and a check that refuses what the
      evidence doesn't hold. Your own assistant writes it a page at a time, or
      PodData's agent does.
  - name: Report runs
    description: >-
      PodData's own agent writing a report or changing one: each run's status,
      its turns and what it cost.
  - name: Quotes
    description: >-
      What people said, as quotes with the speaker, the show, the day, the
      second and a page to cite.
  - name: People
    description: >-
      The people PodData quotes, their sources and timelines, and lookups of
      someone new.
  - name: Shows and episodes
    description: The shows PodData reads and their episodes, with who spoke when.
  - name: Companies
    description: >-
      What companies said and filed themselves: their documents, events,
      transcripts, slides, posts and figures, and passages of at most 80 words
      from them.
  - name: Trackers
    description: >-
      A tracker follows a topic or a person and sends each new quote it matches
      by email, Slack or webhook.
  - name: Lists
    description: >-
      A team's own lists of people and companies, to narrow a search or a
      tracker to them.
  - name: Saved
    description: >-
      What a person signed in has saved, their saved filters and their calendar
      feed. A key, which has no person, is refused most of these.
  - name: Sources
    description: >-
      The sources PodData reads, what it holds from each, and how much of the
      watch list is covered.
  - name: Webhooks
    description: Webhooks a program registers to be sent what its trackers match.
  - name: Usage
    description: The team's calls and reads, counted by day and kind.
  - name: Help
    description: >-
      PodData's guide to itself: what each part of PodData does and where in the
      workspace it's done, topic by topic.
paths:
  /diligence-reports/{id}/links:
    post:
      tags:
        - Reports
      summary: >-
        Makes a private link to a checked report that holds nothing read through
        a team’s own licence. Its address comes back this once. A sign-in only
      description: >-
        Makes a private link to a checked report, for someone outside the team
        to read it at app.poddata.ai: `days`, 7, 30 or 90, or null for a link
        that never expires, and `label`, who it's for. Its address comes back
        this once. A report holding a figure read through your team's own
        licence can't be shared until it's taken out. No MCP tool makes one, and
        a key gets a `403`.


        **Before:** A person signed in to the workspace. A key and an assistant
        are refused with a `403`, and no MCP tool does it, since a link's
        address is shown only once. The report is checked.


        **Next:** Send the address to the person it’s for. `GET
        /diligence-reports/{id}/links` shows how often it’s opened.


        **Limits:** A report that isn’t checked is a `409`.
      operationId: makeDiligenceReportLink
      parameters:
        - schema:
            type: string
            maxLength: 64
          required: true
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            examples:
              made-up:
                summary: 'Made up: no team’s data'
                value:
                  days: 30
                  label: Investment committee
            schema:
              type: object
              properties:
                days:
                  anyOf:
                    - type: number
                      enum:
                        - 7
                    - type: number
                      enum:
                        - 30
                    - type: number
                      enum:
                        - 90
                    - type: 'null'
                  description: >-
                    How many days it works: 7, 30 or 90, or null for never. 30
                    if left out
                label:
                  type: string
                  maxLength: 120
                  description: Who it's for, as you'd write it
              additionalProperties: false
      responses:
        '201':
          description: 'Made: its address, shown this once'
          content:
            application/json:
              schema:
                type: object
                properties:
                  link:
                    type: object
                    properties:
                      id:
                        type: string
                      label:
                        type:
                          - string
                          - 'null'
                      expires_at:
                        type:
                          - string
                          - 'null'
                      turned_off_at:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                      opens:
                        type: integer
                      last_opened_at:
                        type:
                          - string
                          - 'null'
                      works:
                        type: boolean
                    required:
                      - id
                      - label
                      - expires_at
                      - turned_off_at
                      - created_at
                      - opens
                      - last_opened_at
                      - works
                  url:
                    type: string
                    format: uri
                required:
                  - link
                  - url
        default:
          description: An error
          content:
            application/json:
              examples:
                made-up:
                  summary: 'Made up: no team’s data'
                  value:
                    error:
                      code: forbidden
                      message: >-
                        A report's private links are made in PodData's
                        workspace, signed in, since a link's address is shown
                        only once. A key reads the report with GET
                        /v1/diligence-reports/{id}.
              schema:
                $ref: '#/components/schemas/ApiError'
      x-codeSamples:
        - lang: bash
          label: curl, made-up values
          source: >-
            curl -X POST
            'https://api.poddata.ai/v1/diligence-reports/dlr_01JD9K4M5N6P00000000000000/links'
            \
              -H "Authorization: Bearer $PODDATA_API_KEY" \
              -H 'Content-Type: application/json' \
              -d '{"days":30,"label":"Investment committee"}'
components:
  schemas:
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - bad_request
                - no_key
                - plan
                - forbidden
                - not_found
                - conflict
                - unclear
                - slow_down
                - internal
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    key:
      type: http
      scheme: bearer
      description: >-
        An API key, sent as `Authorization: Bearer pd_live_…`. Someone on your
        team makes one in the workspace, Settings › API keys; it's shown once.
        Staging's keys start with `pd_test_`.

````

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