API

Use the API for automation, notebook integration, and scalable execution.

Authentication

Authorization header: Bearer <YOUR_API_KEY>

Endpoint

• POST /v1/simulations: Run a simulation

Put simulation job

curl -X POST "https://api.knockg.com/v1/simulations" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "dataset_id": "ds_example_001",
    "mode": "knockdown",
    "targets": ["GENE_A", "GENE_B"],
    "condition": "treated"
    ...
  }'

List available datasets

curl -X GET "https://api.knockg.com/v1/datasets?secret=<KNOCKG_API_SECRET>" \
  -H "Accept: application/json"

List output genes for one screening

curl -X GET "https://api.knockg.com/v1/screenings/<SCREENING_ID>/output_genes?secret=<KNOCKG_API_SECRET>" \
  -H "Accept: application/json"