Create a Knowledge library and its initial draft
POST
/v1/knowledgeHow 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 |
|---|---|---|---|
| name | string | Yes | Human-readable name. |
| description | string | No | Human-readable description. |
| homeTitle | string | No | — |
| homeMarkdown | string | No | — |
| metadata | object | No | Free-form metadata object. |
| permissionSet | object | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Knowledge library createdapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| library | object | No | — |
| library.id | string | Yes | Unique identifier. |
| library.name | string | Yes | Human-readable name. |
| library.description | string | Yes | Human-readable description. |
| library.homeDocumentId | string | Yes | — |
| library.creatorId | string | No | — |
| library.creatorUserId | string | No | — |
| library.creatorName | string | No | — |
| library.creatorEmail | string | No | — |
| library.creatorAvatarUrl | string | No | — |
| library.ownerId | string | No | — |
| library.ownerUserId | string | No | — |
| library.ownerName | string | No | — |
| library.ownerEmail | string | No | — |
| library.ownerAvatarUrl | string | No | — |
| library.currentVersionId | string | Yes | — |
| library.currentVersionNumber | integer | Yes | — |
| library.publishedVersionId | string | No | — |
| library.metadata | object | No | Free-form metadata object. |
| library.permissionSet | object | No | — |
| library.documents | object[] | No | — |
| library.documents[].id | string | Yes | Unique identifier. |
| library.documents[].libraryId | string | Yes | — |
| library.documents[].revisionId | string | Yes | — |
| library.documents[].currentRevisionId | string | No | — |
| library.documents[].parentDocumentId | string | No | — |
| library.documents[].slug | string | No | — |
| library.documents[].sortOrder | integer | No | — |
| library.documents[].archived | boolean | No | — |
| library.documents[].title | string | Yes | Display title. |
| library.documents[].name | string | No | Human-readable name. |
| library.documents[].summary | string | No | — |
| library.documents[].description | string | No | Human-readable description. |
| library.documents[].markdown | string | Yes | — |
| library.documents[].content | string | No | Raw text content. |
| library.documents[].contentHash | string | Yes | — |
| library.documents[].provenance | object | No | — |
| library.documents[].createdByUserId | string | No | — |
| library.documents[].revisionCreatedByUserId | string | No | — |
| library.documents[].createdAt | string | Yes | ISO 8601 timestamp. |
| library.documents[].revisionCreatedAt | string | No | — |
| library.documents[].updatedAt | string | Yes | ISO 8601 timestamp. |
| library.versions | object[] | No | — |
| library.versions[].id | string | Yes | Unique identifier. |
| library.versions[].number | integer | No | — |
| library.versions[].versionNumber | integer | Yes | — |
| library.versions[].name | string | No | Human-readable name. |
| library.versions[].description | string | No | Human-readable description. |
| library.versions[].status | saved | published | Yes | Current lifecycle status. |
| library.versions[].fingerprint | string | Yes | — |
| library.versions[].publishedAt | string | No | — |
| library.versions[].createdAt | string | Yes | ISO 8601 timestamp. |
| library.versions[].updatedAt | string | Yes | ISO 8601 timestamp. |
| library.createdAt | string | Yes | ISO 8601 timestamp. |
| library.updatedAt | string | Yes | ISO 8601 timestamp. |
| version | object | No | — |
| version.id | string | Yes | Unique identifier. |
| version.number | integer | No | — |
| version.versionNumber | integer | Yes | — |
| version.name | string | No | Human-readable name. |
| version.description | string | No | Human-readable description. |
| version.status | saved | published | Yes | Current lifecycle status. |
| version.fingerprint | string | Yes | — |
| version.publishedAt | string | No | — |
| version.createdAt | string | Yes | ISO 8601 timestamp. |
| version.updatedAt | string | Yes | ISO 8601 timestamp. |
| homeDocument | object | No | — |
| homeDocument.id | string | Yes | Unique identifier. |
| homeDocument.libraryId | string | Yes | — |
| homeDocument.revisionId | string | Yes | — |
| homeDocument.currentRevisionId | string | No | — |
| homeDocument.parentDocumentId | string | No | — |
| homeDocument.slug | string | No | — |
| homeDocument.sortOrder | integer | No | — |
| homeDocument.archived | boolean | No | — |
| homeDocument.title | string | Yes | Display title. |
| homeDocument.name | string | No | Human-readable name. |
| homeDocument.summary | string | No | — |
| homeDocument.description | string | No | Human-readable description. |
| homeDocument.markdown | string | Yes | — |
| homeDocument.content | string | No | Raw text content. |
| homeDocument.contentHash | string | Yes | — |
| homeDocument.provenance | object | No | — |
| homeDocument.createdByUserId | string | No | — |
| homeDocument.revisionCreatedByUserId | string | No | — |
| homeDocument.createdAt | string | Yes | ISO 8601 timestamp. |
| homeDocument.revisionCreatedAt | string | No | — |
| homeDocument.updatedAt | string | Yes | ISO 8601 timestamp. |
Create a Knowledge library and its initial draft
Loading...
Response 201
Loading...