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 Tests API
version: 1.0.0
extends: openapi/snyk-tests-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: 3
- target: $.paths['/orgs/{org_id}/test_jobs/{job_id}'].get
update:
x-apievangelist-phrasing:
intent: Check the progress of a test job
effect: read
questions:
- Is the Snyk test I started through the API still running?
- How do I find out when an asynchronous test job has produced a test?
instructions:
- text: Check test job {job_id} in org {org_id}.
slots:
job_id: path.job_id
org_id: path.org_id
- text: Poll the in-progress test job {job_id} for organization {org_id}.
slots:
job_id: path.job_id
org_id: path.org_id
method: generated
generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/tests'].post
update:
x-apievangelist-phrasing:
intent: Start a new open source or code test
effect: write
questions:
- Can I run an open source or code analysis test through the API?
- What do I need to provide to start a new Snyk test?
instructions:
- text: Start a new test in org {org_id}.
slots:
org_id: path.org_id
- text: Run an SCA test on these items for organization {org_id} with request ID {snyk_request_id}.
slots:
org_id: path.org_id
snyk_request_id: header.snyk-request-id
method: generated
generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/tests/{test_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a completed test's summary
effect: read
questions:
- What was the outcome of a finished Snyk test?
- Does the test result include findings, or just a summary?
instructions:
- text: Get test {test_id} in org {org_id}.
slots:
test_id: path.test_id
org_id: path.org_id
- text: Show the result summary of completed test {test_id} for organization {org_id}.
slots:
test_id: path.test_id
org_id: path.org_id
method: generated
generated: '2026-09-26'
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.