Skip to main content
POST
Build Simulator

Authorizations

Authorization
string
header
required

Use a Continuous API key. Send it in the Authorization header as a Bearer token.

Body

multipart/form-data
request
object
required

Build options as JSON.

Example:
document
file[]

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.

spec
file

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

build
object | null
required

The build's latest progress report, or null before the first report. A terminal Simulator keeps its last report.

created_at
string<date-time>
required

Simulator creation time.

credential_ids
string[]
required

Workspace credentials the build was allowed to call real systems with. Empty when none.

error
object | null
required

Why the build failed or was canceled, or null.

id
string
required

Simulator ID.

Pattern: ^smr_[0-9A-HJKMNP-TV-Z]{26}$
instructions
string
required

The instructions the build followed, or empty when none were given.

mode
enum<string>
required

api for a Simulator of the vendor's API; web_app for one of its logged-in web app.

Available options:
api,
web_app
name
string
required

Simulator name. The ID is its identity, and names need not be unique.

Maximum string length: 128
parent_id
string | null
required

Parent Simulator ID, or null.

Pattern: ^smr_[0-9A-HJKMNP-TV-Z]{26}$
publication
object | null
required

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.

research
object | null
required

The build's research stage, or null for a Simulator built before research ran on every build.

source
enum<string>
required

workspace for a Simulator your workspace built; catalog for a read-only Simulator that Continuous publishes.

Available options:
workspace,
catalog
spec_kind
enum<string> | null
required

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.

Available options:
openapi,
wsdl,
graphql,
recorded,
null
status
enum<string>
required

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.

Available options:
pending,
building,
ready,
failed,
canceled