Generated by API Evangelist
Written by API Evangelist tooling for Jira's API. It is a proposal applied on top of the contract, not a document Jira publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Jira Cloud platform REST Project key and name validation API
version: 1.0.0
extends: openapi/jira-project-key-and-name-validation-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['/rest/api/3/projectvalidate/key'].get
update:
x-apievangelist-phrasing:
intent: Check whether a project key is valid and free
effect: read
questions:
- Is a project key I want already taken or invalid?
- What errors come back if my proposed project key breaks the rules?
instructions:
- text: Validate project key {key}.
slots:
key: query.key
- text: Tell me whether {key} can be used as a new project key.
slots:
key: query.key
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/projectvalidate/validProjectKey'].get
update:
x-apievangelist-phrasing:
intent: Get a usable project key, generated if needed
effect: read
questions:
- Can Jira suggest a free project key if mine is already taken?
- How do I get a guaranteed-available project key based on one I propose?
instructions:
- text: Give me a valid project key, generating one if {key} is invalid or in use.
slots:
key: query.key
- text: Suggest an available project key starting from {key}.
slots:
key: query.key
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/projectvalidate/validProjectName'].get
update:
x-apievangelist-phrasing:
intent: Get an unused project name
effect: read
questions:
- Is a project name already in use on my site?
- Will Jira suggest a numbered alternative if my project name is taken?
instructions:
- text: Check that project name {name} is free, or suggest a valid one.
slots:
name: query.name
- text: Get an available project name based on {name}.
slots:
name: query.name
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
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.