Generated by API Evangelist
Written by API Evangelist tooling for Elastic Stack's API. It is a proposal applied on top of the contract, not a document Elastic Stack publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Kibana short url API
version: 1.0.0
extends: openapi/elk-stack-short-url-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: 4
- target: $.paths['/api/short_url'].post
update:
x-apievangelist-phrasing:
intent: Create a Kibana short URL
effect: write
questions:
- How do I make a short, shareable link to a Kibana view?
- Can I choose a human-readable slug for a short URL?
instructions:
- text: Create a short URL for locator {locator_id} with params {params}.
slots:
locator_id: requestBody.locatorId
params: requestBody.params
- text: Make a short link with slug {slug} for locator {locator_id} and params {params}.
slots:
slug: requestBody.slug
locator_id: requestBody.locatorId
params: requestBody.params
method: generated
generated: '2026-09-26'
- target: $.paths['/api/short_url/_slug/{slug}'].get
update:
x-apievangelist-phrasing:
intent: Resolve a short URL by its slug
effect: read
questions:
- Where does a Kibana short link slug point to?
- Can I look up a short URL from its slug instead of its ID?
instructions:
- text: Resolve short URL slug {slug}.
slots:
slug: path.slug
- text: Find the short URL whose slug is {slug}.
slots:
slug: path.slug
method: generated
generated: '2026-09-26'
- target: $.paths['/api/short_url/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a short URL by ID
effect: read
questions:
- What locator and params are stored in one short URL?
- Can I fetch a short URL record using its ID?
instructions:
- text: Get short URL {id}.
slots:
id: path.id
- text: Show the details of short link ID {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/short_url/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a short URL
effect: destructive
questions:
- How do I remove a Kibana short link?
- Can I delete a short URL once it's been shared?
instructions:
- text: Delete short URL {id}.
slots:
id: path.id
- text: Remove short link ID {id}.
slots:
id: path.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.