202 Accepted with a preflight_workflow_id, polled it through the lifecycle, and approved it — landing the IPA in the approved state, ready for the perpetual search agent to begin executing.
The create call:
POST /v0/user/ipa— Create an IPA.
This quickstart uses the post-2026-04-13 IPA model —
preflight_workflow_id, originating_chat_id, originating_agent_task_id, and the originating_agent_task / executing_agent_task expansions. The older guides/ipa.mdx reference still describes the legacy workflow_id / workflow_status fields and is being rewritten — treat this quickstart as the source of truth for IPA shapes until that update lands.Prerequisites
- A Sumvin-verified user with a deployed Safe. If you don’t have one, run the stand up an account quickstart first.
- A that grants the scopes this IPA needs. See PINTs for the mint flow and scopes for the full catalog. This quickstart assumes
pint_uri = "sr:us:pint:def456"already exists. - A Platform API JWT. See authentication.
Mint a PINT for the IPA
Perpetual search IPAs need scopes like
sr:us:pint:perpetual:search plus any downstream action scopes (for example sr:us:pint:spend:execute if the IPA will authorise purchases).The PINT mint flow is covered in full at PINTs. For this quickstart, assume the PINT URI sr:us:pint:def456 is already signed and stored.Create the IPA
Post the user’s intent, autonomy preferences, and constraints. Include the
Idempotency-Key header so retries do not create duplicate IPAs.Inspect the 202 Accepted response
Response: The
202 Acceptedpreflight_workflow_id points to the Upstash durable workflow run that validates the intent and checks the PINT scopes. The IPA status starts as qualifying while preflight runs.Poll the IPA status
Fetch the IPA until it transitions out of Response: The full set of IPA statuses:
qualifying. Use the originating_agent_task expansion to see the preflight agent task in the same response.200 OKqualifying— preflight is validating the intent and scopessearching— the agent is actively crawling for candidatesvalidating— candidates are being scored against constraintspending_clarification— the agent needs more information from the userpending_approval— approved candidate(s) awaiting user sign-offapproved— the user approved; the executing agent may proceedmonitoring— watching for trigger conditions (price, availability)executing— the purchase is being executedcompleted— the IPA fulfilled its intentfailed— terminal failureexpired— lifetime elapsed without fulfilmentcancelled— the user cancelled
Respond to clarifications (if needed)
If the agent lands in Response:
pending_clarification, answer the outstanding questions. The IPA returns to qualifying while the agent incorporates the answers.PUT /v0/user/ipa/{ipa_id}/answers — Submit clarification answers.200 OK with intent.status: "qualifying".Approve the IPA
This is the working artefact. Once the IPA is Response:
pending_approval, approve it — the executing agent can now begin searching under the terms you set.200 OKThe IPA is live. The executing agent has begun work under the scopes, constraints, and autonomy level you defined — and the user can revoke at any time.
Cancel at any time
Users can cancel an IPA at any non-terminal state. The executing agent halts and the IPA transitions to Response:
cancelled.DELETE /v0/user/ipa/{ipa_id} — Cancel an IPA.200 OK with intent.status: "cancelled".What’s next
| Next | Where | When |
|---|---|---|
| IPA reference | IPA guide | Full field-by-field reference for constraints and autonomy levels |
| State machine | IPA lifecycle | When debugging a stuck status or wiring approval UI |
| Scopes | Scopes | Picking which SRI capability strings the IPA carries |
| PINT mint | PINTs | Before the IPA — the primitive IPAs ride on |