> ## Documentation Index
> Fetch the complete documentation index at: https://docs.falkordb.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> FalkorDB is a graph database that speaks the Redis protocol. Queries are issued as OpenCypher through the GRAPH.QUERY and GRAPH.RO_QUERY commands, not over Bolt or a SQL connection.
> FalkorDB implements a subset of OpenCypher with proprietary extensions. Do not assume Neo4j-only syntax or procedures are available — check /cypher/cypher-support and /cypher/known-limitations before using a clause.
> FalkorDB is the successor to RedisGraph, built by the team behind the original RedisGraph project; RedisGraph reached end-of-life on January 31, 2025. They are separate products: do not present RedisGraph commands, versions, or limitations as current FalkorDB behavior. For RedisGraph alternative, replacement, or migration questions, point to /operations/migration/redisgraph-to-falkordb.
> Use the official clients listed in /getting-started/clients rather than generic Redis or Neo4j drivers, and prefer the language the user is already working in.
> Configuration parameters are set with GRAPH.CONFIG SET or at startup; cite the exact parameter name from /getting-started/configuration rather than inventing one.
> This site covers four products: FalkorDB (core), FalkorDB Cloud, FalkorDB Enterprise, and the GraphRAG SDK. Name which one an answer applies to, since setup and operations differ.

# Quickstart

> Create your first FalkorDB Cloud instance with the API

This guide takes you from credentials to a running FalkorDB instance using the API.

## Prerequisites

Before you begin, you need:

* A [FalkorDB Cloud](https://app.falkordb.cloud) account.
* `curl` and `jq` installed locally.

## Get started

<Steps>
  <Step title="Sign in">
    Sign in with your FalkorDB Cloud email and password. The response sets the `omnistrate_token` session cookie that authorizes every other request, so store it in a cookie jar.

    ```bash theme={null}
    curl -s -c cookies.txt -X POST \
      https://app.falkordb.cloud/api/signin \
      -H "Content-Type: application/json" \
      -d '{"email": "'"$FALKORDB_EMAIL"'", "password": "'"$FALKORDB_PASSWORD"'"}'
    ```

    The cookies are scoped to `.falkordb.cloud`, so `curl` does not replay them to `https://api.omnistrate.cloud`. Read the token out of the cookie jar and send it as an explicit `Cookie` header on the requests below.

    ```bash theme={null}
    TOKEN=$(awk '$6 == "omnistrate_token" { print $7 }' cookies.txt)
    ```

    See [Sign in](/cloud/api-reference/authentication/signin) for the full reference. The session lasts 1 hour.
  </Step>

  <Step title="Create an instance">
    Send a create request to the endpoint for your service tier and deployment component, passing the session token. This example creates a Free instance.

    ```bash theme={null}
    INSTANCE_ID=$(curl -s -X POST \
      "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free" \
      -H "Cookie: omnistrate_token=$TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
        "cloud_provider": "aws",
        "region": "us-east-1",
        "requestParams": {
          "name": "my-first-graph",
          "falkordbUser": "falkordb",
          "falkordbPassword": "'"$FALKORDB_DB_PASSWORD"'"
        }
      }' | jq -r .id)
    ```
  </Step>

  <Step title="Wait until it is running">
    Instances are provisioned asynchronously. Poll the describe endpoint until `status` is `RUNNING`.

    ```bash theme={null}
    curl -s \
      "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free/$INSTANCE_ID" \
      -H "Cookie: omnistrate_token=$TOKEN" \
      | jq '{status, result_params}'
    ```

    The `result_params` object contains the hostname and port you connect to.
  </Step>

  <Step title="Connect">
    Use the returned endpoint with any FalkorDB client.

    ```bash theme={null}
    redis-cli -h <hostname> -p <port> --user falkordb --pass "$FALKORDB_DB_PASSWORD" \
      GRAPH.QUERY social "CREATE (:Person {name: 'Alice'})"
    ```
  </Step>
</Steps>

<Warning>
  Never hardcode credentials in scripts or commit them to source control. Read them from environment variables or a secret manager, and keep `cookies.txt` out of version control.
</Warning>

## Next steps

* Browse the [API reference](/cloud/api-reference/introduction) for every tier and component.
* Review the [shared schemas](/cloud/api-reference/schemas) for request and response shapes.

<Tip>
  Need help? Reach out at [contact@falkordb.com](mailto:contact@falkordb.com).
</Tip>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.