Biointron Documentation

RushData Agent API

English integration guide for RushData order submission and structured result retrieval.

API Agent Spec

API

Real production flow: get access token, create the RushData order, then retrieve the RushData JSON by order number.

Three-Step API

Three-Step API Flow

End-to-End Secured Data Pipeline via RushData API

The login API returns an access token. The order API submits a RushData order and returns an order number such as RD-000000. The final data API uses that order number to return the structured RushData JSON payload.

01
POST /customer/getAccessToken appkey + username

Use your personal app key (your_appkey) and username (your_username), which is typically your email address. BioIntron sends both credentials to you via email. A successful response returns the access token required for the next steps.

02
POST /order/inquiryOrder x-access-token + order payload

Use the x-access-token obtained in Step 01. Prepare your experiment and order data in the standard JSON format shown in the "Create RushData Order" example on the right, then submit the payload. A successful submission returns the order number used to track the experiment.

03
POST /order/api/getRushData x-access-token + orderNo

After the experiment is complete, BioIntron sends the project number (orderNo) to you via email. Use this number together with the access token to query and retrieve your structured experiment information and result data through the API.

Step 01 — Access Token Request 
POST https://myorder.biointron.com/byorderapi/by-order-client/customer/getAccessToken
Content-Type: application/json

{
  "appkey": "your_appkey",
  "username": "your_username"
}
Step 02 — Create RushData Order 
POST https://myorder.biointron.com/byorderapi/by-order-client/order/inquiryOrder
x-access-token: your_access_token
Content-Type: application/json

{
  "lineTypeCode": "rushData",
  "rushDataList": [
    {
      "projectName": "RushData-Project-A",
      "poNum": "PO-TEST-0001",
      "projectRemarks": "first rushdata project",
      "antibodyOrSupernatant": 0,
      "binding": "BLI",
      "developAbility": "AC-SINS,DSF,PSR-ELISA",
      "antigenList": [
        {
          "sampleName": "Antigen-1",
          "sampleSource": "customer",
          "isAntigen": 1,
          "sampleTag": "His",
          "sampleConcentration": 1.5,
          "sampleMolecularWeight": "50kDa",
          "sampleBuffer": "PBS,pH7.4"
        },
        {
          "sampleName": "Antigen-2",
          "sampleSource": "customer",
          "isAntigen": 1,
          "sampleTag": "Fc",
          "sampleConcentration": 2.0,
          "sampleMolecularWeight": "60kDa",
          "sampleBuffer": "PBS,pH7.4"
        }
      ]
    }
  ],
  "antibodyExpressionList": [
    {
      "chSequence": "ASTKGP",
      "clSequence": "RTVAAPS",
      "proteinName": "XXX-001",
      "vhSequence": "QAAVQLQS",
      "vlSequence": "AASGSGSGT"
    },
    {
      "chSequence": "ASTKGP",
      "clSequence": "RTVAAPS",
      "proteinName": "XXX-002",
      "vhSequence": "QAAVQLQS",
      "vlSequence": "AASGSGSGT"
    }
  ]
}
Step 03 — Get RushData Request 
POST https://myorder.biointron.com/byorderapi/by-order-client/order/api/getRushData
x-access-token: your_access_token
Content-Type: application/json

{
  "orderNo": "RD-000000"
}
Response 
{
  "success": true,
  "message": "",
  "code": 200,
  "result": {
    "...": "Rush Data JSON"
  }
}

API Field Reference

This section describes the request fields used by the three API steps, including authentication, order creation and RushData retrieval. It covers every unique request field in the rushData_complete example. Array fields may contain multiple records, as demonstrated by Antigen-1, Antigen-2, XXX-001 and XXX-002.

