Skip to main content
POST
Error

Authorizations

​
Authorization
string
header
required

API Key (format: vsp_sk_...)

Body

application/json

Request for importing a single state vector

​
data
string
required

The raw state vector data in the specified format. For OPM: complete CCSDS OPM message. For SPACEX_OPM: SpaceX-specific format. Maximum size: 1MB.

Maximum string length: 1048576
​
format
enum<string>
required

Format of the state vector data

Available options:
OPM,
SPACEX_OPM
Pattern: ^(OPM|SPACEX_OPM)$
Example:

"OPM"

​
contentHash
string

Optional SHA-256 content hash from a prior /imports/inspect call. When present, the server re-computes the hash of the uploaded data and rejects with 409 on mismatch. When absent, the check is skipped entirely.

​
metadata
object

Optional metadata for state vector import

​
resolutionFingerprint
string

Optional resolution fingerprint from a prior /imports/inspect call. When present, the server re-computes the fingerprint of the resolved target and rejects with 409 on mismatch. When absent, the check is skipped entirely.

​
spacecraftId
string

ID of the spacecraft to associate with the imported state vector. Required for SPACEX_OPM format. For OPM format, if omitted, the spacecraft is auto-resolved from OBJECT_ID and OBJECT_NAME in the OPM metadata.

Example:

"spacecraft-abc-123"

Response

State vector imported successfully

State vector representation with position, velocity, and metadata

​
covariance
object | null

State covariance data including 6x6 matrix and standard deviations. Null if covariance is not available.

​
creationDate
string

Creation timestamp when this state vector was created/imported in ISO-8601 format

Example:

"2024-01-15T12:30:00Z"

​
epoch
string

Epoch timestamp of the state vector in ISO-8601 format

Example:

"2024-01-15T12:00:00Z"

​
hasCovariance
boolean

Whether covariance data is available for this state vector

Example:

true

​
id
string

Unique identifier for the state vector (format: SV-{sequence})

Example:

"SV-123"

​
keplerianElements
object | null

Mean Keplerian orbital elements derived via DSST averaging of the osculating state. Null when the DSST conversion fails (e.g., highly perturbed orbits).

​
mass
number<double>

Spacecraft mass in kilograms

Example:

1500

​
meanElementTheory
enum<string> | null

Theory used to produce meanElements. 'DSST' on success, null when meanElements is null.

Available options:
DSST
Example:

"DSST"

​
meanElements
object | null

Mean Keplerian orbital elements derived via DSST averaging of the osculating state. Null when the DSST conversion fails (e.g., highly perturbed orbits).

​
orbitSolutionId
string | null

ID of the associated OrbitSolution if this state vector was produced by orbit determination. Null for imported state vectors.

Example:

"GS002-559"

​
originator
string

Originator or source of this state vector data

Example:

"VALAR"

​
position
number<double>[]

Position vector [x, y, z] in kilometers

Position vector [x, y, z] in kilometers

Example:
​
referenceFrame
string

Reference frame of the state vector (e.g., EME2000, GCRF, TEME)

Example:

"EME2000"

​
sourceType
enum<string>

Source type indicating how this state vector was created. OPM_IMPORT for imported OPMs, ORBIT_DETERMINATION for OD results, MANUAL for manually entered.

Available options:
OPM_IMPORT,
ORBIT_DETERMINATION,
MANUAL
Example:

"OPM_IMPORT"

​
spacecraftId
string

ID of the spacecraft this state vector belongs to

Example:

"spacecraft-abc-123"

​
spacecraftName
string

Name of the spacecraft

Example:

"GS002"

​
velocity
number<double>[]

Velocity vector [vx, vy, vz] in km/s

Velocity vector [vx, vy, vz] in km/s

Example:
​
warnings
string[]

Non-fatal validation warnings raised while importing this state vector. Empty when the import raised none. A perigee altitude below OrbitGeometryValidator.PERIGEE_WARN_ALTITUDE_M (120 km) is reported here rather than rejected — the state vector is persisted, but its propagations may be truncated at the 100 km in-flight floor.

Non-fatal validation warnings raised while importing this state vector. Empty when the import raised none. A perigee altitude below OrbitGeometryValidator.PERIGEE_WARN_ALTITUDE_M (120 km) is reported here rather than rejected — the state vector is persisted, but its propagations may be truncated at the 100 km in-flight floor.

Example: