Skip to content

fix: Add A2A task endpoints and deprecate generic API #648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VirusDumb wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Add A2A task endpoints and deprecate generic API #648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion agent-os/interfaces/a2a/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,15 @@ For each available agent, team and workflow, the following A2A-compatible endpoi
See [API reference](/reference-api/schema/a2a/stream-message-agent) and [A2A protocol docs](https://a2a-protocol.org/v0.3.0/specification/#356-method-mapping-reference-table).

- `/a2a/agents/{id}/v1/message:send`:
Runs the agen, returning the response in A2A format (non-streaming).
Runs the agent, returning the response in A2A format (non-streaming).
See [A2A protocol docs](https://a2a-protocol.org/v0.3.0/specification/#356-method-mapping-reference-table).

- `/a2a/agents/{id}/v1/tasks:get`:
Retrieves task status by ID. See [API reference](/reference-api/schema/a2a/get-agent-task).

- `/a2a/agents/{id}/v1/tasks:cancel`:
Cancels a running task. See [API reference](/reference-api/schema/a2a/cancel-agent-task).


### Teams

Expand All @@ -90,6 +96,12 @@ For each available agent, team and workflow, the following A2A-compatible endpoi
- `/a2a/teams/{id}/v1/message:send`:
Runs the team, returning the response in A2A format (non-streaming). See [API reference](/reference-api/schema/a2a/run-message-agent).

- `/a2a/teams/{id}/v1/tasks:get`:
Retrieves task status by ID. See [API reference](/reference-api/schema/a2a/get-team-task).

- `/a2a/teams/{id}/v1/tasks:cancel`:
Cancels a running task. See [API reference](/reference-api/schema/a2a/cancel-team-task).

### Workflows

- `/a2a/workflows/{id}/.well-known/agent-card.json`:
Expand Down
8 changes: 7 additions & 1 deletion reference-api/schema/a2a/send-message.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
openapi: post /a2a/message/send
---
---

<Warning>
This generic endpoint is deprecated. Use the per-resource endpoints instead:
`/a2a/agents/{id}/v1/message:send`, `/a2a/teams/{id}/v1/message:send`, or
`/a2a/workflows/{id}/v1/message:send`.
</Warning>
8 changes: 7 additions & 1 deletion reference-api/schema/a2a/stream-message.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
openapi: post /a2a/message/stream
---
---

<Warning>
This generic endpoint is deprecated. Use the per-resource endpoints instead:
`/a2a/agents/{id}/v1/message:stream`, `/a2a/teams/{id}/v1/message:stream`, or
`/a2a/workflows/{id}/v1/message:stream`.
</Warning>
13 changes: 13 additions & 0 deletions reference/clients/a2a-client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ print(f"Context ID: {result.context_id}")
| `videos` | `Optional[List[Video]]` | `None` | Videos to include |
| `files` | `Optional[List[File]]` | `None` | Files to include |
| `metadata` | `Optional[Dict[str, Any]]` | `None` | Additional metadata |
| `headers` | `Optional[Dict[str, str]]` | `None` | Extra HTTP headers to send with the request |

**Returns:** `TaskResult`

Expand Down Expand Up @@ -129,6 +130,12 @@ if card:
print(f"Capabilities: {card.capabilities}")
```

**Parameters:**

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `headers` | `Optional[Dict[str, str]]` | `None` | Extra HTTP headers to send with the request |

**Returns:** `AgentCard` if available, `None` otherwise

---
Expand All @@ -144,6 +151,12 @@ if card:
print(f"Capabilities: {card.capabilities}")
```

**Parameters:**

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `headers` | `Optional[Dict[str, str]]` | `None` | Extra HTTP headers to send with the request |

**Returns:** `AgentCard` if available, `None` otherwise

## Response Types
Expand Down
Loading