Create measurements

POST

https://acme-api.invivo.benchling.com/api/public/v1/studies/:studyId/measurements

POST

/api/public/v1/studies/:studyId/measurements

curl -X POST https://acme-api.invivo.benchling.com/api/public/v1/studies/sdy_3vQ8kZpLmN2xRt7YwBcDfG/measurements \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "animal_id": "aml_7KpQ2mNvR4tXwZ9bYcDfGh",
    "measured_at": "2026-09-18",
    "calculations": [
      {
        "key": "weight",
        "variables": [
          {
            "key": "weight",
            "value": "25.3"
          }
        ]
      }
    ]
  }
]'

{
  "data": [
    {
      "id": "mst_6pR3kWqMvN9xTz5YbCdFgL",
      "measured_at": "2026-09-18",
      "calculations": [
        {
          "id": "vbl_4qQ6mKpNvR2zTw9YbCdFgX",
          "key": "weight",
          "name": "Weight",
          "unit": "g",
          "excluded": true,
          "value": "55",
          "formula": "weight",
          "variables": [
            {
              "id": "vbl_4qQ6mKpNvR2zTw9YbCdFgX",
              "key": "weight",
              "value": "55",
              "unit": "g"
            }
          ]
        }
      ],
      "study": {
        "id": "sdy_3vQ8kZpLmN2xRt7YwBcDfG",
        "project_id": "pjt_9kLmNpQrStUvWxYzAbCdEf",
        "name": "string",
        "code": "string",
        "study_code_id": "sdc_7hJ4nQrXsT9wYzAbCdEfGh",
        "type": "internal",
        "status": "in_progress",
        "description": "string",
        "timezone": "America/Los_Angeles",
        "metadata": {
          "cohort_size": 24,
          "species": "Mus musculus"
        },
        "author": {
          "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
          "name": "string",
          "email": "string",
          "timezone": "string"
        },
        "owner": {
          "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
          "name": "string",
          "email": "string",
          "timezone": "string"
        },
        "started_on": "2026-09-18",
        "tracking_day_base": 1,
        "completed_at": "2026-09-18T14:03:22.123456Z",
        "canceled_at": "2026-09-18T14:03:22.123456Z",
        "created_at": "2026-09-18T14:03:22.123456Z",
        "updated_at": "2026-09-18T14:03:22.123456Z"
      },
      "animal": {
        "id": "aml_7KpQ2mNvR4tXwZ9bYcDfGh",
        "name": "string",
        "number": 1,
        "catalog": "string",
        "species": "Mus musculus",
        "strain": "string",
        "sex": "m",
        "dob": "2026-09-18",
        "donor": "string",
        "ear": "string",
        "tag": "string",
        "tail": "string",
        "cage_id": "cge_5mR8kWpQnL3xTv7YzBcDfH",
        "study_id": "sdy_3vQ8kZpLmN2xRt7YwBcDfG",
        "study_group_id": "grp_9nT4kZpMvR2xQw8YbCdFgJ",
        "tracking_date": "2026-09-18",
        "disease_induction_date": "2026-09-18",
        "disease_survivor": true,
        "terminated_at": "2026-09-18",
        "terminated_by": {
          "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
          "name": "string",
          "email": "string",
          "timezone": "string"
        },
        "terminated_reason": {
          "glossary_id": "gly_5xQ4mKpNvR9zTw3YbCdFgV",
          "title": "string",
          "comment": "string"
        },
        "metadata": {
          "cohort_size": 24,
          "species": "Mus musculus"
        },
        "created_at": "2026-09-18T14:03:22.123456Z",
        "updated_at": "2026-09-18T14:03:22.123456Z"
      },
      "user": {
        "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
        "name": "string",
        "email": "string",
        "timezone": "America/Los_Angeles",
        "status": "active",
        "metadata": {
          "cohort_size": 24,
          "species": "Mus musculus"
        },
        "created_at": "2026-09-18T14:03:22.123456Z",
        "updated_at": "2026-09-18T14:03:22.123456Z"
      },
      "created_at": "2026-09-18T14:03:22.123456Z",
      "updated_at": "2026-09-18T14:03:22.123456Z"
    }
  ]
}

Records measurements for between 1 and 100 animal and day combinations on the study, computing each calculation from the variables supplied. The request is validated as a whole; if any item is invalid, none are created. A study that is not on your team is reported as a validation error rather than as forbidden.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

studyIdstringRequiredformat: "^sdy_[a-zA-Z0-9]{10,22}$"

The unique identifier of the study.

Request

The measurements to record.

animal_idstringRequiredformat: "^aml_[a-zA-Z0-9]{10,22}$"

The animal measured. Must be on the study.

measured_atdateRequired

The day the measurements were taken.

calculationslist of objectsRequired

The calculations to record, each listed at most once. At least one variable must be supplied across them.

Response headers

X-RateLimit-LimitintegerOptional

The number of requests permitted in the current rate limit window.

X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional

The number of seconds until the current rate limit window resets.

Response

The created measurements.

datalist of objects

The measurements.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error