Look Up Capsule

GET

/vault/alpha/capsules/{id}

curl --request GET \
  --url https://example.com/vault/alpha/capsules/example

Reports whether a delivery is still collectable, and what it holds — never the payload itself.

This is deliberately NON-CONSUMING, and that is a requirement rather than a nicety: chat and mail clients fetch posted URLs unbidden to build a preview, so a check that consumed would destroy the payload before the recipient ever clicked.

Parameters

Path Parameters

id

required

string

The capsule’s identifier — the public half of the split token, and the only half a lookup needs.

Responses

200

OK

Media type application/json

What an anonymous recipient may learn about a capsule before collecting it.

A separate message rather than a redacted Capsule, because the difference is not redaction but entitlement: the recipient is a stranger holding a link, and the fields absent here are absent by decision. In particular it carries NO sender identity — that is the one field a recipient does not need in order to decide whether to collect, and the only one that names a person to whoever holds a guessed identifier.

object

id

The capsule’s identifier, echoed back.

stringOutput only

state

Whether the delivery is still collectable, and if not, how it ended.

string format: enum Output only

Allowed values: CAPSULE_STATE_UNSPECIFIED CAPSULE_STATE_ACTIVE CAPSULE_STATE_REDEEMED CAPSULE_STATE_EXPIRED CAPSULE_STATE_REVOKED

content_type

Optional IANA media type of the payload.

stringOutput only

payload_size_bytes

Size of the payload in bytes, so a recipient knows what they are about to collect before collecting it.

stringOutput only

expire_time

The deadline, so a recipient can tell how long they have.

string format: date-time Output only

Example

{
  "state": "CAPSULE_STATE_UNSPECIFIED"
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}