Get a file

GET

files

{file_id}

Get a file

curl --request GET \
  --url https://api.axilio.ai/api/v1/files/{file_id} \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/files/{file_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.axilio.ai/api/v1/files/{file_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.axilio.ai/api/v1/files/{file_id}"

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

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/files/{file_id}")

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

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "filename": "<string>",
  "id": "<string>",
  "mime_type": "<string>",
  "on_phone_count": 123,
  "preview_state": "processing",
  "size_bytes": 123,
  "source": "upload",
  "status": "uploading",
  "attachment_url": "<string>",
  "bytes_transferred": 123,
  "capture_error": "<string>",
  "capture_state": "detected",
  "checksum": "<string>",
  "display_url": "<string>",
  "download_url": "<string>",
  "duration_seconds": 123,
  "height": 123,
  "message_id": "<string>",
  "phone_id": "<string>",
  "reel_url": "<string>",
  "session_id": "<string>",
  "surface": "phone",
  "thumbnail_url": "<string>",
  "width": 123
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Minimum role required: Viewer

Authorizations

X-Axilio-Api-Key

string

header

required

Customer API key (axl_ prefix).

Path Parameters

file_id

string<uuid>

required

file identifier

Response

One file in the org's library.

created_at

string<date-time>

required

When the file was registered: upload registration, or capture detection.

filename

string

required

Original filename; used as the display name when the file lands on a phone.

string

required

File identifier. Unique across the whole library; deliverable to a phone regardless of source.

mime_type

string

required

Declared MIME type, pinned by the presigned upload.

on_phone_count

integer<int64>

required

Distinct phones currently holding or receiving a delivered copy. Informational: deleting the file from the library does not remove these.

preview_state

enum<string>

required

Whether the preview exists, is still being generated, or will never be available for this format.

Available options:

processing,

ready,

unavailable

size_bytes

integer<int64>

required

Declared size in bytes, pinned by the presigned upload.

source

enum<string>

required

How the file entered the library: upload (put in directly), capture (lifted off a session), or message (attached to a message one of the org's dedicated phones received).

Available options:

upload,

capture,

message

status

enum<string>

required

uploading until the object is verified in storage, then ready. For a capture, read capture_state for the fuller lifecycle.

Available options:

uploading,

ready

attachment_url

string

Short-lived signed URL that downloads the file as an attachment under its name. Present only for ready files.

bytes_transferred

integer<int64>

Bytes moved so far for an in-flight phone transfer. Absent until the phone reports progress.

capture_error

string

Reason the phone's upload failed, when it did. Present for captures and message attachments.

capture_state

enum<string>

Upload lifecycle of a file the phone sends itself: detected/uploading while in flight, ready when usable, or a terminal skip/failure with its reason. Present for captures and message attachments.

Available options:

detected,

uploading,

ready,

skipped_size,

skipped_quota,

skipped_type,

dropped_teardown,

failed

checksum

string

SHA-256 of the bytes, computed on the phone while uploading. Present for captures and message attachments.

display_url

string

Short-lived signed URL for a full-resolution JPEG of a HEIC or HEIF original, for display where a browser cannot draw the original. Absent for other types and until generated.

download_url

string

Short-lived signed URL to read the file's bytes. Present only for ready files; re-list to refresh an expired one.

duration_seconds

integer<int64>

Video duration in seconds.

height

integer<int64>

Intrinsic pixel height of the source.

message_id

string

The message this file was attached to. Present for message attachments once the message is stored; a file whose message never arrived still names its phone.

phone_id

string

The phone that received the message this file was attached to. Present for message attachments.

reel_url

string

Short-lived signed URL for the animated hover preview. Videos only; absent until generated.

session_id

string

Session that produced the file. Present only for captures.

surface

enum<string>

Which surface a capture or message attachment came off (phone today). Absent for a direct upload.

Available options:

phone

thumbnail_url

string

Short-lived signed URL for the generated preview image. Absent while generation is pending, and permanently absent for formats without a preview.

width

integer<int64>

Intrinsic pixel width of the source.

Get a file

curl --request GET \
  --url https://api.axilio.ai/api/v1/files/{file_id} \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/files/{file_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.axilio.ai/api/v1/files/{file_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.axilio.ai/api/v1/files/{file_id}"

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

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/files/{file_id}")

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

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "filename": "<string>",
  "id": "<string>",
  "mime_type": "<string>",
  "on_phone_count": 123,
  "preview_state": "processing",
  "size_bytes": 123,
  "source": "upload",
  "status": "uploading",
  "attachment_url": "<string>",
  "bytes_transferred": 123,
  "capture_error": "<string>",
  "capture_state": "detected",
  "checksum": "<string>",
  "display_url": "<string>",
  "download_url": "<string>",
  "duration_seconds": 123,
  "height": 123,
  "message_id": "<string>",
  "phone_id": "<string>",
  "reel_url": "<string>",
  "session_id": "<string>",
  "surface": "phone",
  "thumbnail_url": "<string>",
  "width": 123
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Overview

Device Control Protocol

REST API

Argus API

Authorizations

Path Parameters

Response