Create Harbor Context | Polytomic Docs

Creates and attaches a context document to a Harbor. The new document belongs only to this Harbor. Context documents cannot be attached to multiple Harbors.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

harbor_idstringRequiredformat: "uuid"

Unique identifier of the Harbor.

Request

This endpoint expects an object.

contentstringRequired

Plain-text context content. Maximum 20,000 characters.

titlestringRequired

Human-readable context title. Maximum 200 characters.

descriptionstringOptional

Short summary of the context document. Maximum 1,000 characters.

Response

dataobjectOptional

Errors

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X POST https://app.polytomic.com/api/harbors/248df4b7-aa70-47b8-a036-33ac447e668d/contexts \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"content": "Bookings use the contract signed date...",
>	"title": "Revenue definitions"
>	}'

1	{
2	"data": {
3	"content": "string",
4	"created_at": "2024-01-15T09:30:00Z",
5	"description": "string",
6	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7	"title": "string",
8	"updated_at": "2024-01-15T09:30:00Z"
9	}
10	}

Authentication

Path parameters

Headers

Request

Response

Errors