Find the insights and best practices about our product.
AI Cards

This endpoint returns the AI Cards your tenant publishes. Use it to track their status alongside the AI Systems they document. AI Cards your tenant receives from vendors are not in this list. They have their own routes, described in Endpoint Reference: Received AI Cards.

List AI Cards

Returns a paginated list of the AI Cards your tenant publishes.

Request

GET /api/public/aicards

Authentication

Bearer token. See Authentication & Generating Credentials.

Required Permission

Api_AiCards_Read

Query Parameters

ParameterTypeValue
limitintegerResults per page. Maximum 200.
cursorstringSync cursor. Omit on the first call to begin from the beginning. Pass nextCursor from the previous response on subsequent calls.
updatedAfterISO 8601 timestampReturn only records updated at or after this timestamp. Use to recover a lost cursor or reset to a known point in time.

Response Fields

FieldTypeRules
aiCardIdGUIDUnique identifier for the AI Card.
namestringCard name.
statusstringPublication lifecycle: Draft or Published.
validationStatusstringOutcome of Cranium's content validation: Pending or Validated. Independent of status; check both if you are gating on card readiness.
aiSystemIdGUIDThe AI System this card belongs to. Matches aiSystemId on GET /api/public/aisystems.
aiSystemNamestring or nullName of the associated AI System, denormalized for convenience.
createdAtISO 8601 timestampWhen the card was created.
updatedAtISO 8601 timestampWhen the card was last modified. null if it has never been modified since creation; treat updatedAt ?? createdAt as the effective last-changed time.

Sample Response

{
  "data": [
    {
      "aiCardId": "c4f12a8b-6d3e-4f5a-9b7c-1d2e3f4a5b6c",
      "name": "Fraud Detection Platform - AI Card",
      "status": "Published",
      "validationStatus": "Validated",
      "aiSystemId": "a2d78b6f-9c4c-4a7d-d16f-4e1d8c9b0f20",
      "aiSystemName": "Fraud Detection Platform",
      "createdAt": "2026-01-10T08:00:00Z",
      "updatedAt": "2026-06-01T20:11:09Z"
    },
    {
      "aiCardId": "d5a23b9c-7e4f-4a6b-ac8d-2e3f4a5b6c7d",
      "name": "Customer Support Assistant - AI Card",
      "status": "Draft",
      "validationStatus": "Pending",
      "aiSystemId": "b3e89c7a-0d5d-4b8e-e27a-5f2e9d0a1f31",
      "aiSystemName": "Customer Support Assistant",
      "createdAt": "2026-05-20T12:14:00Z",
      "updatedAt": null
    }
  ],
  "pagination": {
    "limit": 100,
    "nextCursor": "eyJ1cGRhdGVkQXQiOiIyMDI2LTA1LTIwVDEyOjE0OjAwWiIsImlkIjoiZDVhMjNiOWMifQ==",
    "hasMore": false
  },
  "error": null,
  "meta": {
    "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "timestamp": "2026-08-13T10:45:00Z"
  }
}

The card body is not exposed by this endpoint. It returns identity and status metadata only; there is no field carrying the card's questionnaire answers or attachments. hasMore: false with a non-null nextCursor is the normal end-of-feed state. Store the cursor and replay it on your next poll to pick up changes incrementally.

Error Responses

  • 400 VALIDATION_FAILED: the cursor is invalid, or cursor and updatedAfter were supplied together.
  • 401 UNAUTHORIZED: the token is missing, invalid or expired. Refresh the token and retry.
  • 403 Forbidden: the API client's role does not include Api_AiCards_Read. The response body names the missing permission in requiredPermission. Grant that permission to the API client's role, then retry. Retrying without the grant cannot succeed.
  • 500 INTERNAL_ERROR: an unexpected server error.
  • 503 Service Unavailable: permissions could not be verified. The request did not fail on its merits. Retry the request after a short wait.

The 403 and 503 responses use Content-Type: application/problem+json and a smaller body than the other errors. The body holds title, status and detail, plus requiredPermission on a 403. It has no error, meta or requestId.

Sample 403 response:

{
  "title": "Forbidden",
  "status": 403,
  "detail": "You don't have the Api_AiCards_Read permission needed for this request. Ask an administrator to grant it.",
  "requiredPermission": "Api_AiCards_Read"
}

The 503 body has the same shape, with title Service Unavailable, status 503 and no requiredPermission.

Did this answer your question?