Uploadcare

https://uploadcare.com/docs
Admin
Uploadcare is a developer-friendly infrastructure platform for file uploading, storage, processing,...
Tokens:661,567
Snippets:4,651
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### Get metadata example

Source: https://uploadcare.com/docs/cli/reference/file

Example command to get the metadata value for the key 'source'.

```bash
uploadcare metadata get 740e1b8c-1ad8-4324-b7ec-112345678900 source
```

--------------------------------

### Python SDK example

Source: https://uploadcare.com/docs/api/rest/conversion/video-convert-status

Uses the pyuploadcare library to get the video conversion status. Requires public and secret keys.

```python
from pyuploadcare import Uploadcare
uploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')

token = 1201016744
video_convert_status = uploadcare.video_convert_api.status(token)
print(video_convert_status.status)
```

--------------------------------

### uploadcare project create examples

Source: https://uploadcare.com/docs/cli/reference/project

Examples of creating a project with different flags: basic, set as default, no save, and dry-run.

```bash
uploadcare project create "My App" --project-api-token <token>
```

```bash
uploadcare project create "My App" --use --project-api-token <token>
```

```bash
uploadcare project create "My App" --no-save --project-api-token <token>
```

```bash
uploadcare project create "My App" --dry-run --project-api-token <token>
```

--------------------------------

### Install uploadcare-go with go get

Source: https://uploadcare.com/docs/integrations/golang

Install the uploadcare-go v2 package using the go get command. Requires Go 1.25 or later.

```bash
go get -u -v github.com/uploadcare/uploadcare-go/v2/...
```

--------------------------------

### addon execute examples

Source: https://uploadcare.com/docs/cli/reference/other

Examples of running various add-ons with different flags, including `--json`, `--no-wait`, `--params`, and `--dry-run`.

```bash
uploadcare addon execute uc-clamav-virus-scan UUID
```

```bash
uploadcare addon execute aws-rekognition-detect-labels UUID --json all
```

```bash
uploadcare addon execute remove-bg UUID --json all
```

```bash
uploadcare addon execute uc-clamav-virus-scan UUID --no-wait --json all
```

```bash
uploadcare addon execute aws-rekognition-detect-labels UUID --params '{"max_labels": 5}'
```

```bash
uploadcare addon execute uc-clamav-virus-scan UUID --dry-run
```

--------------------------------

### Install CLI with curl

Source: https://uploadcare.com/docs/cli/guides/ci-cd

Installs the Uploadcare CLI using the official install script. Use in a CI setup step.

```bash
curl -fsSL https://raw.githubusercontent.com/uploadcare/uploadcare-cli/main/scripts/install.sh | sh
```

--------------------------------

### Install with Environment Variables

Source: https://uploadcare.com/docs/cli

Shows how to use the install script with environment variables: VERSION for a specific version, INSTALL_DIR for a custom directory, and UNINSTALL=1 to remove the binary. Configuration is not affected by uninstall.

```bash
# Install a specific version
curl -fsSL https://raw.githubusercontent.com/uploadcare/uploadcare-cli/main/scripts/install.sh | VERSION=0.1.0 sh

# Install to a custom directory
curl -fsSL https://raw.githubusercontent.com/uploadcare/uploadcare-cli/main/scripts/install.sh | INSTALL_DIR=~/.local/bin sh

# Uninstall
curl -fsSL https://raw.githubusercontent.com/uploadcare/uploadcare-cli/main/scripts/install.sh | UNINSTALL=1 sh
```

--------------------------------

### C#: RestSharp GET metadata

Source: https://uploadcare.com/docs/api/rest/file-metadata/key

C# example using RestSharp. It sends a GET request to the metadata endpoint with the required headers.

```csharp
using RestSharp;

var client = new RestClient("https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/metadata/subsystem/");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/vnd.uploadcare-v0.7+json");
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);

```

--------------------------------

### Deploy to staging and production with --project

Source: https://uploadcare.com/docs/cli/guides/ci-cd

Shows how to target different environments using the --project flag. Includes two commands, one for staging and one for production.

