Sada Files

Developer docs

  1. Developers

Quickstart

Four steps from nothing to a processed file. The first needs no account.

1. Inspect a tool

Tool metadata is public. Press Run to fetch the real schema for Compress Image: its accepted formats, options, defaults and limits.

GEThttps://api.sadafiles.com/v1/tools/compress-image

2. Create a key

Create a free account and generate a key with the tools:run scope. Copy it straight away, because it is shown once. Then put it in your environment:

export SADAFILES_API_KEY="sf_live_…"

The SDK packages are not on npm or PyPI yet, so see SDKs to install from a checkout. cURL works today.

3. Run a tool

Post the file as files[] and the options as a JSON string in options. Unknown option names are rejected, so copy them from the tool's page.

curl -X POST "https://api.sadafiles.com/v1/tools/compress-image" \
  -H "X-API-Key: $SADAFILES_API_KEY" \
  -F "files[]=@photo.png" \
  -F 'options={"quality":75}' \
  -o photo-small.png

A finished run answers 201 with the file as the body, plus X-Sada-Job and X-Sada-Expires-At headers. If it needs more than 60 seconds you get 202 with the job as JSON, and the file is not lost. Jobs explains what to do next.

4. Call a data API

Data APIs are plain GET requests that return JSON.

curl "https://api.sadafiles.com/v1/apis/google-news?q=electric+vehicles&hl=en&gl=US" \
  -H "X-API-Key: $SADAFILES_API_KEY"

Where to go next

Every endpoint has a Try it panel

Open any page in tool endpoints or the data API catalog to edit parameters, watch the samples update and send a real request.

What's next?