API reference

Search Chats

Search for chat sessions based on the provided query. If no query is provided, returns recent chat sessions.

Before you begin

This page uses Nexus's generated request and response schema. Requests still require the correct account, workspace, and resource permissions.

GET/chat/search

Workspace

curl --request GET 'https://school.narb.cc/api/chat/search' \
  --header 'Authorization: Bearer YOUR_TOKEN'

This builds a request example. Fill in required query values, then replace path placeholders and YOUR_TOKEN in your own environment. Use a token for a user with access to this workspace. Responses and permissions depend on your account and deployment. Never paste a private token into documentation.

Download the Nexus OpenAPI schema ↗
Import the schema into your API client. It describes the backend source; enabled routes depend on your workspace.

Authentication and scope#

Send requests to the workspace that owns the resource. Authentication does not by itself grant a school membership, class assignment, or administrator permission. School endpoints apply their role and class checks on the server.

Use a credential issued for that workspace with only the permissions your integration needs. Keep it on your server. Do not place credentials in a public website or a shared skill.

Search for chat sessions based on the provided query. If no query is provided, returns recent chat sessions.

Parameters#

Name	Location	Required	Type
`query`	query	No	string or null
`page`	query	No	integer
`page_size`	query	No	integer
`tenant_id`	query	No	string or null

The tenant_id parameter is part of the engine schema. It does not authorize a caller to another school. Use the workspace and permissions assigned to your account.

Responses#

200#

Successful Response

{
  "properties": {
    "groups": {
      "items": {
        "$ref": "#/components/schemas/ChatSessionGroup"
      },
      "type": "array",
      "title": "Groups"
    },
    "has_more": {
      "type": "boolean",
      "title": "Has More"
    },
    "next_page": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Page"
    }
  },
  "type": "object",
  "required": [
    "groups",
    "has_more"
  ],
  "title": "ChatSearchResponse"
}

422#

Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Access and error handling#

A signed-out or expired session needs authentication. A denied request can mean the account lacks permission, class membership, an approved model, or an available allowance. Do not retry a write blindly after a network failure; first check whether it was recorded.

Treat validation errors as a request problem. Use the returned field details to correct the request. Resource identifiers do not confer access.

Schema version#

Generated from Nexus backend source fe1c3a07c793029d3d87191a68f89e481afd6bc8. Check your deployed version before integrating. Schema coverage is not a live acceptance test.