> For the complete documentation index, see [llms.txt](https://docs.ox.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ox.security/api-documentation/api-reference/api--vibesec/types/objects/applied-guideline.md).

# appliedGuideline

### Examples

```graphql
type AppliedGuideline {
  oxGuidelineId: String!
  displayName: String!
  category: String!
  createdBy: String!
  prompt: String!
  promptSizeBytes: Int
  isFromCache: Boolean
  tokenCount: Int
}
```

### Fields

| Field                   | Description                                                                                                                                | Supported fields |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- |
| oxGuidelineId `String!` | Identifier of the OX guideline that was applied                                                                                            |                  |
| displayName `String!`   | Display name of the guideline                                                                                                              |                  |
| category `String!`      | Category the guideline belongs to                                                                                                          |                  |
| createdBy `String!`     | Who created the guideline                                                                                                                  |                  |
| prompt `String!`        | Guideline text injected into the agent session                                                                                             |                  |
| promptSizeBytes `Int`   | Size of the injected guideline text, in bytes                                                                                              |                  |
| isFromCache `Boolean`   | True when the client already held this guideline in the model context and received only a short reminder instead of the full text.         |                  |
| tokenCount `Int`        | Tokens this guideline cost on this prompt as the hook injected it: body plus the hook tail, or the reminder-line estimate when isFromCache |                  |

### References

#### Fields with this object:

* [{} PromptAgentActivity.appliedGuidelines](/api-documentation/api-reference/api--vibesec/types/objects/prompt-agent-activity.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ox.security/api-documentation/api-reference/api--vibesec/types/objects/applied-guideline.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.