Skip to content
RouteDeskDevelopers

Get started

Build with an AI agent

Let Claude, Codex or another coding agent write the integration. Give it these docs in the form it reads best, then review what it builds.

Paste this prompt

  1. Open your agent in your own codebase, the one that holds your leads.
  2. Paste the prompt beside this text. It points the agent at the full reference, so you don't have to copy the docs in.
  3. Answer its questions about how your fields map onto RouteDesk's.
  4. Review the code before it sends anything to a broker.
Prompt for Claude, Codex or another agent
I am integrating our system with the RouteDesk lead intake API, to send our leads to an auto transport broker.

1. Read the full reference: https://developer.routedesk.com/llms-full.txt
   (OpenAPI spec, if useful: https://developer.routedesk.com/openapi.json)
2. Find where leads are created or stored in this codebase.
3. Implement sending each new lead to RouteDesk in the standard format:
   - map our fields onto RouteDesk's fields;
   - read the Auth Key from the ROUTEDESK_AUTH_KEY environment variable;
   - handle every documented response and retry only as the docs say.
4. Test it against the shared demo account described in the reference, then add tests.

Follow the implementation checklist in the reference. Ask me if a field mapping is unclear.

Files made for agents

Every file is generated from the same source as these pages, so it is always current.

  • llms-full.txt: The complete documentation as one Markdown file: an implementation checklist, every field with its rules, every response with its body, limits, retries and testing.
  • openapi.json: An OpenAPI 3.1 spec of the endpoint, for agents and code generators that work from a spec.
  • llms.txt: An index of these docs, the standard file AI tools look for.

Getting a good result

  • Let the agent test against the demo account. The reference includes its Auth Key, so the agent can send test leads and you can see them by signing in. See Testing your integration.
  • Keep the live Auth Key out of the chat. Have the agent read it from an environment variable (the prompt asks for ROUTEDESK_AUTH_KEY) and set the value yourself.
  • Never paste real customer data into the agent or into test requests.
  • Check the field mapping yourself. A misspelled field is ignored rather than rejected, so compare a test lead with what you sent.