Scale Intelligence■ Docs
Docs / Reference / The API and the MCP server

The API and the MCP server.

Every route and every tool of the platform at contract 0476e35e6e275db5. Every route takes a POST with a typed body and four headers, and returns one card shape or one error shape.

Figure 1Route familiesspecified
SESSION6 routes6 toolsASK15 routes15 toolsREAD70 routes70 toolsVIEW7 routes7 toolsACT72 routes72 toolsWORK14 routes14 toolsHARNESS1 routes1 toolsFILES4 routes4 toolsECONOMICS6 routes6 tools
Every route and every tool belongs to one family.

Generated from the tool register and the type register; never edited by hand. Every operation is POST with a typed body, four envelope headers, one answer shape and one error shape. Register hash 0476e35e6e275db5.

Routes#

route purpose tool long step
/v1/session/my_grants the caller, and a place to its permissions there, after all three narrowings si.session.my_grants
/v1/session/my_scopes the caller to the scopes it reads, set on the database transaction before any query runs si.session.my_scopes
/v1/session/sign_out the session or the user to nothing si.session.sign_out
/v1/session/whoami a token, a key, or a run’s identity to the caller, with its scopes and its access scopes si.session.whoami
/v1/session/sign_in nothing, or the tenant to sign in to to the way the browser was opened, then the caller as a view once the code came back; the refresh token goes to the keychain and never to the caller si.session.sign_in
/v1/session/cache nothing, or a call to forget to what the app holds from earlier answers, by call and date, and when each expires si.session.cache
/v1/ask/facts a unit or a population, the date it was true, and the date we knew it, as two parameters. Both default to now to the facts, and the tier that gave them si.ask.facts
/v1/ask/get_content a ContentRequest to a ContentResponse, the page in bronze si.ask.get_content task
/v1/ask/groups a scope, the two dates, and the resolution of the cut to the cluster response cards: each group with the share each layer of likeness contributed, its top communities, words and domains, its size and trend by month, and the proxies that placed its members si.ask.groups
/v1/ask/judge_fit Judges one entity against a buyer profile, and against a brand whose offerings’ fit is in question to The answer gives the fit with each criterion and its highlights, the temperature with its reason, and the verdict. It makes no lead si.ask.judge_fit
/v1/ask/keep_question the question and its scope to a saved question si.ask.keep_question
/v1/ask/neighbours an entity, one kind of connection, and the two dates to the members, one hop away, and whether the cap was reached si.ask.neighbours
/v1/ask/preview a predicate or its hash, the place, the window, the speeds wanted, and the caller with the surface it calls from to the typed answer of section 2.3, as it fills si.ask.preview task
/v1/ask/propose_template a ProposeTemplateInput to a draft template with fields and evidence spans for the person to confirm si.ask.propose_template task
/v1/ask/read_source the installed connector, the kind, a cursor to a page of source objects, the next cursor, the cells credited si.ask.read_source task
/v1/ask/saved_view the view. Or the view and a caller to the definition. Or its rows, with when they were built si.ask.saved_view
/v1/ask/scrape a ScrapeRequest to a ScrapeResult, the rows as source objects with their evidence spans si.ask.scrape task
/v1/ask/search a SearchRequest to SearchResult rows, streamed as engines answer, credited to cells si.ask.search task
/v1/ask/semantic_search a text or a subject’s vector, the model, a floor and a population to the units above the floor. With them: the model, the floor, the measured recall of quantized embeddings, and the tier si.ask.semantic_search
/v1/ask/sql a query, in a strategy to rows, with how many and whether a bound was reached si.ask.sql
/v1/ask/local a question in one of the ask tools’ owning types, over the files the app may read to the card, answered by the app’s own engine over its tenant’s files, with the same foot si.ask.local
/v1/read/attributes a population and, where wanted, a window to the attributes its units carry, each with its plain name, the units that carry it, the value type read and up to three examples, most carried first, with the units read and in, and the partial answer when the budget ran out si.read.attributes
/v1/read/audience_map a brand, two facets or a facet and a community, the window to the shared subjects, the share, the lift, the negative control that bounds it, and the size as bounds si.read.audience_map
/v1/read/basket the basket, and one subject, a set of subjects, a scope predicate or a cut into groups, with the window to the basket reading as a fact: memberships with their scale of association and likelihood for one subject; population readings and co-membership for a set; proxy against group with lift and control for groups si.read.basket
/v1/read/board the board and a period to the board with every tile’s numbers, each with its basis and its population si.read.board
/v1/read/brand_design_system the brand, and a version, else the newest to the design system as it stands, with every basis si.read.brand_design_system
/v1/read/brand_design_system_changes the brand and two versions, else the two newest to every value that differs, by path, with the basis on each side, and the counts si.read.brand_design_system_changes
/v1/read/browse_view a BrowseViewInput to one frame of the page as the person sees it, with its size and address, for a dashboard that shows the session live and forwards the person’s clicks and words as steps si.read.browse_view
/v1/read/candidates Reads the candidates of one brand, narrowed by a buyer profile or by a place to Each candidate arrives with the signals gathered about it, the rung it has reached, and what it still lacks to qualify si.read.candidates
/v1/read/capture_health a platform and a window, or nothing to captures by platform in the window against the window before, with a verdict si.read.capture_health
/v1/read/capture_rules a platform, or nothing to the rules with each platform’s readiness si.read.capture_rules
/v1/read/catalogue a tenant or a brand to every source and connector with its kinds of reading and action, its state, the identity it needs, its cost, its rights, its coverage and its health si.read.catalogue
/v1/read/chain a brand to its roles, its handovers and each handover’s count with its instrument si.read.chain
/v1/read/compare two brands, a question from the closed list of comparisons to two summaries over one structure, each with its coverage si.read.compare
/v1/read/connectors a tenant or a brand to every kind of reading and of action, by source, with its state, the identity it needs, its cost and its rights si.read.connectors
/v1/read/consent the person or tenant, and the use to a fact. Or yes or no, with the fact that decides si.read.consent
/v1/read/coverage a cell, or a scope of entities with a window to what has been read, when and how deep, in the three positions si.read.coverage
/v1/read/coverage_by_cell a source, or a scope with a window to measured, never measured with the reason, withheld si.read.coverage_by_cell
/v1/read/document the document, the version, the caller to the version, with when it was built and what it was built from si.read.document
/v1/read/document_changes two versions to every number that moved with its unit, every figure replaced si.read.document_changes
/v1/read/effect a move, the window to the effect with its interval, or withheld with what would settle it si.read.effect
/v1/read/entity an entity, and the two dates to every identifier it ever had, every account, everything it published, every thread, community and gathering, and every connection, across platforms and sources si.read.entity
/v1/read/estimate an estimator, the case to the estimate with its interval, its evidence and its familiarity, or withheld si.read.estimate
/v1/read/explain_catch the match to the conditions that admitted it, the words each matched, the observation, and the source si.read.explain_catch
/v1/read/failed_calls a tenant to every signed call that did not land, with why, and a way to send it again si.read.failed_calls
/v1/read/fit_frame Reads the frame of one fit search to The answer gives the markets ranked, the offering sculpted for each buyer profile, the tactics proposed to test the fit, the verdict for each market, and the set of options that compares them si.read.fit_frame
/v1/read/fit_plays Reads the tactics that fit one phase of the search, for a vertical or a kind of offering to The answer gives the tactics in the order to run them si.read.fit_plays
/v1/read/forecasts a play or a tactic, across brands to every forecast with its effect, how well the band held, and the proper score by play, tactic, kind of buyer, framing, actor and content si.read.forecasts
/v1/read/grounding_priors a platform, or nothing (GroundingPriorsInput) to how often a person supported each kind of suggestion at each breadth, one row per kind, platform and breadth (GroundingPriors) si.read.grounding_priors
/v1/read/groundings one capture’s, one entity’s, or every grounding in a place to each grounding with its hypotheses si.read.groundings
/v1/read/instruction_set nothing to the set at its current version, assembled si.read.instruction_set
/v1/read/intelligence a subject and a kind of intelligence to the kind’s facts about the subject with their basis, their coverage and their date si.read.intelligence
/v1/read/invitations nothing to the invitations with their states si.read.invitations
/v1/read/invoices a period, or nothing to the invoices with their states si.read.invoices
/v1/read/leads Reads the leads of one brand, narrowed by a place, a condition or a user to The answer gives the leads, or the package that holds them si.read.leads
/v1/read/ledger a strategy, the window to every move, action, forecast, effect and impact in order, with the budget spent by kind si.read.ledger
/v1/read/lineage an artefact to its whole history and footprint, marking unavailable what a store cannot answer si.read.lineage
/v1/read/lookup a key: a namespace with a value, or a name with a place, and with a name a breadth. And the two dates to the entity, or the possible matches, or nothing; with a breadth, the record’s candidates by the one candidate search si.read.lookup
/v1/read/map a brand, and the two dates to the map si.read.map
/v1/read/market a brand, a segment, the window to the four stages, each with its count, value, basis and coverage, and the silent remainder si.read.market
/v1/read/market_twin Reads one market twin, and the date to read it as of to The answer gives the twin: the model family and template it was instanced from, the participants placed on the chain, the level of every stock as of the date, the simulations run on it in order, and the strategy whose armed plays are its interventions si.read.market_twin
/v1/read/methods a question, or nothing to the methods that answer it, or every method, each with its readiness si.read.methods
/v1/read/model_families Reads the model families that fit a vertical or a representation to Each family arrives with what it represents, the substrate it is written over, its solver and its check si.read.model_families
/v1/read/monitor_strength the monitor and a window to the four numbers, each with its population si.read.monitor_strength
/v1/read/page_changes a PageChangesInput to PageChange rows for the site or the watch in the window si.read.page_changes
/v1/read/parameter its name to its value, with its dimension and version si.read.parameter
/v1/read/plan_report a strategy and a window (PlanReportInput) to each play completed, partial or missing, and the items done off plan si.read.plan_report
/v1/read/policy_replay a policy row and its version, a strategy and a window (PolicyReplayInput) to what the policy would have chosen at every logged decision against what was chosen, and the effects that followed (PolicyReplay) si.read.policy_replay
/v1/read/posture a community, the window to open, conditional, closed or unknown, with the two removal rates and the archetype si.read.posture
/v1/read/predicate_language the register’s name to its rows with the hash si.read.predicate_language
/v1/read/propensity a lead, a move or a play, and which faces, actors or content or both (PropensityInput) to every eligible actor and every fitting content with the chance, its interval, its basis and the policy’s odds, and the one the policy would choose (PropensityAnswer) si.read.propensity
/v1/read/proxy the proxy and its version, the two dates, and a place to its members as a population, with the raw count, the estimate corrected by the recall and the undercount’s interval, its calibration by segment, its coverage by channel, and its co-membership with other proxies; for an aggregate-only proxy the counts alone and never a member si.read.proxy
/v1/read/receipts the kind, export or erasure to the receipts si.read.receipts
/v1/read/register its name, and a version or current to its rows, and the hash si.read.register
/v1/read/registered a register and a name to the row, or nothing si.read.registered
/v1/read/roles nothing, or one role to the register of roles: each role’s side, what it does, what it hands on, which connection holds it, and whether its holder can be a lead si.read.roles
/v1/read/scrape_runs a ScrapeRunsInput to ScrapeRun rows with pages, rows, bytes, cost and time si.read.scrape_runs
/v1/read/signals a monitor, a subject, a kind or a strategy, and a window to the facts, with the coverage and the count not evaluable for the same window si.read.signals
/v1/read/simulation_frame Reads the frame of one simulation to The answer gives the trajectory of every stock, the gain of every loop, the sensitivity to every intervention, and the set of options that compares strategies laid over the same template si.read.simulation_frame
/v1/read/source_procedure a source to its procedure at its version, the date of its last reading and whether it is stale si.read.source_procedure
/v1/read/speed_to_lead Reads the delay from delivery to the first touch for one brand, over a window to The answer gives the measure’s readings, with the population each was read over si.read.speed_to_lead
/v1/read/strategy a strategy, as of a date (StrategyReadInput) to the Strategy with its life, its game, its graph of plays with each play’s class and its reading, the experiments’ shares and the frame of its last simulation si.read.strategy
/v1/read/systems_models Reads the systems models that fit one vertical or one kind of offering to Each template arrives with its readiness and the defect it carries named si.read.systems_models
/v1/read/trajectory a strategy or one move, and a window (TrajectoryInput) to plan item to grounded move to outcome: each move with the items that carried it out, their readings and its effect si.read.trajectory
/v1/read/under_test a subject or a scope, and the two dates to every hypothesis about it with its standing, its evidence for and against, the tests run and the tests owed, and what would settle each si.read.under_test
/v1/read/unit the kind, the id, the caller to the unit si.read.unit
/v1/read/usage_statement a period to the tenant’s usage of the period by kind, priced, against the plan si.read.usage_statement
/v1/read/value_chain Reads the value chain of one vertical, with the brand whose participants are placed on it to The answer gives the chain’s stocks and handovers with their counts, the participants on each stock, and the loops the templates name over it si.read.value_chain
/v1/read/vertical the vertical, or a brand whose vertical is meant to its chain by side with every stock’s count and basis, its roles, its segments, its templates, its words and its rules si.read.vertical
/v1/read/why any unit to the chain of reasons, from this unit back to its first cause si.read.why
/v1/read/withheld Reads the withheld count for one brand or one tenant to The answer gives the count by buyer profile and temperature, with the period and the limit it was read against si.read.withheld
/v1/view/capabilities nothing to the page si.view.capabilities
/v1/view/journey a unit’s id to its hops, back and forward si.view.journey
/v1/view/oldest a kind, a place, and how many to those units, each with its reason and since when si.view.oldest
/v1/view/pairings a scope to each pairing, with the units that lack their pair si.view.pairings
/v1/view/stocks a part, a kind or a place, and a scope the caller holds to the six numbers for each si.view.stocks
/v1/view/usage a tenant, a kind, a provider, a window to quantity and cost by kind, by tenant, by provider and by period, with each provider’s reconciliation state si.view.usage
/v1/view/waiting the caller to notifications, oldest first. Or nothing si.view.waiting
/v1/act/act_through_connector the installed connector, the kind, the arguments with their sources to a move, proposed or running by the grant’s mode; then the source’s own id for what was done si.act.act_through_connector task
/v1/act/annotate an Annotation with the target an entity and the entity’s id, from the web shell, the desktop shell, the agent or the API; in the side panel the same type travels inside the page’s reading to the fact the person stated, a claim or a connection, by its id and kind (UnitRef) si.act.annotate
/v1/act/arm_monitor the monitor’s version, and for arming the preview it was judged by to the monitor’s new state si.act.arm_monitor
/v1/act/arm_play a strategy, the play and its version, the goal it serves, and the share it is armed on with its holdout (a share under one makes the play an experiment) to the armed play with its class proposed from the kind’s usual class and the rivals’ coverage, and the demand cells it raised si.act.arm_play
/v1/act/assign Assigns one lead to one user by hand, or hands it on to The answer gives the assignment, with the person who made it as its reason si.act.assign
/v1/act/beat what runs, and when to the beat si.act.beat
/v1/act/bind_buyer the kind, an offering or a segment, the weight, the mode to the binding, and the preview of the kind’s members si.act.bind_buyer
/v1/act/board the board with its tiles to the board, ready, or not ready with the tile that could not be drawn si.act.board
/v1/act/browse_step a BrowseStepInput to the step’s result: the accessibility tree, the text, the markdown, a screenshot’s hash, or a download set si.act.browse_step task
/v1/act/build_document the document, the two dates, which default to now to the build, then the version, or not ready with every number that is missing si.act.build_document task
/v1/act/capacity Sets how many new leads one user can take in a period to The answer gives the new capacity, with how many the user holds and when it refills si.act.capacity
/v1/act/capture the document, the network events, the address, the person’s identity to the capture with its source objects and the cells credited si.act.capture
/v1/act/capture_rule the rule to the rule, ready or not ready with the reason si.act.capture_rule
/v1/act/change_plan the plan kind to the change as a proposal, and the provider’s own page for payment si.act.change_plan
/v1/act/correct the id of the wrong event, and the right facts to a correcting event si.act.correct
/v1/act/crawl a ScrapeRequest whose scope names the site’s seeds, with sitemap-driven discovery on to the ScrapeRun, queued, or the run that already stands for the same template version and scope inside its freshness; every page lands as a capture through the one pipeline, and each page that could not be read is a gap with its reason si.act.crawl task
/v1/act/decide_ask the ask, by a user who may to the ask, approved or declined si.act.decide_ask
/v1/act/decide_brand_design the brand, the value’s path, the decision (accepted, declined, changed) and, when changed, the tenant’s own value, with the reason to the decision as a fact at brand scope: the brand’s memory, read by the merge, so a changed value stands as stated by the tenant until the site changes and a declined one is never proposed again si.act.decide_brand_design
/v1/act/decide_move the move, the caller to the move in its new place, with who moved it si.act.decide_move
/v1/act/deepen an observation, and the depth: fetched in full, or given meaning to a deepening si.act.deepen task
/v1/act/dry_run an action to what it would do, and what the inverse would be si.act.dry_run
/v1/act/erase_person the person to the erasure as work, then its receipt si.act.erase_person task
/v1/act/export_tenant nothing to the export as work, then its receipt si.act.export_tenant task
/v1/act/goal a strategy, a measure, a target, a window to the goal, naming the measure’s version si.act.goal
/v1/act/grant the grant, by a caller who may give it to the grant’s new version si.act.grant
/v1/act/ground exactly one of a capture, an entity, a text or an address, and a breadth (GroundInput) to the grounding with its hypotheses (GroundingAnswer), the channels that ran and the ones not ready with their reason si.act.ground
/v1/act/hold_identity the platform, the scopes the rows declare to a browser session for the person; then the credential with its vault entry si.act.hold_identity
/v1/act/install_connector the connector, the ways chosen, and the identity for each to an installed connector, ready or not ready with its reason si.act.install_connector
/v1/act/install_pack a brand, the pack and its version to the copies made, each naming its origin si.act.install_pack
/v1/act/invite an address and a role to the invitation, open, with its expiry si.act.invite
/v1/act/keep_basket its name, its scope and its proxies by version to the basket with its version, not ready while any proxy is si.act.keep_basket
/v1/act/keep_buyer the whole profile as it should stand next, with its predicate’s tree given in full, its bindings and its ladder to the profile as its next version, ready, or not ready with the compiler’s reason; the predicate kept by its hash si.act.keep_buyer
/v1/act/keep_ladder its ordered rungs, each a predicate over the population, and the rung that qualifies; the rungs’ predicates in full where they are not yet kept to the ladder with its version, not ready while a rung’s predicate is not kept or does not compile si.act.keep_ladder
/v1/act/keep_monitor its name, its predicate, the place it runs at, the kind of signal it makes, the strategy where one is chosen, and for a platform monitor the vertical to the monitor with its version, not armed; not ready while its predicate does not compile at its place, with the reasons from compile si.act.keep_monitor
/v1/act/keep_play a play for a brand, written once by the platform as an original or by the tenant: its goal, its condition as a predicate over its population, its class, its tactic, the move it proposes, its measure, its window, its forecast rule, its comparison, when it stops, and its graph of moves as edges (KeepPlayInput); the predicates given in full are kept by their hashes in the same call to the play as the next version of its name under the brand, ready, or not ready with the first reason: the condition does not compile, the graph has a cycle naming the edge, an edge cannot be evaluated naming the edge and the population, an edge is neither always nor guarded si.act.keep_play
/v1/act/keep_proxy a proxy: its name, the facet kind it stands for, its scope, its rule as a predicate, its strength, its named control, its failure mode, and whether it is aggregate-only to the proxy with its version by hash, not ready until its controls have run and its calibration is read si.act.keep_proxy
/v1/act/make_brand_design_system the brand, and the site when it is not the brand row’s own to the brand’s design system as the next version of its name: every colour, face, size, step, radius, shadow and the logo, each measured, inferred by a named rule or never measured, with the artefacts it was read from and the gaps; and the same values in the platform’s token shape si.act.make_brand_design_system
/v1/act/make_market_twin Makes one market twin from a vertical, a segment, a brand, a template and the way of going to market it serves to The answer gives the twin, ready or not ready with the stock the record cannot read named si.act.make_market_twin
/v1/act/map_brand a web address, and the brand scope to hold the map to the map as it stands, with every part measured or never measured, and the demand raised si.act.map_brand task
/v1/act/mark_lead Marks a condition on one lead, with a reason where the condition asks for one to The answer gives the lead’s new outcome si.act.mark_lead
/v1/act/mark_rival a brand, the rival’s entity, the evidence to the fact si.act.mark_rival
/v1/act/membership the person’s address, and the roles with where each is held to the membership si.act.membership
/v1/act/move_strategy a strategy, the place to move it to and the reason (StrategyMoveInput): drafted, simulated, rolled out in part, running, paused, ended to the Strategy in its new place, with who moved it si.act.move_strategy
/v1/act/notification_channel Writes one notification channel, which is where a notice goes to The channel is ready once its test notice is acknowledged. Until then it is not ready, with the reason si.act.notification_channel
/v1/act/notification_rule Writes one notification rule, which says who is told and never what happens to The answer gives the rule, with the next notice it will send si.act.notification_rule
/v1/act/parameter a parameter by its name, its value and its scope to the parameter as written, at its new version si.act.parameter
/v1/act/place_participant Places one party in one role on one stock of a vertical’s chain, with the evidence for it to The answer gives the participant, ready or not ready with the reason si.act.place_participant
/v1/act/probe_identity the identity to its readiness with the reason si.act.probe_identity
/v1/act/propose_move a match of a play to the move, proposed, with its forecast and its assignments as facts si.act.propose_move
/v1/act/publish the version, the address, the visibility to the publishing, proposed or published, and its receipt si.act.publish
/v1/act/raise_need a cell’s key, the reason and the value to the cell, wanted si.act.raise_need
/v1/act/record_fit_reading Records one result of a person’s own test: the tactic, the market, the measure, its value, the sample and where it came from to The answer gives the reading as a fact the record keeps si.act.record_fit_reading
/v1/act/remember a memory and its scope to the memory, or a later fact that ends it si.act.remember
/v1/act/routing Writes, previews or arms a routing rule from a predicate and the people or the team it attaches to A write or an arm gives the rule. A preview gives the leads it would have admitted and who would have had them, read over history si.act.routing
/v1/act/run_action an action prepared by a move to the action, allowed or not allowed with the reason, then running, then done or failed si.act.run_action task
/v1/act/scrape_template a TemplateInput to the template, ready or not ready with the reason; for a preview, the rows from its samples and a bounded live scope si.act.scrape_template
/v1/act/seed_tenant the manifest and the window to the seed as work, then its receipt with counts by kind and what is not ready si.act.seed_tenant task
/v1/act/set_aside_run a SetAsideRunInput: the run’s key and a person’s plain reason to the ScrapeRun, kept in the parked place with the reason, which the beat never takes up; each move is an event with the reason si.act.set_aside_run
/v1/act/settle a hypothesis, the standing, the caller to the hypothesis settled, with who settled it and on what si.act.settle
/v1/act/settle_match the possible match, and a user’s answer or a proof to confirmed, with the merge. Or rejected si.act.settle_match
/v1/act/sign_up the company’s name, and its domain where known, from a signed-in person who belongs to no tenant to the tenant, made on the trial plan with the person as its first member and owner, in one transaction with its events si.act.sign_up
/v1/act/strategy a brand or brands, a name, a window if any to the strategy, with the standing measures si.act.strategy
/v1/act/sync_rule the installed connector, the offer, the fields of section 2.8 to the rule; for a preview, what it would read and push si.act.sync_rule
/v1/act/undo a done action to the action, undone, and the inverse’s own action si.act.undo
/v1/act/undo_action the move to the inverse move si.act.undo_action
/v1/act/undo_merge the merge or the decision, and the reason to a parting. Or a later decision, with the facts written again si.act.undo_merge
/v1/act/watch a public entity to a watched identity, with its monitor armed si.act.watch
/v1/act/watch_site a WatchSiteInput to the watch, ready or not ready; for a preview, the pages it would read and the changes it would have raised over the window si.act.watch_site
/v1/act/webhook the address, what to be told about, and a secret to sign with to the row si.act.webhook
/v1/act/weigh a hypothesis, and a fact or a test’s reading to the hypothesis with the evidence attached and its standing recomputed against its bar si.act.weigh
/v1/act/withdraw a publishing to the publishing, withdrawn si.act.withdraw
/v1/act/workflow its steps and what starts it to the workflow, and for a preview what it would have done over history, acting on nothing si.act.workflow
/v1/work/backfill a source, an access method, a window, a plane to the job; then partitions carrying the window si.work.backfill task
/v1/work/browse_open a BrowseOpenInput to the session, opened, with its live view si.work.browse_open task
/v1/work/browse_take_over a BrowseTakeOverInput to the session, driven by the person or handed back si.work.browse_take_over
/v1/work/build_facet a facet kind, a seed (a predicate, a list of communities, or a place from the gazetteer), the scope, and the positive and negative controls to the facet’s register with every candidate kept or dropped and its reason in words, its people, its pairs and its trend, and the facet not ready until its calibration is read si.work.build_facet task
/v1/work/cancel the preview to nothing si.work.cancel
/v1/work/download_set a DownloadInput to DownloadJob rows, one per file si.work.download_set task
/v1/work/download_set_control a DownloadControlInput to the jobs in their new place si.work.download_set_control
/v1/work/lay_strategy Lays one strategy on one twin, with the bounds of the run to The call returns the simulation whose interventions are the strategy’s armed plays, then the frame si.work.lay_strategy task
/v1/work/mine the caller to every run the caller started that is still running, each with what it has done, whether it may be stopped, and the tool that stops it si.work.mine
/v1/work/run_procedure the procedure and its inputs to a task si.work.run_procedure task
/v1/work/search_fit Searches for product-market fit from one end: an offering looking for its markets, or a concept looking for a market to The call returns the search as work, then the frame that holds what it settled si.work.search_fit task
/v1/work/simulate_market Runs one systems model template over a market, with the interventions to try and the bounds of the run to The call returns the simulation as work, then the frame that holds what it reached si.work.simulate_market task
/v1/work/status the task to its progress. Or nothing si.work.status
/v1/work/local_procedure a named procedure whose inputs are files in the workspace to a task run by the app with its steps in the app’s own journal, resumable si.work.local_procedure task
/v1/harness/delegate words, in a strategy to response cards, as they come, and a task where the work goes on si.harness.delegate task
/v1/files/download a file’s pointer from a task or a document, and where in the workspace to put it to progress by bytes moved of bytes in all, then the path inside the workspace si.files.download task
/v1/files/upload a path inside the workspace, and what the file is for to progress, then the pointer the platform kept si.files.upload task
/v1/files/list a path inside the workspace, or nothing to the files with their sizes, kinds and when they were written si.files.list
/v1/files/workspace nothing, or a folder to make the workspace to the workspace folder, and every act the app made in it on the ledger si.files.workspace
/v1/economics/benchmarks a driver, and a population or a buyer profile to the benchmarks that apply, each with its interval, population, period, source and what its rights allow si.economics.benchmarks
/v1/economics/estimate EstimateReturnInput: the buyer (an entity, a lead, a buyer profile or a session), the offering or tier, the stated numbers, and whether to simulate to a Card whose body is a FrameOfASale si.economics.estimate
/v1/economics/ladder nothing, or a version to the price ladder in force with its study si.economics.ladder
/v1/economics/models a vertical, a segment or a buyer profile to the business models that apply, each with its readiness, its drivers and its outputs si.economics.models
/v1/economics/offer ReadingOfferedInput: the buyer profile, the model, the drivers to ask to the reading offered, ready or not ready with the reason, and its page’s address si.economics.offer
/v1/economics/study PricingStudyInput: the methods to run, the buyer profiles, the rivals’ window to the study as a fact and its candidate ladders as a set of options si.economics.study task

Envelope, errors and limits#

Every call is POST /v1/<family>/<verb>. Its JSON body is the serialisation of one owning type. Four headers go with every call. They carry the key, the scope, the date when the facts must have been true, and the date when the platform must have known them. Every response is a card with its foot. Every response also carries the contract’s hash in the Scale-Contract header, and the platform reports a mismatch to a client whose hash differs. A long step returns status 202 with a task. The envelope page describes each part.