API Reference Checks

Create Check

POSThttps://api-v2.crosscheck.cloud/api/v1/checks

Create a check record in the active workspace. Owners, admins and members can create checks. Upload and finalize capture media separately after creating the record.

The request editor covers the primary fields. The API also accepts deviceInfo and recordingMeta objects, tagIds and initial comments arrays, and bug-report fields such as severity, feature, preCondition, idealBehavior and stepsToReproduce.

Authentication

Send a valid Crosscheck session JWT in the Authorization: Bearer YOUR_SESSION_TOKEN header. Workspace endpoints use the active workspace in your session. MCP OAuth tokens are not accepted here.

Body Parameters

application/json

typestringrequired

The capture type.

namestring

Optional title for the check.

projectIdstring

Optional project UUID.

pageUrlstring

URL where the check was captured.

Headers

Accept

JSON request and response format.

application/json

Authorization

A valid session JWT from Crosscheck authentication.

Bearer YOUR_SESSION_TOKEN

Content-Type

JSON request and response format.

application/json

Responses

201 Created

`id`string · uuid	Unique check identifier.
`name`string \| null	Check title.
`type`string	Screenshot, recording or replay capture type.
`projectId`string \| null	Project containing this check.
`pageUrl`string \| null	URL where the check was captured.

400 Invalid request

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

401 Authentication required

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

403 Insufficient permissions

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

404 Resource not found

The API returns success, error, code and statusCode. Validation errors also include details. Select this status in the example panel to inspect the shape.

Selected fields and abbreviated examples are shown. Additional fields and error codes depend on the resource, permissions, plan and retention state.