> ## Documentation Index
> Fetch the complete documentation index at: https://docs.correl8.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Correl8 guidelines

> Same JSON as the MCP tool `get_correl8_guidelines`. Returns project-specific markdown for observations and research posting. `research` is present only when the project has at least one active research study. Active studies themselves are fetched separately — see `getActiveStudies`.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/project/{project_id}/correl8-guidelines/
openapi: 3.1.0
info:
  title: Correl8 API
  description: >-
    Public REST API for Correl8 custom integrations — observations, guidelines,
    and research answers. MCP integration is documented separately.
  version: 1.0.0
servers:
  - url: https://api.correl8.ai
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /v1/project/{project_id}/correl8-guidelines/:
    get:
      tags:
        - Guidelines
      summary: Get Correl8 guidelines
      description: >-
        Same JSON as the MCP tool `get_correl8_guidelines`. Returns
        project-specific markdown for observations and research posting.
        `research` is present only when the project has at least one active
        research study. Active studies themselves are fetched separately — see
        `getActiveStudies`.
      operationId: getCorrel8Guidelines
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Project UUID
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            End-user identifier. Has no effect on this response; pass it for
            consistency with other calls.
      responses:
        '200':
          description: Guidelines payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Correl8Guidelines'
              example:
                observations: |-
                  ## Internal observations (`post_observations`)

                  …
                research: |-
                  ## Research studies (`post_research_answer`)

                  …
        '401':
          description: Missing or invalid API key
        '404':
          description: Project not found or key not authorized for this project
components:
  schemas:
    Correl8Guidelines:
      type: object
      required:
        - observations
      properties:
        observations:
          type: string
          description: 'Markdown: when and how to call `post_observations`'
        research:
          type: string
          description: >-
            Markdown: when and how to conduct research and call
            `post_research_answer`. Present only when the project has at least
            one active research study.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Project API key prefixed with `ApiKey`, e.g. `Authorization: ApiKey
        c8.xxx`. Alternatively use header `X-Api-Key: c8.xxx`.

````