canonical: https://jentic.com/apis/antsroute.com/antsroute # Antsroute API Jentic publishes the only available OpenAPI specification for Antsroute API, keeping it validated and agent-ready. Antsroute is a last-mile route-optimisation platform whose API exposes 74 endpoints for managing services, deliveries and collects, agents and their hourly plans, customers and absences, item types, skills, packages, and route planning under the /capi namespace. Agents can create orders, place them on a planning, search availability slots, and reconcile order status by external ID, supporting both schedule-and-dispatch and bring-your-own-route workflows. Authentication uses an API key sent in the cakey header. ## For AI agents Schedule, optimise, and track last-mile delivery and service orders through Antsroute's 74 endpoints. Drives orders, agents, skills, customers, and route planning end-to-end. ## Scope Does not handle payment collection, driver mobile-app UI, or warehouse inventory - use for delivery and service order scheduling, route planning, and agent management only. ## Capabilities - Create services, deliveries, and collect orders and place them on Antsroute's planning - Search availability slots and validate one before confirming a customer booking - Manage delivery agents along with their per-day hourly plans and skill sets - Reconcile order status using either Antsroute's internal ID or your own external reference - Maintain customer records including absences that block routing on certain dates - Configure item types, packages, and skills used by Antsroute's optimiser to assign work ## Use cases ### On-Demand Delivery Booking Let a customer-facing app book a delivery slot by calling the availability search endpoint with the address and required skills, then confirming the chosen slot to insert the order onto the planning. Antsroute's optimiser handles agent assignment, sequencing, and ETA calculation server-side, so the booking flow only deals with slot selection and confirmation rather than full route maths. Example prompt: Call the availability search endpoint for the customer's address, present the returned slots, then POST a service/delivery/collect order with the chosen slot ### External-ID-Driven Order Sync Synchronise orders between an upstream OMS or e-commerce platform and Antsroute by addressing each order via /capi/order/external-id/{externalId}. The agent can update, schedule, unschedule, or read status without storing Antsroute's internal IDs, which keeps the integration idempotent against retries and lets either side own the canonical reference. Example prompt: Call GET /capi/order/external-id/{externalId} to read the current status, then PATCH the schedule via /capi/order/external-id/unschedule or /capi/order/id/{id}/schedule/{scheduledDate} ### Agent and Skill Management Manage the rota that drives the optimiser by maintaining agents, their hourly plans, and the skills required for specific order types. The agent endpoints let dispatchers add a new courier, set a custom hourly plan for a peak day, and attach skills like 'cold chain' or 'heavy goods' so the optimiser only assigns matching orders to that agent. Example prompt: Call the agent skills endpoint to attach a 'cold chain' skill to a courier, then verify by reading /capi/agent/{agentEmail}/skills ### AI Agent Dispatch Operations via Jentic An AI agent embedded in a logistics ops console can drive Antsroute through Jentic without managing the cakey header directly. Jentic's intent search routes the agent to the correct /capi endpoint with its parameter schema, and the API key is loaded from the vault at execution time so it never enters the agent's tool context. Example prompt: Search Jentic for 'create a delivery order in Antsroute', load the order-creation endpoint, and execute with the customer address, parcel size, and required skills ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /capi/order/id/{id} | Retrieve an order by Antsroute internal ID | | GET | /capi/order/external-id/{externalId} | Retrieve an order by external reference | | POST | /capi/order/id/{id}/schedule/{scheduledDate} | Schedule an order for a specific date | | POST | /capi/order/unschedule | Unschedule a previously scheduled order | | GET | /capi/agent/{agentEmail}/skills | List skills assigned to an agent | | GET | /capi/agent/{agentEmail}/hourly-plans | Read an agent's hourly plan | | GET | /capi/customer/id/{id} | Retrieve a customer by ID | | GET | /capi/skill/{id} | Retrieve a skill definition | ## Key resources - **Service/Delivery/Collect** — Create, update, schedule, and unschedule orders that drive Antsroute's optimiser - **Route** — Read planned and historical routes per agent and date - **Agent** — Manage delivery agents, their hourly plans, and per-agent skills - **Customer** — Maintain customer records and per-customer absences - **Skill** — Define and assign skills the optimiser uses for matching - **Item type** — Catalogue of item types referenced by orders - **Package** — Package definitions used at order creation - **Search availabilities and validate one in your planning** — Slot search and confirmation flow for booking - **Customer absences** — Per-customer non-availability windows that affect routing - **Agent Hourly Plan** — Per-agent working hours used by the optimiser ## Why Jentic - **Setup:** Wiring the Antsroute API by hand means managing the cakey and finding the right routes across a 74-endpoint scheduling surface yourself. Through Jentic you install once, import Antsroute from the API Directory, store the API key once, and your agent calls it. - **Permission scoping:** Antsroute puts the order and agent id in the URL path (/order/id/{id}/schedule/..., /agent/{agentEmail}/skills), so a rule can pin your agent to one order or agent: it can read and schedule that order and nothing else. You choose the operations it may call, so an unschedule is not included unless you add it. - **Credential handling:** Your Antsroute cakey is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'schedule a delivery order' or 'get an agent's hourly plan', and Jentic returns the matching Antsroute operation with its input schema so the agent calls the right endpoint without navigating the 74-endpoint surface manually. ## Related APIs - **Routific API** — Routific is a route-optimisation API that solves the same vehicle-routing problem as Antsroute. - **Tookan API** — Tookan is a delivery management platform with task creation, dispatch, and tracking endpoints. - **Track-POD API** — Track-POD covers route planning, ePOD, and driver app for last-mile fleets. ## FAQ ### Why is there no official OpenAPI spec for Antsroute API? Antsroute exposes a Swagger UI at app.antsroute.com/v3/api-docs/public for partners but does not publish a versioned downloadable OpenAPI specification. Jentic captures the live spec, validates it, and keeps it agent-ready. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Antsroute API use? Antsroute uses an API key sent in the cakey header on every request. The key is generated from your Antsroute account under your name menu in the dashboard. Through Jentic the cakey is stored in the encrypted vault and injected at execution time, so the raw key never enters the agent's prompt context. ### Can I address Antsroute orders by my own external ID? Yes. /capi/order/external-id/{externalId} mirrors the internal-ID endpoints so you can read, schedule, and unschedule orders without storing Antsroute's IDs. This keeps integrations idempotent against retries and lets the upstream OMS own the canonical reference. ### What are the rate limits for the Antsroute API? The OpenAPI spec does not declare explicit rate limits. Antsroute applies per-tenant throughput on the live service - back off on 429 responses and confirm your plan's ceiling with Antsroute before high-volume slot searches. ### How do I create a delivery order in Antsroute through Jentic? Run pip install jentic, then search Jentic for 'create a delivery order in Antsroute'. Jentic returns the matching service/delivery/collect creation endpoint with its schema. Execute with the customer address, parcel detail, and any required skills; the cakey is injected from the vault. ### Does the Antsroute API support availability search before booking? Yes. The 'Search availabilities and validate one in your planning' endpoint group lets the agent query open slots for an address and skill set, then confirm one of the returned slots to insert the order onto the planning. ### Can I limit what my agent is allowed to do with the Antsroute API? Yes. Because you run Jentic One yourself, your own rules decide which Antsroute operations and credentials the agent may use. Antsroute puts the order and agent identifiers in the URL path, such as /capi/order/id/{id}/schedule/{scheduledDate} and /capi/agent/{agentEmail}/skills, so a rule can pin the agent to one order or one agent and let it read and schedule that order while touching nothing else. You choose the exact operations it may call, so an unschedule stays off limits unless you explicitly add it, and the cakey is injected at execution time rather than exposed to the agent.