Skip to main content
POST
/
ns_create
Create a new `namespace`.
curl --request POST \
  --url https://api.ragkit.com/v1/ns_create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "description": "<string>"
}
'
{
  "success": true,
  "data": {
    "key": "<string>",
    "description": "<string>"
  }
}
Namespaces are created automatically when referenced from other API functions. It is not necessary to create them manually.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
key
string | null

The key of the namespace to create.

  • Must be unique to the authorized organization.
  • Must only contain A-Z, a-z, 0-9, dash (-), or underscore (_).
  • Must have length between 3-63 (inclusive).

A prefixed UUID will be generated for you if this is omitted.

Required string length: 3 - 63
​
description
string | null

A description of the namespace.

  • Must have length between 1-1024 (inclusive).
Required string length: 1 - 1024

Response

Success

​
success
enum<boolean>
required

Always true.

Available options:
true,
false
​
data
object
required

The namespace.