API reference

Every /v1 endpoint, generated from the API itself.

Base URL

https://api.akumi.cloud/v1

Authentication

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY

GET /recall/threads

Parameters

  • limit integer · query

Example

cURL

curl https://api.akumi.cloud/v1/recall/threads \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "GET",
    "https://api.akumi.cloud/v1/recall/threads",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/threads", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
POST /recall/threads

Example

cURL

curl -X POST https://api.akumi.cloud/v1/recall/threads \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "POST",
    "https://api.akumi.cloud/v1/recall/threads",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/threads", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 201
  • 401
GET /recall/threads/{thread}

Parameters

  • thread string · path · required

Example

cURL

curl https://api.akumi.cloud/v1/recall/threads/{thread} \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "GET",
    "https://api.akumi.cloud/v1/recall/threads/{thread}",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/threads/{thread}", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
DELETE /recall/threads/{thread}

Parameters

  • thread string · path · required

Example

cURL

curl -X DELETE https://api.akumi.cloud/v1/recall/threads/{thread} \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "DELETE",
    "https://api.akumi.cloud/v1/recall/threads/{thread}",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/threads/{thread}", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
POST /recall/search

Example

cURL

curl -X POST https://api.akumi.cloud/v1/recall/search \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "POST",
    "https://api.akumi.cloud/v1/recall/search",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/search", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
  • 422
POST /recall/facts/search

Use POST /v1/recall/search.

Example

cURL

curl -X POST https://api.akumi.cloud/v1/recall/facts/search \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "POST",
    "https://api.akumi.cloud/v1/recall/facts/search",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/facts/search", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
  • 422
GET /recall/facts

Parameters

  • limit integer · query

Example

cURL

curl https://api.akumi.cloud/v1/recall/facts \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "GET",
    "https://api.akumi.cloud/v1/recall/facts",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/facts", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
POST /recall/facts

Example

cURL

curl -X POST https://api.akumi.cloud/v1/recall/facts \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "POST",
    "https://api.akumi.cloud/v1/recall/facts",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/facts", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 202
  • 401
  • 422
DELETE /recall/facts/{id}

Parameters

  • id string · path · required

Example

cURL

curl -X DELETE https://api.akumi.cloud/v1/recall/facts/{id} \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "DELETE",
    "https://api.akumi.cloud/v1/recall/facts/{id}",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/facts/{id}", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
GET /recall/export

Parameters

  • user_ref string · query · required
  • limit integer · query

Example

cURL

curl https://api.akumi.cloud/v1/recall/export \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "GET",
    "https://api.akumi.cloud/v1/recall/export",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/export", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
  • 422
DELETE /recall

Example

cURL

curl -X DELETE https://api.akumi.cloud/v1/recall \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "DELETE",
    "https://api.akumi.cloud/v1/recall",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
  • 422
POST /recall/documents/search

Use POST /v1/recall/search.

Example

cURL

curl -X POST https://api.akumi.cloud/v1/recall/documents/search \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "POST",
    "https://api.akumi.cloud/v1/recall/documents/search",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/documents/search", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
  • 422
GET /recall/documents

Parameters

  • limit integer · query

Example

cURL

curl https://api.akumi.cloud/v1/recall/documents \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "GET",
    "https://api.akumi.cloud/v1/recall/documents",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/documents", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
POST /recall/documents

Example

cURL

curl -X POST https://api.akumi.cloud/v1/recall/documents \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "POST",
    "https://api.akumi.cloud/v1/recall/documents",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/documents", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 201
  • 401
  • 422
GET /recall/documents/{document}

Parameters

  • document string · path · required The document UUID

Example

cURL

curl https://api.akumi.cloud/v1/recall/documents/{document} \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "GET",
    "https://api.akumi.cloud/v1/recall/documents/{document}",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/documents/{document}", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 404
  • 401
DELETE /recall/documents/{document}

Parameters

  • document string · path · required The document UUID

Example

cURL

curl -X DELETE https://api.akumi.cloud/v1/recall/documents/{document} \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "DELETE",
    "https://api.akumi.cloud/v1/recall/documents/{document}",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/documents/{document}", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 404
  • 401
GET /recall/collections

Parameters

  • limit integer · query

Example

cURL

