← Back to Riveter
Run status
Check the current status of a project run
Riveter·Free
Example code
// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";
const orthogonal = new Orthogonal({
apiKey: process.env.ORTHOGONAL_API_KEY,
});
const output = await orthogonal.run({
api: "riveter",
path: "/v1/run_status",
query: {
"run_key": "example"
}
});
console.log(output);Query parameters
run_keyrequired
string
The run key (UUID) of the project run to check
Response
status
string
message
string
run_key
string
credits_used
number
project_name
string
project_uuid
string
error_message
null
request_status
string
completed_cells
number
not_found_cells
number
riveter_app_link
string
total_cells_expected
number