> ## Documentation Index > Fetch the complete documentation index at: https://docs.lanesurf.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > You are reading the Lanesurf Agent API docs. Start with /for-ai-agents.md for the rules an agent must follow. > The API is at https://agent.lanesurf.com and the MCP server at https://agent.lanesurf.com/mcp. Lanesurf doesn't send webhooks: poll. > Limits: /rate-limits.md. Keys: /api-keys.md. Safe retries: /idempotency.md. Every route on one page: /api-reference.md. > Always confirm with the person before accepting a carrier offer or bidding on a load. Never reveal an API key, and never show broker contact details to a carrier. > The full contract is at /openapi.yaml. > Sign up with POST /v1/signup (carrier or broker, a work email, an MC and/or DOT number), then POST /v1/signup/{signup_id}/verify. Follow next_step on every signup answer. # Get brokerage setup > What Lanesurf's agents tell carriers about your brokerage, and whether outreach is on. What Lanesurf's agents tell carriers about the brokerage: company name, MC/DOT, working hours, payment terms, who is copied on carrier emails, `ask_first_pricing`, and whether carriers' AI agents can see your loads (`loads_visible_to_carriers`). `outreach.activated` is `false` for a brokerage that signed up through the API until Lanesurf reviews it and turns carrier outreach on. ## OpenAPI ````yaml /openapi.yaml get /v1/broker/setup openapi: 3.1.0 info: title: Lanesurf Agent API version: 0.4.0 summary: >- Let any AI agent get a freight load covered, or get a truck loaded, through Lanesurf. description: > Lanesurf finds carriers for freight loads by email, phone and text, and negotiates the rate. This API lets AI agents (Claude, ChatGPT, Grok, Cursor and others) and scripts use Lanesurf directly. There are two kinds of caller: - **Broker agents** ("cover this load for me"): post a load as JSON fields, send any fields Lanesurf says are missing, then read carrier offers and pick one. Paths under `/v1/loads`. - **Carrier / dispatcher agents** ("find a load for my truck"): post trucks and lanes, search loads, and bid on a load. Paths under `/v1/carrier`. Every request (except signup and `/health`) uses `Authorization: Bearer ls_live_...`. - A **broker key** belongs to one rep at a brokerage. It reaches only loads that brokerage posted through this API, whichever of the brokerage's reps posted them. It never reaches loads that came from the brokerage's TMS or from other brokerages. - A **carrier key** belongs to one carrier signup. Its trucks, lanes and bids are its own; no other key sees them. Load search covers active loads from Lanesurf brokers that show their loads to carriers' agents, without broker identity or contacts. Only **verified** carrier keys can read loads (search, one load, matches) and bid; keys whose carrier account is under review (`needs_review`) get `403 verification_required` there. Anyone can get a key with `POST /v1/signup` (carrier or broker, a work email, an MC and/or DOT number) and `POST /v1/signup/{signup_id}/verify`. Every signup reply has `next_step`, which tells an agent what to do next. A brokerage that signs up starts with carrier outreach off until Lanesurf reviews it. Broker keys can't call `/v1/carrier/*` and carrier keys can't call `/v1/loads/*` (`403 wrong_role`). Every response has an `X-Request-Id` header, and every error body a `request_id`. Send your own `X-Request-Id` (8-64 letters, digits, `.`, `_` or `-`) to have it used instead. Quote it to Lanesurf support when something fails. Every authenticated `/v1` route is limited to 120 requests per minute per API key, counted on each Lanesurf server (treat it as the most to send). Over the limit you get `429 rate_limited` with a `Retry-After` header. **Lists.** Your loads (`GET /v1/loads`) come a page at a time: `limit` (1 to 100, default 25), then send `next_cursor` back as `cursor` until it is `null`. Load search (`GET /v1/carrier/loads/search`) and truck matches (`GET /v1/carrier/trucks/{truck_id}/matches`) take `limit` (1 to 100, default 25) and return the closest loads first (see each route), with `total` = the number returned. There is no `offset` or cursor: to see other loads, narrow or change the search. The other lists have no paging and return the newest items up to a cap: trucks 200, lanes 500, bids 200, and a carrier's outreach 50 loads (from the last 30 days). A load's outreach lists every carrier on that load. Lanesurf doesn't send webhooks: poll a load (`GET /v1/loads/{id}`) or your bids (`GET /v1/carrier/bids`) every few minutes. Versioning, limits and changes: see https://docs.lanesurf.com/versioning, https://docs.lanesurf.com/rate-limits and https://docs.lanesurf.com/changelog. contact: name: Lanesurf support url: https://docs.lanesurf.com email: support@lanesurf.com license: name: Proprietary. Use is subject to the Lanesurf Terms of Service url: https://www.lanesurf.com/terms servers: - url: https://agent.lanesurf.com description: Production security: - bearerAuth: [] tags: - name: Broker loads description: A broker's agent posts a load and gets it covered. - name: Authentication description: >- Sign up as a carrier or a brokerage with a work email and a one-time code, and see who a key belongs to. - name: Broker setup description: >- What Lanesurf's agents tell carriers about a brokerage, and whether carrier outreach is on. - name: Carrier trucks description: A carrier's agent says where its trucks are and when they're free. - name: Carrier lanes description: A carrier's agent saves the lanes the carrier runs (its terminals). - name: Carrier loads description: A carrier's agent finds loads, bids on one, and follows its bids. - name: System description: Service health. paths: /v1/broker/setup: get: tags: - Broker setup summary: Your brokerage's setup description: > What Lanesurf's agents tell carriers about the brokerage (company name, MC/DOT, working hours, payment terms, CC emails, ask_first_pricing), whether carriers' AI agents see its loads (loads_visible_to_carriers) and whether carrier outreach is on. outreach.activated is false for a brokerage that signed up through the API until Lanesurf reviews it. operationId: getBrokerSetup responses: '200': description: The setup. headers: Cache-Control: $ref: '#/components/headers/NoStore' content: application/json: schema: $ref: '#/components/schemas/BrokerSetup' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/WrongRole' '404': description: '`not_found`: Lanesurf has no setup for this brokerage yet.' content: application/json: schema: $ref: '#/components/schemas/Error' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/Internal' '502': $ref: '#/components/responses/Upstream' '503': description: >- `unavailable`: Lanesurf couldn't check the API key right now (the key may be fine; don't ask for a new one): wait `Retry-After` (30) seconds and send the same request again. Or brokerage setup can't run right now; retry later. content: application/json: schema: $ref: '#/components/schemas/Error' components: headers: NoStore: description: Responses that carry secrets are never cached. schema: type: string example: no-store RetryAfter: description: Seconds to wait before trying again. schema: type: integer schemas: BrokerSetup: type: object required: - company_name - cc_emails - ask_first_pricing - loads_visible_to_carriers - outreach properties: company_name: type: string description: What Lanesurf's agents call the brokerage. mc_number: type: - string - 'null' dot_number: type: - string - 'null' working_hours: type: - string - 'null' example: Mon-Fri 7am-6pm CT payment_terms: type: - string - 'null' example: Net 30; quick pay 2% cc_emails: type: array items: type: string format: email description: Who Lanesurf copies on carrier email threads. ask_first_pricing: type: boolean description: >- `true`: the agents ask the carrier for their rate before quoting one. loads_visible_to_carriers: type: boolean description: >- `true`: carriers' AI agents can search and bid on this brokerage's loads through the Agent API. Off until the broker turns it on. outreach: type: object required: - activated - email - phone properties: activated: type: boolean description: >- `false` until Lanesurf reviews a brokerage that signed up through the API. Always `true` for brokerages Lanesurf onboarded. email: type: boolean description: Whether Lanesurf emails carriers when a load is posted. phone: type: boolean description: Whether Lanesurf calls carriers when a load is posted. Error: type: object required: - error - code properties: error: type: string description: A message for people. example: invalid API key code: type: string description: A stable machine-readable code. Branch on this, not on `error`. enum: - missing_api_key - invalid_api_key - wrong_role - verification_required - invalid_request - missing_fields - not_found - already_covered - invalid_state - already_bid - bid_decided - idempotency_in_progress - idempotency_key_reused - idempotency_key_required - load_rejected - offer_changed - bid_update_limit - existing_customer - already_redeemed - rate_limited - invalid_code - signup_expired - broker_name_taken - broker_name_mismatch - unavailable - upstream_error - internal example: invalid_api_key missing: type: array description: '`missing_fields` only: exact field names or paths still needed.' items: type: string next_step: allOf: - $ref: '#/components/schemas/NextStep' description: >- On signup errors and on every broker load tool's errors (`list_loads`, `post_load`, `get_load`, `load_outreach`, accept, decline, covered). current_rate: type: number description: '`offer_changed` only: the offer''s rate now.' request_id: type: string description: >- This request's id (also the `X-Request-Id` response header). Quote it to Lanesurf support. example: req_0192f3a4-7b1c-7d2e-9f00-1a2b3c4d5e6f NextStep: type: string description: >- For the agent. Exactly what to do next and which MCP tool to call (REST path in brackets). responses: Unauthorized: description: >- `missing_api_key` (no `Authorization` header) or `invalid_api_key` (wrong, malformed or revoked key). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: invalid API key code: invalid_api_key WrongRole: description: >- `wrong_role`: this key's role can't use this route (a carrier key on a broker route, or the reverse). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: this API key can't use broker routes code: wrong_role TooManyRequests: description: > `rate_limited`: too many requests. Signup has limits per contact, per carrier and per IP (the 300 per 10 minutes limit groups IPv6 addresses by /64). Every authenticated `/v1` route is limited to 120 requests per minute per API key, counted on each Lanesurf server. Wait `Retry-After` seconds, then retry. headers: Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' example: error: too many requests for this API key; slow down code: rate_limited Internal: description: '`internal`: unexpected error. Safe to retry later.' content: application/json: schema: $ref: '#/components/schemas/Error' Upstream: description: >- `upstream_error`: a Lanesurf system behind the API failed. Safe to retry later. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: a Lanesurf system behind the API failed; try again later code: upstream_error securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: ls_live_ description: One key per broker rep or per carrier signup. Keep it secret. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.