Skip to main content
Docs

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

    API reference

    Inference

    On this page

    Submit an inference request

    POST/api/v1/inference/submit

    API key or tokenCounts toward monthly limits

    Parameters

    Headers
    NameTypeDescription
    Idempotency-Keystring

    Request body

    application/json · InferenceSubmitRequest

    Request fields
    FieldTypeDescription
    model_namerequiredstring
    model_typerequiredstring
    payloadrequiredobject

    Example request

    curl -X POST "https://api.cognichem.com/api/v1/inference/submit" \
      -H "X-Api-Key: $COGNICHEM_API_KEY" \
      -H "Idempotency-Key: $(uuidgen)" \
      -H "Content-Type: application/json" \
      -d '{
      "model_name": "public-model-example",
      "model_type": "mpnn",
      "payload": {
        "input_data": [
          "CCO"
        ],
        "input_format": "smiles",
        "is_public_model": true
      }
    }'

    Responses

    Successful Response · application/json · JobSubmitResponse

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

    Submit a batch of inference requests

    POST/api/v1/inference/submit-batch

    API key or tokenCounts toward monthly limits

    Parameters

    Headers
    NameTypeDescription
    Idempotency-Keystring

    Request body

    application/json · InferenceSubmitBatchRequest

    Request fields
    FieldTypeDescription
    jobs[]requiredInferenceSubmitRequest[]

    Limits: min items 1, max items 50

    jobs.model_namerequiredstring
    jobs.model_typerequiredstring
    jobs.payloadrequiredobject

    Example request

    curl -X POST "https://api.cognichem.com/api/v1/inference/submit-batch" \
      -H "X-Api-Key: $COGNICHEM_API_KEY" \
      -H "Idempotency-Key: $(uuidgen)" \
      -H "Content-Type: application/json" \
      -d '{
      "jobs": [
        {
          "model_name": "public-model-example",
          "model_type": "mpnn",
          "payload": {
            "input_data": [
              "CCO"
            ],
            "input_format": "smiles",
            "is_public_model": true
          }
        }
      ]
    }'

    Responses

    Successful Response · application/json · JobSubmitMultipleResponse

    Response fields
    FieldTypeDescription
    process_ids[]string[]

    Default: []

    List inference requests

    GET/api/v1/inference/list

    API key or token

    Example request

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

    Responses

    Successful Response · application/json · ListPIDsResponse

    Response fields
    FieldTypeDescription
    process_ids[]string[]

    Default: []

    Get inference status

    GET/api/v1/inference/status

    API key or token

    Parameters

    Query parameters
    NameTypeDescription
    process_idrequiredstring

    Example request

    curl "https://api.cognichem.com/api/v1/inference/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"
    }

    Get an inference result

    GET/api/v1/inference/result

    API key or token

    Parameters

    Query parameters
    NameTypeDescription
    process_idrequiredstring

    Example request

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

    Responses

    Successful Response · application/json · InferenceResultResponse

    Response fields
    FieldTypeDescription
    datarequiredobject

    Delete an inference request

    DELETE/api/v1/inference/delete

    API key or token

    Parameters

    Query parameters
    NameTypeDescription
    process_idrequiredstring

    Example request

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

    Responses

    Successful Response · application/json · MessageResponse

    Response fields
    FieldTypeDescription
    messagerequiredstring

    Cancel an inference request

    POST/api/v1/inference/cancel

    API key or token

    Parameters

    Query parameters
    NameTypeDescription
    process_idrequiredstring

    Example request

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

    Responses

    Successful Response · application/json · MessageResponse

    Response fields
    FieldTypeDescription
    messagerequiredstring