Experiments

Creates an Experiment resource with a provided name

Changed on Sep 30, 2026

post/api/v1/experiments/

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/usnistgov/apis/dioptra-rest-api/docs/api/v1/experiments/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

X-Fieldsstring mask

An optional fields mask

Request body

groupinteger required

ID of the Group that will own the Experiment resource.

namestring required

Name of the Experiment resource.

descriptionstring

Description of the Experiment resource.

entrypointsinteger[]

A list of Entrypoint IDs.

Response

Success

idinteger

ID for the Experiment resource.

snapshotinteger

ID for the underlying Experiment snapshot.

createdOnstring date-time

Timestamp when the Experiment resource was created.

snapshotCreatedOnstring date-time

Timestamp when the Experiment resource snapshot was created.

lastModifiedOnstring date-time

Timestamp when the Experiment resource was last modified.

latestSnapshotboolean

Whether or not the Experiment resource is the latest version.

hasDraftboolean

Whether a draft exists for the Experiment resource.

deletedboolean

Whether the Experiment resource has been deleted.