Skip to main content
Docs

Search guides and API endpoints, for example “Idempotency-Key” or “submit job”.

    API reference

    Jobs

    On this page

    Estimate job reservation cost

    POST/api/v1/jobs/estimate

    API key or token

    Request body

    application/json · JobEstimateRequest

    Request fields
    FieldTypeDescription
    job_typerequiredstring
    payloadrequiredobject
    resourcestring

    Default: "default"

    Example request

    curl -X POST "https://api.cognichem.com/api/v1/jobs/estimate" \
      -H "X-Api-Key: $COGNICHEM_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
      "job_type": "admet-predict",
      "payload": {
        "input_data": [
          "CCO",
          "c1ccccc1"
        ],
        "input_format": "smiles",
        "thresholds": [
          {
            "endpoint": "admet_herg",
            "op": "lt",
            "value": 0.3
          }
        ]
      },
      "resource": "default"
    }'

    Responses

    Successful Response · application/json · JobEstimateResponse

    Response fields
    FieldTypeDescription
    assumptionsobject

    Default: {}

    costrequirednumber
    expected_runtime_secrequirednumber
    job_typerequiredstring
    rate_per_secrequirednumber
    resourcerequiredstring
    tierrequiredinteger

    Submit a job

    POST/api/v1/jobs/submit

    API key or tokenCharges your wallet

    Parameters

    Headers
    NameTypeDescription
    Idempotency-Keystring

    Request body

    application/json · JobSubmitRequest

    Request fields
    FieldTypeDescription
    job_namerequiredstring
    job_typerequiredstring
    payloadrequiredobject
    resourcestring

    Default: "default"

    Example request

    curl -X POST "https://api.cognichem.com/api/v1/jobs/submit" \
      -H "X-Api-Key: $COGNICHEM_API_KEY" \
      -H "Idempotency-Key: $(uuidgen)" \
      -H "Content-Type: application/json" \
      -d '{
      "job_name": "catalog-admet-predict",
      "job_type": "admet-predict",
      "payload": {
        "input_data": [
          "CCO",
          "c1ccccc1"
        ],
        "input_format": "smiles",
        "thresholds": [
          {
            "endpoint": "admet_herg",
            "op": "lt",
            "value": 0.3
          }
        ]
      },
      "resource": "default"
    }'

    Responses

    Successful Response · application/json · JobSubmitResponse

    Response fields
    FieldTypeDescription
    process_idrequiredstring
    Example 200 response
    {
      "process_id": "fc-01HZXY9ABCDEF1234567890"
    }

    Submit several jobs

    POST/api/v1/jobs/submit-multiple

    API key or tokenCharges your wallet

    Parameters

    Headers
    NameTypeDescription
    Idempotency-Keystring

    Request body

    application/json · JobSubmitMultipleRequest

    Request fields
    FieldTypeDescription
    jobs[]requiredJobSubmitRequest[]
    jobs.job_namerequiredstring
    jobs.job_typerequiredstring
    jobs.payloadrequiredobject
    jobs.resourcestring

    Default: "default"

    Example request

    curl -X POST "https://api.cognichem.com/api/v1/jobs/submit-multiple" \
      -H "X-Api-Key: $COGNICHEM_API_KEY" \
      -H "Idempotency-Key: $(uuidgen)" \
      -H "Content-Type: application/json" \
      -d '{
      "jobs": [
        {
          "job_name": "catalog-admet-predict",
          "job_type": "admet-predict",
          "payload": {
            "input_data": [
              "CCO",
              "c1ccccc1"
            ],
            "input_format": "smiles",
            "thresholds": [
              {
                "endpoint": "admet_herg",
                "op": "lt",
                "value": 0.3
              }
            ]
          },
          "resource": "default"
        }
      ]
    }'

    Responses

    Successful Response · application/json · JobSubmitMultipleResponse

    Response fields
    FieldTypeDescription
    process_ids[]string[]

    Default: []

    List jobs

    GET/api/v1/jobs/list

    API key or token

    Parameters

    Query parameters
    NameTypeDescription
    limitinteger

    Limits: ≥ 1, ≤ 100

    offsetinteger

    Limits: ≥ 0

    statusstring

    Limits: max length 200

    job_typestring

    Limits: max length 100

    qstring

    Limits: max length 200

    sortstring

    Limits: max length 40

    Example request

    curl "https://api.cognichem.com/api/v1/jobs/list" \
      -H "X-Api-Key: $COGNICHEM_API_KEY"

    Responses

    Successful Response · application/json · ListJobsResponse

    Response fields
    FieldTypeDescription
    items[]JobListItem[]

    Default: []

    items.charged_amountnumber | null
    items.created_atstring | null
    items.expected_billing_costnumber | null
    items.finished_atstring | null
    items.job_namerequiredstring
    items.job_typerequiredstring
    items.messagestring

    Default: ""

    items.process_idrequiredstring
    items.resourcerequiredstring
    items.result_artifact_idstring | null
    items.runtime_secondsnumber

    Default: 0

    items.started_atstring | null
    items.statusrequiredstring

    One of: "queued", "dispatched", "running", "completed", "error", "cancelled"

    job_names[]string[]

    Default: []

    job_pids[]string[]

    Default: []

    limitinteger

    Default: 100

    offsetinteger

    Default: 0

    totalinteger

    Default: 0

    Get job details

    GET/api/v1/jobs/info

    API key or token

    Parameters

    Query parameters
    NameTypeDescription
    process_idrequiredstring

    Example request

    curl "https://api.cognichem.com/api/v1/jobs/info?process_id=PROCESS_ID" \
      -H "X-Api-Key: $COGNICHEM_API_KEY"

    Responses

    Successful Response · application/json · JobInfoResponse

    Response fields
    FieldTypeDescription
    inforequiredobject
    process_idrequiredstring

    Get job status

    GET/api/v1/jobs/status

    API key or token

    Parameters

    Query parameters
    NameTypeDescription
    process_idrequiredstring

    Example request

    curl "https://api.cognichem.com/api/v1/jobs/status?process_id=PROCESS_ID" \
      -H "X-Api-Key: $COGNICHEM_API_KEY"

    Responses

    Successful Response · application/json · JobStatusResponse

    Response fields
    FieldTypeDescription
    messagestring | null
    process_idrequiredstring
    result_artifact_idstring | null
    statusrequiredstring

    One of: "queued", "dispatched", "running", "completed", "error", "cancelled"

    Example 200 response
    {
      "process_id": "fc-01HZXY9ABCDEF1234567890",
      "result_artifact_id": "art-01HZXY9ABCDEF1234567890",
      "status": "completed"
    }

    Download a job result

    GET/api/v1/jobs/result

    API key or token

    Parameters

    Query parameters
    NameTypeDescription
    process_idrequiredstring

    Example request

    curl "https://api.cognichem.com/api/v1/jobs/result?process_id=PROCESS_ID" \
      -H "X-Api-Key: $COGNICHEM_API_KEY"

    Responses

    Successful Response · application/json

    Response fields: any

    Download several job results

    GET/api/v1/jobs/result-multiple

    API key or token

    Parameters

    Query parameters
    NameTypeDescription
    process_idsrequiredstring

    Example request

    curl "https://api.cognichem.com/api/v1/jobs/result-multiple?process_ids=PROCESS_IDS" \
      -H "X-Api-Key: $COGNICHEM_API_KEY"

    Responses

    Successful Response · application/json

    Response fields: any

    Cancel a job

    DELETE/api/v1/jobs/cancel

    API key or token

    Parameters

    Query parameters
    NameTypeDescription
    process_idrequiredstring

    Example request

    curl -X DELETE "https://api.cognichem.com/api/v1/jobs/cancel?process_id=PROCESS_ID" \
      -H "X-Api-Key: $COGNICHEM_API_KEY"

    Responses

    Successful Response · application/json · MessageResponse

    Response fields
    FieldTypeDescription
    messagerequiredstring

    Delete a job

    DELETE/api/v1/jobs/delete

    API key or token

    Parameters

    Query parameters
    NameTypeDescription
    process_idrequiredstring

    Example request

    curl -X DELETE "https://api.cognichem.com/api/v1/jobs/delete?process_id=PROCESS_ID" \
      -H "X-Api-Key: $COGNICHEM_API_KEY"

    Responses

    Successful Response · application/json · MessageResponse

    Response fields
    FieldTypeDescription
    messagerequiredstring