Get an operation - Perflo Financial Agents API

Get an operation

curl --request GET \
  --url https://api.perflo.ai/v1/operations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>'

import requests

url = "https://api.perflo.ai/v1/operations/{id}"

headers = {
    "DPoP": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {DPoP: '<api-key>', Authorization: 'Bearer <token>'}};

fetch('https://api.perflo.ai/v1/operations/{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.perflo.ai/v1/operations/{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 => [
    "Authorization: Bearer <token>",
    "DPoP: <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.perflo.ai/v1/operations/{id}"

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

	req.Header.Add("DPoP", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	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/v1/operations/{id}")

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

request = Net::HTTP::Get.new(url)
request["DPoP"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "<string>",
  "submission_uncertain": true,
  "failure_code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "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
}

{
  "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
}

{
  "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
}

{
  "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

operations

{id}

Get an operation

curl --request GET \
  --url https://api.perflo.ai/v1/operations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>'

import requests

url = "https://api.perflo.ai/v1/operations/{id}"

headers = {
    "DPoP": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {DPoP: '<api-key>', Authorization: 'Bearer <token>'}};

fetch('https://api.perflo.ai/v1/operations/{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.perflo.ai/v1/operations/{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 => [
    "Authorization: Bearer <token>",
    "DPoP: <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.perflo.ai/v1/operations/{id}"

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

	req.Header.Add("DPoP", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	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/v1/operations/{id}")

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

request = Net::HTTP::Get.new(url)
request["DPoP"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "<string>",
  "submission_uncertain": true,
  "failure_code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "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
}

{
  "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
}

{
  "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
}

{
  "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
}

Authorizations

DPoP

string

header

required

Per-request RFC 9449 DPoP proof signed with ES256. Protected requests use Authorization: DPoP your_access_token_here. Create a new proof for the exact method and normalized target URI, and include the server nonce when challenged.

Authorization

string

header

required

OAuth 2.0 with RFC 9700 security practices. Discover exact environment endpoints from /.well-known/openid-configuration and /.well-known/oauth-authorization-server, and discover the resource from /.well-known/oauth-protected-resource. Authorization-code clients use PKCE S256, the exact environment resource, nonce with openid, and DPoP binding. Confidential clients also require PAR and private_key_jwt. Access and refresh tokens are sender-constrained with DPoP. purchases:execute is unavailable and omitted from this scope registry.

Headers

X-Request-Id

string

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

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

Path Parameters

string<uuid>

required

Stable identifier for one durable financial operation.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

The matching client-owned operation.

A durable financial operation projected without credentials, provider payloads, or identity fields.

string<uuid>

required

Stable identifier for one durable financial operation.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

kind

string

required

Stable machine-readable financial operation kind.

Required string length: 1 - 100

Pattern: ^[a-z][a-z0-9_]*$

state

enum<string>

required

Current durable operation state.

Available options:

accepted,

submitting,

submitted,

succeeded,

failed,

indeterminate,

cancelled

submission_uncertain

boolean

required

Whether the provider may have accepted the mutation and the client must not resubmit it.

failure_code

string | null

required

Stable failure or submission-uncertainty code, or null when none is recorded.

Required string length: 1 - 100

Pattern: ^[a-z][a-z0-9_]*$

created_at

string<date-time>

required

RFC 3339 timestamp for durable operation evidence.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

updated_at

string<date-time>

required

RFC 3339 timestamp for durable operation evidence.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

⌘I