Update collection

PATCH
Update properties of an existing collection.
Authentication
X-API-Key
apiKey
Body Parameters
body
CollectionUpdate
*
name
string
description
string
access
object
Responses
200
Collection
id
string
createdAt
string<date-time>
createdBy
string
updatedAt
string<date-time>
updatedBy
string
name
string
description
string
access
object
metrics
CollectionMetrics
default
Default error response
ErrorResponse
code
integer
*
message
string
*
status
string
*
data
object
Curl
JS
Ruby
Python
curl --location --globoff --request PATCH 'https://api.askgrok.ai/collections/{cId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'
curl --location --globoff --request PATCH 'https://api.askgrok.ai/collections/{cId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'
Responses
200
default
{
  "id": "a1b2c3d4e5",
  "createdAt": "2020-01-01T01:01:01Z",
  "createdBy": "user-1234",
  "updatedAt": "2020-01-01T01:01:01Z",
  "updatedBy": "user-1234",
  "name": "",
  "description": "",
  "access": {},
  "metrics": {
    "totalConversations": 0,
    "totalDocuments": 0,
    "totalPages": 0,
    "totalBlocks": 0,
    "totalSize": 0,
    "averagePagesPerDocument": 0,
    "averageBlocksPerDocument": 0,
    "averageDocumentSize": 0
  }
}
{
  "id": "a1b2c3d4e5",
  "createdAt": "2020-01-01T01:01:01Z",
  "createdBy": "user-1234",
  "updatedAt": "2020-01-01T01:01:01Z",
  "updatedBy": "user-1234",
  "name": "",
  "description": "",
  "access": {},
  "metrics": {
    "totalConversations": 0,
    "totalDocuments": 0,
    "totalPages": 0,
    "totalBlocks": 0,
    "totalSize": 0,
    "averagePagesPerDocument": 0,
    "averageBlocksPerDocument": 0,
    "averageDocumentSize": 0
  }
}
﻿
﻿
Delete collection
Search collection