Skip to main content
DELETE
/
v0
/
user
/
ipa
/
{ipa_id}
Cancel Ipa
curl --request DELETE \
  --url https://api.sumvin.com/v0/user/ipa/{ipa_id} \
  --header 'x-sumvin-pat: <api-key>'
{
  "_links": {},
  "intent": {
    "id": "<string>",
    "created_at": 123,
    "raw_intent": "<string>",
    "specification": "<string>",
    "constraints": {
      "max_price": 123,
      "max_total": 123,
      "currency": "<string>",
      "deadline": 123,
      "preferred_sellers": [
        "<string>"
      ],
      "excluded_sellers": [
        "<string>"
      ],
      "extra": {}
    },
    "preflight_workflow_id": "<string>",
    "conditions": [
      {
        "target_price": "<string>",
        "type": "price_target",
        "currency": "USD"
      }
    ],
    "monitor_until": 123,
    "clarification_questions": [
      "<string>"
    ],
    "failure_reason": "<string>",
    "pint_uris": [
      "<string>"
    ],
    "updated_at": 123,
    "completed_at": 123,
    "originating_agent_task": {
      "id": "<string>",
      "status": "<string>",
      "trigger_type": "<string>",
      "created_at": 123,
      "workflow_run_id": "<string>",
      "task": "<string>",
      "title": "<string>",
      "started_at": 123,
      "completed_at": 123
    },
    "executing_agent_task": {
      "id": "<string>",
      "status": "<string>",
      "trigger_type": "<string>",
      "created_at": 123,
      "workflow_run_id": "<string>",
      "task": "<string>",
      "title": "<string>",
      "started_at": 123,
      "completed_at": 123
    },
    "candidates": [
      {
        "id": "<string>",
        "offer_id": "<string>",
        "status": "<string>",
        "created_at": 123,
        "rank": 123,
        "score": 123,
        "rejection_reason": "<string>"
      }
    ],
    "manifests": [
      {
        "id": "<string>",
        "status": "<string>",
        "items": [
          {
            "offer_id": "<string>",
            "quantity": 123,
            "unit_price_amount": "<string>",
            "unit_price_asset": "<string>"
          }
        ],
        "created_at": 123,
        "total_amount": "<string>",
        "total_asset": "<string>",
        "approved_at": 123,
        "purchased_at": 123
      }
    ],
    "events": [
      {
        "id": "<string>",
        "created_at": 123,
        "payload": "<string>"
      }
    ]
  }
}

Authorizations

x-sumvin-pat
string
header
required

Personal access token issued to the Sumvin CLI. Send it in the x-sumvin-pat header to authenticate as the owning user.

Headers

x-juno-orgid
string | null

Tenant org ID for multi-tenant auth

x-sumvin-token
string | null
x-sumvin-pat
string | null
x-juno-jwt
string | null
X-Timestamp-Format
string

Controls how timestamp fields are serialized in JSON response bodies.

Default (header omitted or any other value): epoch milliseconds as integers. iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.

Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".

Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.

Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.

Example:

"iso8601"

Path Parameters

ipa_id
string
required

Response

IPA cancelled

HAL-style hypermedia links for navigation and available actions.

intent
IPAData · object
required