API docs by Redocly

Astra DB JSON API (1.0.0-BETA-7)

Download OpenAPI specification:Download

URL: https://stargate.io License: Apache 2.0 Terms of Service

The Astra DB JSON API modifies and queries data stored as unstructured JSON documents in collections. See the documentation site for additional information.

General

Executes general commands.

Execute command

Executes a single general command.

Authorizations:
Token
Request Body schema: application/json
Any of
object (JsonNode)
name
required
string [ 1 .. 48 ] characters [a-zA-Z][a-zA-Z0-9_]*

Service name to be created

apiProvider
string(openai|vertexai|huggingface)

Embedding service provider name

apiKey
required
string

Api token from the service provider

baseUrl
required
string

Base url for the service provider

Responses

Request samples

Content type
application/json
Example
{
  • "createEmbeddingService": {}
}

Response samples

Content type
application/json
Example
{
  • "status": {
    }
}

Namespaces

Executes namespace commands.

Execute command

Executes a single command against a collection.

Authorizations:
Token
path Parameters
namespace
required
string <= 48 characters [a-zA-Z][a-zA-Z0-9_]*
Example: cycling

The namespace where the collection is located.

Request Body schema: application/json
Any of
name
required
string [ 1 .. 48 ] characters [a-zA-Z][a-zA-Z0-9_]*

Name of the collection

object

Configuration for the collection

Responses

Request samples

Content type
application/json
Example
{
  • "createCollection": {
    }
}

Response samples

Content type
application/json
Example
{
  • "status": {
    }
}

Documents

Executes document commands against a single collection.

Execute command

Executes a single command against a collection.

Authorizations:
Token
path Parameters
namespace
required
string <= 48 characters [a-zA-Z][a-zA-Z0-9_]*
Example: cycling

The namespace where the collection is located.

collection
required
string <= 48 characters [a-zA-Z][a-zA-Z0-9_]*
Example: events

The name of the collection.

Request Body schema: application/json
Any of
object (JsonNode)
object (FilterClause)

Responses

Request samples

Content type
application/json
Example
{
  • "countDocuments": {
    }
}

Response samples

Content type
application/json
Example
{
  • "status": {
    }
}