Generated by API Evangelist
Written by API Evangelist tooling for Lytics's API. It is a proposal applied on top of the contract, not a document Lytics publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for V1 Lytics Data Upload API
version: 1.0.0
extends: openapi/lytics-data-upload-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-02'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/collect/bulk/{stream}'].post
update:
x-apievangelist-phrasing:
intent: Bulk upload a CSV file to a stream
effect: write
questions:
- Can I bulk load a gzipped CSV file into a data stream?
- What if my CSV has no header row or uses a different delimiter?
- Can I do a dry run of a CSV upload first?
instructions:
- text: Upload this CSV into stream {stream}.
slots:
stream: path.stream
- text: Bulk load the CSV to {stream} using {timestamp_field} as the event time and delimiter {delimiter}.
slots:
stream: path.stream
timestamp_field: query.timestamp_field
delimiter: query.delimiter
method: generated
generated: '2026-10-02'
- target: $.paths['/collect/bulk/{streamname}'].post
update:
x-apievangelist-phrasing:
intent: Bulk upload JSON records to a stream
effect: write
questions:
- Can I bulk upload a file of JSON records to a stream?
- What JSON shapes are rejected in a bulk upload, like objects nested in arrays?
instructions:
- text: Bulk upload these JSON records to stream {streamname}.
slots:
streamname: path.streamname
- text: 'Dry-run a bulk JSON load into {streamname}: {dryrun}.'
slots:
streamname: path.streamname
dryrun: query.dryrun
method: generated
generated: '2026-10-02'
- target: $.paths['/collect/json/{stream}'].post
update:
x-apievangelist-phrasing:
intent: Send JSON events to a stream
effect: write
questions:
- Can I post individual JSON events to a stream using an access token?
- Which field should be used as the event timestamp when I send JSON?
instructions:
- text: Send this JSON event to stream {stream} with access token {access_token}.
slots:
stream: path.stream
access_token: query.access_token
- text: Collect JSON data into {stream} using {timestamp_field} as the timestamp, token {access_token}.
slots:
stream: path.stream
timestamp_field: query.timestamp_field
access_token: query.access_token
method: generated
generated: '2026-10-02'
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.