Get guidelines - Correl8 documentation

GET /v1/project/{project_id}/correl8-guidelines/

Same JSON as the MCP tool get_correl8_guidelines. Use this when your integration cannot call MCP tools — for example, the basic-agent REST example fetches guidelines at startup and injects them into the system prompt. For the full schema, see Get Correl8 guidelines in the API reference.

Request

curl "https://api.correl8.ai/v1/project/{project_id}/correl8-guidelines/?user_id=user-42" \
  -H "Authorization: ApiKey c8.xxx"

Pass user_id as a query parameter when you have a stable end-user id (it has no effect on this response, but keep it consistent with your other calls).

Response

Returns 200 with JSON:

Field	Description
`observations`	Markdown — when and how to call `post_observations`
`research`	Markdown — how to conduct studies and call `post_research_answer`. Present only when the project has at least one active research study.

Customize observations and research in the app — see Guidelines. This endpoint does not include active studies. To fetch those, call Get active studies.