List inference calls

GET

usage

inferences

curl --request GET \
  --url https://api.axilio.ai/api/v1/usage/inferences \
  --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/usage/inferences', 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/usage/inferences",
  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/usage/inferences"

	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/usage/inferences")

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

{
  "inferences": [
    {
      "cost_microdollars": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "endpoint": "detect",
      "inference_id": "<string>",
      "latency_ms": 123,
      "model": "<string>",
      "ocr_pages": 123,
      "api_key_id": "<string>",
      "ocr_engine": "free",
      "session_id": "<string>",
      "vlm_model": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "total": 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"
}

Minimum role required: Viewer

Authorizations

X-Axilio-Api-Key

string

header

required

Customer API key (axl_ prefix).

Query Parameters

start_date

string<date-time>

required

Beginning of the inferences query window (RFC 3339).

end_date

string<date-time>

required

End of the inferences query window (RFC 3339).

limit

integer<int64>

default:50

Number of inferences per page (1-100).

Required range: 1 <= x <= 100

offset

integer<int64>

default:0

Pagination offset.

Required range: x >= 0

endpoint_filter

string[] | null

Restrict results to the given vision endpoints ('detect'/'locate').

model

string

Restrict results to a single model name.

string

Filter by inference (event) id substring.

session_id

string

Restrict results to inferences that ran under one phone session.

order_by

string

Sort expression '<field> <asc|desc>'; field one of created_at, cost_microdollars, latency_ms, endpoint, model, inference_id. Defaults to created_at desc.

Response

Paginated list of inference calls.

inferences

object[] | null

required

Page of inference-call records.

Show child attributes

limit

integer<int64>

required

Page size used for this response.

offset

integer<int64>

required

Pagination offset used for this response.

total

integer<int64>

required

Total number of inference calls matching the query.

List inference calls

curl --request GET \
  --url https://api.axilio.ai/api/v1/usage/inferences \
  --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/usage/inferences', 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/usage/inferences",
  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/usage/inferences"

	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/usage/inferences")

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

{
  "inferences": [
    {
      "cost_microdollars": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "endpoint": "detect",
      "inference_id": "<string>",
      "latency_ms": 123,
      "model": "<string>",
      "ocr_pages": 123,
      "api_key_id": "<string>",
      "ocr_engine": "free",
      "session_id": "<string>",
      "vlm_model": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "total": 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"
}

Overview

Device Control Protocol

REST API

Vision API

List inference calls

Authorizations

Query Parameters

Response