Skip to main content
GET
/
api
/
v1
/
agents
/
{ref}
/
reports
List reports
curl --request GET \
  --url https://gateway.sanfoundation.com/api/v1/agents/{ref}/reports \
  --header 'x-api-key: <api-key>'
{
  "agent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalId": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "domain": "<string>",
    "description": "<string>"
  },
  "count": 123,
  "reports": [
    {
      "reportId": "<string>",
      "agentSlug": "<string>",
      "agentCodename": "<string>",
      "title": "<string>",
      "summary": "<string>",
      "analysis": "<string>",
      "coverageWindow": {
        "windowType": "<string>",
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "asOf": "2023-11-07T05:31:56Z",
      "generatedAt": "2023-11-07T05:31:56Z",
      "sourceEventIds": [
        "<string>"
      ],
      "region": [
        "<string>"
      ],
      "situation": {
        "headline": "<string>",
        "what_happened": "<string>",
        "what_changed": "<string>",
        "why_it_matters": "<string>"
      },
      "decisionAdvantage": {
        "personal": {
          "bottom_line": "<string>",
          "recommended_posture": "<string>",
          "time_horizon": "<string>"
        },
        "research": {
          "bottom_line": "<string>",
          "recommended_posture": "<string>",
          "time_horizon": "<string>"
        },
        "business_operations": {
          "bottom_line": "<string>",
          "recommended_posture": "<string>",
          "time_horizon": "<string>"
        },
        "trading_investments": {
          "bottom_line": "<string>",
          "recommended_posture": "<string>",
          "time_horizon": "<string>"
        }
      },
      "nextLikelyDevelopments": [
        "<string>"
      ],
      "confidence": {
        "overall": "low",
        "notes": [
          "<string>"
        ]
      },
      "trend": "stable",
      "generationReason": "<string>",
      "triggerType": "<string>",
      "changeScore": 123,
      "inboundSignalIds": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

SAN-issued API key (sk_…) issued from the SAN Agents Dashboard (Settings → API Keys). Used by every /api/v1/* endpoint; usage is billed in credits against the owning account's active Stripe subscription.

Path Parameters

​
ref
string
required

Flexible agent identifier. Accepts any of:

  • UUID — 488ed3ff-6a4d-42e5-8e24-44eeef77959c
  • Name (case-insensitive) — Noah, noah, NOAH
  • Slug — lowercase name with spaces as underscores
  • External ID — 017, 17, 069, 69 (# and zero-padding tolerated)

Query Parameters

​
limit
integer
default:1

Max number of reports to return.

Required range: 1 <= x <= 3

Response

OK — recent generated reports for the agent.

​
agent
object
required
​
count
integer
required
​
reports
object[]
required