Quickstart

Create a small file in your context repository, then read it back by ID.

1. Create an API key

In the Qontext app, open Clients → API Keys and select + Create API key. Copy the key and store it as an environment variable:

export QONTEXT_API_KEY="your-api-key"

The key needs permission to create and read files at the example path. See Authentication for access controls.

2. Create a file

This request creates /api-example/hello.md. Missing parent folders are created automatically.

curl --fail-with-body https://api.qontext.ai/v1/files \
  -H "Authorization: Bearer $QONTEXT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"/api-example/hello.md","content":"# Hello\n\nCreated with the Qontext API."}'

import json
import os
from urllib.request import Request, urlopen

request = Request(
    "https://api.qontext.ai/v1/files",
    data=json.dumps({
        "path": "/api-example/hello.md",
        "content": "# Hello\n\nCreated with the Qontext API.",
    }).encode(),
    headers={
        "Authorization": f"Bearer {os.environ['QONTEXT_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
with urlopen(request) as response:
    file = json.load(response)
print(file["id"])

const response = await fetch("https://api.qontext.ai/v1/files", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.QONTEXT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    path: "/api-example/hello.md",
    content: "# Hello\n\nCreated with the Qontext API.",
  }),
});
if (!response.ok) throw new Error(await response.text());
const file = await response.json();
console.log(file.id);

A successful request returns 201 and a file object. These are the fields you need next:

{
  "id": "doc_9f2k1x8b3m7q0v",
  "path": "/api-example/hello.md",
  "lastChangeId": "chg_7t4p2w9c1n6s8k"
}

This is an excerpt; see Create a file for the full response. Save the returned id and lastChangeId.

Running the example again at the same path returns 409 path_already_exists. Choose another path, or find the existing file with the path filter. Creating a file never overwrites existing content.

3. Read the file

Replace the example ID with the id returned by your create request.

curl --fail-with-body https://api.qontext.ai/v1/files/doc_9f2k1x8b3m7q0v \
  -H "Authorization: Bearer $QONTEXT_API_KEY"

request = Request(
    f"https://api.qontext.ai/v1/files/{file['id']}",
    headers={"Authorization": f"Bearer {os.environ['QONTEXT_API_KEY']}"},
)
with urlopen(request) as response:
    saved = json.load(response)
print(saved["content"])

const read = await fetch(`https://api.qontext.ai/v1/files/${file.id}`, {
  headers: { Authorization: `Bearer ${process.env.QONTEXT_API_KEY}` },
});
if (!read.ok) throw new Error(await read.text());
const saved = await read.json();
console.log(saved.content);

The Python and JavaScript examples continue from the previous step. The response includes the full content and the file’s lastChangeId.

Next steps

Update the file using the version you read.
Search your context by meaning. Newly written content may take a moment to become searchable.
Manage files and folders using stable IDs and paths.

Get started

Using the API

Files

Folders

Search

1. Create an API key

2. Create a file

3. Read the file

Next steps

​1. Create an API key

​2. Create a file

​3. Read the file

​Next steps

1. Create an API key

2. Create a file

3. Read the file

Next steps