Skip to main content
POST
/
v1
/
namespace
/
{id}
/
create
Create a new namespace
curl --request POST \
  --url {scheme}://{host}:{port}/{basePath}/v1/namespace/{id}/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identity": {
    "api_key": "<string>",
    "auth_token": "<string>"
  },
  "context": {},
  "id": [
    "<string>"
  ],
  "mode": "<string>",
  "properties": {}
}
'
{
  "transaction_id": "<string>",
  "properties": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.lancedb.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
required

string identifier of an object in a namespace, following the Lance Namespace spec. When the value is equal to the delimiter, it represents the root namespace. For example, v1/namespace/$/list performs a ListNamespace on the root namespace.

Query Parameters

​
delimiter
string

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

Body

application/json
​
identity
object

Identity information of a request.

​
context
object

Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation.

REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention x-lance-ctx-<key>: <value>. For example, a context entry {"trace_id": "abc123"} would be sent as the header x-lance-ctx-trace_id: abc123.

​
id
string[]
​
mode
string

There are three modes when trying to create a namespace, to differentiate the behavior when a namespace of the same name already exists. Case insensitive, supports both PascalCase and snake_case. Valid values are:

  • Create: the operation fails with 409.
  • ExistOk: the operation succeeds and the existing namespace is kept.
  • Overwrite: the existing namespace is dropped and a new empty namespace with this name is created.
​
properties
object

Properties stored on the namespace, if supported by the implementation.

Response

Result of creating a namespace

​
transaction_id
string

Optional transaction identifier

​
properties
object

Properties after the namespace is created.

If the server does not support namespace properties, it should return null for this field. If namespace properties are supported, but none are set, it should return an empty object.