Get an instruction proposal

curl --request GET \
  --url https://api.checkfu.com/v1/instruction-proposals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/instruction-proposals/{id}"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/instruction-proposals/{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.checkfu.com/v1/instruction-proposals/{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>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/instruction-proposals/{id}"

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.checkfu.com/v1/instruction-proposals/{id}")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/instruction-proposals/{id}")

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

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

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

{
  "id": "<string>",
  "status": "authoring",
  "agent": "<string>",
  "base_draft_revision": 1,
  "base_instructions": "<string>",
  "model_routing_profile_key": "<string>",
  "judge_model_routing_profile_key": "<string>",
  "source_session_ids": [
    "<string>"
  ],
  "instructions": "<string>",
  "length_budget": 1,
  "deltas": [
    {
      "op": "add",
      "after": "<string>",
      "text": "<string>",
      "provenance": {
        "sources": [
          {
            "session": "<string>",
            "event": "<string>"
          }
        ],
        "note": "<string>"
      }
    }
  ],
  "result_instructions": "<string>",
  "evaluation_material": {
    "task": "<string>",
    "rubric": "<string>"
  },
  "evaluations": [
    {
      "baseline_session": "<string>",
      "candidate_session": "<string>",
      "started_at": "<string>",
      "result": {
        "baseline": "satisfied",
        "candidate": "satisfied",
        "improved": true,
        "baseline_cost_tokens": 1,
        "candidate_cost_tokens": 1,
        "completed_at": "<string>"
      }
    }
  ],
  "application": {
    "agent_version": 1,
    "draft_revision": 1,
    "applied_at": "<string>"
  },
  "published_version": 1,
  "error": "input_session_unavailable",
  "usage": {
    "input_tokens": 1,
    "cached_input_tokens": 1,
    "cache_write_input_tokens": 1,
    "output_tokens": 1,
    "reasoning_output_tokens": 1,
    "total_tokens": 1
  },
  "created_at": "<string>",
  "updated_at": "<string>",
  "version": 1
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Get an instruction proposal

Read one InstructionProposal: the base draft revision and instructions its deltas address, the authored deltas with their event citations, the deterministically applied result text, evaluation material, every recorded holdout evaluation, and the first published version carrying its deltas.

Checkfu support posture: alpha; hosted. Required evidence journey: skill-delivery. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

GET

instruction-proposals

{id}

Get an instruction proposal

curl --request GET \
  --url https://api.checkfu.com/v1/instruction-proposals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/instruction-proposals/{id}"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/instruction-proposals/{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.checkfu.com/v1/instruction-proposals/{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>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/instruction-proposals/{id}"

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.checkfu.com/v1/instruction-proposals/{id}")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/instruction-proposals/{id}")

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

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

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

{
  "id": "<string>",
  "status": "authoring",
  "agent": "<string>",
  "base_draft_revision": 1,
  "base_instructions": "<string>",
  "model_routing_profile_key": "<string>",
  "judge_model_routing_profile_key": "<string>",
  "source_session_ids": [
    "<string>"
  ],
  "instructions": "<string>",
  "length_budget": 1,
  "deltas": [
    {
      "op": "add",
      "after": "<string>",
      "text": "<string>",
      "provenance": {
        "sources": [
          {
            "session": "<string>",
            "event": "<string>"
          }
        ],
        "note": "<string>"
      }
    }
  ],
  "result_instructions": "<string>",
  "evaluation_material": {
    "task": "<string>",
    "rubric": "<string>"
  },
  "evaluations": [
    {
      "baseline_session": "<string>",
      "candidate_session": "<string>",
      "started_at": "<string>",
      "result": {
        "baseline": "satisfied",
        "candidate": "satisfied",
        "improved": true,
        "baseline_cost_tokens": 1,
        "candidate_cost_tokens": 1,
        "completed_at": "<string>"
      }
    }
  ],
  "application": {
    "agent_version": 1,
    "draft_revision": 1,
    "applied_at": "<string>"
  },
  "published_version": 1,
  "error": "input_session_unavailable",
  "usage": {
    "input_tokens": 1,
    "cached_input_tokens": 1,
    "cache_write_input_tokens": 1,
    "output_tokens": 1,
    "reasoning_output_tokens": 1,
    "total_tokens": 1
  },
  "created_at": "<string>",
  "updated_at": "<string>",
  "version": 1
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-24

Path Parameters

string

required

Pattern: ^inp_[0-9a-f]{32}$

Response

distinct reflection and judge bindings, an error exactly on authoring failure, an artifact exactly past authoring, an application exactly on applied, a published version only after application, and evaluation states only with a recorded comparison

string

required

Pattern: ^inp_[0-9a-f]{32}$

status

enum<string>

required

Available options:

authoring,

drafted,

authoring_failed,

evaluating,

evaluated,

evaluation_failed,

applied,

discarded

agent

string

required

Pattern: ^agent_[0-9a-f]{32}$

base_draft_revision

integer

required

Required range: x > 0

base_instructions

string

required

model_routing_profile_key

string

required

Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$

judge_model_routing_profile_key

string

required

Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$

source_session_ids

string[]

required

Required array length: 1 - 8 elements

Pattern: ^sess_[0-9a-f]{32}$

instructions

string | null

required

Maximum string length: 4096

length_budget

integer

required

Required range: x > 0

deltas

object[] | null

required

Required array length: 1 - 8 elements

Option 1
Option 2
Option 3

Show child attributes

result_instructions

string | null

required

evaluation_material

object | null

required

Show child attributes

evaluations

object[]

required

Maximum array length: 4

Show child attributes

application

object | null

required

Show child attributes

published_version

integer | null

required

Required range: x > 0

error

enum<string> | null

required

Available options:

input_session_unavailable,

input_sessions_too_large,

authoring_failed,

internal

usage

object

required

Show child attributes

created_at

string

required

updated_at

string

required

version

integer

required

Required range: x > 0

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Get an instruction proposal

Authorizations

Headers

Path Parameters

Response