Endpoint Field Type Required Description
/by-order-client/customer/getAccessToken appkey String Yes Application key used to identify the client application.
/by-order-client/customer/getAccessToken username String Yes Username associated with the requesting account.
/by-order-client/customer/getAccessToken Content-Type String Yes Fixed as application/json for the login request body.
/by-order-client/order/inquiryOrder x-access-token String Yes Access token returned by the login API and sent in the request header for authentication.
/by-order-client/order/inquiryOrder Content-Type String Yes Fixed as application/json.
/by-order-client/order/inquiryOrder lineTypeCode String Yes Business line type code. For RushData requests the value should be rushData.
/by-order-client/order/inquiryOrder rushDataList Array No List of RushData project objects, including project details and antigen information.
/by-order-client/order/inquiryOrder antibodyExpressionList Array No List of antibody expression sequence objects, including heavy chain, light chain and protein naming fields.
/by-order-client/order/api/getRushData x-access-token String Yes Access token returned by the login API and sent in the request header for authentication.
/by-order-client/order/api/getRushData Content-Type String Yes Fixed as application/json.
/by-order-client/order/api/getRushData orderNo String Yes RushData order number used to retrieve the final structured JSON payload.
Object Field Type Required Description
rushDataList[] projectName String Yes Project name for the RushData order item.
rushDataList[] projectRemarks String No Optional remarks or notes for the project.
rushDataList[] poNum String No Purchase order number for the project.
rushDataList[] antibodyOrSupernatant Integer Yes Type marker where 0 means antibody and 1 means supernatant.
rushDataList[] binding String No Binding method, such as BLI or SPR.
rushDataList[] developAbility String No Comma-separated assay list, such as AC-SINS,DSF,PSR-ELISA.
rushDataList[] antigenList Array No List of antigen sample objects attached to the project.
antigenList[] sampleName String Yes Sample name for the antigen record.
antigenList[] sampleSource String Yes Sample source, for example customer shipment or in-house collection.
antigenList[] isAntigen Integer Yes Whether the sample is an antigen. The documented value is 1.
antigenList[] sampleTag String No Optional antigen tag such as His or Fc.
antigenList[] sampleConcentration Number No Antigen sample concentration.
antigenList[] sampleMolecularWeight String No Molecular weight such as 50kDa.
antigenList[] sampleBuffer String No Buffer system, for example PBS,pH7.4.
antibodyExpressionList[] proteinName String Yes Protein name or identifier for the antibody expression record.
antibodyExpressionList[] vhSequence String No Heavy-chain variable region sequence.
antibodyExpressionList[] vlSequence String No Light-chain variable region sequence.
antibodyExpressionList[] chSequence String No Heavy-chain constant region sequence.
antibodyExpressionList[] clSequence String No Light-chain constant region sequence.
Authentication

Access Token Requirements

Every order request must include the JWT returned by getAccessToken in the x-access-token header. Missing or invalid tokens result in a 401 Unauthorized response.

The lineTypeCode field is required and must be rushData for RushData orders.

Specification for Agent

This module explains how the API response should be interpreted by downstream pipelines and AI agents. The API returns a full response envelope, while the agent-facing business payload is the result object.

Field Guide
After calling getRushData, the client first receives the full API response envelope. This Specification for Agent section is the field-level interpretation of response.result, which is the RushData payload that applications, data pipelines and AI agents should actually parse.
Step 1
Send Request

Submit orderNo after obtaining the access token.

->
Step 2
Receive Response

The API returns success, message, code and result.

->
Step 3
Parse result

The detailed RushData structure below is the translated schema of result.

meta
Identity

Order, customer, project, assay list and report version metadata inside result.

stats
Summary

High-level sample totals returned inside result, such as the total number of samples.

samples
Sample Records

Per-sample business records containing customer identifiers, sample attributes and experiment-specific result blocks.

assays
Nested Modules

Assay-specific structures such as cGE, DSF, BLI, SPR, PSR_BVP and ACSINS.

