Optimize Everything API Documentation

Welcome to the Optimize Everything API. This product hosts the creation, trading, and execution of transportation contracts so that riders, operators, and market makers can maximize total value. At its core, everyone has values—the things they want—and the ability to provide value to others. A Value Function models the value created (in money, positive or negative) from a Service using Parameters such as travel time, vehicle type, or convenience.

An agreement for one party to provide a Service to another for an amount specified by a Value Function is a Contract. Contracts can be created, auctioned by their creator, bought and sold, and even split. A person always pays the amount of Value actually created for them by the Service. Operators define Contracts whose Parameters are based on Contracts assigned to them, letting them express operational preferences and costs. Market Makers are algorithms that improve efficiency by buying, selling, and splitting Contracts to maximize value system‑wide.

This API is aimed at rideshare and mobility platforms that want to improve efficiency and customer experience with dynamic, multi‑leg routing and competitive allocation. It also integrates with transit and casual carpooling to bridge first/last‑mile gaps.

🎯 Target market

• People taking the bus who face long walks or multiple inefficient transfers
• Drivers who want to offset costs by carpooling
• Drivers who would prefer to take transit if it were more convenient

🚦 End-to-end process

1. Create accounts and verify identities Create rider, operator, and market‑maker accounts and attach the appropriate roles. Connect a verification provider to handle KYC, driving credentials, or program‑specific checks. Initiate verification requests and store results so that subsequent operations (bids, trips, payments) can reference verification status when needed.

   • Create User
   • Create Verification Service
   • Submit Verification Request
   • Review User Verifications
   • Create User Event Verification

2. Define pricing and business logic Value Functions turn operational Parameters (travel time, arrival time, transfer count, vehicle type, etc.) into monetary value, allowing each stakeholder to express preferences. Use the builder to compose reusable functions and persist them for contracts and bids.

   • Understand Value Functions
   • Value Function Builder
   • Create Value Function
   • Get Value Functions

3. Prepare supply Register vehicles and define their capabilities and constraints (capacity, type, accessibility). Provide schedules and availability windows so the optimizer can respect driver preferences.

   • Create Vehicle, Manage Vehicles
   • Create Schedule, Manage Schedules

4. Establish agreement Create Contracts that specify the Service, the applicable Value Function, and the operational Parameters that bind the parties. Contracts are auctioned by their creator and can be split or reassigned by market makers as value opportunities are detected.

   • Create Contract, Manage Contracts

5. Create demand Riders place Orders that describe origin, destination, timing, and preferences. Orders reference Value Functions so the system can quantify value trade‑offs (time vs. cost) during matching.

   • Create Order

6. Match supply and demand Operators and automated agents submit Bids against Orders, quoting the value they can deliver given current supply and constraints. Market makers optimize allocation by buying/selling contracts and choosing winning bids that maximize total created value.

   • Create Bid

7. Plan the trip Once bids are accepted, the system creates Legs that represent concrete segments (ride segment, transit ride). Trips assemble legs into a cohesive itinerary.

   • Create Legs
   • Create Trip
   • Trip Builder — interactive guide to generate legs and trips

8. Execute and track Execution is recorded with User Events (start, handoff, delay, complete). Events may require verification (e.g., driver identity, pickup confirmation) and feed back into value calculations for settlement.

   • Create User Event

9. Payments Settlement reflects the value actually created for the rider and the realized costs for the operator. Use payment endpoints to charge, refund, and reconcile with full traceability to contracts, bids, and events.

   • Payment Endpoints

🔗 API Reference

• Full API Reference — complete, low-level endpoint docs

---

Use the steps above to follow the lifecycle from onboarding to settlement. Click any link for details, or use the sidebar to jump to a specific area.