Run
Copy link Define the structure of your output directly in the API request. This endpoint allows you to define both your input data and output configuration in a single request.
Dynamic pricing
rowCount(body.input) * keyCount(body.output) * 0.025 * 1.025 + 0.004
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",
body: {
"input": {},
"output": {}
}
});
console.log(output);Query parameters
Custom identifier for this run (optional, will be generated if not provided)
Body parameters
The input object contains your source data: Keys are column/attribute names Values are arrays of strings (all arrays must be the same length) Maximum 1000 rows per request Example: {"company":["Stripe","Ramp"],"domain":["stripe.com","ramp.com"]} (every value array must be the same length).
The output object defines what data you want to extract: Keys are the names of attributes you want to extract Each attribute requires: prompt: Instructions for finding/extracting this data contexts: Array of input or other output attribute names this depends on. Optional Output Configuration Each output attribute can optionally include: format: Data type ('number', 'json', 'url', 'text', 'email', 'tag', 'date', 'boolean') format_details: Format-specific configuration (varies by format type). For json format, you can provide either a description (string) or a schema (JSON Schema object) or both. tools: Array of tools to use (['web_search', 'web_scrape', 'query_pdf', 'query_image']) max_tool_calls: Number of tool calls allowed (0-10) run_when: When to run this extraction ('always', 'any_filled', 'all_filled') Example: {"ceo_name":{"prompt":"Find the company's CEO","contexts":["company"],"format":"text"}}.
Response