Response Envelope 
{
  "success": true,
  "message": "",
  "code": 200,
  "result": {
    "...": "Rush Data JSON"
  }
}
Agent Schema 

          

        


        

        
Response Field Reference

        
This section expands the detailed fields inside response.result. As a general rule, if a corresponding assay result exists, the field contains the returned value; if no corresponding result exists, the field is typically returned as an empty value such as "".


        

          

            
              

                Field Path
                Type
                Description
                When No Result
              

            
            
              

                meta.order_id
                String
                Order number returned for the RushData job.
                Usually not empty for a valid order.
              

              

                meta.customer_name
                String
                Customer name associated with the order.
                Empty if the source order record does not provide it.
              

              

                meta.project_name
                String
                Project name defined for the RushData order.
                Empty if the project name is not populated.
              

              

                meta.assay_list
                Array<String>
                List of assay types included in the report.
                Empty array or blank if no assay list is provided.
              

              

                meta.report_version
                String
                Version of the RushData report template or payload schema.
                Empty if the report version is not assigned.
              

              

                stats.n_samples
                Number
                Total number of samples included in the payload.
                Empty or zero if no sample count is available.
              

              

                samples[].Project ID
                String
                Project-level sample identifier.
                Empty if no project identifier is mapped to the sample.
              

              

                samples[].PPB ID
                String
                Customer-facing identifier for the sample or project.
                Empty if the customer identifier is unavailable.
              

              

                samples[].DPP ID
                String
                Internal DPP tracking identifier.
                Empty if the internal DPP identifier is unavailable.
              

              

                samples[].Samples Name
                String
                Customer sample name shown in the report.
                Empty if the sample name is not provided.
              

              

                samples[].Tag
                String
                Optional sample tag such as His, Fc or another label.
                Empty if the sample has no tag.
              

              

                samples[].Conc.
                Number / String
                Reported sample concentration.
                Empty if concentration is not reported.
              

              

                samples[].Lot No.
                String
                Lot number associated with the sample.
                Empty if no lot number exists.
              

              

                samples[].Molecular weight
                Number / String
                Molecular weight of the sample.
                Empty if molecular weight is not reported.
              

              

                samples[].PI
                String
                PI-related field returned by the source report.
                Empty if no PI-related value is provided.
              

              

                samples[].Order_ID
                String
                Order number associated with the sample row.
                Usually not empty for a valid sample row.
              

              

                samples[].IsControl
                Boolean / String
                Indicates whether the row is a control sample.
                Empty if the control flag is not defined.
              

              

                samples[].Expression_mg_per_mL
                Number / String
                Expression yield value, typically in mg/mL.
                Empty if no expression result is returned.
              

            
          

        


        

          

            
              

                Field Path
                Type
                Description
                When No Result
              

            
            
              

                samples[].cGE.purity_no_r
                Number / String
                Purity value calculated without replicate handling.
                Empty if no cGE purity result is available.
              

              

                samples[].cGE.purity_r
                Number / String
                Purity value calculated with replicate handling.
                Empty if no replicated cGE purity result is available.
              

              

                samples[].cGE.purity_Outcome
                String
                Final cGE purity assessment result.
                Empty if no cGE outcome is generated.
              

              

                samples[].cGE.src
                String
                Image payload for the cGE result, typically base64 content or an image reference.
                Empty if no cGE image is returned.
              

              

                samples[].cGE.title
                String
                Display title for the cGE image or plot.
                Empty if no cGE image title exists.
              

              

                samples[].cGE.plate_name
                String
                Plate name associated with the cGE result.
                Empty if no plate metadata is attached.
              

              

                samples[].cGE.well
                String
                Well position associated with the cGE result.
                Empty if no well metadata is attached.
              

              

                samples[].cGE.plate
                String
                Plate identifier associated with the cGE result.
                Empty if no plate identifier is attached.
              

              

                samples[].DSF.tonset
                Number / String
                DSF onset temperature.
                Empty if no DSF onset result is available.
              

              

                samples[].DSF.tm1
                Number / String
                Primary DSF melting temperature value.
                Empty if no DSF Tm1 result is available.
              

              

                samples[].DSF.tm2
                Number / String
                Secondary DSF melting temperature value.
                Empty if no DSF Tm2 result is available.
              

              

                samples[].DSF.tm3
                Number / String
                Additional DSF melting temperature value.
                Empty if no DSF Tm3 result is available.
              

              

                samples[].DSF.tm4
                Number / String
                Additional DSF melting temperature value.
                Empty if no DSF Tm4 result is available.
              

              

                samples[].DSF.outcome
                String
                Final DSF assessment result.
                Empty if no DSF outcome is generated.
              

              

                samples[].DSF.src
                String
                Image payload for the DSF result, typically base64 content or an image reference.
                Empty if no DSF image is returned.
              

              

                samples[].DSF.title
                String
                Display title for the DSF image or plot.
                Empty if no DSF image title exists.
              

              

                samples[].DSF.plate_name
                String
                Plate name associated with the DSF result.
                Empty if no plate metadata is attached.
              

              

                samples[].DSF.well
                String
                Well position associated with the DSF result.
                Empty if no well metadata is attached.
              

              

                samples[].DSF.plate
                String
                Plate identifier associated with the DSF result.
                Empty if no plate identifier is attached.
              

              

                samples[].BLI.response
                Number / String
                Primary BLI response value.
                Empty if no BLI response result is available.
              

              

                samples[].BLI.kd_M
                Number / String
                Octet KD value in molar units.
                Empty if no KD result is available.
              

              

                samples[].BLI.kd_error
                Number / String
                KD fitting error for the BLI result.
                Empty if no KD error metric is returned.
              

              

                samples[].BLI.ka_M_s
                Number / String
                Octet association rate constant ka.
                Empty if no ka result is available.
              

              

                samples[].BLI.ka_error
                Number / String
                Association rate fitting error.
                Empty if no ka error metric is returned.
              

              

                samples[].BLI.kd_s
                Number / String
                Octet dissociation rate constant kd.
                Empty if no kd result is available.
              

              

                samples[].BLI.kdis_error
                Number / String
                Dissociation rate fitting error.
                Empty if no kd error metric is returned.
              

              

                samples[].BLI.full_r_2
                Number / String
                Overall fit R squared value.
                Empty if no fit-quality metric is returned.
              

              

                samples[].BLI.rss
                Number / String
                Residual sum of squares for the fit.
                Empty if no RSS metric is returned.
              

              

                samples[].BLI.rsskd
                Number / String
                KD-related residual metric.
                Empty if no residual KD metric is returned.
              

              

                samples[].BLI.rss_r_2
                Number / String
                R squared value associated with the RSS fit.
                Empty if no RSS fit-quality metric is returned.
              

              

                samples[].BLI.outcome
                String
                Final Octet/BLI assay outcome.
                Empty if no BLI outcome is generated.
              

              

                samples[].BLI.src
                String
                Image payload for the BLI result, typically base64 content or an image reference.
                Empty if no BLI image is returned.
              

              

                samples[].BLI.title
                String
                Display title for the BLI image or plot.
                Empty if no BLI image title exists.
              

              

                samples[].BLI.plate_name
                String
                Plate name associated with the BLI result.
                Empty if no plate metadata is attached.
              

              

                samples[].BLI.well
                String
                Well position associated with the BLI result.
                Empty if no well metadata is attached.
              

              

                samples[].BLI.plate
                String
                Plate identifier associated with the BLI result.
                Empty if no plate identifier is attached.
              

              

                samples[].Carterra.Human TL1A.kd_M
                Number / String
                KD value for the Human TL1A Carterra target.
                Empty if no TL1A kinetic result is available.
              

              

                samples[].Carterra.Human TL1A.ka_M_s
                Number / String
                Association rate constant ka for the Human TL1A Carterra target.
                Empty if no TL1A association result is available.
              

              

                samples[].Carterra.Human TL1A.kd_s
                Number / String
                Dissociation rate constant kd for the Human TL1A Carterra target.
                Empty if no TL1A dissociation result is available.
              

              

                samples[].Carterra.Human TL1A.outcome
                String
                Final outcome for the Human TL1A Carterra target.
                Empty if no TL1A outcome is generated.
              

              

                samples[].Carterra.Human TL1A.src
                String
                Image payload for the Human TL1A Carterra result.
                Empty if no TL1A image is returned.
              

              

                samples[].Carterra.Human TL1A.title
                String
                Display title for the Human TL1A Carterra image.
                Empty if no TL1A image title exists.
              

              

                samples[].Carterra.Human TL1A.plate_name
                String
                Plate name for the Human TL1A Carterra result.
                Empty if no TL1A plate metadata is attached.
              

              

                samples[].Carterra.Human TL1A.well
                String
                Well position for the Human TL1A Carterra result.
                Empty if no TL1A well metadata is attached.
              

              

                samples[].Carterra.Human TL1A.plate
                String
                Plate identifier for the Human TL1A Carterra result.
                Empty if no TL1A plate identifier is attached.
              

              

                samples[].Carterra.Human TSLP.kd_M
                Number / String
                KD value for the Human TSLP Carterra target.
                Empty if no TSLP kinetic result is available.
              

              

                samples[].Carterra.Human TSLP.ka_M_s
                Number / String
                Association rate constant ka for the Human TSLP Carterra target.
                Empty if no TSLP association result is available.
              

              

                samples[].Carterra.Human TSLP.kd_s
                Number / String
                Dissociation rate constant kd for the Human TSLP Carterra target.
                Empty if no TSLP dissociation result is available.
              

              

                samples[].Carterra.Human TSLP.outcome
                String
                Final outcome for the Human TSLP Carterra target.
                Empty if no TSLP outcome is generated.
              

              

                samples[].Carterra.Human TSLP.src
                String
                Image payload for the Human TSLP Carterra result.
                Empty if no TSLP image is returned.
              

              

                samples[].Carterra.Human TSLP.title
                String
                Display title for the Human TSLP Carterra image.
                Empty if no TSLP image title exists.
              

              

                samples[].Carterra.Human TSLP.plate_name
                String
                Plate name for the Human TSLP Carterra result.
                Empty if no TSLP plate metadata is attached.
              

              

                samples[].Carterra.Human TSLP.well
                String
                Well position for the Human TSLP Carterra result.
                Empty if no TSLP well metadata is attached.
              

              

                samples[].Carterra.Human TSLP.plate
                String
                Plate identifier for the Human TSLP Carterra result.
                Empty if no TSLP plate identifier is attached.
              

              

                samples[].PSR_BVP.Signal_1.signal
                Number / String
                Signal value for the first PSR_BVP channel.
                Empty if Signal 1 is not available.
              

              

                samples[].PSR_BVP.Signal_1.src
                String
                Image payload for PSR_BVP Signal 1.
                Empty if no Signal 1 image is returned.
              

              

                samples[].PSR_BVP.Signal_1.title
                String
                Display title for PSR_BVP Signal 1.
                Empty if no Signal 1 title exists.
              

              

                samples[].PSR_BVP.Signal_1.plate_name
                String
                Plate name for PSR_BVP Signal 1.
                Empty if no Signal 1 plate metadata is attached.
              

              

                samples[].PSR_BVP.Signal_1.well
                String
                Well position for PSR_BVP Signal 1.
                Empty if no Signal 1 well metadata is attached.
              

              

                samples[].PSR_BVP.Signal_1.plate
                String
                Plate identifier for PSR_BVP Signal 1.
                Empty if no Signal 1 plate identifier is attached.
              

              

                samples[].PSR_BVP.Signal_2.signal
                Number / String
                Signal value for the second PSR_BVP channel.
                Empty if Signal 2 is not available.
              

              

                samples[].PSR_BVP.Signal_2.src
                String
                Image payload for PSR_BVP Signal 2.
                Empty if no Signal 2 image is returned.
              

              

                samples[].PSR_BVP.Signal_2.title
                String
                Display title for PSR_BVP Signal 2.
                Empty if no Signal 2 title exists.
              

              

                samples[].PSR_BVP.Signal_2.plate_name
                String
                Plate name for PSR_BVP Signal 2.
                Empty if no Signal 2 plate metadata is attached.
              

              

                samples[].PSR_BVP.Signal_2.well
                String
                Well position for PSR_BVP Signal 2.
                Empty if no Signal 2 well metadata is attached.
              

              

                samples[].PSR_BVP.Signal_2.plate
                String
                Plate identifier for PSR_BVP Signal 2.
                Empty if no Signal 2 plate identifier is attached.
              

              

                samples[].PSR_BVP.mfi
                Number / String
                Mean fluorescence intensity or equivalent PSR_BVP summary metric.
                Empty if no MFI result is returned.
              

              

                samples[].PSR_BVP.sb_data
                Number / String
                Signal-to-background related data for the PSR_BVP assay.
                Empty if no signal-to-background data is returned.
              

              

                samples[].PSR_BVP.score
                Number / String
                Overall PSR_BVP score.
                Empty if no PSR_BVP score is available.
              

              

                samples[].PSR_BVP.outcome
                String
                Final PSR_BVP assessment result.
                Empty if no PSR_BVP outcome is generated.
              

              

                samples[].ACSINS.wavelength
                Number / String
                AC-SINS score or wavelength-related result field returned by the report.
                Empty if no AC-SINS score is available.
              

              

                samples[].ACSINS.red_shift
                Number / String
                AC-SINS red-shift value, typically in nm.
                Empty if no red-shift result is available.
              

              

                samples[].ACSINS.Outcome
                String
                Final AC-SINS assessment result.
                Empty if no AC-SINS outcome is generated.
              

              

                samples[].ACSINS.src
                String
                Image payload for the AC-SINS result, typically base64 content or an image reference.
                Empty if no AC-SINS image is returned.
              

              

                samples[].ACSINS.title
                String
                Display title for the AC-SINS image or plot.
                Empty if no AC-SINS image title exists.
              

              

                samples[].ACSINS.plate_name
                String
                Plate name associated with the AC-SINS result.
                Empty if no plate metadata is attached.
              

              

                samples[].ACSINS.well
                String
                Well position associated with the AC-SINS result.
                Empty if no well metadata is attached.
              

              

                samples[].ACSINS.plate
                String
                Plate identifier associated with the AC-SINS result.
                Empty if no plate identifier is attached.
              

            
          

        


        
In short: response.result is the RushData JSON that downstream systems should parse.