Skip to content
SHRINKED

Quickstart Guide

Getting Started

Follow this guide to make your first API request to Shrinked. You’ll learn how to authenticate, send requests, and handle responses.

Accessing the API

The API is available through our dashboard. You can:

  1. Try the API in our interactive playground
  2. Generate API keys in Account Settings
  3. Use workspaces to manage different projects and track usage

Authentication

All requests to the Shrinked API require an x-api-key header with your API key.

Terminal window
curl -H "x-api-key: YOUR_API_KEY" https://api.shrinked.ai/v1/...

If you’re using one of our client SDKs, the key will be automatically included in all requests.

Making Your First Request

Here’s a simple example of uploading a file for processing in different languages:

cURL

Terminal window
curl https://api.shrinked.ai/v1/uploads/single \
     -H "x-api-key: YOUR_API_KEY" \
     -H "content-type: application/json" \
     -d '{
         "email": "[email protected]",
         "language": "en",
         "payload": "https://example.com/file.mp3"
     }'

Python

import requests


api_key = "YOUR_API_KEY"
response = requests.post(
    "https://api.shrinked.ai/v1/uploads/single",
    headers={
        "x-api-key": api_key,
        "content-type": "application/json"
    },
    json={
        "email": "[email protected]",
        "language": "en",
        "payload": "https://example.com/file.mp3"
    }
)
print(response.json())

JavaScript

const response = await fetch('https://api.shrinked.ai/v1/uploads/single', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    email: '[email protected]',
    language: 'en',
    payload: 'https://example.com/file.mp3'
  })
});
const data = await response.json();
console.log(data);

Response

A successful request will return a response like this:

{
  "taskId": "task_abc123",
  "status": "in_progress"
}

Next Steps

Rate Limits

The API has the following default rate limits:

  • 10 requests per minute for single uploads
  • 2 requests per minute for batch uploads
  • Maximum 200GB total file size per batch

Contact support to request increased limits for your account.