> 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/write-edit-agent-activity.md).

# writeEditAgentActivity

Fetch a single WriteEdit activity by id.

### Examples

{% tabs %}
{% tab title="GraphQL" %}

```graphql
query WriteEditAgentActivity($input: AgentActivityByIdInput!) {
  writeEditAgentActivity(input: $input) {
    id
    createdAt
    activityType
    oxAction
    userEmail
    userRole
    source
    appName
    threadId
    filePath
    model
    appliedGuidelines {
      name
      lineNumber
    }
    hoursSaved
  }
}
```

#### 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 WriteEditAgentActivity($input: AgentActivityByIdInput!) { writeEditAgentActivity(input: $input) { id createdAt activityType oxAction userEmail userRole source appName threadId filePath model appliedGuidelines { name lineNumber } hoursSaved } }",
 "variables": {
    "input": {
      "id": "68b7c1f0a2e4d51234567890"
    }
  }
}'
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const query = 'query WriteEditAgentActivity($input: AgentActivityByIdInput!) { writeEditAgentActivity(input: $input) { id createdAt activityType oxAction userEmail userRole source appName threadId filePath model appliedGuidelines { name lineNumber } hoursSaved } }';

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 WriteEditAgentActivity($input: AgentActivityByIdInput!) { writeEditAgentActivity(input: $input) { id createdAt activityType oxAction userEmail userRole source appName threadId filePath model appliedGuidelines { name lineNumber } hoursSaved } }'

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 `writeEditAgentActivity` query.

| Argument                                                                                                                                                                                  | Description | Supported fields |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ---------------- |
| input [`AgentActivityByIdInput!`](/api-documentation/api-reference/api--vibesec/types/inputs/agent-activity-by-id-input.md) <mark style="color:red;background-color:red;">required</mark> |             | id `ID!`         |

### Fields

Return type: [`WriteEditAgentActivity`](/api-documentation/api-reference/api--vibesec/types/objects/write-edit-agent-activity.md)

You can use the following field(s) to specify what information your `writeEditAgentActivity` 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           |                                                                  |
| filePath `String!`                                                                                                                           | Path of the file the agent wrote or edited                             |                                                                  |
| model `String`                                                                                                                               | AI model that produced the change                                      |                                                                  |
| appliedGuidelines [`[AppliedGuidelineLocation!]`](/api-documentation/api-reference/api--vibesec/types/objects/applied-guideline-location.md) | OX guidelines applied to this change, with their locations in the file | <p>name <code>String!</code><br>lineNumber <code>Int!</code></p> |
| hoursSaved `Float`                                                                                                                           | Estimated engineering hours saved, derived from the applied guideline  |                                                                  |


---

# 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/write-edit-agent-activity.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.
