Notify a device about a conversion

Example

curl -X PUT "https://api.switchfile.io/v1/conversions/0b8a7c1e-5d0f-4a51-9f39-2f7f4c1d9a10/push" \
  -H "Authorization: Bearer $SWITCHFILE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "device_id": "b3e1f2a4-5c6d-4e7f-8a9b-0c1d2e3f4a5b"
  }'

const res = await fetch("https://api.switchfile.io/v1/conversions/0b8a7c1e-5d0f-4a51-9f39-2f7f4c1d9a10/push", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.SWITCHFILE_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    device_id: "b3e1f2a4-5c6d-4e7f-8a9b-0c1d2e3f4a5b"
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

<?php
$ch = curl_init('https://api.switchfile.io/v1/conversions/0b8a7c1e-5d0f-4a51-9f39-2f7f4c1d9a10/push');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => json_encode([
        'device_id' => 'b3e1f2a4-5c6d-4e7f-8a9b-0c1d2e3f4a5b',
    ]),
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('SWITCHFILE_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException("HTTP $status: $response");
}
print_r(json_decode($response, true));

import os
import requests

res = requests.put(
    "https://api.switchfile.io/v1/conversions/0b8a7c1e-5d0f-4a51-9f39-2f7f4c1d9a10/push",
    headers={"Authorization": f"Bearer {os.environ['SWITCHFILE_API_KEY']}"},
    json={
        "device_id": "b3e1f2a4-5c6d-4e7f-8a9b-0c1d2e3f4a5b",
    },
)
res.raise_for_status()
print(res.json())

Parameters

Request body

Responses

• 200OK

  • conversion_idstring (uuid)required
  • device_idstring (uuid)required
  • live_activitybooleanrequired
  • progressstring (integer) | integerrequired
  • statusstringrequired

    one of "queued", "processing", "finished", "failed"

  200 application/jsonCopy

  {
    "conversion_id": "0b8a7c1e-5d0f-4a51-9f39-2f7f4c1d9a10",
    "device_id": "b3e1f2a4-5c6d-4e7f-8a9b-0c1d2e3f4a5b",
    "status": "processing",
    "progress": 50,
    "live_activity": false
  }

• 401The API key is missing or not validUNAUTHENTICATED

  401 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-unauthenticated",
    "title": "Unauthenticated",
    "status": 401,
    "code": "UNAUTHENTICATED",
    "detail": "Missing or invalid API key."
  }

• 403Not available with a service key or a connected appNOT_AVAILABLE

  403 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-not-available",
    "title": "Not available",
    "status": 403,
    "code": "NOT_AVAILABLE",
    "detail": "This endpoint is only available with your own API key or the switchfile app."
  }

• 404Does not exist for this accountNOT_FOUND

  404 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-not-found",
    "title": "Not found",
    "status": 404,
    "code": "NOT_FOUND",
    "detail": "Not found."
  }

• 422Invalid data. errors names the fieldsINVALID_DATA

  422 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-invalid-data",
    "title": "Invalid data",
    "status": 422,
    "code": "INVALID_DATA",
    "detail": "The request contains invalid data.",
    "errors": {
      "to": [
        "Expected string"
      ]
    }
  }

• 429Too many requests or a daily quota is used up. See Retry-AfterRATE_LIMIT_EXCEEDED

  429 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-rate-limit-exceeded",
    "title": "Rate limit exceeded",
    "status": 429,
    "code": "RATE_LIMIT_EXCEEDED",
    "detail": "Too many requests. Try again in 12 seconds."
  }

Error bodies and codes are explained in Errors.