# Kinetics Query

When species, databanks, redox, and solid phases are correctly specified, equilibrium equations formulated based on the resulting species are available via the kinetics query method.

### Request Payload 

```json
 {   
	"params": {
	"thermodynamicFramework": "Aqueous (H+ ion)",
	"privateDatabanks": [
		"COR"
	],
	"inflows": [
		{
			"name": "H2O"
		},
		{
			"name": "NACL"
		},
		{
			"name": "FECL3"
		}],
	"phases": [
        	"liquid1",
        	"vapor",
        	"solid", 
        	"liquid2"
      ],
	  "redox": {
		"enabled": true,
		"subSystems": [
			{
				"name": "Chlorine",
				"enabled": false,
				"valenceStates": [
					{
						"name": "Cl(-1)",
						"enabled": true
					},
					{
						"name": "Cl(+1)",
						"enabled": true
					},
					{
						"name": "Cl(+3)",
						"enabled": true
					},
					{
						"name": "Cl(+5)",
						"enabled": true
					},
					{
						"name": "Cl(+7)",
						"enabled": true
					},
					{
						"name": "Cl(+4)",
						"enabled": true
					}
				]
			},
			{
				"name": "Iron",
				"enabled": false,
				"valenceStates": [
					{
						"name": "Fe(0)",
						"enabled": false
					},
					{
						"name": "Fe(+2)",
						"enabled": true
					},
					{
						"name": "Fe(+3)",
						"enabled": false
					},
					{
						"name": "Fe(+6)",
						"enabled": false
					}
				]
			},
			{
				"name": "Sodium",
				"enabled": false,
				"valenceStates": [
					{
						"name": "Na(0)",
						"enabled": true
					},
					{
						"name": "Na(+1)",
						"enabled": true
					}
				]
			}
		]
	}, 
        "includedSolids": {
            "enabled": true,
            "solids": [
				"FECL3"
            ]
        }
	}
 }


```

<table><thead><tr><th width="252" align="center">params</th><th width="116" align="center">required</th><th width="136" align="center">type</th><th align="center">description</th></tr></thead><tbody><tr><td align="center">thermodynamicFramework</td><td align="center"><span data-gb-custom-inline data-tag="emoji" data-code="2714">✔️</span></td><td align="center">String</td><td align="center">The name of thermodynamic framework (e.g. Aqueous (H+ ion))</td></tr><tr><td align="center">privateDatabanks</td><td align="center"><span data-gb-custom-inline data-tag="emoji" data-code="274c">❌</span></td><td align="center">Array of String</td><td align="center">The array of private data bank codes (e.g. "COR" and "CER")</td></tr><tr><td align="center">Inflows</td><td align="center"><span data-gb-custom-inline data-tag="emoji" data-code="2714">✔️</span></td><td align="center">Array of JSON Object</td><td align="center">The array of JSON object containing a valid identity of inflow species (e.g. {"name": "CO2"} for carbon dioxide)</td></tr><tr><td align="center">phases</td><td align="center"><span data-gb-custom-inline data-tag="emoji" data-code="2714">✔️</span></td><td align="center">Array of String</td><td align="center">The array of String which specify phases to be included (e.g. ["liquid1", "vapor", "solid"])</td></tr><tr><td align="center">redox</td><td align="center"><span data-gb-custom-inline data-tag="emoji" data-code="2714">✔️</span></td><td align="center">JSON Object</td><td align="center">enable or disable valence states for a particular element in a species.</td></tr></tbody></table>

### Response (status=SUCCESS)

If no run-time [errors ](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/supporting-information-for-chembuilder/chembuilder-errors)are encountered, the [Query output](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/chembuilder-query/query-output-results) with the requested contents will be available for users to view.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/chembuilder-query/kinetics-query.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.