Agorapulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agorapulse Media API

4 actions 4 updates phrasing extends openapi/agorapulse-media-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/media'].post

$.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/media/{mediaUid}'].get

$.paths['/v1.0/library/organizations/{organizationId}/workspaces/{workspaceId}/studio/media/upload'].post

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 Agorapulse Media API
  version: 1.0.0
extends: openapi/agorapulse-media-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/media'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an upload slot for a post's media
      effect: write
      questions:
      - How do I upload a video so I can attach it to a scheduled social post?
      - What steps follow after I get a presigned media upload URL for publishing?
      - How long do I have to upload a file before the media upload slot expires?
      instructions:
      - text: Create a media upload slot for {file} in workspace {workspace}, org {org}.
        slots:
          file: requestBody.fileName
          workspace: path.workspaceId
          org: path.organizationId
      - text: Register publishing media {file} and give me the upload URL for workspace {workspace} of org {org}.
        slots:
          file: requestBody.fileName
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/media/{mediaUid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the processing status of uploaded media
      effect: read
      questions:
      - Has my uploaded video finished processing and is it ready to post?
      - What technical metadata is available for a media file after it is probed?
      instructions:
      - text: Get the status of media {media} in workspace {workspace}, org {org}.
        slots:
          media: path.mediaUid
          workspace: path.workspaceId
          org: path.organizationId
      - text: Check whether media {media} is ready yet in workspace {workspace} of org {org}.
        slots:
          media: path.mediaUid
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1.0/library/organizations/{organizationId}/workspaces/{workspaceId}/studio/media/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an upload URL for Content Studio media
      effect: write
      questions:
      - How do I upload a file into the Content Studio media library?
      - What file size and MIME type details are needed to request a studio upload URL?
      - Can I group several studio uploads under one Content Studio session?
      instructions:
      - text: Request a studio upload URL for a {extension} file of {size} bytes, type {type}, origin {origin}, in workspace {workspace}, org {org}.
        slots:
          extension: requestBody.extension
          size: requestBody.fileSize
          type: requestBody.contentType
          origin: requestBody.origin
          workspace: path.workspaceId
          org: path.organizationId
      - text: Upload a {extension} file ({type}, {size} bytes, from {origin}) to studio session {session} in workspace {workspace}, org {org}.
        slots:
          type: requestBody.contentType
          size: requestBody.fileSize
          session: requestBody.contentStudioSessionId
          workspace: path.workspaceId
          org: path.organizationId
          extension: requestBody.extension
          origin: requestBody.origin
      method: generated
      generated: '2026-10-01'