Get pre-signed URL for user file upload · Email

infoOverview

About this API

Generates a pre-signed URL for uploading a file to S3. The file name and type are required. A unique file key will be generated automatically.

MethodPOST

Versionv1.0

Get Test URL Get Test API Key

Content Typeapplication/json

keySecurity

Authentication

Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.

Locationheader

Field nameAuthorization: Bearer <TOKEN>

Example valueYOUR_ACCESS_TOKEN

uploadInput

Request Body

Send a application/json payload. Replace placeholder values with data from your integration.

Top-Level Fields

file_namestringRequiredName of the file to be uploaded.

file_sizeintegerNot specifiedSize of the file in bytes.

file_typestringRequiredFile type/extension (without the dot).

{}

{
  "type": "object",
  "required": [
    "file_name",
    "file_type"
  ],
  "properties": {
    "file_name": {
      "type": "string",
      "example": "document.pdf",
      "description": "Name of the file to be uploaded."
    },
    "file_size": {
      "type": "integer",
      "example": 1024000,
      "nullable": true,
      "description": "Size of the file in bytes."
    },
    "file_type": {
      "type": "string",
      "example": "pdf",
      "description": "File type/extension (without the dot)."
    }
  }
}

codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

Request URL

shield_lockCredentials protectedAdd secrets only in your secure server environment.

downloadSDK

curl --request POST 'https://email.1spoc.com/api/user/files/get-pre-signed-url' \
  --header 'Authorization: Bearer <TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const response = await fetch('https://email.1spoc.com/api/user/files/get-pre-signed-url', {
  method: 'POST',
  headers: {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

const response = await fetch('https://email.1spoc.com/api/user/files/get-pre-signed-url', {
  method: 'POST',
  headers: {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

import json
import requests

url = 'https://email.1spoc.com/api/user/files/get-pre-signed-url'
headers = {
  "Authorization": "Bearer <TOKEN>",
  "Content-Type": "application/json"
}
payload = json.loads(r'''{}''')
response = requests.post(url, headers=headers, json=payload)

response.raise_for_status()
print(response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
String body = """
{}
""";
var request = HttpRequest.newBuilder(URI.create("https://email.1spoc.com/api/user/files/get-pre-signed-url"))
    .header("Authorization", "Bearer <TOKEN>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(body))
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());

<?php
$curl = curl_init();
$payload = '{}';
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://email.1spoc.com/api/user/files/get-pre-signed-url',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ["Authorization: Bearer <TOKEN>","Content-Type: application/json"],
    CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = AuthenticationHeaderValue.Parse("Bearer <TOKEN>");
var json = """
{}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://email.1spoc.com/api/user/files/get-pre-signed-url", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

package main

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

func main() {
    request, err := http.NewRequest("POST", "https://email.1spoc.com/api/user/files/get-pre-signed-url", bytes.NewBufferString("{}"))
    if err != nil { panic(err) }
    request.Header.Set("Content-Type", "application/json")
    request.Header.Set("Accept", "application/json")
    request.Header.Set("Authorization", "Bearer <TOKEN>")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}

downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "example": "https://s3.amazonaws.com/bucket/file-key?X-Amz-Algorithm=...",
      "description": "Pre-signed URL for uploading the file to S3."
    },
    "readURL": {
      "type": "string",
      "example": "https://s3.amazonaws.com/bucket/file-key?X-Amz-Algorithm=...",
      "description": "Pre-signed URL for reading/downloading the file from S3."
    }
  }
}

ruleHTTP Responses

Status Codes

200Pre-signed URL generated successfully.

400Missing file name or file type

401Unauthorized (missing or invalid user access token)

500Internal server error