Nash API Documentation for LLMs
Give the LLM the API documentation in a machine-readable format:- Complete API Documentation: https://docs.usenash.com/llms-full.txt
- Condensed Documentation: https://docs.usenash.com/llms.txt
Example Prompt
Best Practices for Using LLMs with Nash API
- Provide Clear Context: Share the relevant Nash API documentation links with the LLM
- Be Specific: Clearly describe your use case and requirements
- Include Complete Information: When troubleshooting, share error messages and API responses
Key Integration Areas Where LLMs Can Help
- Understanding Nash Concepts: Orders, Jobs, Batch Jobs, Dispatch Strategies
- API Request/Response Formatting: Generate code samples for API calls
- Webhook Implementation: Set up secure webhook handlers for delivery updates
- Error Handling: Understand and resolve API error responses
Keep sensitive data out of the prompt
The documentation links above are safe to share — they’re public. Your operational data is not. Treat anything you paste into a third-party LLM as if it could be retained or used for training, and keep these out of the prompt:- Credentials — API keys, tokens,
Authorizationheaders, webhook signing secrets. - Customer and recipient PII — names, dropoff addresses, phone numbers, email addresses.
- Identifiers that map back to your operation — organization IDs,
Nash-Org-Id, order/job IDs, request IDs. - Raw API responses and webhook payloads — these bundle several of the above together. Redact before sharing.
<API_KEY>, <ORG_ID>, 123 Main St) before pasting. The structure is what the model needs; the real values are not.
For comprehensive integration guidance, refer to our Plan Your Integration documentation.