```bash
# Deploy to staging
uploadcare file upload ./assets/* --project "Staging" --store true

# Deploy to production
uploadcare file upload ./assets/* --project "Production" --store true
```

--------------------------------

### Upload file examples

Source: https://uploadcare.com/docs/cli/reference/file

Examples of uploading files with options for storage behavior, metadata, JSON output, dry-run validation, and reading paths from stdin. The --store flag accepts auto, true, or false; --metadata is repeatable; --multipart-threshold sets the size threshold for multipart upload; --force-multipart and --force-direct override the automatic method; --progress shows upload progress on stderr; --dry-run validates without uploading; --from-stdin reads file paths from stdin.

```bash
uploadcare file upload photo.jpg
```

```bash
uploadcare file upload photo.jpg --store true
```

```bash
uploadcare file upload photo.jpg --metadata source=camera --metadata project=vacation
```

```bash
uploadcare file upload *.jpg --json uuid,filename,size
```

```bash
uploadcare file upload photo.jpg --dry-run --json all
```

```bash
find ./images -name '*.png' | uploadcare file upload --from-stdin --json uuid
```

--------------------------------

### Java: Unirest GET metadata

Source: https://uploadcare.com/docs/api/rest/file-metadata/key

Java example using Unirest. It performs a GET request to the metadata endpoint with the required headers.

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/metadata/subsystem/")
  .header("Accept", "application/vnd.uploadcare-v0.7+json")
  .header("Authorization", "<apiKey>")
  .asString();

```

--------------------------------

### Set metadata examples

Source: https://uploadcare.com/docs/cli/reference/file

Example commands for setting metadata. The second uses --dry-run to preview changes and outputs JSON.

```bash
uploadcare metadata set 740e1b8c-1ad8-4324-b7ec-112345678900 source camera
```

```bash
uploadcare metadata set 740e1b8c-1ad8-4324-b7ec-112345678900 source camera --dry-run --json all
```

--------------------------------

### Install @google-cloud/storage

Source: https://uploadcare.com/docs/google-cloud-storage

Installs the official Google Cloud Storage client library for Node.js. Required before using the Storage class in the following examples.

```bash
npm install @google-cloud/storage
```

--------------------------------

### group info examples

Source: https://uploadcare.com/docs/cli/reference/group

Examples of getting group info with and without JSON output. Quote group IDs to prevent shell expansion of the ~ character.

```bash
uploadcare group info "740e1b8c-1ad8-4324-b7ec-112345678900~3"
```

```bash
uploadcare group info "740e1b8c-1ad8-4324-b7ec-112345678900~3" --json all
```

--------------------------------

### group create examples

Source: https://uploadcare.com/docs/cli/reference/group

Examples of creating file groups, including reading UUIDs from stdin and dry-run validation.

```bash
uploadcare group create UUID1 UUID2 UUID3
```

```bash
uploadcare group create UUID1 UUID2 --json all
```

```bash
uploadcare file list --page-all --stored true --json uuid | head -5 | uploadcare group create --from-stdin
```

```bash
uploadcare group create UUID1 UUID2 --dry-run
```

--------------------------------

### List Files with App Data (C#)

Source: https://uploadcare.com/docs/api/rest/file/files-list

C# example using RestSharp to GET files with app data, including the same query parameters as the Java example.

```csharp
using RestSharp;

var client = new RestClient("https://api.uploadcare.com/files/?from=2015-09-10T10%3A00%3A00Z&include=appdata&limit=100&ordering=-datetime_uploaded&removed=true&stored=true");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/vnd.uploadcare-v0.7+json");
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

--------------------------------

### List Files with SDK (Python)

Source: https://uploadcare.com/docs/api/rest/file/files-list

Python example using pyuploadcare to list stored files and print their info.

```python
from pyuploadcare import Uploadcare
uploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')

files = uploadcare.list_files(stored=True, limit=10)
for file in files:
    print(file.info)
```

--------------------------------

### Go: HTTP GET metadata

