Skip to content
deedglassdocs

Seal a file you hold

POST
/v1/deeds/files
curl --request POST \
  --url http://127.0.0.1:8080/v1/deeds/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Deedglass-Version: 2026-10-01' \
  --data '{ "sha256": "example", "bytes": 1, "media_type": "application/pdf", "label": "example" }'

What deedglass deeds seal-file calls (S38): seals the admin deed file.sealed from a file’s sha256, size, media type and label. The file itself never reaches the server; the CLI hashes it locally. The deed carries the label as admin.reason and data_digest over these four fields, so deedglass verify <deed.json> --file <path> checks the file against the deed offline. It seals the file’s hash, size, type and label. It says nothing about whether the file’s contents are right. An admin+ Console session or an org admin key; agent keys get 403 insufficient_scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Deedglass-Version
string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/

The API version (YYYY-MM-DD). Leave it out to use your org’s pinned version (public routes use the latest). An unknown version is 400 api_version_invalid.

Deedglass-CSRF
string

Needed when the request uses a Console session (it changes state); without it the answer is 403 csrf_failed. Not sent with an API key.

Idempotency-Key
string
>= 1 characters <= 255 characters

1 to 255 printable ASCII characters. A retry with the same key and body returns the stored response with Deedglass-Idempotent-Replayed: true for 24 hours.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
sha256
required
string
/^sha256:[0-9a-f]{64}$/
bytes
required
integer
<= 9007199254740991
media_type
required
string
Allowed values: application/pdf text/markdown application/json text/plain text/html
label
required

No line breaks or control characters.

string
>= 1 characters <= 120 characters

Responses

Section titled “Responses”

201

Section titled “201”

The sealed file and its deed.

Media typeapplication/json
object
object
required
string
Allowed value: sealed_file
sha256
required
string
/^sha256:[0-9a-f]{64}$/
bytes
required
integer
media_type
required
string
label
required
string
deed
required

A sealed deed (docs/DEED_SPEC.md). The stored and exported form is the RFC 8785 canonical JSON of this object. seal is Ed25519 over the bytes “deedglass/deed/v1\n” + body_hash.

object
object
required
string
Allowed value: deed
id
required

Equal to body.deed_id (not signed; verifiers check it).

string
/^deed_[0-7][0-9a-hjkmnp-tv-z]{25}$/
body
required

Deed v1. Every key is always present; which sections are null depends on kind (docs/DEED_SPEC.md §5). Digests only, never payloads. The full DeedBody schema is in openapi.yaml.

object
body_hash
required

“sha256:” + lowercase hex of SHA-256.

string
/^sha256:[0-9a-f]{64}$/
seal
required
string
/^ed25519:[A-Za-z0-9_-]{86}$/
seal_key_id
required
string
/^sk_[0-7][0-9a-hjkmnp-tv-z]{25}$/
Example
{
  "object": "sealed_file",
  "deed": {
    "object": "deed"
  }
}

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.