API Reference

Integrate Refyle's AI rename engine into your own applications and workflows.

Overview

The Refyle API lets you send files and get back AI-generated filenames — the same intelligence that powers the app, available over HTTP. Upload a PDF, image, or document and receive a structured rename suggestion with extracted metadata.

Base URL

https://app.refyle.com/api/v1

All endpoints accept and return JSON. File uploads use multipart/form-data.

Authentication

All requests must include an Authorization header with a Bearer token.

Authorization: Bearer rfk_live_...

Generate API keys in Settings → API Keys. Keys are available on the Enterprise plan. Each key can be revoked at any time.

POST/api/v1/rename

Analyse a file and return a proposed filename with extracted metadata. Nothing is stored — results are returned immediately in the response.

Request — multipart/form-data

Field	Required	Description
`file`	Yes	The file to analyse. Supported types: PDF · JPG · PNG · WEBP · TXT · CSV
`profile`	No	Naming profile. Default: `general`. Options: `general` · `finance` · `legal` · `photo` · `propertymgmt` · `realestate`

Response — 200 OK

{
  "proposed_name": "Invoice - Acme Corp - 2024-03-15 - $299.00.pdf",
  "vendor":        "Acme Corp",
  "date":          "2024-03-15",
  "amount":        "$299.00",
  "doc_type":      "Invoice",
  "confidence":    "high"
}

highAll fields clearly extracted

mediumSome fields estimated

lowUnclear document, best effort

Error response

{ "error": "Invalid or revoked API key" }

401Missing, invalid, or expired key

400Missing file or invalid profile

500Analysis failed — try again

Code examples

curl -X POST https://app.refyle.com/api/v1/rename \
  -H "Authorization: Bearer rfk_live_..." \
  -F "file=@invoice.pdf" \
  -F "profile=finance"

Rate limits

Plan	API access	Rate limit
FREE	✕ No	—
PRO	✕ No	—
BUSINESS	✕ No	—
ENTERPRISE	✓ Yes	60 requests / minute

Requests exceeding the rate limit receive a 429 Too Many Requests response. Contact hello@refyle.com for higher limits.

Ready to get started? Generate your API key in Settings → API Keys →