Source: https://uploadcare.com/docs/api/rest/file-metadata/key

Go example using the standard library. It sends a GET request to the metadata endpoint with an API key and prints the response.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/metadata/subsystem/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept", "application/vnd.uploadcare-v0.7+json")
	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

```

--------------------------------

### Go SDK example for file info

Source: https://uploadcare.com/docs/api/url/file-information/file-info-json

Uses net/http to send a GET request to the file info endpoint and prints the response status and body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ucarecdn.com/d7fe74ac-65b8-4ade-875f-ccd92759a70f/-/json/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

--------------------------------

### Multipart Upload Start Response (JSON)

Source: https://uploadcare.com/docs/api/upload/upload/multipart-file-upload-start

Example response from the multipart upload start endpoint. Contains the file UUID and a list of presigned URLs for each part.

```json
{
  "uuid": "67947755-1584-4e3f-902b-d4e2bf76a841",
  "parts": [
    "<presigned-url-1>",
    "<presigned-url-2>",
    "<presigned-url-3>",
    "<presigned-url-4>",
    "<presigned-url-5>"
  ]
}
```

--------------------------------

### Example URLs for align:center and crop migration

Source: https://uploadcare.com/docs/guides/from-filestack

Shows the full URLs for the align:center and crop migration example.

```text
https://process.filestackapi.com/resize=width:200,height:400,fit:crop,align:center/2h25ZGRHTfmQ2DBEt3yR
https://demo.ucarecd.net/b85bbf3a-393d-4217-b23e-02f0329a017d/-/scale_crop/200x400/center/
```

--------------------------------

### Get File Tags - PHP

Source: https://uploadcare.com/docs/api/rest/file-tags/get-tags

PHP example using GuzzleHttp to GET the tags of a file. Requires an API key and the file UUID. Echoes the response body.

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/tags/', [
  'headers' => [
    'Accept' => 'application/vnd.uploadcare-v0.7+json',
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

--------------------------------

### Install @uploadcare/ai-image-editor with bun

Source: https://uploadcare.com/docs/ai-image-editor/quickstart

Install the package using bun.

```bash
bun add @uploadcare/ai-image-editor
```

--------------------------------

### Get File Tags - Java

Source: https://uploadcare.com/docs/api/rest/file-tags/get-tags

Java example using Unirest to GET the tags of a file. Requires an API key and the file UUID. The response is stored as a string.

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/tags/")
  .header("Accept", "application/vnd.uploadcare-v0.7+json")
  .header("Authorization", "<apiKey>")
  .asString();
```

--------------------------------

### Get File Tags - Swift

Source: https://uploadcare.com/docs/api/rest/file-tags/get-tags

Swift example using URLSession to GET the tags of a file. Requires an API key and the file UUID. Prints the error or HTTP response.

