Przejdź do treści
Dokumentacja API
Dokumentacja API

Tworzenie przesyłania pliku

Prześlij jeden lokalny plik, zdalny adres URL HTTPS lub źródło base64 i otrzymaj tymczasowy URL.

Prześlij jeden lokalny plik, zdalny adres URL HTTPS lub źródło base64 i otrzymaj tymczasowy URL.

Punkt końcowy

POST /api/v1/files
Bazowy URL
https://runapi.ai
Wersja API
v1
Uwierzytelnianie
Authorization: Bearer YOUR_API_KEY
02

Żądanie

Treść JSON

Wysyłaj wartości wyłącznie w podanej lokalizacji żądania.

application/json - Base64 source4 pola
file_namestring
Opcjonalne

Opcjonalna nazwa pliku dla tworzonego przesyłania pliku.

sourceobject
Wymagane

Bajty źródłowe zakodowane w Base64.

source.datastring
Wymagane

Dane Base64

source.typestring
Wymagane

Wybiera reprezentację źródła base64.

application/json - URL source4 pola
file_namestring
Opcjonalne

Opcjonalna nazwa pliku dla tworzonego przesyłania pliku.

sourceobject
Wymagane

Zdalne źródło HTTPS do pobrania.

source.typestring
Wymagane

Wybiera reprezentację źródła URL.

source.urlstring
Wymagane

Publiczny adres HTTPS do pobrania.

multipart/form-data2 pola
filestring
Wymagane

Bajty lokalnego pliku do przesłania.

file_namestring
Opcjonalne

Opcjonalna nazwa pliku dla tworzonego przesyłania pliku.

03

Odpowiedź sukcesu

HTTP 201

POST /api/v1/files

JSON
{
  "created_at": "2026-07-27T10:00:00.000Z",
  "expires_at": "2026-07-27T11:00:00.000Z",
  "file_name": "mask.png",
  "mime_type": "image/png",
  "size_bytes": 204800,
  "url": "https://file.runapi.ai/temp/user-uploads/mask.png"
}
04

Odpowiedź błędu (401)

HTTP 401
Schemat odpowiedzi
JSON
{
  "properties": {
    "error": {
      "description": "Czytelny dla człowieka komunikat o błędzie.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Przykład odpowiedzi

JSON
{
  "error": "Authentication required"
}
05

Odpowiedź błędu (403)

HTTP 403
Schemat odpowiedzi
JSON
{
  "properties": {
    "error": {
      "description": "Czytelny dla człowieka komunikat o błędzie.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Przykład odpowiedzi

JSON
{
  "error": "Standard API key required"
}
06

Odpowiedź błędu (400)

HTTP 400
Schemat odpowiedzi
JSON
{
  "properties": {
    "error": {
      "description": "Czytelny dla człowieka komunikat o błędzie.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Przykład odpowiedzi

JSON
{
  "error": "Only HTTPS URLs are allowed"
}
07

Odpowiedź błędu (408)

HTTP 408
Schemat odpowiedzi
JSON
{
  "properties": {
    "error": {
      "description": "Czytelny dla człowieka komunikat o błędzie.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Przykład odpowiedzi

JSON
{
  "error": "Download timeout"
}
08

Odpowiedź błędu (413)

HTTP 413
Schemat odpowiedzi
JSON
{
  "properties": {
    "error": {
      "description": "Czytelny dla człowieka komunikat o błędzie.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Przykład odpowiedzi

JSON
{
  "error": "File size exceeds the maximum allowed size"
}
09

Odpowiedź błędu (415)

HTTP 415
Schemat odpowiedzi
JSON
{
  "properties": {
    "error": {
      "description": "Czytelny dla człowieka komunikat o błędzie.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Przykład odpowiedzi

JSON
{
  "error": "This content type is not supported"
}
10

Odpowiedź błędu (422)

HTTP 422
Schemat odpowiedzi
JSON
{
  "properties": {
    "error": {
      "description": "Czytelny dla człowieka komunikat o błędzie.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Przykład odpowiedzi

JSON
{
  "error": "File upload failed. Please try again."
}
11

Odpowiedź błędu (429)

HTTP 429
Schemat odpowiedzi
JSON
{
  "properties": {
    "error": {
      "description": "Czytelny dla człowieka komunikat o błędzie.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Przykład odpowiedzi

JSON
{
  "error": "Too many file uploads for this account. Please retry later."
}
12

Przykład cURL

CURL
curl -X POST https://runapi.ai/api/v1/files \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"source":{"type":"url","url":"https://cdn.runapi.ai/public/samples/mask.png"},"file_name":"mask.png"}'