Build Simulator
Starts an asynchronous Simulator build and returns the Simulator with status pending. Builds start in queue order when workspace capacity is available. Send multipart/form-data with a JSON part named request. To build from a document, add a file part named spec with the OpenAPI, WSDL or GraphQL document. For an incremental build, omit spec and set parent_id and instructions. Add file parts named document to give the builder and reviewer vendor documentation.
Authorizations
Use a Continuous API key. Send it in the Authorization header as a Bearer token.
Body
Build options as JSON.
Vendor documentation the builder and reviewer read before they start, as repeated file parts: UTF-8 text (.md, .txt, .html, .json, .yaml, .xml, .csv) or PDF (.pdf). The documents share the request body limit with the spec. An incremental build inherits its parent's documents and index; a document sent with the same name replaces the parent's. A document named INDEX.md indexes the others and skips research; the build fails if it names a document the build does not have, leaves a document unnamed, or leaves out a selected operation; an incremental build's documents include the inherited ones.
OpenAPI, WSDL or GraphQL document, UTF-8 encoded, at most 64 MiB. Required unless the request is an incremental build (parent_id and instructions, no spec).
Response
Accepted
The build's latest progress report, or null before the first report. A terminal Simulator keeps its last report.
Simulator creation time.
Workspace credentials the build was allowed to call real systems with. Empty when none.
Why the build failed or was canceled, or null.
Simulator ID.
^smr_[0-9A-HJKMNP-TV-Z]{26}$The instructions the build followed, or empty when none were given.
api for a Simulator of the vendor's API; web_app for one of its logged-in web app.
api, web_app Simulator name. The ID is its identity, and names need not be unique.
128Parent Simulator ID, or null.
^smr_[0-9A-HJKMNP-TV-Z]{26}$The latest attempt to publish the Simulator's image into the workspace's default customer runtime environment, or null when the workspace has none, no attempt is recorded, or the response does not report it. Get and list report it.
The build's research stage, or null for a Simulator built before research ran on every build.
workspace for a Simulator your workspace built; catalog for a read-only Simulator that Continuous publishes.
workspace, catalog The specification the Simulator was built from, or null until a build has read it. recorded is a Web App Simulator's: the calls its discovery journeys captured.
openapi, wsdl, graphql, recorded, null pending while waiting for capacity; building while the build runs; ready when Simulations, Worlds, and incremental builds can use it; failed when the build failed; canceled when a cancel request took effect.
pending, building, ready, failed, canceled