Skip to main content
GET
/
v1
/
particles
List Particles
curl --request GET \
  --url https://api.cuadra.ai/v1/particles \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "category": "tone",
      "isSystem": true,
      "enabled": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "description": "Sets professional tone",
      "currentVersion": 3,
      "tokenCount": 25,
      "content": "Maintain a professional tone.",
      "versions": [
        {
          "id": "<string>",
          "version": 123,
          "tokenCount": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "content": "You are a helpful assistant.",
          "createdBy": "user_xyz789"
        }
      ]
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

JWT token from Stytch B2B authentication (magic link, SSO, or M2M)

Query Parameters

category
enum<string> | null

Filter by particle category Categories for organizing particles by their purpose.

Available options:
role,
tone,
guardrails,
constraints,
format
enabled
boolean
default:true

Filter to enabled particles only

limit
integer
default:20

Maximum results to return

Required range: 1 <= x <= 100
cursor
string | null

Pagination cursor

Response

Successful Response

Paginated response for particle listings.

items
ParticleOut · object[]
required

List of particles

hasMore
boolean
required

Whether more results exist

nextCursor
string | null

Cursor for next page