curl https://api.akumi.cloud/v1/recall/collections \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "GET",
    "https://api.akumi.cloud/v1/recall/collections",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/collections", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
POST /recall/collections

Example

cURL

curl -X POST https://api.akumi.cloud/v1/recall/collections \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "POST",
    "https://api.akumi.cloud/v1/recall/collections",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/collections", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 201
  • 401
  • 422
GET /recall/collections/{slug}

Parameters

  • slug string · path · required

Example

cURL

curl https://api.akumi.cloud/v1/recall/collections/{slug} \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "GET",
    "https://api.akumi.cloud/v1/recall/collections/{slug}",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/collections/{slug}", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
  • 404
PATCH /recall/collections/{slug}

Parameters

  • slug string · path · required

Example

cURL

curl -X PATCH https://api.akumi.cloud/v1/recall/collections/{slug} \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "PATCH",
    "https://api.akumi.cloud/v1/recall/collections/{slug}",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/collections/{slug}", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
  • 404
  • 422
DELETE /recall/collections/{slug}

Parameters

  • slug string · path · required

Example

cURL

curl -X DELETE https://api.akumi.cloud/v1/recall/collections/{slug} \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "DELETE",
    "https://api.akumi.cloud/v1/recall/collections/{slug}",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/recall/collections/{slug}", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
  • 404
GET /audit-logs

List audit log entries for the authenticated organization, newest first (fixed order: `created_at` desc, `id` desc). Supports filtering by `action`, `component`, `from`, and `to`. Returns a cursor-paginated envelope `{data, next_cursor}` where `next_cursor` is an opaque base64 string (or `null` on the final page). Use `?limit=N` (default 50, cap 100) to control page size. Pass `?cursor=<next_cursor>` to advance pages

Parameters

  • limit integer · query

Example

cURL

curl https://api.akumi.cloud/v1/audit-logs \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "GET",
    "https://api.akumi.cloud/v1/audit-logs",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/audit-logs", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
GET /audit-logs/{uuid}

Fetch a single audit log entry by UUID. Returns 404 if the entry does not belong to the authenticated organization

Parameters

  • uuid string · path · required

Example

cURL

curl https://api.akumi.cloud/v1/audit-logs/{uuid} \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "GET",
    "https://api.akumi.cloud/v1/audit-logs/{uuid}",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/audit-logs/{uuid}", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200 `AuditLogApiResource`
  • 401
  • 404
POST /chat/completions

Example

cURL

curl https://api.akumi.cloud/v1/chat/completions \
  -H "Authorization: Bearer $AKUMI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "default",
    "messages": [{"role": "user", "content": "Hello"}]
  }'

Python

from openai import OpenAI

client = OpenAI(base_url="https://api.akumi.cloud/v1", api_key="$AKUMI_API_KEY")

completion = client.chat.completions.create(
    model="default",
    messages=[{"role": "user", "content": "Hello"}],
)
print(completion.choices[0].message.content)

JavaScript

import OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.akumi.cloud/v1", apiKey: process.env.AKUMI_API_KEY });

const completion = await client.chat.completions.create({
  model: "default",
  messages: [{ role: "user", content: "Hello" }],
});
console.log(completion.choices[0].message.content);

Responses

  • 200
  • 401
  • 422
POST /embeddings

Example

cURL

curl -X POST https://api.akumi.cloud/v1/embeddings \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

import os, requests

response = requests.request(
    "POST",
    "https://api.akumi.cloud/v1/embeddings",
    headers={"Authorization": f"Bearer {os.environ['AKUMI_API_KEY']}"},
)
print(response.json())

JavaScript

const response = await fetch("https://api.akumi.cloud/v1/embeddings", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.AKUMI_API_KEY}` },
});
console.log(await response.json());

Responses

  • 200
  • 401
  • 422
GET /models

Example

cURL

curl https://api.akumi.cloud/v1/models \
  -H "Authorization: Bearer $AKUMI_API_KEY"

Python

from openai import OpenAI

client = OpenAI(base_url="https://api.akumi.cloud/v1", api_key="$AKUMI_API_KEY")
print(client.models.list())

JavaScript

import OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.akumi.cloud/v1", apiKey: process.env.AKUMI_API_KEY });
console.log(await client.models.list());

Responses

  • 200
  • 401