Generated by API Evangelist
Written by API Evangelist tooling for Netlify's API. It is a proposal applied on top of the contract, not a document Netlify publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Netlify's API documentation File API
version: 1.0.0
extends: openapi/netlify-file-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['/sites/{site_id}/files'].get
update:
x-apievangelist-phrasing:
intent: List files in a site's live deploy
effect: read
questions:
- What files are in my site's currently published deploy?
- Can I list every file served by my site?
instructions:
- text: List files for site {site}.
slots:
site: path.site_id
- text: Show every file in the live deploy of site {site}.
slots:
site: path.site_id
method: generated
generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/files/{file_path}'].get
update:
x-apievangelist-phrasing:
intent: Get a site file by path
effect: read
questions:
- Can I fetch one file from my site by its path?
- How do I check a specific file's details on my live site?
instructions:
- text: Get file {file_path} from site {site}.
slots:
file_path: path.file_path
site: path.site_id
- text: Show details of {file_path} on site {site}.
slots:
file_path: path.file_path
site: path.site_id
method: generated
generated: '2026-09-26'
- target: $.paths['/deploys/{deploy_id}/files/{path}'].put
update:
x-apievangelist-phrasing:
intent: Upload a file to a deploy
effect: write
questions:
- How do I upload a file that a new deploy is asking for?
- Can I send the size of a file when uploading it to a deploy?
instructions:
- text: Upload file {path} to deploy {deploy}.
slots:
path: path.path
deploy: path.deploy_id
- text: Upload {path} of {size} bytes to deploy {deploy}.
slots:
path: path.path
size: query.size
deploy: path.deploy_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.