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

# Put audits context

> Replace an audit's extra context. This is a full replacement, not a merge: the brief and the reference URL list are both set to exactly what you send, so send an empty value to clear one. Context is edited here rather than through the audit itself, so an ordinary unrelated edit to the audit can never overwrite it.



## OpenAPI

````yaml /reference/openapi.json put /audits/{id}/context
openapi: 3.1.0
info:
  title: AgentEye API
  description: >-
    The AgentEye observability API.


    Every path below is relative to `/v1` on your deployment's dashboard origin
    — e.g. `https://app.example.com/v1/sessions`. Authenticate with a scoped API
    key as a bearer token.


    Organization scoping: a key belongs to one organization and acts on it
    automatically. An instance-scoped key selects one per request with the
    `X-AgentEye-Org` header; without it, such a key resolves to the default
    organization, so set it explicitly on a multi-org deployment.
  license:
    name: MIT
    identifier: MIT
  version: 0.0.1-beta.77
servers:
  - url: /v1
    description: This deployment
security:
  - api_key: []
tags:
  - name: Events
    description: Ingest and query the event store.
  - name: Sessions
    description: Agent sessions and their evaluations.
  - name: Evaluations
    description: Evaluation results and re-runs.
  - name: Dashboards
    description: Dashboards and their tiles.
  - name: Queries
    description: Saved SQL and ad-hoc query execution.
  - name: Keys
    description: Mint and manage scoped API keys.
  - name: Users
    description: Dashboard members and access.
  - name: Settings
    description: Operational settings and context-window overrides.
  - name: Permission sets
    description: Named permission roles.
  - name: Alerts
    description: Alert rules and their recipients.
  - name: Issues
    description: Open, triage, assign and resolve issues.
  - name: Audits
    description: Recurring audits and their findings.
  - name: Usage
    description: Organization usage and billing windows.
  - name: Health
    description: Liveness.
  - name: Auth
    description: Describe the key you are calling with.
paths:
  /audits/{id}/context:
    put:
      tags:
        - Audits
      description: >-
        Replace an audit's extra context. This is a full replacement, not a
        merge: the brief and the reference URL list are both set to exactly what
        you send, so send an empty value to clear one. Context is edited here
        rather than through the audit itself, so an ordinary unrelated edit to
        the audit can never overwrite it.
      operationId: put_context
      parameters:
        - name: id
          in: path
          description: The audit's id.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContextBody'
        required: true
      responses:
        '200':
          description: Context replaced. Returns the stored brief and sources.
        '401':
          description: Missing, unknown, or disabled key.
        '403':
          description: The key lacks `audits:write`.
        '404':
          description: No such audit in this organization.
        '422':
          description: >-
            The brief is too long, or a URL is invalid, duplicated, or over the
            limit.
      security:
        - api_key: []
components:
  schemas:
    ContextBody:
      type: object
      properties:
        text:
          type: string
          description: >-
            The audit's written brief. Replaced wholesale — send an empty string
            to

            clear it. Limited to 8192 characters.
        urls:
          type: array
          items:
            type: string
          description: >-
            Reference URLs this audit draws on. Replaced wholesale — send an
            empty

            array to remove every source and the text stored for it. The order
            you

            send is the order they are used. At most 5.
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
      description: >-
        A scoped AgentEye API key. Mint one in the dashboard under Settings →
        API keys, or with `POST /v1/keys`. Each endpoint names the permission it
        requires; a key without it gets 403 and a `required_permission` field
        naming what was missing.

````