API ReferenceDatabase context
API Reference

Database context

Store and retrieve named text or Markdown documents scoped to a specific database.

List database contexts

GET/v1/databases/{database_id}/context

Path parameters

  • database_id stringrequired. Database ID

Response 200 — Contexts

  • contexts DatabaseContextEntry[] — required
    • content stringrequired
    • name stringrequired
    • updated_at stringrequired
{
  "contexts": [
    {
      "content": "string",
      "name": "string",
      "updated_at": "2026-01-01T00:00:00Z"
    }
  ]
}

Errors

StatusDescription
404Database not found

Create or update database context

POST/v1/databases/{database_id}/context

Stores a named document (for example Markdown) scoped to a database. Reuses the same name to replace content.

Path parameters

  • database_id stringrequired. Database ID

Request body

  • content stringrequired
  • name stringrequired. Upsert key in the catalog. Validated with table-name rules (preserves case): ASCII letter or _ first; then alphanumeric or _ only; 1–128 chars; not a SQL reserved word.
{
  "content": "The orders table holds one row per completed purchase. `amount` is in USD cents.",
  "name": "orders_overview"
}

Response 200 — Context saved

  • context DatabaseContextEntryrequired. One context entry returned by the API.
    • content stringrequired
    • name stringrequired
    • updated_at stringrequired
{
  "context": {
    "content": "string",
    "name": "string",
    "updated_at": "2026-01-01T00:00:00Z"
  }
}

Errors

StatusDescription
400Invalid request
404Database not found

Get one database context

GET/v1/databases/{database_id}/context/{name}

Path parameters

  • database_id stringrequired. Database ID
  • name stringrequired. Context key: same character rules as a table name

Response 200 — Context found

  • context DatabaseContextEntryrequired. One context entry returned by the API.
    • content stringrequired
    • name stringrequired
    • updated_at stringrequired
{
  "context": {
    "content": "string",
    "name": "string",
    "updated_at": "2026-01-01T00:00:00Z"
  }
}

Errors

StatusDescription
400Invalid request
404Database or context not found

Delete database context

DELETE/v1/databases/{database_id}/context/{name}

Removes a named context document from a database.

Path parameters

  • database_id stringrequired. Database ID
  • name stringrequired. Context key: same character rules as a table name

Response 204 — Context deleted

Errors

StatusDescription
400Invalid request
404Database or context not found