Skip to content
deedglassdocs

Show the approval behind an emailed link

POST
/v1/approval-links/preview
curl --request POST \
  --url http://127.0.0.1:8080/v1/approval-links/preview \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

Public: the one-time token (from the link’s #t= fragment) in the body is the credential (S22). Previewing never consumes the link. Unknown, used, voided and expired tokens all answer the same 401 approval_link_invalid. Limited to 30 a minute per client and 10 per token.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
token
required

The 43-character token from the link’s fragment.

string
Examplegenerated
{
  "token": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The approval as the link’s person sees it.

Media typeapplication/json
object
object
string
Allowed values: approval_link_preview
approval

A person’s countersign on one action (S22). The agent view leaves out context, approvers and denied_by, and countersigned is a count.

object
object
required
string
Allowed values: approval
id
required
string
action
required
string
agent
required
object
id
string
name
string
tool
required
string
status
required
string
Allowed values: pending approved denied expired cancelled
rule_id
required
string | null
reason
required
string | null
required
required
integer
approvers
Array<string>
countersigned
required
One of:
integer
denied_by
object
id
string
name
string
decision_reason
required
string | null
summary
required
string
context

The context snapshot v1 the person countersigns (docs/APPROVALS.md).

object
context_digest
required
string | null
you
object
eligible
boolean
can_decide
boolean
why_not
string | null
created_at
required
string
expires_at
required
string
decided_at
required
string | null
deed
required
string | null
livemode
required
boolean
action_status

Decide answers only.

string
review_only
boolean
org_name
string
time_zone
string
agent_stopped
boolean
sql
string
console_url
string
expires_clock
string
decided_clock
string
countersign_clocks
Array<string>
Example
{
  "object": "approval_link_preview",
  "approval": {
    "object": "approval",
    "status": "pending",
    "countersigned": [
      {
        "via": "console"
      }
    ]
  }
}

Headers

Section titled “Headers”
Deedglass-Request-Id
string
/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

default

Section titled “default”

An error. Every error has this envelope; doc_url explains the code.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error policy_error rate_limit_error api_error
code
required
string
Allowed values: invalid_api_key api_key_revoked api_key_expired agent_suspended agent_stopped org_stopped insufficient_scope policy_denied approval_required approval_expired budget_exceeded intent_required intent_invalid intent_replay tool_unknown connector_unavailable upstream_error timeout rate_limited idempotency_conflict validation_failed not_found conflict internal_error authentication_required method_not_allowed request_too_large unsupported_media_type invalid_json api_version_invalid idempotency_key_invalid idempotency_key_in_use service_unavailable session_expired csrf_failed insufficient_role login_link_invalid login_code_invalid last_owner policy_unavailable policy_invalid credentials_missing destination_blocked vault_unavailable upstream_auth_failed upstream_not_found upstream_rate_limited response_too_large statement_refused row_limit_exceeded database_role_unsafe database_not_ready witness_not_configured approval_decided already_countersigned approver_not_eligible self_approval approval_needs_person context_changed approval_unsatisfiable approval_link_invalid approval_link_review_only approver_unmapped stripe_live_key_refused stripe_livemode_detected upstream_approval_pending schedule_needs_approval action_executing from_denied undo_unavailable undo_plan_stale already_undone undo_conflict replay_too_large replay_window_invalid suggestion_stale shadow_slot_taken suggestion_decided observe_not_enabled pro_required
message
required

One or more calm sentences with the next step.

string
param
required

The request field, query parameter or header the error is about.

string | null
request_id
required
string
/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/
doc_url
required
string format: uri
diagnostics

On policy_invalid only. Each problem with its line, code and hint.

Array<object>

One finding about a policy file, with its position and the next step. Codes are stable and listed in docs/POLICY_ERRORS.md. In the policy_invalid error envelope each diagnostic also carries object: policy_diagnostic. The full PolicyDiagnostic schema is in openapi.yaml.

object
action

One agent action. Its sections mirror the deed’s. status is the one field an agent needs; state is the exact lifecycle state (docs/GATE.md). The Gate’s own responses (POST /v1/actions and its result report) add execution.result and witness.reasons; lists leave both out. The full Action schema is in openapi.yaml.

object
checks

On undo_unavailable only. Every check of the undo, each with its fix. Additive (S23).

Array<object>

One of the twelve safety checks (S23 §3.3). Available means no check failed. The full UndoCheck schema is in openapi.yaml.

object
Example
{
  "error": {
    "type": "invalid_request_error",
    "code": "not_found",
    "message": "There's no endpoint at GET /v1/helth. Did you mean /v1/health?",
    "param": null,
    "request_id": "req_01j9zr3m5k8q2w7x4t6v0b1c9d",
    "doc_url": "https://docs.deedglass.com/errors/not_found"
  }
}

Headers

Section titled “Headers”
Deedglass-Request-Id
string
/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

Deedglass-Version
string

The API version this response follows.