Ask Content

Ask Content

curl --request POST \
  --url https://api.sublay.io/api/v6/:projectId/api/v7/search/ask \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "sourceTypes": [
    "<string>"
  ],
  "spaceId": "<string>",
  "includeChildSpaces": true,
  "conversationId": "<string>",
  "limit": 123
}
'

import requests

url = "https://api.sublay.io/api/v6/:projectId/api/v7/search/ask"

payload = {
    "query": "<string>",
    "sourceTypes": ["<string>"],
    "spaceId": "<string>",
    "includeChildSpaces": True,
    "conversationId": "<string>",
    "limit": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    sourceTypes: ['<string>'],
    spaceId: '<string>',
    includeChildSpaces: true,
    conversationId: '<string>',
    limit: 123
  })
};

fetch('https://api.sublay.io/api/v6/:projectId/api/v7/search/ask', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sublay.io/api/v6/:projectId/api/v7/search/ask",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'sourceTypes' => [
        '<string>'
    ],
    'spaceId' => '<string>',
    'includeChildSpaces' => true,
    'conversationId' => '<string>',
    'limit' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sublay.io/api/v6/:projectId/api/v7/search/ask"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"sourceTypes\": [\n    \"<string>\"\n  ],\n  \"spaceId\": \"<string>\",\n  \"includeChildSpaces\": true,\n  \"conversationId\": \"<string>\",\n  \"limit\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sublay.io/api/v6/:projectId/api/v7/search/ask")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"sourceTypes\": [\n    \"<string>\"\n  ],\n  \"spaceId\": \"<string>\",\n  \"includeChildSpaces\": true,\n  \"conversationId\": \"<string>\",\n  \"limit\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sublay.io/api/v6/:projectId/api/v7/search/ask")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"sourceTypes\": [\n    \"<string>\"\n  ],\n  \"spaceId\": \"<string>\",\n  \"includeChildSpaces\": true,\n  \"conversationId\": \"<string>\",\n  \"limit\": 123\n}"

response = http.request(request)
puts response.read_body

Ask Content

curl --request POST \
  --url https://api.sublay.io/api/v6/:projectId/api/v7/search/ask \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "sourceTypes": [
    "<string>"
  ],
  "spaceId": "<string>",
  "includeChildSpaces": true,
  "conversationId": "<string>",
  "limit": 123
}
'

import requests

url = "https://api.sublay.io/api/v6/:projectId/api/v7/search/ask"

payload = {
    "query": "<string>",
    "sourceTypes": ["<string>"],
    "spaceId": "<string>",
    "includeChildSpaces": True,
    "conversationId": "<string>",
    "limit": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    sourceTypes: ['<string>'],
    spaceId: '<string>',
    includeChildSpaces: true,
    conversationId: '<string>',
    limit: 123
  })
};

fetch('https://api.sublay.io/api/v6/:projectId/api/v7/search/ask', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sublay.io/api/v6/:projectId/api/v7/search/ask",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'sourceTypes' => [
        '<string>'
    ],
    'spaceId' => '<string>',
    'includeChildSpaces' => true,
    'conversationId' => '<string>',
    'limit' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sublay.io/api/v6/:projectId/api/v7/search/ask"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"sourceTypes\": [\n    \"<string>\"\n  ],\n  \"spaceId\": \"<string>\",\n  \"includeChildSpaces\": true,\n  \"conversationId\": \"<string>\",\n  \"limit\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sublay.io/api/v6/:projectId/api/v7/search/ask")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"sourceTypes\": [\n    \"<string>\"\n  ],\n  \"spaceId\": \"<string>\",\n  \"includeChildSpaces\": true,\n  \"conversationId\": \"<string>\",\n  \"limit\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sublay.io/api/v6/:projectId/api/v7/search/ask")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"sourceTypes\": [\n    \"<string>\"\n  ],\n  \"spaceId\": \"<string>\",\n  \"includeChildSpaces\": true,\n  \"conversationId\": \"<string>\",\n  \"limit\": 123\n}"

response = http.request(request)
puts response.read_body

Answers a natural language question using content from your project as context. The endpoint first performs semantic retrieval to find relevant content, then sends the context to an LLM to generate a grounded answer. Responds via Server-Sent Events (SSE) for streaming output. Requires a paid plan with semantic search enabled. Requires an authenticated user. Send the user’s access token as Authorization: Bearer <token>. Requests without a valid token are rejected before any work is done — missing token → 401, invalid/expired token → 403 (refresh the access token and retry).

Body Parameters

string

required

The question to answer. Typos and ambiguous phrasing are handled gracefully.

string[]

default:"[\"entity\", \"comment\", \"message\"]"

Content types to use as context. Any combination of entity, comment, message.

string

Restrict the context lookup to a specific space.

boolean

default:"false"

Only applies with a spaceId. When true, the context lookup also includes every space nested under it — children, grandchildren, the whole subtree at any depth — not just the named space. Use it to ask across a community and all of its channels at once. Ignored without a spaceId.

string

Restrict message context lookup to a specific conversation.

number

default:"20"

Maximum number of content chunks to retrieve for context. Maximum 50.

Query Parameters

Space-scoped reputation

This endpoint has a space in context, so it accepts the opt-in reputation params. They add a spaceReputation field to each source record’s populated user, alongside the always-present reputation total. Requires the reputation bundle. See the Reputation data model for the full contract.

Response

The response is a Server-Sent Events stream with Content-Type: text/event-stream. Three event types are emitted: token — streamed LLM answer tokens:

event: token
data: {"content": "Based on"}

event: token
data: {"content": " the discussion..."}

sources — the content records used as context, sent after the answer is complete:

event: sources
data: [{"sourceType": "entity", "similarity": 0.87, "record": {...}}, ...]

Each source object follows the same shape as the Search Content response — sourceType, similarity, and a fully populated record. An empty array is sent when no relevant context was found. done — signals the stream is finished:

event: done
data: {}

If no relevant content is found above the similarity threshold, the LLM response is skipped and the answer event immediately says “I couldn’t find any relevant content to answer your question.”

Error Responses

Authentication Required — 401 / 403

The endpoint requires an authenticated user. A missing token returns a bare 401; an invalid or expired token returns a bare 403 — refresh the access token and retry. These are returned before streaming starts.

Plan Required — 403

{ "error": "Semantic search requires a paid plan", "code": "project/plan-required" }

Only returned when headers have not yet been sent (i.e., before streaming starts).

Error Event (during stream)

If an error occurs after streaming starts:

event: error
data: {"error": "Internal server error"}

Overview

Auth Endpoints

OAuth Endpoints

User Endpoints

User Follow Operations

User Connection Operations

User Block Operations

Follow Endpoints

Connection Endpoints

Entity Endpoints

Comment Endpoints

Chat — Conversations

Chat — Members

Chat — Messages

Collection Endpoints

App Notification Endpoints

Push Notification Endpoints

Report Endpoints

Search Endpoints

Space Endpoints

Space — Membership

Space — Rules

Space — Moderation

Space — Chat

Workspace Endpoints

Workspace — Membership

Workspace — Invitations

Event Endpoints

Reputation Grant Endpoints

Storage Endpoints

Utils

Crypto

Body Parameters

Query Parameters

Space-scoped reputation

Response

Error Responses

​Body Parameters

​Query Parameters

​Space-scoped reputation

​Response

​Error Responses

Body Parameters

Query Parameters

Space-scoped reputation

Response

Error Responses