```swift
import Foundation

let headers = [
  "Accept": "application/vnd.uploadcare-v0.7+json",
  "Authorization": "<apiKey>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/tags/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

--------------------------------

### Staging vs. production workflow

Source: https://uploadcare.com/docs/cli/configuration

Example of uploading files to a staging project, then verifying and uploading to a production project.

```bash
# Upload to staging
uploadcare file upload assets/*.jpg --project "Staging"

# Verify, then upload to production
uploadcare file upload assets/*.jpg --project "Production"
```

--------------------------------

### uploadcare project list examples

Source: https://uploadcare.com/docs/cli/reference/project

Examples of listing projects with different flags: basic, JSON output, and paginated NDJSON stream.

```bash
uploadcare project list --project-api-token <token>
```

```bash
uploadcare project list --json all --project-api-token <token>
```

```bash
uploadcare project list --page-all --json all --project-api-token <token>
```

--------------------------------

### Get File Tags - C#

Source: https://uploadcare.com/docs/api/rest/file-tags/get-tags

C# example using RestSharp to GET the tags of a file. Requires an API key and the file UUID. Executes the request and stores the response.

```csharp
using RestSharp;

var client = new RestClient("https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/tags/");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/vnd.uploadcare-v0.7+json");
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

--------------------------------

### Get File Tags - Ruby

Source: https://uploadcare.com/docs/api/rest/file-tags/get-tags

Ruby example using Net::HTTP to GET the tags of a file. Requires an API key and the file UUID. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/tags/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.uploadcare-v0.7+json'
request["Authorization"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### group list examples

Source: https://uploadcare.com/docs/cli/reference/group

Examples of listing file groups with JSON output, custom ordering, and streaming all pages.

```bash
uploadcare group list --json all
```

```bash
uploadcare group list --ordering -datetime_created --json all
```

```bash
uploadcare group list --page-all --json id
```

--------------------------------

### Serve Angular app

Source: https://uploadcare.com/docs/integrations/angular

Run this command to start the Angular development server and test the uploader widget.

```bash
ng serve --open
```

--------------------------------

### Get File Tags - Go

Source: https://uploadcare.com/docs/api/rest/file-tags/get-tags

Go example using net/http to GET the tags of a file. Requires an API key and the file UUID. Prints the response status and body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/tags/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept", "application/vnd.uploadcare-v0.7+json")
	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

--------------------------------

### Get File Tags - JavaScript

Source: https://uploadcare.com/docs/api/rest/file-tags/get-tags

JavaScript example using fetch to GET the tags of a file. Requires an API key and the file UUID. Logs the JSON response or error.

```javascript
const url = 'https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/tags/';
const options = {
  method: 'GET',
  headers: {Accept: 'application/vnd.uploadcare-v0.7+json', Authorization: '<apiKey>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

--------------------------------

### Example URLs for align:left and crop migration

Source: https://uploadcare.com/docs/guides/from-filestack

Shows the full URLs for the align:left and crop migration example.

```text
https://process.filestackapi.com/resize=width:200,height:400,fit:crop,align:left/2h25ZGRHTfmQ2DBEt3yR
https://demo.ucarecd.net/b85bbf3a-393d-4217-b23e-02f0329a017d/-/scale_crop/200x400/
```

--------------------------------

### Full config file example at ~/.uploadcare/config.yaml

Source: https://uploadcare.com/docs/cli/configuration

Shows the complete structure of the CLI config file, including top-level fallback keys, a project API token, a default project, named projects with per-project CDN overrides, and commented API base URL overrides.

```yaml
# Top-level keys are used as fallback when no project is selected
public_key: "demopublickey"
secret_key: "demosecretkey"

# Account-level token for project management commands
project_api_token: "your-bearer-token"

# Set a default named project
default_project: "Production"

# Named projects for multi-project setups
projects:
  "Production":
    public_key: "prod-public-key"
    secret_key: "prod-secret-key"
    cdn_base: "https://cdn.example.com"  # optional per-project CDN
  "Staging":
    public_key: "staging-public-key"
    secret_key: "staging-secret-key"

# API base URL overrides (rarely needed)
# rest_api_base: "https://api.uploadcare.com"
# upload_api_base: "https://upload.uploadcare.com"
```

--------------------------------

### Get File Tags - Python

Source: https://uploadcare.com/docs/api/rest/file-tags/get-tags

Python example using the requests library to GET the tags of a file. Requires an API key and the file UUID. Prints the JSON response.

```python
import requests

url = "https://api.uploadcare.com/files/21975c81-7f57-4c7a-aef9-acfe28779f78/tags/"

headers = {
    "Accept": "application/vnd.uploadcare-v0.7+json",
    "Authorization": "<apiKey>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

--------------------------------

### C#: GET document convert info

Source: https://uploadcare.com/docs/api/rest/conversion/document-convert-info

C# example using RestSharp to call the Document Convert Info API. It creates a GET request with the required headers and executes it.

```csharp
using RestSharp;

var client = new RestClient("https://api.uploadcare.com/convert/document/86c91c35-58e1-41f7-9b23-2d7652cfcd17/");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/vnd.uploadcare-v0.7+json");
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

--------------------------------

### List metadata examples

Source: https://uploadcare.com/docs/cli/reference/file

Example commands for listing metadata. The second command outputs all metadata in JSON format.

```bash
uploadcare metadata list 740e1b8c-1ad8-4324-b7ec-112345678900
```

```bash
uploadcare metadata list 740e1b8c-1ad8-4324-b7ec-112345678900 --json all
```

--------------------------------

### PHP SDK fromUrl Example

Source: https://uploadcare.com/docs/api/upload/upload/from-url-upload

Uses the Uploadcare PHP library to start an upload from a URL. Requires public and secret keys from environment variables. The 'action' metadata key is set to 'upload from URL'.

```php
<?php
$configuration = Uploadcare\Configuration::create((string) $_ENV['UPLOADCARE_PUBLIC_KEY'], (string) $_ENV['UPLOADCARE_SECRET_KEY']);

$uploader = new Uploadcare\Uploader\Uploader($configuration);
$url = 'https://source.unsplash.com/featured';
$token = $uploader->fromUrl($url, null, null, 'auto', [
    'action' => 'upload from URL', // The "Action" is the metadata key
    'checkDuplicates' => true,
    'storeDuplicates' => false,
]);
echo \sprintf('Upload from URL \'%s\' has been started. Token is %s', $url, $token);
```

--------------------------------

### on() in plugin setup - Auto cleanup

Source: https://uploadcare.com/docs/file-uploader/api

Inside a plugin's setup, return the unsubscribe function from api.on() to have it called automatically when the plugin is unregistered. The example logs only image uploads.

```typescript
import { EventType } from '@uploadcare/file-uploader';

setup({ uploaderApi }) {
  const unsubscribe = uploaderApi.on(EventType.FILE_UPLOAD_SUCCESS, (fileEntry) => {
    if (fileEntry.isImage) {
      console.log('Image uploaded:', fileEntry.cdnUrl);
    }
  });

  return () => unsubscribe();
}
```

--------------------------------

### Convert video examples

Source: https://uploadcare.com/docs/cli/reference/other

Examples of converting videos with flags for format, size, quality, cut, thumbs, and no-wait.

```bash
uploadcare convert video UUID --format mp4
```

```bash
uploadcare convert video UUID --format mp4 --size 1280x720 --quality better
```

```bash
uploadcare convert video UUID --format mp4 --cut 000:00:05.000/000:00:15.000
```

```bash
uploadcare convert video UUID --thumbs 5
```

```bash
uploadcare convert video UUID --format mp4 --no-wait --json all
```

--------------------------------

### Multipart Upload Start Request (JSON)

Source: https://uploadcare.com/docs/api/upload/upload/multipart-file-upload-start

Example request body for the multipart upload start endpoint. Includes required fields: UPLOADCARE_PUB_KEY, UPLOADCARE_STORE, content_type, filename, and size.

```json
{
  "UPLOADCARE_PUB_KEY": "YOUR_PUBLIC_KEY",
  "UPLOADCARE_STORE": "auto",
  "content_type": "video/mp4",
  "filename": "myfile.mp4",
  "size": 27796904
}
```

--------------------------------

### Install gems with bundle install

Source: https://uploadcare.com/docs/integrations/rails

Execute bundle install to install the gem and its dependencies.

```console
bundle install
```

--------------------------------

### Get File Tags - Response

Source: https://uploadcare.com/docs/api/rest/file-tags/get-tags

Example response for the Get File Tags endpoint. Returns a JSON object with a "tags" array containing the file's tags.

```json
{
  "tags": [
    "cat",
    "animal"
  ]
}
```

--------------------------------

### Python SDK example

Source: https://uploadcare.com/docs/api/rest/file-metadata/update-file-metadata-key

Uses the pyuploadcare library to update or create a metadata key. Requires public and secret keys.

```python
from pyuploadcare import Uploadcare
uploadcare = Uploadcare(public_key='YOUR_PUBLIC_KEY', secret_key='YOUR_SECRET_KEY')

file_uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
key, value = "pet", "dog"
uploadcare.metadata_api.update_or_create_key(file_uuid, key, value)

```
Tokens:
Raw