Search published Knowledge documents
POST
/v1/knowledge/searchReturns citation-ready passages only from exact published library versions the caller can access.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
None.
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| query | string | Yes | — |
| libraryIds | string[] | No | — |
| projectId | string | No | Project ID. |
| bindings | object[] | No | Restrict results to explicit immutable library versions. |
| bindings[].libraryId | string | Yes | — |
| bindings[].versionId | string | Yes | — |
| limit | integer | No | — |
| cursor | string | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Ranked Knowledge passagesapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| object | list | Yes | — |
| data | object[] | Yes | — |
| data[].libraryId | string | Yes | — |
| data[].libraryName | string | No | — |
| data[].libraryVersionId | string | Yes | — |
| data[].libraryVersionNumber | integer | No | — |
| data[].libraryFingerprint | string | No | — |
| data[].documentId | string | Yes | Document ID. |
| data[].revisionId | string | Yes | — |
| data[].title | string | Yes | Display title. |
| data[].slug | string | No | — |
| data[].parentDocumentId | string | No | — |
| data[].summary | string | No | — |
| data[].excerpt | string | Yes | — |
| data[].contentHash | string | Yes | — |
| data[].provenance | object | No | — |
| data[].score | number | No | — |
| data[].citationId | string | Yes | Stable version-document-revision tuple for audit and replay. |
| nextCursor | string | No | — |
Search published Knowledge documents
Loading...
Response 200
Loading...