Skip to main content

​
Prerequisites

  • A deployed Guard API (your administrator creates this in Citadel)
  • The API endpoint URL (https://api.starfort.aim-intelligence.com/v1/guard/{api-id}/analyze)
  • A valid API key

​
Your first request

curl -X POST https://api.starfort.aim-intelligence.com/v1/guard/{api-id}/analyze \
  -H "Authorization: Bearer $STARFORT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      { "role": "user", "content": "Please summarize the attached document." }
    ]
  }'

​
What you get back

{
  "guardian": "Text Analysis Guardian",
  "action": "PASS",
  "processed_content": "Please summarize the attached document.",
  "results": {
    "PII":   { "action": "PASS", "detected_count": 0, "detected_items": [] },
    "TOPIC": { "action": "PASS", "detected_count": 0, "detected_items": [] }
  },
  "processing_time_ms": 156
}

​
Next

Request format

Response format