You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/docs/reference/cloud-rest-api/neo/_index.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,7 +69,7 @@ POST /api/preview/agents/{orgName}/tasks
69
69
|`message.type`| string | Yes | Type of event (must be "user_message") |
70
70
|`message.content`| string | Yes | The exact natural language instruction from the user |
71
71
|`message.timestamp`| string (ISO 8601) | Yes | When the event occurred |
72
-
|`message.entity_diff`| object | No | Entities to add or remove from the agent. See [Entity Types](#entity-types) for details |
72
+
|`message.entity_diff`| object | No | Entities to add or remove from the agent. See [Entity Types](#entity-types) for details. Note: Pull request entities cannot be added via this API.|
73
73
74
74
### Example
75
75
@@ -393,7 +393,7 @@ Send a user message event to provide additional instructions or responses to the
393
393
|`type`| string | Yes | Must be "user_message" |
394
394
|`content`| string | Yes | The user's response or additional instructions |
395
395
|`timestamp`| string (ISO 8601) | Yes | When the event occurred |
396
-
|`entity_diff`| object | No | Entities to add or remove from the agent context |
396
+
|`entity_diff`| object | No | Entities to add or remove from the agent context. See [Entity Types](#entity-types) for details. Note: Pull request entities cannot be added via this API.|
397
397
398
398
### User Confirmation Event
399
399
@@ -471,7 +471,7 @@ Represents a source code repository that the agent can analyze and work with.
471
471
{
472
472
"type": "repository",
473
473
"name": "my-repo",
474
-
"owner": "my-org",
474
+
"org": "my-org",
475
475
"forge": "github"
476
476
}
477
477
```
@@ -482,22 +482,25 @@ Represents a source code repository that the agent can analyze and work with.
482
482
|-------|------|----------|-------------|
483
483
|`type`| string | Yes | Must be "repository" |
484
484
|`name`| string | Yes | The name of the repository |
485
-
|`owner`| string | Yes | The owner of the repository |
485
+
|`org`| string | Yes | The organization owning the repository |
486
486
|`forge`| string | Yes | The forge/provider where the repository is hosted (e.g., "github") |
487
487
488
488
### Pull Request Entity
489
489
490
490
Represents a pull request that the agent can analyze and work with.
491
491
492
+
**Note**: Pull request entities cannot be added using the create task or respond to task APIs. They are managed by the system and associated with tasks through other mechanisms.
493
+
492
494
```json
493
495
{
494
496
"type": "pull_request",
495
497
"number": 123,
496
498
"repository": {
497
499
"name": "my-repo",
498
-
"owner": "my-org",
500
+
"org": "my-org",
499
501
"forge": "github"
500
-
}
502
+
},
503
+
"merged": true
501
504
}
502
505
```
503
506
@@ -507,9 +510,10 @@ Represents a pull request that the agent can analyze and work with.
507
510
|-------|------|----------|-------------|
508
511
|`type`| string | Yes | Must be "pull_request" |
509
512
|`number`| integer | Yes | The pull request number |
513
+
|`merged`| boolean | Yes | If the PR has been merged already |
510
514
|`repository`| object | Yes | The repository information |
511
515
|`repository.name`| string | Yes | The name of the repository |
512
-
|`repository.owner`| string | Yes | The owner of the repository |
516
+
|`repository.org`| string | Yes | The organization owning the repository |
513
517
|`repository.forge`| string | Yes | The forge/provider where the repository is hosted |
0 commit comments