API reference
- OpenAPI
- openapi.yaml
- JSON
- openapi.json
- Guide
- Developers
Send Authorization: Bearer with a Platform Key and NeoNumber-Contract-Version: 1.1 on every call, and an Idempotency-Key on every write. Bodies are JSON; quantities are decimal strings.
Ideas
Save the person's own words and read them back by exact version.
List saved Ideas
GET /v1/ideas
- Operation id
get_v1_ideas- Request body
- None
- Response
IdeaList or IdeaListV11- Query parameters
after- Credential
- Platform Key or web session
select exact saved versions, fifty Ideas per page. Advisory only.
Save an Idea
POST /v1/ideas
- Operation id
post_v1_ideas- Request body
IdeaCreate- Response
Idea or IdeaV11- Credential
- Platform Key or web session
Words-only intake; infer visibly, preserve original. Advisory only.
Read an Idea
GET /v1/ideas/{id}
- Operation id
get_v1_ideas_id- Request body
- None
- Response
Idea or IdeaV11- Path parameters
id- Credential
- Platform Key or web session
Read an authorized Idea and visible inferences. Advisory only.
Read an exact Idea version
GET /v1/ideas/{id}/versions/{version_id}
- Operation id
get_v1_ideas_id_versions_version_id- Request body
- None
- Response
Idea or IdeaV11- Path parameters
id, version_id- Credential
- Platform Key or web session
Read exact preserved historical version, not latest. Advisory only.
Readings
What NeoNumber read from the words; confirm or correct it as a new version.
Confirm or correct a reading as a new version
POST /v1/ideas/{id}/versions
- Operation id
post_v1_ideas_id_versions- Request body
IdeaRevision- Response
Idea or IdeaV11- Path parameters
id- Credential
- Platform Key or web session
Create revision, carry applicable adverse history; never edit old version. Advisory only.
Read a reading
GET /v1/readings/{id}
- Operation id
get_v1_readings_id- Request body
- None
- Response
ReadingResource- Path parameters
id- Credential
- Platform Key or web session
poll the saved intake reading. Advisory only.
Reviews
A judgment of one exact version. A Score is never a probability.
Request a Review
POST /v1/ideas/{id}/score
- Operation id
post_v1_ideas_id_score- Request body
ScoreRequest- Response
Review- Path parameters
id- Credential
- Platform Key or web session
Standalone Score; no Question or Result dependency. Advisory only.
Read a Review
GET /v1/reviews/{id}
- Operation id
get_v1_reviews_id- Request body
- None
- Response
Review- Path parameters
id- Credential
- Platform Key or web session
Read immutable Review referenced by a Record. Advisory only.
Read a Review's clarification question
GET /v1/reviews/{id}/clarification
- Operation id
get_v1_reviews_id_clarification- Request body
- None
- Response
ReviewClarification- Path parameters
id- Credential
- Platform Key or web session
optional clarification beside the partial Review. Advisory only.
Comparisons
Two or three versions judged for one objective under shared conditions.
Read a Comparison
GET /v1/comparisons/{id}
- Operation id
get_v1_comparisons_id- Request body
- None
- Response
Comparison- Path parameters
id- Credential
- Platform Key or web session
Read preserved Comparison and its exact version references. Advisory only.
Request a Comparison
POST /v1/comparisons
- Operation id
post_v1_comparisons- Request body
ComparisonRequest- Response
Comparison- Credential
- Platform Key or web session
Require comparable versions/conditions/method; allow tie or inconclusive. Advisory only.
Measurements
Agree what to measure before the work starts.
List measurement tasks
GET /v1/measurement-tasks
- Operation id
get_v1_measurement_tasks- Request body
- None
- Response
MeasurementTaskPage- Query parameters
after, filter (all or due)- Credential
- Platform Key or web session
per-objective work for confirmed project and strategy plans, in stable key order. Due is determined by server time and the latest matching Result; pending or absent components remain outstanding. Missing dates stay unknown. Prediction resolution is listed in Activity instead. Refresh from the start for changed states; this is not a correction cursor.
Confirm a measurement plan
POST /v1/measurement-plans
- Operation id
post_v1_measurement_plans- Request body
MeasurementConfirmation- Response
MeasurementPlan- Credential
- Platform Key or web session
confirm proposed definitions and freeze source selections. Advisory only.
Read a measurement plan
GET /v1/measurement-plans/{id}
- Operation id
get_v1_measurement_plans_id- Request body
- None
- Response
MeasurementPlan- Path parameters
id- Credential
- Platform Key or web session
open confirmed definitions. Advisory only.
Register measurement definitions directly
POST /v1/ideas/{id}/measurements
- Operation id
post_v1_ideas_id_measurements- Request body
MeasurementRegistration- Response
RegistrationReceipt- Path parameters
id- Credential
- Platform Key or web session
Server binds definitions and exact version before start; after-start registration cannot establish preregistration. Advisory only.
Propose measurement definitions
POST /v1/ideas/{id}/measurement-proposals
- Operation id
post_v1_ideas_id_measurement_proposals- Request body
MeasurementProposalRequest- Response
MeasurementProposalResource- Path parameters
id- Credential
- Platform Key or web session
propose definitions before customer confirmation. Advisory only.
Read a measurement proposal
GET /v1/measurement-proposals/{id}
- Operation id
get_v1_measurement_proposals_id- Request body
- None
- Response
MeasurementProposalResource- Path parameters
id- Credential
- Platform Key or web session
poll proposed definitions and missing essentials. Advisory only.
Results
What was measured, per objective. Never combined with a Review Score.
Correct a Result
POST /v1/results/{id}/corrections
- Operation id
post_v1_results_id_corrections- Request body
ResultCorrection- Response
Result- Path parameters
id- Credential
- Platform Key or web session
supersede a customer-reported Result, preserving its definitions. Advisory only.
Follow Result corrections
GET /v1/tenants/me/result-corrections
- Operation id
get_v1_tenants_me_result_corrections- Request body
- None
- Response
ResultCorrectionsCursor- Query parameters
cursor- Credential
- Platform Key or web session
every superseding Result, including collection and finalization. Advisory only.
Report project outcomes
POST /v1/projects/{id}/results
- Operation id
post_v1_projects_id_results- Request body
ResultIntake- Response
Result- Path parameters
id- Credential
- Platform Key or web session
Retrospective Measure without Review. Derive history from trusted registration, never a caller label. Advisory only.
Report strategy outcomes
POST /v1/strategies/{id}/results
- Operation id
post_v1_strategies_id_results- Request body
ResultIntake- Response
Result- Path parameters
id- Credential
- Platform Key or web session
Exact-version scoped paper/backtest/live component intake; constructed examples require design_examples entitlement. Advisory only.
Read a Result
GET /v1/results/{id}
- Operation id
get_v1_results_id- Request body
- None
- Response
Result- Path parameters
id- Credential
- Platform Key or web session
Read mixed component Results with individual dates and limitations. Advisory only.
Campaigns
Two or three ideas compared for one objective, the choice, and the Result benchmarked after.
List campaigns
GET /v1/campaigns
- Operation id
get_v1_campaigns- Request body
- None
- Response
CampaignList- Query parameters
after- Credential
- Platform Key or web session
Start a campaign decision cycle
POST /v1/campaigns
- Operation id
post_v1_campaigns- Request body
CampaignCreate- Response
Campaign- Credential
- Platform Key or web session
Read a campaign
GET /v1/campaigns/{id}
- Operation id
get_v1_campaigns_id- Request body
- None
- Response
Campaign- Path parameters
id- Credential
- Platform Key or web session
Record a campaign decision
POST /v1/campaigns/{id}
- Operation id
post_v1_campaigns_id- Request body
CampaignUpdate- Response
Campaign- Path parameters
id- Credential
- Platform Key or web session
Read a campaign's benchmark
GET /v1/campaigns/{id}/benchmark
- Operation id
get_v1_campaigns_id_benchmark- Request body
- None
- Response
CampaignBenchmark- Path parameters
id- Credential
- Platform Key or web session
Read a campaign's history
GET /v1/campaigns/{id}/snapshot
- Operation id
get_v1_campaigns_id_snapshot- Request body
- None
- Response
CampaignSnapshot- Path parameters
id- Credential
- Platform Key or web session
Records
Reviews and Results kept separately by kind and domain.
List Records
GET /v1/records
- Operation id
get_v1_records- Request body
- None
- Response
RecordList or RecordListV11- Credential
- Platform Key or web session
list this workspace�s Records separately by kind and domain. Advisory only.
Read a Record
GET /v1/records/{id}
- Operation id
get_v1_records_id- Request body
- None
- Response
Record or RecordV11- Path parameters
id- Credential
- Platform Key or web session
Only authorized/private or consent-published history. Constructed examples excluded. Advisory only.
Read a Method's validity
GET /v1/validity/{id}
- Operation id
get_v1_validity_id- Request body
- None
- Response
Validity- Path parameters
id- Credential
- Platform Key or web session
Prospective comparable observed pairs only; coverage and floor beside every figure. Advisory only.
Read the workspace context
GET /v1/tenants/me
- Operation id
get_v1_tenants_me- Request body
- None
- Response
TenantContext- Credential
- Platform Key or web session
Return authenticated tenant identity for client digest/AAD binding and resolved default. Advisory only.
Events
Signed announcements of your own work, oldest first; you pull them with a cursor.
Read the signed event feed
GET /v1/events
- Operation id
get_v1_events- Request body
- None
- Response
EventList- Query parameters
after, limit- Credential
- Platform Key or web session
the pull event feed. The tenant's own signed outbox announcements (Review published; Resolution published, finalized, corrected), oldest first in (recorded_at, id) order, each exactly as signed. Read-only: no delivery state, no destination and no webhook. Omitting after starts from the beginning; pass next_cursor as after to continue, and poll with the last one. A cursor issued to another tenant is refused, and one older than the retention window refuses with cursor_expired. Advisory only.
Methods
The declared method and version behind each Review.
Read a Method version
GET /v1/methods/{id}
- Operation id
get_v1_methods_id- Request body
- None
- Response
Method- Path parameters
id- Query parameters
version- Credential
- Platform Key or web session
Return the explicit method version; never silently substitute latest. Advisory only.
Forecast Questions
Sealed forecasts and their resolutions; outside the campaign workflow.
Read a Question
GET /v1/questions/{id}
- Operation id
get_v1_questions_id- Request body
- None
- Response
Question- Path parameters
id- Credential
- Platform Key or web session
read the frozen Question and current state inside its Idea. Advisory only.
Read a commitment
GET /v1/commitments/{id}
- Operation id
get_v1_commitments_id- Request body
- None
- Response
Commitment- Path parameters
id- Credential
- Platform Key or web session
reopen a sealed Commitment receipt. Never plaintext. Advisory only.
Read a resolution
GET /v1/resolutions/{id}
- Operation id
get_v1_resolutions_id- Request body
- None
- Response
Resolution- Path parameters
id- Credential
- Platform Key or web session
Read exact immutable signed Resolution ID, including superseded versions. Advisory only.
Create a forecast Question
POST /v1/questions
- Operation id
post_v1_questions- Request body
QuestionCreate- Response
Question- Credential
- Platform Key or web session
Freeze rule with source priorities/target; resolve authorization default at intake. Advisory only.
Seal a forecast commitment
POST /v1/questions/{id}/commitments
- Operation id
post_v1_questions_id_commitments- Request body
CommitmentCreate- Response
Commitment- Path parameters
id- Credential
- Platform Key or web session
Server time must be strictly before lock. Validate ciphertext/envelope sizes and store immutable receipt. Advisory only.
Read a commitment's Review
GET /v1/commitments/{id}/review
- Operation id
get_v1_commitments_id_review- Request body
- None
- Response
Review- Path parameters
id- Credential
- Platform Key or web session
Reviewer opens input only, never outcome; history stays beside the Review. Advisory only.
Read a Question's resolution
GET /v1/questions/{id}/resolution
- Operation id
get_v1_questions_id_resolution- Request body
- None
- Response
Resolution or ResolutionStatus- Path parameters
id- Credential
- Platform Key or web session
Current signed version, or not_yet; source failure parks without a guessed outcome. Advisory only.
Read a commitment's Result
GET /v1/commitments/{id}/score
- Operation id
get_v1_commitments_id_score- Request body
- None
- Response
Result- Path parameters
id- Credential
- Platform Key or web session
Scorer verifies digest after Resolution and returns accuracy Result, never blended Review/Result. Advisory only.
Dispute a resolution
POST /v1/resolutions/{id}/disputes
- Operation id
post_v1_resolutions_id_disputes- Request body
DisputeCreate- Response
Dispute- Path parameters
id- Credential
- Platform Key or web session
Creator/committer standing, within window, one open dispute per party/version; fresh blind pass. Advisory only.
Follow resolution corrections
GET /v1/tenants/me/corrections
- Operation id
get_v1_tenants_me_corrections- Request body
- None
- Response
CorrectionsCursor- Query parameters
cursor- Credential
- Platform Key or web session
Tenant-scoped oldest-first superseding finalized versions, replayable; expiry requires snapshot. Advisory only.
Read the current evaluation key
GET /v1/evaluation-keys/current
- Operation id
get_v1_evaluation_keys_current- Request body
- None
- Response
EvaluationKey- Credential
- Platform Key or web session
Tenant evaluation public material only; old keys kept in custody for old sealed openings. Advisory only.
Read a verification key
GET /v1/verification-keys/{id}
- Operation id
get_v1_verification_keys_id- Request body
- None
- Response
VerificationKey- Path parameters
id- Credential
- Platform Key or web session
Read verification material; fixture keys never trusted as production. Advisory only.
Read a tier-2 quote
GET /v1/questions/{id}/tier2-quote
- Operation id
get_v1_questions_id_tier2_quote- Request body
- None
- Response
Tier2Quote- Path parameters
id- Credential
- Platform Key or web session
Read-only quote and authorization decision; does not commence work. Advisory only.
Read a Question's sealed commitment
GET /v1/questions/{id}/commitment
- Operation id
get_v1_questions_id_commitment- Request body
- None
- Response
CommitmentReceipt- Path parameters
id- Credential
- Platform Key or web session
the Commitment receipt this workspace already sealed for the Question, so a reload does not seal twice. No sealed payload. Advisory only.
Public
Projections a workspace owner chose to publish; no credential needed.
List public forecast Records
GET /v1/public/bench
- Operation id
get_v1_public_bench- Request body
- None
- Response
BenchList- Query parameters
after- Credential
- None
public forecast Record projections. Advisory only.
Compare two public forecast Records
GET /v1/public/bench/compare
- Operation id
get_v1_public_bench_compare- Request body
- None
- Response
BenchComparison- Query parameters
left, right- Credential
- None
matched binary forecast outcomes, existing minimum-data floor. Advisory only.
Read a public forecast Record
GET /v1/public/bench/{id}
- Operation id
get_v1_public_bench_id- Request body
- None
- Response
BenchEntry- Path parameters
id- Credential
- None
one declared participant and its public forecast Record. Advisory only.
List public forecast Questions
GET /v1/public/library
- Operation id
get_v1_public_library- Request body
- None
- Response
LibraryList- Query parameters
after, domain- Credential
- None
browse immutable library projections. Advisory only.
Read a public forecast Question
GET /v1/public/library/{id}
- Operation id
get_v1_public_library_id- Request body
- None
- Response
LibraryQuestion- Path parameters
id- Credential
- None
one frozen public Question. Advisory only.
Read a public Record
GET /v1/public/records/{id}
- Operation id
get_v1_public_records_id- Request body
- None
- Response
PublicRecord- Path parameters
id- Credential
- None
read the prepared public projection only. Advisory only.
Read a public scorecard
GET /v1/public/scorecards/{id}
- Operation id
get_v1_public_scorecards_id- Request body
- None
- Response
PublicScorecard- Path parameters
id- Credential
- None
read the prepared public projection only. Advisory only.
Read a public Result
GET /v1/public/results/{id}
- Operation id
get_v1_public_results_id- Request body
- None
- Response
PublicResult- Path parameters
id- Credential
- None
read the prepared public projection only. Advisory only.