Keep / Stop / Remind

POST

/v1/intel/trials/{id}/decision

const url = 'https://api.trustysweep.com/v1/intel/trials/example/decision';
const options = {
  method: 'POST',
  headers: {
    cookie: 'sweep_session=<sweep_session>',
    'Content-Type': 'application/json'
  },
  body: '{"decision":"keep","remind_at":"2026-04-15T12:00:00Z"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.trustysweep.com/v1/intel/trials/example/decision \
  --header 'Content-Type: application/json' \
  --cookie sweep_session=<sweep_session> \
  --data '{ "decision": "keep", "remind_at": "2026-04-15T12:00:00Z" }'

Authorizations

sessionCookie
sessionToken
apiKey
intel:read
oauth2
intel:read

Parameters

Path Parameters

required

string

/^trl_[0-9A-HJKMNP-TV-Z]{26}$/

Header Parameters

Idempotency-Key

string

<= 255 characters

Unique key per logical operation. Same key + same body within 24h replays the original response with Idempotent-Replayed: true; same key + different body → 409 idempotency_key_reused.

Request Body^required

application/json

object

decision

required

string

Allowed values: keep stop remind

remind_at

string format: date-time

Responses

200

application/json

object

trial

required

object

required

Prefixed ULID (trl_…)

string

/^trl_[0-9A-HJKMNP-TV-Z]{26}$/

vendor

required

string

vendorDomain

One of:

string
null

string

product

One of:

string
null

string

startedAt

One of:

string
null

string format: date-time

endsAt

One of:

string
null

string format: date-time

postTrialAmountCents

One of:

integer
null

integer

cadence

required

string

Allowed values: weekly monthly quarterly annual usage one_time unknown

annualizedCents

One of:

integer
null

integer

cancellationPath

One of:

string
null

string

decision

required

string

Allowed values: undecided keep stop remind

remindAt

One of:

string
null

string format: date-time

evidenceLevel

required

CONFIRMED = direct platform/API/settlement evidence; DETECTED = reliable statement/email/invoice evidence; ESTIMATED = calculation from observable rates or incomplete evidence. An estimate is never presented as confirmed.

string

Allowed values: CONFIRMED DETECTED ESTIMATED

confidence

required

number

evidence

required

Array<object>

object

kind

required

string

Allowed values: email statement api invoice contract receipt user derived

ref

required

string

sourceId

string

observedAt

required

string format: date-time

excerpt

string

<= 300 characters

worthIt

One of:

object
null

object

daysRemaining

One of:

number
null

number

activeDays

One of:

integer
null

integer

lastDetectedActivityAt

One of:

string
null

string format: date-time

estimatedCostPerActiveDayCents

One of:

integer
null

integer

verdict

required

string

Allowed values: likely_worth_it unclear likely_not_worth_it

rationale

required

Array<string>

updatedAt

required

string format: date-time

action

required

string

Allowed values: none plan_created path_provided

plan_id

One of:

string
null

Prefixed ULID (pln_…)

string

/^pln_[0-9A-HJKMNP-TV-Z]{26}$/

path

One of:

string
null

string format: uri

Example

{
  "trial": {
    "id": "trl_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
    "cadence": "weekly",
    "decision": "undecided",
    "evidenceLevel": "CONFIRMED",
    "evidence": [
      {
        "kind": "email"
      }
    ],
    "worthIt": {
      "verdict": "likely_worth_it"
    }
  },
  "action": "none",
  "plan_id": "pln_01J8Z3K9M2Q4R6S8T0V2W4X6Y8"
}

Headers

RateLimit-Limit

integer

Requests allowed in the current window.

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

400

Validation failed

application/problem+json

RFC 9457 problem details.

object

type

required

Https://developers.trustysweep.com/errors/

string format: uri

titlerequired

string

statusrequired

integer

detail

string

coderequired

Machine-readable error code from errors.json

string

request_idrequired

string

errors

Array<object>

object

pathrequired

string

messagerequired

string

`Example^generated`

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`401`

Section titled “401”

Unauthenticated

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`403`

Section titled “403”

Forbidden / action denied / step-up required

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`404`

Section titled “404”

Not found

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`409`

Section titled “409”

Conflict (state, stale plan, idempotency key reuse)

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`429`

Section titled “429”

Rate limited

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`Headers`

Section titled “Headers”

Retry-After

integer

Seconds to wait before retrying.

RateLimit-Limit

integer

Requests allowed in the current window.

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

`500`

Section titled “500”

Internal error

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

Keep / Stop / Remind

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

200

Example

Headers

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

Headers

500

Examplegenerated

Request Body^required

`Example^generated`

`401`

`Example^generated`

`403`

`Example^generated`

`404`

`Example^generated`

`409`

`Example^generated`

`429`

`Example^generated`

`Headers`

`500`

`Example^generated`