Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
frequency
number

Source frequency (f)

Required range: x >= 0
waveSpeed
number

Speed of sound (v)

Required range: x >= 0
speedUnit
enum<string>

Speed unit

Available options:
m/s,
km/h,
mph,
kn
sourceSpeed
number

Source speed (vₛ)

Required range: x >= 0
sourceDirection
enum<string>

Source moving

Available options:
toward,
away
observerSpeed
number

Observer speed (vₒ)

Required range: x >= 0
observerDirection
enum<string>

Observer moving

Available options:
toward,
away

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.