SettleOn.Get early access

FOR DEVELOPERS / DESIGN REFERENCE

Build form actions
into your agent.

A guide to the proposed session lifecycle, field results, and MCP tools. Use it to plan an integration and tell us what your workflow needs.

Pre-release design reference

These examples reflect the current product design. The API and MCP server are not publicly available. Routes and schemas may change; no credentials or working endpoint are provided here.

01 / HTTP API

A session is
your unit of work.

Open the form, inspect its state, apply values, and close when finished. An authorized submission is a separate action.

01Open a sessionPOST
/v1/sessions

Start at a form URL with fill-only permission. The proposed response identifies the session and the forms it found.

{
  "url": "https://example.org/apply",
  "leave": "fill"
}
02Inspect the fieldsGET
/v1/sessions/{session}/fields

Read field identifiers, labels, types, current values, and constraints before building the fill request.

// Use the field identifiers returned by the session.
// Read choices when a field requires a selection.
03Fill and inspectPOST
/v1/sessions/{session}/fill

Supply values by field ID or unambiguous name. Inspect the answer for every field, rather than treating a request response as proof that all fields succeeded.

{
  "values": [
    {"field": {"name": "Country"}, "value": "Canada"}
  ],
  "on_miss": "continue"
}
04Close the sessionDELETE
/v1/sessions/{session}

Finish the interaction and release the session. Inspect the session record when you need the operation history.

// Close when the workflow is finished.
// The session record describes what was requested
// and what was returned.

02 / FIELD RESULTS

Handle outcomes,
not just status codes.

confirmed

The requested value was read back from the form. Continue according to your workflow.

not_confirmed

The value did not land as requested or the page rejected it. Inspect the observed value and reason.

cant_tell

The outcome could not be established. Gather more evidence or request a human review.

refused

The action was not attempted because it was not allowed or supported.

not_attempted

The operation did not reach this field, for example because an earlier step stopped the fill.

03 / MCP TOOLSET

Give your assistant
a focused set of tools.

Discover

open_formread_formlist_choices

Start a session and inspect the form before choosing an action.

Interact

fill_fieldspress_buttonlook_at_page

Apply values, act within session permissions, and inspect the resulting page.

Resolve & finish

ask_personread_receiptclose_form

Hand off a human step, inspect a submission receipt, or end the session.

04 / INTEGRATION NOTES

Make the boundaries
explicit in your code.

Keep one operation in flight per session.

The current design serializes work within a session. A concurrent operation is refused as session_busy; the caller should respect the returned retry guidance.

Use returned field identifiers.

Prefer the field IDs supplied by discovery. A name matching more than one field is refused as ambiguous_field rather than guessed.

Read the page’s validation feedback.

Writing a value does not mean the destination accepted it. Check each field’s answer, observed value, and message before progressing.

Distinguish live filling from network isolation.

A live website may save values as they are typed. Fill-only permission prevents an explicit submission; it does not mean the destination has received no data.

YOUR NEXT STEP

Have a workflow in mind?

Share the forms and integration requirements you want to build around.

Request early access ↗