Opens the offer context of one exact Delivery for its own recipient.

GET

/v1/m/sessions/deliveries/{id}/handoff

curl --request GET \
  --url https://example.com/v1/m/sessions/deliveries/example/handoff \
  --header 'Authorization: Bearer <token>'

• this engine

Opens the offer context of one exact Delivery for its own recipient.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

id

required

string

Path parameter id.

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Responses

200

Authorized handoff offer context of one exact Delivery

Media type application/json

object

carrier

required

object

channel_id

required

string format: uuid

delivery_id

required

string format: uuid

delivery_version

required

integer format: int64

message_id

required

string format: uuid

content

required

object

artifact_refs

Array<object>

<= 64 items

object

hash

string

kind

required

string

>= 1 characters

ref

required

string

>= 1 characters

branch

Optional. The git branch the handed-over work is on. A label the sender wrote; the receiver may open a session worktree from it.

string

>= 1 characters <= 512 characters

next_action

required

string

>= 1 characters

risk

string

sha

Optional. The full git commit id the handed-over work is at (40 or 64 lowercase hex digits). The receiver may open a session worktree at it.

string

/^([0-9a-f]{40}|[0-9a-f]{64})$/

summary

required

string

>= 1 characters

deadline_elapsed

required

Response window measured against database time. A row may still be persisted as offered after its deadline; this read never runs the reaper.

boolean

handoff

required

object

ack_deadline

required

string format: date-time

created_at

required

string format: date-time

etag

required

string

/^\"v[0-9]+\"$/

from

required

object

kind

required

string

Allowed values: user agent session

ref

required

string

>= 1 characters <= 1024 characters

id

required

string format: uuid

state

required

string

Allowed values: offered accepted rejected withdrawn expired

terminal_at

Any of:

string

string format: date-time

null

null

terminal_code

string

to

required

object

kind

required

string

Allowed values: user agent session

ref

required

string

>= 1 characters <= 1024 characters

version

required

integer format: int64

observed_at

required

string format: date-time

offer_context

required

string

Allowed values: current stale terminal

terminal_reason

Any of:

object

object

code

required

string

>= 1 characters

references

Array<object>

<= 64 items

object

hash

string

kind

required

string

>= 1 characters

ref

required

string

>= 1 characters

text

string

null

null

work_item

required

object

id

required

string format: uuid

presentation

required

string

Allowed values: handoff_context

Example

{
  "handoff": {
    "from": {
      "kind": "user"
    },
    "state": "offered",
    "to": {
      "kind": "user"
    }
  },
  "offer_context": "current",
  "work_item": {
    "presentation": "handoff_context"
  }
}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}

503

Current authority, custody or store evidence is unavailable; or, with code commit_outcome_unknown, the write was issued and its outcome was never learned, so it may be durable and must not be retried automatically

Media type application/json

object

Example ^generated

{}