Activate Handoff generation at a Source boundary

POST
/v1/handoff/activate

Evaluate the standard Handoff Trigger and synchronously execute any emitted PrepareHandoff Action.

Authorization

BearerAuth
AuthorizationBearer <token>

Static bearer token used when local Server authentication is enabled.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/handoff/activate" \  -H "Content-Type: application/json" \  -d '{    "scope_id": "string",    "boundary_source": {      "name": "string",      "source_id": "string"    },    "objective": "string"  }'
{  "status": "generated",  "boundary_source": {    "name": "string",    "source_id": "string"  },  "previous_position": 0,  "current_position": 0,  "draft": {    "objective": "string",    "state": [      {        "text": "string",        "citations": [          {            "kind": "source",            "source_ref": {              "name": "string",              "source_id": "string"            }          }        ]      }    ],    "disposition": "continuable",    "next_action": {      "text": "string",      "citations": [        {          "kind": "source",          "source_ref": {            "name": "string",            "source_id": "string"          }        }      ]    },    "omissions": [      {        "text": "string",        "citation": {          "kind": "source",          "source_ref": {            "name": "string",            "source_id": "string"          }        }      }    ]  }}