Get collection

Read a collection’s settings, readiness, and file counts.

GET/namespaces/{namespace}/collections/{collection}

PermissionCluster key, or a scoped key with read (write includes read). Key scopes and actions.

Use status and file_counts to distinguish empty, processing, ready, and failed content.
A resource outside the key’s namespace or collection scope returns 404, even when that resource exists.

Request

https://engine.example.com/namespaces/acme/collections/incident-logs

GET /namespaces/acme/collections/incident-logs HTTP/1.1
Host: engine.example.com
Authorization: Bearer <GRAPHON_ENGINE_API_KEY>

Replace engine.example.com with your cluster host. Examples use a key placeholder.

Response

200

The requested resource or result.

{
  "id": "col_01K6Q6N7D8E9F0G1H2J3K4M5N6",
  "namespace": "acme",
  "name": "incident-logs",
  "display_name": "Incident logs",
  "status": "ready",
  "access_control": "off",
  "processing": {
    "keyword": true,
    "semantic": true,
    "graph": true
  },
  "index_generation": "gen_example",
  "file_counts": {
    "pending": 0,
    "indexing": 0,
    "ready": 1,
    "failed": 0
  },
  "created_at": "2026-10-06T10:00:00Z",
  "updated_at": "2026-10-06T10:00:00Z"
}

Path parameters

namespacestringrequired

Namespace name or ns_ ID. It must be visible to this key.

collectionstringrequired

Collection name or col_ ID within the namespace. It must be visible to this key.

Responses

200Success

The requested resource or result.

application/json

Response headers

x-engine-request-idstringrequired

The Engine request ID. Retain it when investigating a failed or unexpected request.

x-request-idstringrequired

The X-Request-Id you sent, echoed when it is a valid ID. Otherwise, the Engine request ID.

access_controlstringrequired

Whether Search, Answer, and Research apply access rules. off accepts no principals. enforced requires principals and starts with an empty root reader list.

off: Retrieval uses the key’s scope and does not accept principals.
enforced: Retrieval requires principals and applies the collection’s access rules.

created_atstring (date-time)required

Time the resource was created, as an ISO 8601 UTC timestamp.

display_namestringrequiredaccepts null

Human-readable label. This label does not change the resource name used in URLs.

file_countsobjectrequired

Current number of living files in each processing state.

idstringrequired

Immutable collection ID with the col_ prefix.

index_generationstringrequiredaccepts null

Opaque identifier for the searchable generation. It changes when indexed data changes. Null means that no searchable generation exists.

namestringrequired

URL name. Use 1–63 lowercase letters, digits, underscores, or hyphens. Start with a letter or digit. A name cannot match its resource ID format.

namespacestringrequired

Name of the namespace that contains this collection.

processingobjectrequired

Index features for this collection. Flags omitted on create default to true. Flags omitted on update keep their values. At least one flag must remain enabled.

statusstringrequired

Aggregate readiness of the collection. A ready file permits retrieval. Check file_counts for failures or ongoing processing.

empty: No living files. Search returns no results. Answer returns collection_empty.
indexing: Files are processing and none is ready yet.
ready: At least one file is ready for retrieval.
degraded: At least one file is ready and at least one failed.
failed: Files exist but none is ready. Inspect file errors.
deleting: Deletion is in progress. Retrieval returns not_found.