> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://documents.pyramid-ai.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://documents.pyramid-ai.com/_mcp/server. # Chat with the Agent over project, org, or Open Library knowledge POST https://api.pyramid-ai.com/api/v2/chat Content-Type: application/json Multi-turn conversational endpoint. Supports both synchronous JSON responses and server-sent event (SSE) streaming via `stream: true`. `search_scope` picks the corpus: `project` (`project_id` required), `org` (the org's own documents), or `open_library` (the shared Open Library corpus — requires the `api.open_library` feature and cannot be combined with `chat_type`). When omitted, the scope is derived from `project_id` presence. Scope is per-request: multi-turn Open Library conversations re-send it with each request. `chat_type` picks the agent: `general`/`project` (org or project knowledge) or `safety` (the shared safety corpus — requires the Safety Assistant to be enabled for the organization via Agent Allocation, otherwise 403 AGENT_NOT_ENABLED). When omitted, the agent is inferred from the message among the agents enabled for the organization. Reference: https://documents.pyramid-ai.com/api-reference/api-explorer/agent/chat ## Authentication - `Authorization` header (bearer token, required) — Pyramid API key (prefix with "Bearer ") ## Servers - `https://api.pyramid-ai.com` (Production, default) - `https://api-staging.pyramid-ai.com` (Staging (sandbox) — use pai_test_* keys) ## Request ### Body (application/json) This endpoint expects an object. - `messages` (list of ApiV2ChatPostRequestBodyContentApplicationJsonSchemaMessagesItems, required) - `project_id` (string, optional) - `chat_id` (string, optional) - `chat_type` (enum, optional) - Allowed values: `general`, `project`, `safety` - `model` (enum, optional) - Allowed values: `chat-model`, `chat-model-reasoning` - `stream` (boolean, optional, default: false) - `search_scope` (enum, optional) — Which corpus the query searches. Exclusive — one request searches one corpus. - `project` — the given project's document chunks (`project_id` required). - `org` — the organization's own org-level documents (`project_id` must be omitted). - `open_library` — the shared Open Library corpus of Hong Kong government engineering documents (`project_id` must be omitted). Requires the `api.open_library` feature to be enabled for your organization. When omitted, the scope is derived for backward compatibility: `project` when `project_id` is present, `org` otherwise. - Allowed values: `project`, `org`, `open_library` ## Response ### 200 Chat response (JSON when stream=false, SSE when stream=true) - `request_id` (string, required) — Server-generated per-request UUID. Also sent as `X-Request-Id` response header. Include in support tickets. - `success` (any, required) - `data` (ApiV2ChatPostResponsesContentApplicationJsonSchemaData, optional) - `pagination` (Pagination, optional) — Present only on list endpoints. Top-level (not nested inside `data`). ## Errors ### 400 Bad Request Error Validation error - `success` (any, required) - `error` (ApiErrorError, required) - `request_id` (string, required) ### 401 Unauthorized Error Unauthorized - `success` (any, required) - `error` (ApiErrorError, required) - `request_id` (string, required) ### 403 Forbidden Error AGENT_NOT_ENABLED — the requested chat_type is a gated agent (e.g. safety) that is not enabled for this organization - `success` (any, required) - `error` (ApiErrorError, required) - `request_id` (string, required) ## Types ### ApiV2ChatPostRequestBodyContentApplicationJsonSchemaMessagesItems - `role` (enum, required) - Allowed values: `user`, `assistant`, `system` - `content` (ApiV2ChatPostRequestBodyContentApplicationJsonSchemaMessagesItemsContent, required) ### ApiV2ChatPostResponsesContentApplicationJsonSchemaData - `chat_id` (string, optional) - `message` (ApiV2ChatPostResponsesContentApplicationJsonSchemaDataMessage, optional) - `sources` (list of ApiV2ChatPostResponsesContentApplicationJsonSchemaDataSourcesItems, optional) - `usage` (ApiV2ChatPostResponsesContentApplicationJsonSchemaDataUsage, optional) ### Pagination Offset-based pagination for list endpoints. Clients compute `has_more` from `offset + data.length < total`. Cursor pagination may be added per-endpoint later if deep-pagination performance becomes a concern. - `total` (integer, required) — Total item count matching the filters (ignoring limit/offset). - `offset` (integer, required) - `limit` (integer, required, default: 50) ### ApiErrorError - `code` (enum, required) - Allowed values: `VALIDATION_ERROR`, `UNAUTHORIZED`, `FORBIDDEN`, `FEATURE_NOT_ENABLED`, `AGENT_NOT_ENABLED`, `QUOTA_EXCEEDED`, `NOT_FOUND`, `CONFLICT`, `IDEMPOTENCY_KEY_REUSED`, `IDEMPOTENCY_IN_PROGRESS`, `UPLOAD_NOT_FOUND`, `UPLOAD_SIZE_MISMATCH`, `RATE_LIMITED`, `INTERNAL_ERROR` - `message` (string, required) — Human-readable description. May be shown to end users; keep stable across minor changes. - `docs_url` (string, optional) — Link to the error's documentation section. - `field` (string, optional) — Only for `VALIDATION_ERROR`. JSONPath-ish reference to the offending field (e.g. `body.project_id`). - `feature` (string, optional) — Only for `FEATURE_NOT_ENABLED`. The feature key the request required. ### ApiV2ChatPostRequestBodyContentApplicationJsonSchemaMessagesItemsContent - string - list of ApiV2ChatPostRequestBodyContentApplicationJsonSchemaMessagesItemsContentOneOf1Items ### ApiV2ChatPostResponsesContentApplicationJsonSchemaDataMessage ### ApiV2ChatPostResponsesContentApplicationJsonSchemaDataSourcesItems ### ApiV2ChatPostResponsesContentApplicationJsonSchemaDataUsage ### ApiV2ChatPostRequestBodyContentApplicationJsonSchemaMessagesItemsContentOneOf1Items ## Examples **Request** ```json { "messages": [ { "role": "user", "content": "string" } ] } ``` **Response** ```json { "request_id": "string", "success": null, "data": { "chat_id": "string", "message": {}, "sources": [ {} ], "usage": {} }, "pagination": { "total": 127, "offset": 0, "limit": 50 } } ``` **SDK Code** ```python import requests url = "https://api.pyramid-ai.com/api/v2/chat" payload = { "messages": [ { "role": "user", "content": "string" } ] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.pyramid-ai.com/api/v2/chat'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"messages":[{"role":"user","content":"string"}]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.pyramid-ai.com/api/v2/chat" payload := strings.NewReader("{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"string\"\n }\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.pyramid-ai.com/api/v2/chat") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"string\"\n }\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.pyramid-ai.com/api/v2/chat") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"string\"\n }\n ]\n}") .asString(); ``` ```php request('POST', 'https://api.pyramid-ai.com/api/v2/chat', [ 'body' => '{ "messages": [ { "role": "user", "content": "string" } ] }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.pyramid-ai.com/api/v2/chat"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"string\"\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["messages": [ [ "role": "user", "content": "string" ] ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.pyramid-ai.com/api/v2/chat")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```