Pcap AI API Documentation | Integrate AI-Powered PCAP Analysis

Pcap AI Advanced REST API

Automate PCAP analysis & PDF report generation

Authentication

All endpoints require a Bearer token in the Authorization header. Advanced‑tier customers can generate API keys in My Account → New API Key.

# Example (bash)
export API_KEY="<your-key>"

POST /api/v1/upload

Upload a .pcap or .pcapng file. Returns a UUID you will use to poll job status and download the PDF.

Request

Headers: Authorization: Bearer <API_KEY>
Body: multipart/form-data with field file

cURL

curl -X POST \  \
  -H "Authorization: Bearer $API_KEY" \  \
  -F "file=@capture.pcap" \  \
  https://pcapai.com/api/v1/upload

Response (200)

{ "id": "d95f1a35-e923-4e7e-bd9c-3735f4b8b3ac" }

GET /api/v1/check

Poll processing status. When your PDF is ready it returns { "status": "done" }; otherwise you’ll receive 404 Not Found.

Request

Headers: Authorization
Query param: id=<UUID>

cURL

curl -H "Authorization: Bearer $API_KEY" \
  "https://pcapai.com/api/v1/check?id=$UPLOAD_ID"

Response (200)

{ "status": "done" }

GET /api/v1/download

Streams the PDF report inline. Default filename is <id>.pdf. Remember that files are retained for only 60 minutes.

Request

Headers: Authorization
Query param: id=<UUID>

cURL

curl -L -H "Authorization: Bearer $API_KEY" \
  -o report.pdf \
  "https://pcapai.com/api/v1/download?id=$UPLOAD_ID"

Response (200)

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: inline; filename="<id>.pdf"