Fetch the Public API v1 OpenAPI specification

GET/openapi.yamlFetch the Public API v1 OpenAPI specification

Returns this very document as application/yaml. Unauthenticated — the spec is public. Rate-limited per caller IP (60 req/min) and cacheable for 5 minutes at the edge.

Responses

Headers

Cache-Control

Edge cache hint (5 minutes) so a busy docs page doesn't thrash the origin.

string

This OpenAPI document, served verbatim.

Example response

"string"

Headers

Retry-After

Seconds the client should wait before retrying.

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "rate_limited",
    "details": {
      "retry_after_seconds": 30
    },
    "message": "Rate limit exceeded"
  }
}

Examples

curl -X GET 'https://api.salfio.com/v1/openapi.yaml'

const response = await fetch('https://api.salfio.com/v1/openapi.yaml', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.salfio.com/v1/openapi.yaml', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.salfio.com/v1/openapi.yaml")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.salfio.com/v1/openapi.yaml", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.salfio.com/v1/openapi.yaml");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.salfio.com/v1/openapi.yaml"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.salfio.com/v1/openapi.yaml")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.salfio.com/v1/openapi.yaml");
using var response = await client.SendAsync(request);

"string"

{
  "error": {
    "code": "rate_limited",
    "details": {
      "retry_after_seconds": 30
    },
    "message": "Rate limit exceeded"
  }
}

Search documentation

Fetch the Public API v1 OpenAPI specification

Responses

Headers

Headers

Documentation menu