This API is designed for external users to submit new jobs to the Bitgenia platform, link external codes with Bitgenia codes, and track the status of previously submitted jobs.
The base URL is https://bitgeniatestadn.com
All requests done to this API must include an API key in the header. The API key is provided by Bitgenia and is unique to each user. The API key must be included in the header as follows: X-API-Key: <API_KEY>
Create a new kit
This operation creates a new kit and links it under the specified external_kit_id.
Authorizations:
Request Body schema: application/jsonrequired
New kit to be added to the database.
| external_kit_id | string non-empty Your own kit ID for this sample |
Responses
Request samples
- Payload
{- "external_kit_id": "MyLabSample-123"
}Response samples
- 201
- 400
- 403
- 500
{- "status": "SUBMITTED",
- "external_kit_id": "MyLabSample-123",
- "kit_id": "EXT2873696BT"
}Rename a kit
This operation renames the external_kit_id of the given kit_id.
Authorizations:
Request Body schema: application/jsonrequired
Kit to be renamed.
| kit_id | string non-empty The kit ID of the sample |
| external_kit_id | string non-empty Your own kit ID for this sample |
Responses
Request samples
- Payload
{- "kit_id": "EXT2873696BT",
- "external_kit_id": "RenamedSample-33"
}Response samples
- 202
- 400
- 403
- 500
{- "status": "SUBMITTED",
- "external_kit_id": "RenamedSample-33",
- "kit_id": "EXT2873696BT"
}Get details about a kit
This operation retrieves details and status of the specified external_kit_id.
Authorizations:
query Parameters
| external_kit_id required | string Your own kit ID for this sample |
Responses
Response samples
- 200
- 403
- 404
- 500
{- "status": "IN_PROGRESS",
- "external_kit_id": "MyLabSample-123",
- "kit_id": "EXT2873696BT"
}