LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Content Use Cases > Image Ad API

5 actions 5 updates phrasing extends openapi/linkedin-use-cases-image-ad-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for LinkedIn's API. It is a proposal applied on top of the contract, not a document LinkedIn publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/images'].post

$.paths['/rest/images/{image_urn}'].get

$.paths['/rest/posts'].get

$.paths['/rest/posts/{postId}'].get

OpenAPI Overlay

# 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 > Image Ad API
  version: 1.0.0
extends: openapi/linkedin-use-cases-image-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: 4
- target: $.paths['/images'].post
  update:
    x-apievangelist-phrasing:
      intent: Initialize an image upload
      effect: write
      questions:
      - Can I get an upload URL before sending an image for an ad?
      - What's the first step to add an image to a single image ad?
      instructions:
      - text: Initialize an image upload with action {action}.
        slots:
          action: query.action
      - text: Register an image upload and give me the upload URL.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/images/{image_urn}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one uploaded image
      effect: read
      questions:
      - Is my uploaded image ready to use in an ad?
      - Can I look up an image asset by URN?
      instructions:
      - text: Get image {image_urn}.
        slots:
          image_urn: path.image_urn
      - text: Check the status of uploaded image {image_urn}.
        slots:
          image_urn: path.image_urn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/posts'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several image ad posts
      effect: read
      questions:
      - Can I retrieve several image ad posts in one call?
      - What content do my image ads show?
      instructions:
      - text: Fetch image ad posts {ids}.
        slots:
          ids: query.ids
      - text: Show post content for image ads {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/posts/{postId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the post behind one image ad
      effect: read
      questions:
      - Which post content is attached to a specific image ad?
      - Can I read a single image ad post by its ID?
      instructions:
      - text: Get image ad post {postId}.
        slots:
          postId: path.postId
      - text: Show the commentary and image of post {postId}.
        slots:
          postId: path.postId
      method: generated
      generated: '2026-09-26'