Generated by API Evangelist
Written by API Evangelist tooling for Snyk's API. It is a proposal applied on top of the contract, not a document Snyk publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Snyk Container Image API
version: 1.0.0
extends: openapi/snyk-container-image-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['/orgs/{org_id}/container_images'].get
update:
x-apievangelist-phrasing:
intent: List container images in an organization
effect: read
questions:
- Which container images has Snyk seen in my organization?
- Can I filter container images by platform or image name?
instructions:
- text: List container images in org {org_id}.
slots:
org_id: path.org_id
- text: Show {platform} container images named {names} in org {org_id}.
slots:
platform: query.platform
names: query.names
org_id: path.org_id
method: generated
generated: '2026-10-01'
- target: $.paths['/orgs/{org_id}/container_images/{image_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a container image
effect: read
questions:
- Where can I see the details of one container image?
- Can I look up a container image by its image ID?
instructions:
- text: Get container image {image_id} in org {org_id}.
slots:
image_id: path.image_id
org_id: path.org_id
- text: Show details of image {image_id} for organization {org_id}.
slots:
image_id: path.image_id
org_id: path.org_id
method: generated
generated: '2026-10-01'
- target: $.paths['/orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs'].get
update:
x-apievangelist-phrasing:
intent: List target references for a container image
effect: read
questions:
- Which targets and tags reference a given container image?
- Can I see where an image is referenced across my Snyk targets?
instructions:
- text: List target references for image {image_id} in org {org_id}.
slots:
image_id: path.image_id
org_id: path.org_id
- text: Show which targets point at container image {image_id} in organization {org_id}.
slots:
image_id: path.image_id
org_id: path.org_id
method: generated
generated: '2026-10-01'
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. See our Privacy Policy and
Terms.