Generated by API Evangelist
Written by API Evangelist tooling for Unity's API. It is a proposal applied on top of the contract, not a document Unity publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Unity Matchmaker Tickets API
version: 1.0.0
extends: openapi/unity-tickets-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['/v3/projects/{projectId}/environments/{environmentId}/tickets'].post
update:
x-apievangelist-phrasing:
intent: Put players into matchmaking with a ticket
effect: write
questions:
- How do I start matchmaking for a player or a party?
- Can I pass player attributes like skill when entering a matchmaking queue?
instructions:
- text: Create a matchmaking ticket for players {players} in queue {queueName}, project {projectId}, environment {environmentId}.
slots:
players: requestBody.players
queueName: requestBody.queueName
projectId: path.projectId
environmentId: path.environmentId
- text: Enter {players} into queue {queueName} with attributes {attributes} (project {projectId}, env {environmentId}).
slots:
players: requestBody.players
queueName: requestBody.queueName
attributes: requestBody.attributes
projectId: path.projectId
environmentId: path.environmentId
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectId}/environments/{environmentId}/tickets/{ticketId}'].get
update:
x-apievangelist-phrasing:
intent: Check a matchmaking ticket's status
effect: read
questions:
- Has my matchmaking ticket found a match yet?
- What is the current status of a ticket I submitted?
instructions:
- text: Check matchmaking ticket {ticketId} in project {projectId}, environment {environmentId}.
slots:
ticketId: path.ticketId
projectId: path.projectId
environmentId: path.environmentId
- text: Poll ticket {ticketId} to see if a match was found (project {projectId}, env {environmentId}).
slots:
ticketId: path.ticketId
projectId: path.projectId
environmentId: path.environmentId
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectId}/environments/{environmentId}/tickets/{ticketId}'].delete
update:
x-apievangelist-phrasing:
intent: Cancel a matchmaking ticket
effect: destructive
questions:
- How does a player leave the matchmaking queue?
- Can I cancel a ticket before a match is found?
instructions:
- text: Cancel matchmaking ticket {ticketId} in project {projectId}, environment {environmentId}.
slots:
ticketId: path.ticketId
projectId: path.projectId
environmentId: path.environmentId
- text: Pull the player out of matchmaking by deleting ticket {ticketId} (project {projectId}, env {environmentId}).
slots:
ticketId: path.ticketId
projectId: path.projectId
environmentId: path.environmentId
method: generated
generated: '2026-10-01'
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.