Penneo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Penneo Collect API

16 actions 16 updates phrasing extends openapi/penneo-penneo-collect-api-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Penneo's API. It is a proposal applied on top of the contract, not a document Penneo publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 16

$.info
$.paths['/v1/casefiles/{id}/answers'].get
$.paths['/v1/casefiles/{id}/files'].get
$.paths['/v1/forms'].get
$.paths['/v1/forms'].post
$.paths['/v1/forms/{externalId}'].get
$.paths['/v1/forms/{externalId}'].put
$.paths['/v1/forms/{externalId}/archive'].post
$.paths['/v1/forms/{externalId}/archive/{version}'].post
$.paths['/v1/forms/{externalId}/publish'].post
$.paths['/v1/forms/{externalId}/publish/{version}'].post
$.paths['/v1/forms/{externalId}/restore/{version}'].post
$.paths['/v1/forms/{externalId}/{version}'].put
$.paths['/v1/forms/{formId}/submissions'].get
$.paths['/v1/forms/{formId}/submissions/{submissionId}/answers'].get
$.paths['/v1/forms/{formId}/submissions/{submissionId}/signed-document'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Penneo Collect API
  version: 1.0.0
extends: openapi/penneo-penneo-collect-api-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-20'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 15
- target: $.paths['/v1/casefiles/{id}/answers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get user-submitted answers for a casefile
      effect: read
      questions:
      - How do I see what a user actually filled in on a casefile?
      - Can I retrieve all submitted answers for one casefile?
      instructions:
      - text: Get the submitted answers for casefile {id}.
        slots:
          id: path.id
      - text: Show every field value a user submitted on casefile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/casefiles/{id}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files attached to a casefile
      effect: read
      questions:
      - Which files were attached to a casefile?
      - Can I list the documents a user uploaded to a casefile?
      instructions:
      - text: List the files attached to casefile {id}.
        slots:
          id: path.id
      - text: Show every document uploaded to casefile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms'].get
  update:
    x-apievangelist-phrasing:
      intent: List forms
      effect: read
      questions:
      - What forms do I have access to?
      - Can I filter my forms by status?
      instructions:
      - text: List my forms.
      - text: Show forms with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a form
      effect: write
      questions:
      - How do I create a new form with sections and fields?
      - Can I publish a form right after creating it?
      instructions:
      - text: Create a {language} form named {name} with sections {sections}.
        slots:
          language: requestBody.language
          name: requestBody.name
          sections: requestBody.sections
      - text: 'Create a {language} form {name} with sections {sections} and publish it: {publish}.'
        slots:
          language: requestBody.language
          name: requestBody.name
          sections: requestBody.sections
          publish: query.publish
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms/{externalId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a form by external ID
      effect: read
      questions:
      - What sections and fields does a given form have?
      - Can I fetch a form's full definition by its external ID?
      instructions:
      - text: Get form {externalId}.
        slots:
          externalId: path.externalId
      - text: Show the sections and fields of form {externalId}.
        slots:
          externalId: path.externalId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms/{externalId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a form
      effect: write
      questions:
      - How do I edit an existing form?
      - Can I update a form and publish it in one step?
      instructions:
      - text: Update form {externalId} with sections {sections} in {language}.
        slots:
          externalId: path.externalId
          sections: requestBody.sections
          language: requestBody.language
      - text: 'Update form {externalId} with sections {sections} in {language} and publish it: {publish}.'
        slots:
          externalId: path.externalId
          sections: requestBody.sections
          language: requestBody.language
          publish: query.publish
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms/{externalId}/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a form
      effect: destructive
      questions:
      - How do I stop new submissions on a form without deleting it?
      - What happens to a form's public URL when I archive it?
      instructions:
      - text: Archive form {externalId}.
        slots:
          externalId: path.externalId
      - text: Unpublish form {externalId} so no new submissions are accepted.
        slots:
          externalId: path.externalId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms/{externalId}/archive/{version}'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive one version of a form
      effect: destructive
      questions:
      - Can I archive just one version of a form?
      - What happens to the public URL of a single archived form version?
      instructions:
      - text: Archive version {version} of form {externalId}.
        slots:
          version: path.version
          externalId: path.externalId
      - text: Unpublish only version {version} of form {externalId}.
        slots:
          version: path.version
          externalId: path.externalId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms/{externalId}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a form
      effect: write
      questions:
      - How do I make a draft form available to end users?
      - Can I publish a form so people can start filling it in?
      instructions:
      - text: Publish form {externalId}.
        slots:
          externalId: path.externalId
      - text: Make draft form {externalId} active so users can submit it.
        slots:
          externalId: path.externalId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms/{externalId}/publish/{version}'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish one version of a form
      effect: write
      questions:
      - Can I publish a specific version of a form?
      - What happens to the public URL when I publish one form version?
      instructions:
      - text: Publish version {version} of form {externalId}.
        slots:
          version: path.version
          externalId: path.externalId
      - text: Make version {version} of form {externalId} active.
        slots:
          version: path.version
          externalId: path.externalId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms/{externalId}/restore/{version}'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived form version
      effect: write
      questions:
      - How do I bring back an archived form version?
      - Can I restore an archived version so I can edit it?
      instructions:
      - text: Restore version {version} of form {externalId}.
        slots:
          version: path.version
          externalId: path.externalId
      - text: Bring archived version {version} of form {externalId} back to draft.
        slots:
          version: path.version
          externalId: path.externalId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms/{externalId}/{version}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a specific form version
      effect: write
      questions:
      - How do I edit a specific version of a form?
      - Can I update a form version and publish it right away?
      instructions:
      - text: Update version {version} of form {externalId} with sections {sections} in {language}.
        slots:
          version: path.version
          externalId: path.externalId
          sections: requestBody.sections
          language: requestBody.language
      - text: 'Update version {version} of form {externalId} with sections {sections} in {language} and publish it: {publish}.'
        slots:
          version: path.version
          externalId: path.externalId
          sections: requestBody.sections
          language: requestBody.language
          publish: query.publish
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms/{formId}/submissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List submissions for a form
      effect: read
      questions:
      - Which submissions have been completed on a form?
      - Can I list only the completed submissions for a form?
      instructions:
      - text: List submissions for form {formId}.
        slots:
          formId: path.formId
      - text: Show completed submissions on form {formId} completed after {completedAfter}.
        slots:
          formId: path.formId
          completedAfter: query.completedAfter
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms/{formId}/submissions/{submissionId}/answers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get submission answers for a form
      effect: read
      questions:
      - What did a user actually fill in on a form submission?
      - Can I retrieve the full answer data for one submission?
      instructions:
      - text: Get the answers for submission {submissionId} on form {formId}.
        slots:
          submissionId: path.submissionId
          formId: path.formId
      - text: Show what user {submissionId} submitted on form {formId}.
        slots:
          submissionId: path.submissionId
          formId: path.formId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/v1/forms/{formId}/submissions/{submissionId}/signed-document'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a form submission's signed document
      effect: read
      questions:
      - How do I download the signed PDF a user completed?
      - Can I stream the signed document for a submission?
      instructions:
      - text: Download the signed document for submission {submissionId} on form {formId}.
        slots:
          submissionId: path.submissionId
          formId: path.formId
      - text: Stream the signed PDF of submission {submissionId} on form {formId}.
        slots:
          submissionId: path.submissionId
          formId: path.formId
      method: generated
      generated: '2026-11-20'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/penneo-penneo-collect-api-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.