Developer API

Conversion, storage, sharing, and file retrieval endpoints that are ready to plug into real apps.

Create API keys from your profile, authenticate with a bearer token, and work with versioned endpoints under /api/v1/. API access is available on eligible paid plans.

Explore examples Manage API keys

Bearer-token authentication

Multi-language examples

API keys from profile

Shown once at creation

Files and folders

List, share, download, delete

Conversion endpoints

Upload and retrieve results fast

Authentication

Every protected request uses a bearer token.

Generate a key in your profile, copy it immediately, and pass it in the Authorization header. Convert and Store stores keys hashed and only reveals the full token once.

Authorization: Bearer cas_your_api_key_here

What this API covers

Health and catalog

Check uptime, inspect tool availability, and keep your client-side integrations aware of what is supported.

Account context

Resolve the authenticated user, plan, and API key identity safely from the token.

Storage management

List files and folders, inspect metadata, download results, and manage public sharing links.

Conversion workflows

Submit supported uploads through a stable versioned endpoint and hand the result back to your app immediately.

Example explorer

Switch endpoints and languages instantly

Pick an endpoint from our live API list, then flip through popular languages to copy the format you need.

11 documented endpoints

Endpoint

Language

Code example

Live route format

Endpoint reference

Everything below is browsable, grouped, and paired with example response shapes so developers can move quickly.

Versioned under /api/v1/

GET Core Optional

/api/v1/status

Checks API uptime and returns the current service timestamp.

Parameters

No required fields for this endpoint.

Example response

{
    "ok": true,
    "service": "convert-and-store",
    "time": "2026-04-28T18:20:00+00:00"
}

GET Catalog Optional

/api/v1/tools

Returns the current tool catalog, grouped by supported conversion families.

Parameters

No required fields for this endpoint.

Example response

{
    "data": [
        {
            "slug": "jpg-to-png",
            "name": "JPG to PNG",
            "category": "image"
        }
    ]
}

GET Account Required

/api/v1/me

Returns the authenticated account tied to the bearer key.

Parameters

No required fields for this endpoint.

Example response

{
    "data": {
        "id": 14,
        "name": "Jane Developer",
        "email": "jane@example.com",
        "plan_code": "pro",
        "api_key_name": "Production App"
    }
}

POST Conversion Required

/api/v1/convert/jpg-to-png

Runs a supported conversion using a multipart file upload in the upload field.

Parameters

upload file Required

Source file to convert.

Example response

{
    "ok": true,
    "data": {
        "conversion_id": 42,
        "tool": "jpg-to-png",
        "source_file_id": 120,
        "result_file_id": 121,
        "result_name": "source.png",
        "download_url": "https://convertandstore.com/api/v1/files/121/download"
    }
}

GET Files Required

/api/v1/files?sort=date_desc&visibility=public

Lists stored files for the authenticated account with optional search, visibility, extension, and sort filters.

Parameters

search query Optional

Searches by file name, MIME type, or folder name.

extension query Optional

Filters by extension such as png, pdf, zip.

visibility query Optional

Use public or private.

sort query Optional

Use date_desc, name_asc, size_desc, or type_asc.

Example response

{
    "ok": true,
    "data": [
        {
            "id": 121,
            "name": "source.png",
            "extension": "png",
            "size_bytes": 845221,
            "is_public": true,
            "download_url": "https://convertandstore.com/api/v1/files/121/download",
            "share_url": "https://convertandstore.com/share/abc123token"
        }
    ],
    "meta": {
        "count": 1,
        "filters": {
            "search": "",
            "extension": "",
            "visibility": "public",
            "sort": "date_desc"
        }
    }
}

GET Files Required

/api/v1/files/121

Returns metadata for a single stored file owned by the authenticated account.

Parameters

No required fields for this endpoint.

Example response

{
    "ok": true,
    "data": {
        "id": 121,
        "name": "source.png",
        "mime_type": "image/png",
        "extension": "png",
        "size_bytes": 845221,
        "folder_id": 9,
        "is_public": true,
        "download_url": "https://convertandstore.com/api/v1/files/121/download"
    }
}

GET Files Required

/api/v1/files/121/download

Downloads a converted or stored file owned by the authenticated account.

Parameters

No required fields for this endpoint.

Example response

{
    "binary": true,
    "content_type": "image/png"
}

GET Folders Required

/api/v1/folders

Lists the authenticated account folders and the current file count in each folder.

Parameters

No required fields for this endpoint.

Example response

{
    "ok": true,
    "data": [
        {
            "id": 9,
            "name": "Client Deliverables",
            "slug": "client-deliverables-ab12cd",
            "file_count": 8
        }
    ]
}

POST Folders Required

/api/v1/folders

Creates a new folder for the authenticated account.

Parameters

name body Required

Folder name under 100 characters.

Example response

{
    "ok": true,
    "data": {
        "id": 9,
        "name": "Client Deliverables",
        "slug": "client-deliverables-ab12cd",
        "file_count": 0
    }
}

POST Sharing Required

/api/v1/files/121/share

Turns public sharing on or off for a stored file and returns the share URL when enabled.

Parameters

is_public body Optional

Use 1 or true to enable, 0 or false to revoke.

Example response

{
    "ok": true,
    "data": {
        "file": {
            "id": 121,
            "name": "source.png",
            "is_public": true
        },
        "share": {
            "is_public": true,
            "token": "abc123token",
            "url": "https://convertandstore.com/share/abc123token"
        }
    }
}

POST Files Required

/api/v1/files/121/delete

Soft deletes a stored file from the authenticated account and updates storage usage.

Parameters

No required fields for this endpoint.

Example response

{
    "ok": true,
    "data": {
        "deleted": true,
        "file_id": 121
    }
}