Generated by API Evangelist
Written by API Evangelist tooling for Uphold's API. It is a proposal applied on top of the contract, not a document Uphold publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Core Files API
version: 1.0.0
extends: openapi/uphold-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: 3
- target: $.paths['/core/files'].post
update:
x-apievangelist-phrasing:
intent: Create a file for upload
effect: write
questions:
- How do I upload a document such as an ID image?
- Which content type and category do I declare when creating a file?
instructions:
- text: Create a {category} file with content type {contentType}.
slots:
category: requestBody.category
contentType: requestBody.contentType
- text: Start a file upload in category {category} as {contentType}.
slots:
category: requestBody.category
contentType: requestBody.contentType
method: generated
generated: '2026-09-26'
- target: $.paths['/core/files/{fileId}'].get
update:
x-apievangelist-phrasing:
intent: Get an uploaded file
effect: read
questions:
- How do I check the status of a file I uploaded?
- Can I fetch an uploaded file's record by its id?
instructions:
- text: Get file {fileId}.
slots:
fileId: path.fileId
- text: Show the status of uploaded file {fileId}.
slots:
fileId: path.fileId
method: generated
generated: '2026-09-26'
- target: $.paths['/core/files/settings'].get
update:
x-apievangelist-phrasing:
intent: List file upload settings
effect: read
questions:
- What file sizes and formats are accepted for uploads?
- Are there different upload rules for image files?
instructions:
- text: List file upload settings.
- text: Show upload settings for the {category} category.
slots:
category: query.category
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.