Skip to main content

Get context

GET/api/projects/{projectId}/context
Signed-in memberRead-only

The AI knows nothing about a product beyond the change in front of it. A Project's context tells it what it cannot guess: what is a client and what is a server, where settings live, how people reach features, and what stays in English by design. Follow Project context on a Project's card, or call GET /api/projects/{projectId}/context, which returns the context and who last changed it. Every member can read it; only administrators write it, on the page or with PUT /api/projects/{projectId}/context and {"context": "..."}. It is plain text of at most 2000 characters; longer returns 400 validation_failed, and an empty one clears it.

Read more: Project contextSource: ProjectApiController#context(opens in new tab)

Path parameters​

NameTypeRequiredNotes
projectIdstring (uuid)Required

Response​

Success: 200

FieldTypeRequiredNotes
projectIdstring (uuid)Optional
contextstringOptional
updatedBystringOptional
updatedAtstring (date-time)Optional

Errors​

StatusCodeApplies to
400validation_faileda field is missing or out of rangeAny endpoint
400invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUIDAny endpoint
401authentication_requiredno sessionAny endpoint
404not_foundno such addressAny endpoint
405method_not_allowedthe address does not take that methodAny endpoint
415unsupported_media_typethe address does not read a body of that typeAny endpoint
500internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind itAny endpoint
400invalid_change_filterChanges area
400invalid_change_reviewChanges area
400invalid_sensitive_pathsChanges area
404change_not_foundChanges area
404duplicate_candidate_not_foundChanges area
409change_processingChanges area
409change_not_eligible_for_aiChanges area
409duplicate_candidate_decidedChanges area
409change_excludedChanges area
409change_in_releaseChanges area
502ai_classification_failedChanges area
503ai_classification_unavailableChanges area
404category_not_foundCategories area
404category_suggestion_not_foundCategories area
409category_code_takenCategories area
409category_systemCategories area
409category_suggestion_decidedCategories area

Request

bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
curl "http://localhost:8080/api/projects/$PROJECT_ID/context" \
-b cookies.txt -c cookies.txt

Response

200

Example

{
  "projectId": "<uuid>",
  "context": "<string>",
  "updatedBy": "<string>",
  "updatedAt": "<date-time>"
}