Skip to main content
Read the live Console catalog for each operation’s availability, input and output schemas, price, billing unit and required scopes. Use the credential and quote for the intended organization before authorizing a run. The worked example uses SEC Financial Research Brief, company.financial_research, at $25 USD per accepted execution. The charge settles after successful delivery and validation. Prerequisites: confirmed organization funding, an API-channel Console credential, private environment storage and purchaser-approved budget. These examples are instructions; reading or copying them does not execute a task.

1. Read available tools

Select company.financial_research only if it appears as available. Inspect its current schema. The SEC example uses cik, an exact ten-digit issuer identifier; a ticker or a similarly named company is not interchangeable.

2. Request a quote

The sample CIK identifies Microsoft. Replace it with the exact eligible issuer you intend to research. Requesting a quote does not authorize a paid run.
Inspect the returned quote, input, currency, price/version and maximum charge. Preserve the complete server-returned quote unchanged. If the quote is refused, expired or outside the approved budget, stop rather than replacing fields to force acceptance.

3. Accept the exact quote

After explicit purchaser acceptance, construct a request with the same toolId and input, the unchanged quote object, accept=true and one stable idempotencyKey. The following is a field guide, not a runnable payload with a fabricated quote:
The key may instead be supplied as idempotencyKey in the body. If both are present they must match. Reuse it with the same request after a transport interruption; never create a new key merely because a response is slow. The console-task: prefix is reserved.

4. Retrieve the result

Use the returned UUID run ID for the same organization. RunDetail.status is the ledger state: OPEN, RESERVED, SETTLED, RELEASED or ABANDONED. RunDetail.resultStatus is SUCCEEDED, FAILED or null; a RunResult uses SUCCEEDED or FAILED in its own status field. Inspect execution outcome, evidence and settlement separately. A successful HTTP response alone does not mean every requested fact was found. You can also use the existing Console playground and runs screen with the authorized organization. These pages retain the same quote, acceptance and budget controls.

Results, batches and errors

The current financial brief compares two adjacent annual US GAAP USD periods with filing citations and labeled derived observations. Unsupported or unresolved periods remain limitations. The public contract has no general paid batch endpoint: accept each eligible issuer separately, or agree a managed batch scope and budget before work starts. Handle 400 validation failures by correcting the intended input; handle 401/403 through the documented account and credential flow. On rate limiting, respect the response’s retry guidance. For an uncertain run or timeout, retrieve the same run and reconcile the charge before another attempt. Read settlement rules and the exact OpenAPI responses.