Skip to content
KataraKatara documentation

Read an immutable uncalibrated certificate

GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/evaluation-calibration-certificates/{id}
curl --request GET \
  --url https://api.katara.com/katara/v1/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/environments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/evaluation-calibration-certificates/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie katara_session=<katara_session>

Requires a current human session and current authority in the exact environment. API keys, services and workloads are refused. Unknown mutation outcomes must be recovered with the same immutable body and idempotency key. Reports remain uncalibrated and do not authorize promotion.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
environment_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000

Header Parameters

Section titled “Header Parameters”
X-Katara-Account-ID
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/

Optional mounted-account binding for cookie reads. A supplied different account returns account_changed.

Responses

Section titled “Responses”

200

Section titled “200”

Read an immutable uncalibrated certificate.

Media typeapplication/json
object
certificate
required
object
id
required
string
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
campaign_id
required
string
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
campaign_digest
required
string
/^sha256:[a-f0-9]{64}$/
labels
required
Array<object>
0 <= 3000 items
object
id
required
string
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
integrity
required
string
/^sha256:[a-f0-9]{64}$/
report
required
object
metric_version
required
Allowed value: katara.calibration.wilson-bonferroni.v1
policy_digest
required
string
/^sha256:[a-f0-9]{64}$/
confidence_ppm
required
integer
>= 1 <= 999999
comparisons
required
integer
>= 6 <= 192
cases
required
integer
>= 1 <= 1000
state
required
Allowed values: insufficient_evidence criteria_failed criteria_met
calibration_status
required
Allowed value: uncalibrated
criteria
required
Array<object>
>= 1 items <= 32 items
object
criterion_id
required
string
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
counts
required
object
cases
required
integer
<= 1000
missing_human
required
integer
<= 1000
unresolved_human
required
integer
<= 1000
human_abstentions
required
integer
<= 1000
judge_abstentions
required
integer
<= 1000
missing_judge
required
integer
<= 1000
human_pairs
required
integer
<= 1000
human_agreements
required
integer
<= 1000
human_pass
required
integer
<= 1000
human_fail
required
integer
<= 1000
true_positive
required
integer
<= 1000
true_negative
required
integer
<= 1000
false_positive
required
integer
<= 1000
false_negative
required
integer
<= 1000
human_agreement
required
Any of:
object
numerator
required
integer
<= 1000
denominator
required
integer
>= 1 <= 1000
lower_ppm
required
integer
<= 1000000
upper_ppm
required
integer
<= 1000000
label_coverage
required
Any of:
object
numerator
required
integer
<= 1000
denominator
required
integer
>= 1 <= 1000
lower_ppm
required
integer
<= 1000000
upper_ppm
required
integer
<= 1000000
judge_coverage
required
Any of:
object
numerator
required
integer
<= 1000
denominator
required
integer
>= 1 <= 1000
lower_ppm
required
integer
<= 1000000
upper_ppm
required
integer
<= 1000000
agreement
required
Any of:
object
numerator
required
integer
<= 1000
denominator
required
integer
>= 1 <= 1000
lower_ppm
required
integer
<= 1000000
upper_ppm
required
integer
<= 1000000
false_positive_rate
required
Any of:
object
numerator
required
integer
<= 1000
denominator
required
integer
>= 1 <= 1000
lower_ppm
required
integer
<= 1000000
upper_ppm
required
integer
<= 1000000
false_negative_rate
required
Any of:
object
numerator
required
integer
<= 1000
denominator
required
integer
>= 1 <= 1000
lower_ppm
required
integer
<= 1000000
upper_ppm
required
integer
<= 1000000
state
required
Allowed values: insufficient_evidence criteria_failed criteria_met
reasons
required
Array
<= 15 items unique items
Allowed values: minimum_cases minimum_human_pass minimum_human_fail human_agreement_undefined label_coverage_undefined judge_coverage_undefined agreement_undefined false_positive_undefined false_negative_undefined human_agreement_below_bound label_coverage_below_bound judge_coverage_below_bound agreement_below_bound false_positive_above_bound false_negative_above_bound
created_by
required
string
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
created_at
required
string format: date-time
integrity
required
string
/^sha256:[a-f0-9]{64}$/
Example
{
  "certificate": {
    "report": {
      "metric_version": "katara.calibration.wilson-bonferroni.v1",
      "state": "insufficient_evidence",
      "calibration_status": "uncalibrated",
      "criteria": [
        {
          "state": "insufficient_evidence",
          "reasons": [
            "minimum_cases"
          ]
        }
      ]
    }
  }
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store

409

Section titled “409”

Version, source authority or cookie account changed. Reinspect before a new intent. Preserve the original key to recover an uncertain committed operation.

default

Section titled “default”

Request rejected or unavailable.

Media typeapplication/json
object
error
required
object
message
required
string
>= 1 characters <= 500 characters
type
required
string
>= 1 characters <= 100 characters
code
required

Stable; branch on it. Any operation can answer invalid_request, with param naming the refused field when there is one; human_session_required, when an API key, service account or workload calls an operation only a signed-in person may perform; reauthentication_required, when a person’s sign-in is too old for the operation; permission_denied; route_not_found and method_not_allowed, when no operation matches the path or method; and feature_unavailable, when the operation’s service is not enabled on this deployment.

string
>= 1 characters <= 100 characters
param
required

The request field a refusal is about, such as the agent_id or run_id query parameter; null when the refusal is not about one field.

string | null
request_id
required
string
>= 1 characters <= 100 characters
upstream_status
required
integer | null
action
Allowed values: sign_in reauthenticate request_access review fund retry reconcile refresh support
operation_id
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
snapshot_ref
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
Example
{
  "error": {
    "action": "sign_in"
  }
}