Generated by API Evangelist
Written by API Evangelist tooling for OpenAI's API. It is a proposal applied on top of the contract, not a document OpenAI publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Openai Files API
version: 1.0.0
extends: openapi/openai-files-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: 5
- target: $.paths['/files'].get
update:
x-apievangelist-phrasing:
intent: List my organization's uploaded files
effect: read
questions:
- Which files have been uploaded to my organization?
- Can I list only the files uploaded for fine-tuning or batch jobs?
instructions:
- text: List all files uploaded to my organization.
- text: Show uploaded files with purpose {purpose}.
slots:
purpose: query.purpose
method: generated
generated: '2026-09-26'
- target: $.paths['/files'].post
update:
x-apievangelist-phrasing:
intent: Upload a file
effect: write
questions:
- How do I upload a JSONL file to use for fine-tuning or a batch job?
- What's the maximum size of a single uploaded file, and how much can my org store in total?
- Can I make an uploaded file expire automatically?
instructions:
- text: Upload {file} with purpose {purpose}.
slots:
file: requestBody.file
purpose: requestBody.purpose
- text: Upload {file} for {purpose} and have it expire after {expires_after}.
slots:
file: requestBody.file
purpose: requestBody.purpose
expires_after: requestBody.expires_after
method: generated
generated: '2026-09-26'
- target: $.paths['/files/{file_id}'].get
update:
x-apievangelist-phrasing:
intent: Get details about an uploaded file
effect: read
questions:
- What's the size, name and purpose of one of my uploaded files?
- Can I check a file's metadata without downloading it?
instructions:
- text: Get the details of file {file_id}.
slots:
file_id: path.file_id
- text: Show the filename, size and purpose of uploaded file {file_id}.
slots:
file_id: path.file_id
method: generated
generated: '2026-09-26'
- target: $.paths['/files/{file_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an uploaded file
effect: destructive
questions:
- How do I delete a file I uploaded so it stops counting against storage?
- Can I permanently remove an uploaded file by ID?
instructions:
- text: Delete file {file_id}.
slots:
file_id: path.file_id
- text: Permanently remove uploaded file {file_id} from my organization.
slots:
file_id: path.file_id
method: generated
generated: '2026-09-26'
- target: $.paths['/files/{file_id}/content'].get
update:
x-apievangelist-phrasing:
intent: Download a file's contents
effect: read
questions:
- Can I download the actual contents of a file, like batch job results?
- What's the way to fetch the raw bytes of an uploaded file?
instructions:
- text: Download the contents of file {file_id}.
slots:
file_id: path.file_id
- text: Fetch the raw content of {file_id} so I can save it locally.
slots:
file_id: path.file_id
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.