Upload and persist a Knowledge library cover image
POST
/v1/knowledge/{libraryId}/coverNormalizes the image to an optimized WebP asset in the deployment's durable artifact store and atomically promotes it to the library's first-class cover field.
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
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| libraryId | path | string | Yes | Knowledge library ID |
Query parameters
None.
Body schema
Content type: multipart/form-data · Required
| Field | Type | Required | Description |
|---|---|---|---|
| file | string | Yes | Supported image file (maximum 15 MB). |
| source | upload | computer | No | — |
| positionX | number | No | — |
| positionY | number | No | — |
| zoom | number | No | — |
| computerId | string | No | — |
| computerPath | string | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Durable cover image saved and linked to the libraryapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| library | object | Yes | — |
| 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.cover | object | Yes | — |
| library.cover.schemaVersion | computer_agents_knowledge_cover_v1 | Yes | — |
| library.cover.type | gradient | Yes | — |
| library.cover.preset | blue | Yes | — |
| 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. |
400Missing or invalid image upload
None.
413Image exceeds the 15 MB upload limit
None.
Upload and persist a Knowledge library cover image
Loading...
Response 201
Loading...