Get the OpenAPI document

curl --request GET \
  --url https://api.perflo.ai/openapi.json

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.perflo.ai/openapi.json",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.perflo.ai/openapi.json"

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

	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.perflo.ai/openapi.json")

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

request = Net::HTTP::Get.new(url)

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

{
  "components": {},
  "info": {
    "description": "<string>",
    "license": {
      "identifier": "<string>",
      "name": "<string>"
    },
    "title": "<string>",
    "version": "<string>"
  },
  "openapi": "<string>",
  "paths": {},
  "servers": [
    {
      "url": "<string>"
    }
  ],
  "tags": [
    {
      "description": "<string>",
      "name": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "fields": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "request_id": "<string>",
  "retryable": true,
  "submission_uncertain": true
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "fields": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "request_id": "<string>",
  "retryable": true,
  "submission_uncertain": true
}

GET

openapi.json

Get the OpenAPI document

curl --request GET \
  --url https://api.perflo.ai/openapi.json

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.perflo.ai/openapi.json",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.perflo.ai/openapi.json"

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

	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.perflo.ai/openapi.json")

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

request = Net::HTTP::Get.new(url)

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

{
  "components": {},
  "info": {
    "description": "<string>",
    "license": {
      "identifier": "<string>",
      "name": "<string>"
    },
    "title": "<string>",
    "version": "<string>"
  },
  "openapi": "<string>",
  "paths": {},
  "servers": [
    {
      "url": "<string>"
    }
  ],
  "tags": [
    {
      "description": "<string>",
      "name": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "fields": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "request_id": "<string>",
  "retryable": true,
  "submission_uncertain": true
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "fields": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "request_id": "<string>",
  "retryable": true,
  "submission_uncertain": true
}

Headers

X-Request-Id

string

Optional caller request identifier. Unsafe values are replaced with a generated UUID.

Pattern: ^[A-Za-z0-9._~-]{8,128}$

Response

The current public OpenAPI document.

The machine-readable OpenAPI 3.1 contract for the public Perflo API.

components

object

required

Reusable OpenAPI component sections.

Show child attributes

info

object

required

OpenAPI document metadata.

Show child attributes

openapi

string

required

OpenAPI specification version.

Allowed value: "3.1.0"

paths

object

required

OpenAPI path items keyed by canonical absolute API paths.

Show child attributes

servers

object[]

required

Available public API origins.

Minimum array length: 1

Show child attributes