# docs.tryenvoy.ai

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.tryenvoy.ai/_mcp/server

## Docs

- [Introduction](https://docs.tryenvoy.ai/guides/getting-started/introduction.md): AI-powered freight logistics automation through a single REST API.
- [Authentication](https://docs.tryenvoy.ai/guides/getting-started/authentication.md): Every API request requires authentication via Bearer token or API key.
- [Quickstart](https://docs.tryenvoy.ai/guides/getting-started/quickstart.md): Create a load, find carrier matches, and track offers in under 5 minutes.
- [Prefixed IDs](https://docs.tryenvoy.ai/guides/core-concepts/prefixed-i-ds.md): Every resource has a self-describing prefixed identifier.
- [Pagination](https://docs.tryenvoy.ai/guides/core-concepts/pagination.md): All list endpoints return paginated responses with a consistent envelope.
- [Error Handling](https://docs.tryenvoy.ai/guides/core-concepts/error-handling.md): Structured error responses with machine-readable codes for reliable integration.
- [Rate Limits](https://docs.tryenvoy.ai/guides/core-concepts/rate-limits.md): Understand request limits and how to handle throttling.
- [Webhooks](https://docs.tryenvoy.ai/guides/core-concepts/webhooks.md): Receive events as HTTPS POSTs to your endpoint. Standard Webhooks compliant.
- [ELP Tests](https://docs.tryenvoy.ai/guides/use-cases/elp-tests.md): Administer English Language Proficiency tests over the phone, then receive structured scores via webhook.

## API Docs

- Endpoints > API Keys [Create an API key](https://docs.tryenvoy.ai/api-reference/endpoints/api-keys/create.md)
- Endpoints > API Keys [List API keys](https://docs.tryenvoy.ai/api-reference/endpoints/api-keys/list.md)
- Endpoints > API Keys [Get an API key](https://docs.tryenvoy.ai/api-reference/endpoints/api-keys/get.md)
- Endpoints > API Keys [Deactivate an API key](https://docs.tryenvoy.ai/api-reference/endpoints/api-keys/delete.md)
- Endpoints > Loads [Create a load](https://docs.tryenvoy.ai/api-reference/endpoints/loads/create.md)
- Endpoints > Loads [Batch create loads](https://docs.tryenvoy.ai/api-reference/endpoints/loads/batch-create.md)
- Endpoints > Loads [List loads](https://docs.tryenvoy.ai/api-reference/endpoints/loads/list.md)
- Endpoints > Loads [Get a load](https://docs.tryenvoy.ai/api-reference/endpoints/loads/get.md)
- Endpoints > Loads [Update a load](https://docs.tryenvoy.ai/api-reference/endpoints/loads/update-load-api-v-1-loads-load-id-patch.md)
- Endpoints > Loads [Get load statistics](https://docs.tryenvoy.ai/api-reference/endpoints/loads/get-stats.md)
- Endpoints > Carriers [Create a carrier](https://docs.tryenvoy.ai/api-reference/endpoints/carriers/create.md)
- Endpoints > Carriers [Batch create carriers](https://docs.tryenvoy.ai/api-reference/endpoints/carriers/batch-create.md)
- Endpoints > Carriers [List carriers](https://docs.tryenvoy.ai/api-reference/endpoints/carriers/list.md)
- Endpoints > Carriers [Get a carrier](https://docs.tryenvoy.ai/api-reference/endpoints/carriers/get.md)
- Endpoints > Carriers [Update a carrier](https://docs.tryenvoy.ai/api-reference/endpoints/carriers/update.md)
- Endpoints > Carriers [Re-enable a previously disabled carrier](https://docs.tryenvoy.ai/api-reference/endpoints/carriers/enable-carrier-api-v-1-carriers-carrier-id-enable-post.md)
- Endpoints > Carriers [Disable a carrier organization-wide](https://docs.tryenvoy.ai/api-reference/endpoints/carriers/disable-carrier-api-v-1-carriers-carrier-id-disable-post.md)
- Endpoints > Lane Preferences [List a carrier's lane preferences](https://docs.tryenvoy.ai/api-reference/endpoints/lane-preferences/list-carrier-lane-preferences-api-v-1-carriers-carrier-id-lane-preferences-get.md)
- Endpoints > Lane Preferences [Toggle a lane preference's is_active flag](https://docs.tryenvoy.ai/api-reference/endpoints/lane-preferences/update-lane-preference-api-v-1-carriers-carrier-id-lane-preferences-preference-id-patch.md)
- Endpoints > Lane Preferences [Restrict a carrier on a specific lane](https://docs.tryenvoy.ai/api-reference/endpoints/lane-preferences/restrict-lane-preference-api-v-1-carriers-carrier-id-lane-preferences-preference-id-restrict-post.md)
- Endpoints > Lane Preferences [Re-enable a carrier on a previously restricted lane](https://docs.tryenvoy.ai/api-reference/endpoints/lane-preferences/unrestrict-lane-preference-api-v-1-carriers-carrier-id-lane-preferences-preference-id-unrestrict-post.md)
- Endpoints > Lane Preferences [Disable a carrier for a load's lane](https://docs.tryenvoy.ai/api-reference/endpoints/lane-preferences/disable-carrier-for-load-api-v-1-carriers-carrier-id-lane-preferences-disable-for-load-post.md)
- Endpoints > Calls [Create a call](https://docs.tryenvoy.ai/api-reference/endpoints/calls/create.md)
- Endpoints > Calls [List calls](https://docs.tryenvoy.ai/api-reference/endpoints/calls/list.md)
- Endpoints > Calls [Get a call](https://docs.tryenvoy.ai/api-reference/endpoints/calls/get.md)
- Endpoints > Calls [Join a call](https://docs.tryenvoy.ai/api-reference/endpoints/calls/join.md)
- Endpoints > Calls [End a call](https://docs.tryenvoy.ai/api-reference/endpoints/calls/end.md)
- Endpoints > Calls [Get call recording](https://docs.tryenvoy.ai/api-reference/endpoints/calls/get-recording.md)
- Endpoints > Outreaches [Initiate carrier outreach](https://docs.tryenvoy.ai/api-reference/endpoints/outreaches/create-outreach-api-v-1-outreaches-post.md)
- Endpoints > Outreaches [List outreaches](https://docs.tryenvoy.ai/api-reference/endpoints/outreaches/list.md)
- Endpoints > Outreaches [Get an outreach record](https://docs.tryenvoy.ai/api-reference/endpoints/outreaches/get.md)
- Endpoints > Offers [Create an offer](https://docs.tryenvoy.ai/api-reference/endpoints/offers/create.md)
- Endpoints > Offers [List offers](https://docs.tryenvoy.ai/api-reference/endpoints/offers/list.md)
- Endpoints > Offers [Get an offer](https://docs.tryenvoy.ai/api-reference/endpoints/offers/get.md)
- Endpoints > Offers [Update an offer](https://docs.tryenvoy.ai/api-reference/endpoints/offers/update.md)
- Endpoints > ELP [Initiate an ELP assessment call](https://docs.tryenvoy.ai/api-reference/endpoints/elp/create-test.md)
- Endpoints > ELP [List ELP assessment tests](https://docs.tryenvoy.ai/api-reference/endpoints/elp/list-results.md)
- Endpoints > ELP [Get an ELP test](https://docs.tryenvoy.ai/api-reference/endpoints/elp/get-result.md)
- Endpoints [offer.updated](https://docs.tryenvoy.ai/api-reference/endpoints/offer-updated.md)
- Endpoints > API [Validate loads without saving](https://docs.tryenvoy.ai/api-reference/endpoints/api/validate-loads-api-v-1-loads-validate-post.md)
- Endpoints > API [Export loads to CSV](https://docs.tryenvoy.ai/api-reference/endpoints/api/export-loads-csv-api-v-1-loads-export-get.md)
- Endpoints > API [Tab counts for the loads list](https://docs.tryenvoy.ai/api-reference/endpoints/api/get-loads-counts-api-v-1-loads-counts-get.md)
- Endpoints > API [Search loads filter options](https://docs.tryenvoy.ai/api-reference/endpoints/api/get-load-filter-options-api-v-1-loads-filter-options-get.md)
- Endpoints > API [Assign or unassign loads to the AI agent](https://docs.tryenvoy.ai/api-reference/endpoints/api/assign-loads-to-ai-agent-api-v-1-loads-assign-ai-agent-post.md)
- Endpoints > API [Post or unpost loads](https://docs.tryenvoy.ai/api-reference/endpoints/api/set-loads-posted-api-v-1-loads-set-posted-post.md)
- Endpoints > API [Get calls for a load](https://docs.tryenvoy.ai/api-reference/endpoints/api/get-load-calls-api-v-1-loads-load-id-calls-get.md)
- Endpoints > API [Get failed carrier verifications for a load](https://docs.tryenvoy.ai/api-reference/endpoints/api/get-load-verifications-api-v-1-loads-load-id-verifications-get.md)
- Endpoints > API [Get active escalations for a load](https://docs.tryenvoy.ai/api-reference/endpoints/api/get-load-escalations-api-v-1-loads-load-id-escalations-get.md)
- Endpoints > API [Get the activity timeline for a load](https://docs.tryenvoy.ai/api-reference/endpoints/api/get-load-activity-api-v-1-loads-load-id-activity-get.md)
- Endpoints > API [List a carrier's verification history](https://docs.tryenvoy.ai/api-reference/endpoints/api/list-carrier-verifications-api-v-1-carriers-carrier-id-verifications-get.md)
- Endpoints > API [Set a carrier's global routing-guide priority tier](https://docs.tryenvoy.ai/api-reference/endpoints/api/set-carrier-routing-guide-tier-api-v-1-carriers-carrier-id-routing-guide-tier-put.md)
- Endpoints > API [Validate carriers without saving](https://docs.tryenvoy.ai/api-reference/endpoints/api/validate-carriers-api-v-1-carriers-validate-post.md)
- Endpoints > API [Validate lane preferences without saving](https://docs.tryenvoy.ai/api-reference/endpoints/api/validate-carrier-lane-preferences-api-v-1-carriers-lane-preferences-validate-post.md)
- Endpoints > API [Import carrier CSV rows](https://docs.tryenvoy.ai/api-reference/endpoints/api/import-carrier-csv-api-v-1-carriers-csv-batch-post.md)
- Endpoints > API [Import carrier-preference CSV rows](https://docs.tryenvoy.ai/api-reference/endpoints/api/import-carrier-preference-csv-api-v-1-carriers-csv-lane-preferences-batch-post.md)
- Endpoints > API [Batch create carrier lane preferences](https://docs.tryenvoy.ai/api-reference/endpoints/api/batch-create-carrier-lane-preferences-api-v-1-carriers-lane-preferences-batch-post.md)
- Endpoints > API [Add a lane preference, optionally blocked](https://docs.tryenvoy.ai/api-reference/endpoints/api/add-lane-preference-api-v-1-carriers-carrier-id-lane-preferences-post.md)
- Endpoints > API [Set a lane preference's routing-guide priority tier](https://docs.tryenvoy.ai/api-reference/endpoints/api/set-lane-preference-routing-guide-tier-api-v-1-carriers-carrier-id-lane-preferences-preference-id-routing-guide-tier-put.md)
- Endpoints > API [Do Not Use a carrier on a specific lane](https://docs.tryenvoy.ai/api-reference/endpoints/api/do-not-use-lane-preference-api-v-1-carriers-carrier-id-lane-preferences-preference-id-do-not-use-post.md)
- Endpoints > API [Lift a Do Not Use block on a specific lane](https://docs.tryenvoy.ai/api-reference/endpoints/api/allow-lane-preference-api-v-1-carriers-carrier-id-lane-preferences-preference-id-allow-post.md)
- Endpoints > API [List the shippers a carrier is blocked for](https://docs.tryenvoy.ai/api-reference/endpoints/api/list-carrier-shipper-dnu-api-v-1-carriers-carrier-id-shipper-dnu-get.md)
- Endpoints > API [Do Not Use a carrier for a shipper](https://docs.tryenvoy.ai/api-reference/endpoints/api/do-not-use-shipper-api-v-1-carriers-carrier-id-shipper-dnu-post.md)
- Endpoints > API [Lift a shipper Do Not Use block](https://docs.tryenvoy.ai/api-reference/endpoints/api/allow-shipper-api-v-1-carriers-carrier-id-shipper-dnu-allow-post.md)
- Endpoints > API [Offer feed](https://docs.tryenvoy.ai/api-reference/endpoints/api/offer-feed-api-v-1-offers-feed-get.md)
- Endpoints > API [Upload a raw CSV file](https://docs.tryenvoy.ai/api-reference/endpoints/api/upload-csv-api-v-1-uploads-csv-post.md)
- Endpoints > API [Log a terminal CSV import summary](https://docs.tryenvoy.ai/api-reference/endpoints/api/log-csv-import-summary-api-v-1-uploads-csv-import-summary-post.md)
- Endpoints > API [List webhook endpoints](https://docs.tryenvoy.ai/api-reference/endpoints/api/list-endpoints-api-v-1-webhooks-endpoints-get.md)
- Endpoints > API [Register a webhook endpoint](https://docs.tryenvoy.ai/api-reference/endpoints/api/create-endpoint-api-v-1-webhooks-endpoints-post.md)
- Endpoints > API [Get a webhook endpoint](https://docs.tryenvoy.ai/api-reference/endpoints/api/get-endpoint-api-v-1-webhooks-endpoints-endpoint-id-get.md)
- Endpoints > API [Delete a webhook endpoint](https://docs.tryenvoy.ai/api-reference/endpoints/api/delete-endpoint-api-v-1-webhooks-endpoints-endpoint-id-delete.md)
- Endpoints > API [Update a webhook endpoint](https://docs.tryenvoy.ai/api-reference/endpoints/api/update-endpoint-api-v-1-webhooks-endpoints-endpoint-id-patch.md)
- Endpoints > API [Rotate the signing secret](https://docs.tryenvoy.ai/api-reference/endpoints/api/rotate-secret-api-v-1-webhooks-endpoints-endpoint-id-rotate-secret-post.md)
- Endpoints > API [List delivery attempts for an endpoint](https://docs.tryenvoy.ai/api-reference/endpoints/api/list-messages-for-endpoint-api-v-1-webhooks-endpoints-endpoint-id-messages-get.md)
- Endpoints > API [List attempts for a logical message](https://docs.tryenvoy.ai/api-reference/endpoints/api/list-attempts-for-message-api-v-1-webhooks-messages-message-id-attempts-get.md)
- Endpoints > API [Replay a delivery](https://docs.tryenvoy.ai/api-reference/endpoints/api/replay-message-api-v-1-webhooks-messages-message-id-replay-post.md)
- Endpoints > API [List subscribable event types](https://docs.tryenvoy.ai/api-reference/endpoints/api/list-event-types-api-v-1-webhooks-event-types-get.md)
- Endpoints > API [Verification feed](https://docs.tryenvoy.ai/api-reference/endpoints/api/verification-feed-api-v-1-verifications-feed-get.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.tryenvoy.ai/openapi.json)
- [OpenAPI YAML](https://docs.tryenvoy.ai/openapi.yaml)