# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Content Use Cases > Document Ad API
  version: 1.0.0
extends: openapi/linkedin-use-cases-document-ad-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a document file to the upload URL
      effect: write
      questions:
      - After initializing, how do I send the actual document file bytes?
      - Where does the PDF go once I have an upload URL for a document ad?
      instructions:
      - text: Upload my document file to the upload URL I was given.
      - text: Send the PDF bytes for the document ad upload.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/images'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several uploaded documents at once
      effect: read
      questions:
      - Can I check the status of several uploaded documents together?
      - Which documents have finished processing for my document ads?
      instructions:
      - text: Get documents {ids}.
        slots:
          ids: query.ids
      - text: Look up the uploaded document assets {ids} in one call.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/posts'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several document ad posts
      effect: read
      questions:
      - Can I retrieve the posts behind several document ads together?
      - What content do my document ad posts contain?
      instructions:
      - text: Fetch document ad posts {ids}.
        slots:
          ids: query.ids
      - text: Show the post content for document ads {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/posts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a document ad post
      effect: write
      questions:
      - Once my document is uploaded, can I turn it into a sponsored post?
      - What's the step to create content for a document ad?
      instructions:
      - text: Create a document ad post from my uploaded document.
      - text: Publish the document content for my sponsored document ad.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Initialize a document upload
      effect: write
      questions:
      - Can I get an upload URL before sending a document for an ad?
      - What's the first step to upload a PDF for a document ad on LinkedIn?
      instructions:
      - text: Initialize a document upload with action {action}.
        slots:
          action: query.action
      - text: Register a new document upload and return the upload URL.
      method: generated
      generated: '2026-09-26'
- target: $.paths['//documents/{document_asset_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one uploaded document
      effect: read
      questions:
      - Is my uploaded document ready to use in an ad?
      - Can I look up a single document asset by its ID?
      instructions:
      - text: Get document {document_asset_id}.
        slots:
          document_asset_id: path.document_asset_id
      - text: Check the processing status of document {document_asset_id}.
        slots:
          document_asset_id: path.document_asset_id
      method: generated
      generated: '2026-09-26'