> 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/queries/prompt-agent-activity.md). # promptAgentActivity Fetch a single Prompt activity by id. ### Examples {% tabs %} {% tab title="GraphQL" %} ```graphql query PromptAgentActivity($input: AgentActivityByIdInput!) { promptAgentActivity(input: $input) { id createdAt activityType oxAction userEmail userRole source appName threadId promptSizeBytes responseTokenCount model appliedGuidelines { oxGuidelineId displayName category createdBy prompt promptSizeBytes isFromCache tokenCount } secretRuleIds maskedSecrets secretTypeLabels blockedSecretCount } } ``` #### Variables This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. ```json { "input": { "id": "68b7c1f0a2e4d51234567890" } } ``` {% endtab %} {% tab title="cURL" %} ```shell curl -X POST \ https://api.cloud.ox.security/api/apollo-gateway \ -H 'Content-Type: application/json' \ -H 'Authorization: YOUR_API_TOKEN' \ -d '{ "query": "query PromptAgentActivity($input: AgentActivityByIdInput!) { promptAgentActivity(input: $input) { id createdAt activityType oxAction userEmail userRole source appName threadId promptSizeBytes responseTokenCount model appliedGuidelines { oxGuidelineId displayName category createdBy prompt promptSizeBytes isFromCache tokenCount } secretRuleIds maskedSecrets secretTypeLabels blockedSecretCount } }", "variables": { "input": { "id": "68b7c1f0a2e4d51234567890" } } }' ``` {% endtab %} {% tab title="Node.js" %} ```javascript const query = 'query PromptAgentActivity($input: AgentActivityByIdInput!) { promptAgentActivity(input: $input) { id createdAt activityType oxAction userEmail userRole source appName threadId promptSizeBytes responseTokenCount model appliedGuidelines { oxGuidelineId displayName category createdBy prompt promptSizeBytes isFromCache tokenCount } secretRuleIds maskedSecrets secretTypeLabels blockedSecretCount } }'; fetch("https://api.cloud.ox.security/api/apollo-gateway", { method: "POST", headers: { "Content-Type": "application/json", "Authorization": "YOUR_API_TOKEN" }, body: JSON.stringify({ query: query, // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. variables: { input: { id: "68b7c1f0a2e4d51234567890" } } }) }) .then(response => response.json()) .then(result => console.log(JSON.stringify(result, null, 2))) .catch(error => console.error('Error:', error)); ``` {% endtab %} {% tab title="Python" %} ```python import requests query = 'query PromptAgentActivity($input: AgentActivityByIdInput!) { promptAgentActivity(input: $input) { id createdAt activityType oxAction userEmail userRole source appName threadId promptSizeBytes responseTokenCount model appliedGuidelines { oxGuidelineId displayName category createdBy prompt promptSizeBytes isFromCache tokenCount } secretRuleIds maskedSecrets secretTypeLabels blockedSecretCount } }' response = requests.post( "https://api.cloud.ox.security/api/apollo-gateway", headers={ "Content-Type": "application/json", "Authorization": "YOUR_API_TOKEN" }, json={ "query": query, # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. "variables": { "input": { "id": "68b7c1f0a2e4d51234567890" } } } ) if response.status_code == 200: result = response.json() print(result) else: print(f"Error: {response.status_code}") print(response.text) ``` {% endtab %} {% endtabs %} ### Arguments You can use the following argument(s) to customize your `promptAgentActivity` query. | Argument | Description | Supported fields | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ---------------- | | input [`AgentActivityByIdInput!`](/api-documentation/api-reference/api--vibesec/types/inputs/agent-activity-by-id-input.md) required | | id `ID!` | ### Fields Return type: [`PromptAgentActivity`](/api-documentation/api-reference/api--vibesec/types/objects/prompt-agent-activity.md) You can use the following field(s) to specify what information your `promptAgentActivity` query will return. Please note that some fields may have their own subfields. | Field | Description | Supported fields | | --------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id `ID!` | Unique identifier of the activity record | | | createdAt `DateTime` | When the activity was recorded | | | activityType [`AgentActivityType!`](/api-documentation/api-reference/api--vibesec/types/enums/agent-activity-type.md) | Kind of agent activity this record represents | | | oxAction [`OxAction!`](/api-documentation/api-reference/api--vibesec/types/enums/ox-action.md) | Action OX took on this activity | | | userEmail `String` | Email address of the developer who triggered the activity | | | userRole `String` | Role of the developer who triggered the activity | | | source [`VibeCodeSource!`](/api-documentation/api-reference/api--vibesec/types/enums/vibe-code-source.md) | Coding agent the activity originated from | | | appName `String` | Application the activity was attributed to | | | threadId `String` | Identifier of the agent conversation the activity belongs to | | | promptSizeBytes `Int` | Size of the prompt, in bytes | | | responseTokenCount `Int` | Tokens of security guidance the model received for this prompt, as the hook injected it, wrapper text included | | | model `String` | AI model the prompt was sent to | | | appliedGuidelines [`[AppliedGuideline!]`](/api-documentation/api-reference/api--vibesec/types/objects/applied-guideline.md) | OX guidelines injected into this prompt |

oxGuidelineId String!
displayName String!
category String!
createdBy String!
prompt String!
promptSizeBytes Int
isFromCache Boolean
tokenCount Int

| | secretRuleIds `[String!]` | Identifiers of the secret-detection rules that matched | | | maskedSecrets `[String!]` | Matched credentials, already masked by the hook | | | secretTypeLabels `[String!]` | Human-readable names of the secret types that matched (e.g. "AWS Access Token"), derived from secretRuleIds. Never derived from the credential itself | | | blockedSecretCount `Int` | How many secret matches the hook reported (capped at 10 by the hook) | | --- # 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/queries/prompt-agent-activity.md?ask=&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.