Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Clusters

List Clusters (GET)

REST-convention listing endpoint. Equivalent to POST /v1/clusters/list with no filters or sort. Use the POST variant when you need filters, sort, or search.

get/v1/clusters

Query parameters

searchstring nullable

Search query string

Search query string

limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean

Response

Successful Response

total_countinteger required

Total number of clusters matching the query

Example response

{
  "results": [
    {
      "source_enrichment_config": {
        "field_mappings": [
          {
            "source_field": "cluster_id",
            "target_field": "category_id"
          },
          {
            "source_field": "cluster_label",
            "target_field": "category_name"
          },
          {
            "source_field": "distance_to_centroid",
            "target_field": "category_confidence"
          }
        ]
      },
      "llm_labeling": {
        "description": "Text-only labeling with multiple fields",
        "enabled": true,
        "include_keywords": true,
        "include_summary": true,
        "labeling_inputs": {
          "input_mappings": [
            {
              "input_key": "title",
              "path": "title",
              "source_type": "payload"
            },
            {
              "input_key": "description",
              "path": "description",
              "source_type": "payload"
            },
            {
              "input_key": "text",
              "path": "text",
              "source_type": "payload"
            }
          ]
        },
        "model_name": "gpt-4o-mini-2024-07-18",
        "provider": "openai"
      }
    }
  ]
}