POST
/
v1
/
storage
/
docsets
Create Docset
curl --request POST \
  --url https://api.aryn.cloud/v1/storage/docsets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "properties": {},
  "schema": {
    "properties": [
      {
        "name": "<string>",
        "field_type": "<string>",
        "default": "<any>",
        "description": "<string>",
        "examples": [
          "<any>"
        ]
      }
    ]
  },
  "prompts": {}
}'
{
  "account_id": "<string>",
  "docset_id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "readonly": true,
  "properties": {},
  "size": 123,
  "schema": {
    "properties": [
      {
        "name": "<string>",
        "property_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.

Body

application/json
name
string
required
properties
object | null
schema
object | null

Represents the schema of a DocSet.

prompts
object | null

Response

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<date-time>
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 number of documents in the DocSet.

schema
object | null

Represents the schema of a DocSet.

prompts
object

The prompts associated with this DocSet.