PATCH
/
v1
/
storage
/
docsets
/
{docset_id}
{
  "account_id": "<string>",
  "docset_id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "readonly": true,
  "properties": {},
  "size": 123,
  "query_schema": {
    "fields": [
      {
        "name": "<string>",
        "field_type": "<string>",
        "default": "<any>",
        "description": "<string>",
        "examples": [
          "<any>"
        ]
      }
    ]
  },
  "prompts": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
docset_id
string
required

The unique identifier of the DocSet.

Body

application/json
​
name
string | null
​
properties
object | null
​
query_schema
object | null

Represents the schema of a DocSet.

​
prompts
object | null

Response

200
application/json
Successful Response
​
account_id
string
required

The account id containing the DocSet.

​
docset_id
string
required

The unique id for the DocSet.

​
name
string
required

The name of the DocSet.

​
created_at
string
required

The creation time of this DocSet.

​
readonly
boolean
required

Whether the DocSet is read-only.

​
properties
object | null

Additional properties for the DocSet.

​
size
integer | null

The size of the DocSet in bytes.

​
query_schema
object | null

The schema of the DocSet.

​
prompts
object

The prompts associated with this DocSet.

Was this page helpful?