-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathschema.yaml
More file actions
1234 lines (1234 loc) · 41.5 KB
/
Copy pathschema.yaml
File metadata and controls
1234 lines (1234 loc) · 41.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
$schema: http://json-schema.org/draft-07/schema#
definitions:
APIKeySecurityScheme:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines a security scheme using an API key.
properties:
description:
description: An optional description for the security scheme.
type: string
location:
description: The location of the API key. Valid values are "query", "header", or "cookie".
type: string
name:
description: The name of the header, query, or cookie parameter to be used.
type: string
required:
- location
- name
title: API Key Security Scheme
type: object
AgentCapabilities:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines optional capabilities supported by an agent.
properties:
extensions:
description: A list of protocol extensions supported by the agent.
items:
$ref: '#/definitions/AgentExtension'
type: array
pushNotifications:
description: Indicates if the agent supports sending push notifications for asynchronous task updates.
type: boolean
stateTransitionHistory:
description: Indicates if the agent provides a history of state transitions for a task.
type: boolean
streaming:
description: Indicates if the agent supports streaming responses.
type: boolean
title: Agent Capabilities
type: object
AgentExtension:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: A declaration of a protocol extension supported by an Agent.
properties:
description:
description: A human-readable description of how this agent uses the extension.
type: string
params:
$ref: '#/definitions/Struct'
description: Optional, extension-specific configuration parameters.
required:
description: If true, the client must understand and comply with the extension's requirements.
type: boolean
uri:
description: The unique URI identifying the extension.
type: string
required:
- uri
- description
- required
title: Agent Extension
type: object
Struct:
$schema: https://json-schema.org/draft/2020-12/schema
title: Struct
type: object
AgentCard:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: |-
AgentCard is a self-describing manifest for an agent. It provides essential
metadata including the agent's identity, capabilities, skills, supported
communication methods, and security requirements.
Next ID: 20
properties:
additionalInterfaces:
description: 'DEPRECATED: Use ''supported_interfaces'' instead.'
items:
$ref: '#/definitions/AgentInterface'
type: array
capabilities:
$ref: '#/definitions/AgentCapabilities'
description: A2A Capability set supported by the agent.
defaultInputModes:
description: |-
protolint:enable REPEATED_FIELD_NAMES_PLURALIZED
The set of interaction modes that the agent supports across all skills.
This can be overridden per skill. Defined as media types.
items:
type: string
type: array
defaultOutputModes:
description: The media types supported as outputs from this agent.
items:
type: string
type: array
description:
description: |-
A human-readable description of the agent, assisting users and other agents
in understanding its purpose.
Example: "Agent that helps users with recipes and cooking."
type: string
documentationUrl:
description: A url to provide additional documentation about the agent.
type: string
iconUrl:
description: An optional URL to an icon for the agent.
type: string
name:
description: |-
A human readable name for the agent.
Example: "Recipe Agent"
type: string
preferredTransport:
description: 'DEPRECATED: Use ''supported_interfaces'' instead.'
type: string
protocolVersion:
description: |-
The version of the A2A protocol this agent supports.
Default: "1.0"
type: string
provider:
$ref: '#/definitions/AgentProvider'
description: The service provider of the agent.
security:
description: |-
protolint:disable REPEATED_FIELD_NAMES_PLURALIZED
Security requirements for contacting the agent.
items:
$ref: '#/definitions/Security'
type: array
securitySchemes:
additionalProperties:
$ref: '#/definitions/SecurityScheme'
description: The security scheme details used for authenticating with this agent.
propertyNames:
type: string
type: object
signatures:
description: JSON Web Signatures computed for this AgentCard.
items:
$ref: '#/definitions/AgentCardSignature'
type: array
skills:
description: |-
Skills represent an ability of an agent. It is largely
a descriptive concept but represents a more focused set of behaviors that the
agent is likely to succeed at.
items:
$ref: '#/definitions/AgentSkill'
type: array
supportedInterfaces:
description: Ordered list of supported interfaces. First entry is preferred.
items:
$ref: '#/definitions/AgentInterface'
type: array
supportsExtendedAgentCard:
description: Whether the agent supports providing an extended agent card when authenticated.
type: boolean
url:
description: 'DEPRECATED: Use ''supported_interfaces'' instead.'
type: string
version:
description: |-
The version of the agent.
Example: "1.0.0"
type: string
required:
- protocolVersion
- name
- description
- version
- capabilities
- defaultInputModes
- defaultOutputModes
- skills
title: Agent Card
type: object
AgentCardSignature:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: |-
AgentCardSignature represents a JWS signature of an AgentCard.
This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
properties:
header:
$ref: '#/definitions/Struct'
description: The unprotected JWS header values.
protected:
description: |-
The protected JWS header for the signature. This is always a
base64url-encoded JSON object. Required.
type: string
signature:
description: The computed signature, base64url-encoded. Required.
type: string
required:
- protected
- signature
title: Agent Card Signature
type: object
AgentInterface:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: |-
Declares a combination of a target URL and a transport protocol for interacting with the agent.
This allows agents to expose the same functionality over multiple protocol binding mechanisms.
properties:
protocolBinding:
description: |-
The protocol binding supported at this URL. This is an open form string, to be
easily extended for other protocol bindings. The core ones officially
supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
type: string
tenant:
description: Tenant to be set in the request when calling the agent.
type: string
url:
description: |-
The URL where this interface is available. Must be a valid absolute HTTPS URL in production.
Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
type: string
required:
- url
- protocolBinding
title: Agent Interface
type: object
AgentProvider:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Represents the service provider of an agent.
properties:
organization:
description: |-
The name of the agent provider's organization.
Example: "Google"
type: string
url:
description: |-
A URL for the agent provider's website or relevant documentation.
Example: "https://ai.google.dev"
type: string
required:
- url
- organization
title: Agent Provider
type: object
AgentSkill:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Represents a distinct capability or function that an agent can perform.
properties:
description:
description: A detailed description of the skill.
type: string
examples:
description: Example prompts or scenarios that this skill can handle.
items:
type: string
type: array
id:
description: A unique identifier for the agent's skill.
type: string
inputModes:
description: The set of supported input media types for this skill, overriding the agent's defaults.
items:
type: string
type: array
name:
description: A human-readable name for the skill.
type: string
outputModes:
description: The set of supported output media types for this skill, overriding the agent's defaults.
items:
type: string
type: array
security:
description: |-
protolint:disable REPEATED_FIELD_NAMES_PLURALIZED
Security schemes necessary for this skill.
items:
$ref: '#/definitions/Security'
type: array
tags:
description: A set of keywords describing the skill's capabilities.
items:
type: string
type: array
required:
- id
- name
- description
- tags
title: Agent Skill
type: object
AuthorizationCodeOAuthFlow:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines configuration details for the OAuth 2.0 Authorization Code flow.
properties:
authorizationUrl:
description: The authorization URL to be used for this flow.
type: string
refreshUrl:
description: The URL to be used for obtaining refresh tokens.
type: string
scopes:
additionalProperties:
type: string
description: The available scopes for the OAuth2 security scheme.
propertyNames:
type: string
type: object
tokenUrl:
description: The token URL to be used for this flow.
type: string
required:
- authorizationUrl
- tokenUrl
- scopes
title: Authorization CodeO Auth Flow
type: object
ClientCredentialsOAuthFlow:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines configuration details for the OAuth 2.0 Client Credentials flow.
properties:
refreshUrl:
description: The URL to be used for obtaining refresh tokens.
type: string
scopes:
additionalProperties:
type: string
description: The available scopes for the OAuth2 security scheme.
propertyNames:
type: string
type: object
tokenUrl:
description: The token URL to be used for this flow.
type: string
required:
- tokenUrl
- scopes
title: Client CredentialsO Auth Flow
type: object
HTTPAuthSecurityScheme:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines a security scheme using HTTP authentication.
properties:
bearerFormat:
description: |-
A hint to the client to identify how the bearer token is formatted (e.g., "JWT").
This is primarily for documentation purposes.
type: string
description:
description: An optional description for the security scheme.
type: string
scheme:
description: |-
The name of the HTTP Authentication scheme to be used in the Authorization header,
as defined in RFC7235 (e.g., "Bearer").
This value should be registered in the IANA Authentication Scheme registry.
type: string
required:
- scheme
title: HTTP Auth Security Scheme
type: object
ImplicitOAuthFlow:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines configuration details for the OAuth 2.0 Implicit flow.
properties:
authorizationUrl:
description: The authorization URL to be used for this flow.
type: string
refreshUrl:
description: The URL to be used for obtaining refresh tokens.
type: string
scopes:
additionalProperties:
type: string
description: The available scopes for the OAuth2 security scheme.
propertyNames:
type: string
type: object
required:
- authorizationUrl
- scopes
title: ImplicitO Auth Flow
type: object
MutualTlsSecurityScheme:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines a security scheme using mTLS authentication.
properties:
description:
description: An optional description for the security scheme.
type: string
required:
- description
title: Mutual Tls Security Scheme
type: object
OAuth2SecurityScheme:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines a security scheme using OAuth 2.0.
properties:
description:
description: An optional description for the security scheme.
type: string
flows:
$ref: '#/definitions/OAuthFlows'
description: An object containing configuration information for the supported OAuth 2.0 flows.
oauth2MetadataUrl:
description: |-
URL to the oauth2 authorization server metadata
RFC8414 (https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
type: string
required:
- flows
title: O Auth2 Security Scheme
type: object
OAuthFlows:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines the configuration for the supported OAuth 2.0 flows.
properties:
authorizationCode:
$ref: '#/definitions/AuthorizationCodeOAuthFlow'
description: Configuration for the OAuth Authorization Code flow.
clientCredentials:
$ref: '#/definitions/ClientCredentialsOAuthFlow'
description: Configuration for the OAuth Client Credentials flow.
implicit:
$ref: '#/definitions/ImplicitOAuthFlow'
description: Configuration for the OAuth Implicit flow.
password:
$ref: '#/definitions/PasswordOAuthFlow'
description: Configuration for the OAuth Resource Owner Password flow.
title: O Auth Flows
type: object
OpenIdConnectSecurityScheme:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines a security scheme using OpenID Connect.
properties:
description:
description: An optional description for the security scheme.
type: string
openIdConnectUrl:
description: |-
The OpenID Connect Discovery URL for the OIDC provider's metadata.
See: https://openid.net/specs/openid-connect-discovery-1_0.html
type: string
required:
- openIdConnectUrl
title: Open Id Connect Security Scheme
type: object
PasswordOAuthFlow:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines configuration details for the OAuth 2.0 Resource Owner Password flow.
properties:
refreshUrl:
description: The URL to be used for obtaining refresh tokens.
type: string
scopes:
additionalProperties:
type: string
description: The available scopes for the OAuth2 security scheme.
propertyNames:
type: string
type: object
tokenUrl:
description: The token URL to be used for this flow.
type: string
required:
- tokenUrl
- scopes
title: PasswordO Auth Flow
type: object
Security:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
properties:
schemes:
additionalProperties:
$ref: '#/definitions/StringList'
propertyNames:
type: string
type: object
title: Security
type: object
SecurityScheme:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: |-
Defines a security scheme that can be used to secure an agent's endpoints.
This is a discriminated union type based on the OpenAPI 3.2 Security Scheme Object.
See: https://spec.openapis.org/oas/v3.2.0.html#security-scheme-object
properties:
apiKeySecurityScheme:
$ref: '#/definitions/APIKeySecurityScheme'
description: API key-based authentication.
httpAuthSecurityScheme:
$ref: '#/definitions/HTTPAuthSecurityScheme'
description: HTTP authentication (Basic, Bearer, etc.).
mtlsSecurityScheme:
$ref: '#/definitions/MutualTlsSecurityScheme'
description: Mutual TLS authentication.
oauth2SecurityScheme:
$ref: '#/definitions/OAuth2SecurityScheme'
description: OAuth 2.0 authentication.
openIdConnectSecurityScheme:
$ref: '#/definitions/OpenIdConnectSecurityScheme'
description: OpenID Connect authentication.
title: Security Scheme
type: object
StringList:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: protolint:disable REPEATED_FIELD_NAMES_PLURALIZED
properties:
list:
items:
type: string
type: array
title: String List
type: object
Artifact:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Artifacts represent task outputs.
properties:
artifactId:
description: |-
Unique identifier (e.g. UUID) for the artifact. It must be at least unique
within a task.
type: string
description:
description: A human readable description of the artifact, optional.
type: string
extensions:
description: The URIs of extensions that are present or contributed to this Artifact.
items:
type: string
type: array
metadata:
$ref: '#/definitions/Struct'
description: Optional metadata included with the artifact.
name:
description: A human readable name for the artifact.
type: string
parts:
description: The content of the artifact. Must contain at least one part.
items:
$ref: '#/definitions/Part'
type: array
required:
- artifactId
- parts
title: Artifact
type: object
DataPart:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: DataPart represents a structured blob.
properties:
data:
$ref: '#/definitions/Struct'
description: A JSON object containing arbitrary data.
title: Data Part
type: object
required:
- data
FilePart:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: |-
FilePart represents the different ways files can be provided. If files are
small, directly feeding the bytes is supported via file_with_bytes. If the
file is large, the agent should read the content as appropriate directly
from the file_with_uri source.
properties:
fileWithBytes:
description: The base64-encoded content of the file.
pattern: ^[A-Za-z0-9+/]*={0,2}$
type: string
fileWithUri:
description: A URL pointing to the file's content.
type: string
mediaType:
description: The media type of the file (e.g., "application/pdf").
type: string
name:
description: An optional name for the file (e.g., "document.pdf").
type: string
required:
- mediaType
- name
title: File Part
type: object
Part:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: |-
Part represents a container for a section of communication content.
Parts can be purely textual, some sort of file (image, video, etc) or
a structured data blob (i.e. JSON).
properties:
data:
$ref: '#/definitions/DataPart'
description: The structured data content.
file:
$ref: '#/definitions/FilePart'
description: The file content, represented as either a URI or as base64-encoded bytes.
metadata:
$ref: '#/definitions/Struct'
description: Optional metadata associated with this part.
text:
description: The string content of the text part.
type: string
title: Part
type: object
AuthenticationInfo:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Defines authentication details, used for push notifications.
properties:
credentials:
description: Optional credentials
type: string
schemes:
description: A list of supported authentication schemes (e.g., 'Basic', 'Bearer').
items:
type: string
type: array
required:
- schemes
title: Authentication Info
type: object
CancelTaskRequest:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Represents a request for the `tasks/cancel` method.
properties:
name:
description: |-
The resource name of the task to cancel.
Format: tasks/{task_id}
type: string
tenant:
description: Optional tenant, provided as a path parameter.
type: string
required:
- tenant
- name
title: Cancel Task Request
type: object
DeleteTaskPushNotificationConfigRequest:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Represents a request for the `tasks/pushNotificationConfig/delete` method.
properties:
name:
description: |-
The resource name of the config to delete.
Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
type: string
tenant:
description: Optional tenant, provided as a path parameter.
type: string
required:
- tenant
- name
title: Delete Task Push Notification Config Request
type: object
GetExtendedAgentCardRequest:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
properties:
tenant:
description: Optional tenant, provided as a path parameter.
type: string
required:
- tenant
title: Get Extended Agent Card Request
type: object
GetTaskPushNotificationConfigRequest:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
properties:
name:
description: |-
The resource name of the config to retrieve.
Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
type: string
tenant:
description: Optional tenant, provided as a path parameter.
type: string
required:
- tenant
- name
title: Get Task Push Notification Config Request
type: object
GetTaskRequest:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Represents a request for the `tasks/get` method.
properties:
historyLength:
description: The maximum number of messages to include in the history.
maximum: 2147483647
minimum: -2147483648
type: integer
name:
description: |-
The resource name of the task.
Format: tasks/{task_id}
type: string
tenant:
description: Optional tenant, provided as a path parameter.
type: string
required:
- name
title: Get Task Request
type: object
ListTaskPushNotificationConfigRequest:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
properties:
pageSize:
description: The maximum number of configurations to return.
maximum: 2147483647
minimum: -2147483648
type: integer
pageToken:
description: A page token received from a previous ListTaskPushNotificationConfigRequest call.
type: string
parent:
description: |-
The parent task resource.
Format: tasks/{task_id}
type: string
tenant:
description: Optional tenant, provided as a path parameter.
type: string
required:
- tenant
- parent
- pageSize
- pageToken
title: List Task Push Notification Config Request
type: object
ListTaskPushNotificationConfigResponse:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: |-
Represents a successful response for the `tasks/pushNotificationConfig/list`
method.
properties:
configs:
description: The list of push notification configurations.
items:
$ref: '#/definitions/TaskPushNotificationConfig'
type: array
nextPageToken:
description: |-
A token, which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
type: string
required:
- nextPageToken
title: List Task Push Notification Config Response
type: object
PushNotificationConfig:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Configuration for setting up push notifications for task updates.
properties:
authentication:
$ref: '#/definitions/AuthenticationInfo'
description: Information about the authentication to sent with the notification
id:
description: A unique identifier (e.g. UUID) for this push notification.
type: string
token:
description: Token unique for this task/session
type: string
url:
description: Url to send the notification too
type: string
required:
- url
title: Push Notification Config
type: object
TaskPushNotificationConfig:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: |-
A container associating a push notification configuration with a specific
task.
properties:
name:
description: |-
The resource name of the config.
Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
type: string
pushNotificationConfig:
$ref: '#/definitions/PushNotificationConfig'
description: The push notification configuration details.
required:
- name
- pushNotificationConfig
title: Task Push Notification Config
type: object
ListTasksRequest:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Parameters for listing tasks with optional filtering criteria.
properties:
contextId:
description: Filter tasks by context ID to get tasks from a specific conversation or session.
type: string
historyLength:
description: The maximum number of messages to include in each task's history.
maximum: 2147483647
minimum: -2147483648
type: integer
includeArtifacts:
description: |-
Whether to include artifacts in the returned tasks.
Defaults to false to reduce payload size.
type: boolean
lastUpdatedAfter:
description: |-
Filter tasks updated after this timestamp (milliseconds since epoch).
Only tasks with a last updated time greater than or equal to this value will be returned.
type: integer
pageSize:
description: |-
Maximum number of tasks to return. Must be between 1 and 100.
Defaults to 50 if not specified.
maximum: 2147483647
minimum: -2147483648
type: integer
pageToken:
description: Token for pagination. Use the next_page_token from a previous ListTasksResponse.
type: string
status:
description: Filter tasks by their current status state.
enum:
- TASK_STATE_UNSPECIFIED
- TASK_STATE_SUBMITTED
- TASK_STATE_WORKING
- TASK_STATE_COMPLETED
- TASK_STATE_FAILED
- TASK_STATE_CANCELLED
- TASK_STATE_INPUT_REQUIRED
- TASK_STATE_REJECTED
- TASK_STATE_AUTH_REQUIRED
title: Task State
type: string
tenant:
description: Optional tenant, provided as a path parameter.
type: string
required:
- tenant
- contextId
- status
- pageToken
- lastUpdatedAfter
title: List Tasks Request
type: object
ListTasksResponse:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: Result object for tasks/list method containing an array of tasks and pagination information.
properties:
nextPageToken:
description: Token for retrieving the next page. Empty string if no more results.
type: string
pageSize:
description: The size of page requested.
maximum: 2147483647
minimum: -2147483648
type: integer
tasks:
description: Array of tasks matching the specified criteria.
items:
$ref: '#/definitions/Task'
type: array
totalSize:
description: Total number of tasks available (before pagination).
maximum: 2147483647
minimum: -2147483648
type: integer
required:
- tasks
- nextPageToken
- pageSize
- totalSize
title: List Tasks Response
type: object
Message:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: |-
Message is one unit of communication between client and server. It is
associated with a context and optionally a task. Since the server is
responsible for the context definition, it must always provide a context_id
in its messages. The client can optionally provide the context_id if it
knows the context to associate the message to. Similarly for task_id,
except the server decides if a task is created and whether to include the
task_id.
properties:
contextId:
description: |-
The context id of the message. This is optional and if set, the message
will be associated with the given context.
type: string
extensions:
description: The URIs of extensions that are present or contributed to this Message.
items:
type: string
type: array
messageId:
description: |-
The unique identifier (e.g. UUID) of the message. This is required and
created by the message creator.
type: string
metadata:
$ref: '#/definitions/Struct'
description: |-
protolint:enable REPEATED_FIELD_NAMES_PLURALIZED
Any optional metadata to provide along with the message.
parts:
description: |-
protolint:disable REPEATED_FIELD_NAMES_PLURALIZED
Parts is the container of the message content.
items:
$ref: '#/definitions/Part'
type: array
referenceTaskIds:
description: A list of task IDs that this message references for additional context.
items:
type: string
type: array
role:
description: Identifies the sender of the message.
enum:
- ROLE_UNSPECIFIED
- ROLE_USER
- ROLE_AGENT
title: Role
type: string
taskId:
description: |-
The task id of the message. This is optional and if set, the message
will be associated with the given task.
type: string
required:
- messageId
- role
- parts
title: Message
type: object
Task:
$schema: https://json-schema.org/draft/2020-12/schema
additionalProperties: false
description: |-
Task is the core unit of action for A2A. It has a current status
and when results are created for the task they are stored in the
artifact. If there are multiple turns for a task, these are stored in
history.
properties:
artifacts:
description: A set of output artifacts for a Task.
items:
$ref: '#/definitions/Artifact'
type: array
contextId:
description: |-
Unique identifier (e.g. UUID) for the contextual collection of interactions
(tasks and messages). Created by the A2A server.
type: string
history:
description: |-
protolint:disable REPEATED_FIELD_NAMES_PLURALIZED
The history of interactions from a task.
items:
$ref: '#/definitions/Message'
type: array
id:
description: |-
Unique identifier (e.g. UUID) for the task, generated by the server for a