Skip to content
DashboardGet API key

Get a collection

View .md
GET

The collection's definition: its indexes, default TTL and status. Collections are project-level, so this takes no scope.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • collectionstringrequired

    Collection name.

Responses

200Collection details.
  • collectionobjectrequired

    A namespace of JSON documents addressed by key.

    6 properties
    • namestringrequired
    • indexesobject[]required

      Fields that POST /v1/memory/collections/{collection}/query can filter on. Immutable after creation.

      1 properties
      • fieldstringrequired
    • defaultTtlSecondsintegerrequirednullable

      TTL applied to items written without their own ttlSeconds. Null means items are kept until deleted.

    • statusstringrequired

      active, or deleting while a delete drains in the background.

    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
400Invalid collection name.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Collection not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject