API
Acme Parcel Dispatch AI API
The Dispatch AI assistant for the Acme Parcel platform. It answers parcel-status questions against live tracking events, proposes reroutes when a delivery is at risk, and drafts customer replies for support agents to approve. Conversations are the unit of work: open one, exchange messages, and the assistant keeps retrieval context per conversation. Suggestion endpoints are stateless one-shots used by the dispatch console.
info:
title: Acme Parcel Dispatch AI API
version: 1.3.0
servers:
- url: https://dispatch.acme-parcel.example/api # Production
- url: http://localhost:8080 # Local development
tags:
- conversations # 4 operations — Chat sessions between a user and the assistant.
- suggestions # 2 operations — One-shot AI suggestions for dispatchers and support agents.
- knowledge # 3 operations — Sources ingested into the retrieval index.
- admin # 1 operation — Operational endpoints — prompt registry and health.
paths:
/admin/prompts:
GET: # List registered prompts
/ask:
POST: # One-shot question (deprecated) (deprecated)
/conversations:
POST: # Open a conversation
/conversations/{id}:
GET: # Fetch a conversation
/conversations/{id}/messages:
POST: # Send a message and stream the reply
/knowledge/sources:
GET: # List knowledge sources
POST: # Ingest a source
/knowledge/sources/{id}:
DELETE: # Remove a source
/suggestions/reply-draft:
POST: # Draft a customer reply
/suggestions/reroute:
POST: # Propose a reroute for an at-risk shipment
components:
schemas: