Read principal-bound funding settlement state

GET

actions

{action_id}

settlement

curl --request GET \
  --url https://api.1849.ai/v1/actions/{action_id}/settlement \
  --header 'X-Api-Key: <api-key>'

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

fetch('https://api.1849.ai/v1/actions/{action_id}/settlement', 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.1849.ai/v1/actions/{action_id}/settlement",
  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-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.1849.ai/v1/actions/{action_id}/settlement"

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

	req.Header.Add("X-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.1849.ai/v1/actions/{action_id}/settlement")

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

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

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

{
  "action_id": "<string>",
  "status": "prepared",
  "escrow_address": "<string>"
}

{
  "error": {
    "code": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  }
}

Authorizations

X-Api-Key

string

header

required

A connection-bound gk_agent_ credential. REST deliberately accepts it through either X-Api-Key or Authorization: Bearer; X-Api-Key remains supported. Its fixed scopes are intersected with the current live grant before route authorization.

Path Parameters

action_id

string

required

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

Response

Current principal-bound funding settlement state.

action_id

string

required

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

status

enum<string>

required

Available options:

prepared,

submitted,

included,

confirmed,

cancelled_preseal,

expired_preseal,

reverted,

reorged,

funding_uncertain

escrow_address

string

Present only in confirmed state from the matching indexed TreeCreated.

Pattern: ^0x[a-fA-F0-9]{40}$

Read principal-bound funding settlement state

curl --request GET \
  --url https://api.1849.ai/v1/actions/{action_id}/settlement \
  --header 'X-Api-Key: <api-key>'

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

fetch('https://api.1849.ai/v1/actions/{action_id}/settlement', 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.1849.ai/v1/actions/{action_id}/settlement",
  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-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.1849.ai/v1/actions/{action_id}/settlement"

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

	req.Header.Add("X-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.1849.ai/v1/actions/{action_id}/settlement")

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

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

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

{
  "action_id": "<string>",
  "status": "prepared",
  "escrow_address": "<string>"
}

{
  "error": {
    "code": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  }
}

Get started

API reference

Endpoints

SDK

CLI

MCP server

Agent format

Canonical JSON

Read principal-bound funding settlement state

Authorizations

Path Parameters

Response