Get the field-level contract for one capability | AgentRouter

{
  "domainKey": "email",
  "capabilityKey": "email.send",
  "capabilityId": "send",
  "contractStatus": "available",
  "notes": [
    "Capability contracts are the canonical place to inspect exact request fields."
  ],
  "docsUrl": "https://docs.agentrouter.to/core-concepts/capability",
  "recommend": {
    "status": "available",
    "requiredFields": [],
    "optionalFields": [
      "agentName",
      "optimizationPreferences",
      "tracking"
    ],
    "conditionallyRequiredFields": [],
    "fields": [
      {
        "name": "agentName",
        "type": "string",
        "required": false
      },
      {
        "name": "optimizationPreferences",
        "type": "array",
        "required": false,
        "itemsType": "string"
      },
      {
        "name": "tracking",
        "type": "boolean",
        "required": false
      }
    ],
    "notes": [
      "Use recommend before execute when the caller has not pinned one provider yet."
    ],
    "dtoName": "RecommendEmailProviderDto",
    "requestExample": {
      "agentName": "alpha_agent",
      "optimizationPreferences": [
        "cost",
        "quality"
      ],
      "tracking": true
    }
  },
  "execute": {
    "status": "available",
    "requiredFields": [
      "to",
      "subject"
    ],
    "optionalFields": [
      "html",
      "text",
      "provider",
      "allowFallback"
    ],
    "conditionallyRequiredFields": [],
    "fields": [
      {
        "name": "to",
        "type": "string",
        "required": true
      },
      {
        "name": "subject",
        "type": "string",
        "required": true
      },
      {
        "name": "html",
        "type": "string",
        "required": false
      },
      {
        "name": "text",
        "type": "string",
        "required": false
      },
      {
        "name": "provider",
        "type": "string",
        "required": false
      },
      {
        "name": "allowFallback",
        "type": "boolean",
        "required": false
      }
    ],
    "notes": [
      "Provide exactly the inner execute body. Do not wrap it again in domain or capability fields."
    ],
    "dtoName": "SendEmailDto",
    "requestExample": {
      "to": "maya@example.com",
      "subject": "Hello from AgentRouter",
      "html": "<p>Hello</p>",
      "provider": "resend",
      "allowFallback": true
    }
  }
}

Path parameters

domainKeystringRequired

Domain identifier such as email, search, text, web, enrichment, or social.

capabilityIdstringRequired

Capability identifier inside the selected domain, such as send, answer, analyze, people-search, or extract.

Response

Capability contract for recommend and execute

domainKeystring

capabilityKeystring

capabilityIdstring

contractStatusenum

noteslist of strings

docsUrlstringformat: "uri"

executeobject

Errors

404

Not Found Error

1	{
2	"domainKey": "email",
3	"capabilityKey": "email.send",
4	"capabilityId": "send",
5	"contractStatus": "available",
6	"notes": [
7	"Capability contracts are the canonical place to inspect exact request fields."
8	],
9	"docsUrl": "https://docs.agentrouter.to/core-concepts/capability",
10	"recommend": {
11	"status": "available",
12	"requiredFields": [],
13	"optionalFields": [
14	"agentName",
15	"optimizationPreferences",
16	"tracking"
17	],
18	"conditionallyRequiredFields": [],
19	"fields": [
20	{
21	"name": "agentName",
22	"type": "string",
23	"required": false
24	},
25	{
26	"name": "optimizationPreferences",
27	"type": "array",
28	"required": false,
29	"itemsType": "string"
30	},
31	{
32	"name": "tracking",
33	"type": "boolean",
34	"required": false
35	}
36	],
37	"notes": [
38	"Use recommend before execute when the caller has not pinned one provider yet."
39	],
40	"dtoName": "RecommendEmailProviderDto",
41	"requestExample": {
42	"agentName": "alpha_agent",
43	"optimizationPreferences": [
44	"cost",
45	"quality"
46	],
47	"tracking": true
48	}
49	},
50	"execute": {
51	"status": "available",
52	"requiredFields": [
53	"to",
54	"subject"
55	],
56	"optionalFields": [
57	"html",
58	"text",
59	"provider",
60	"allowFallback"
61	],
62	"conditionallyRequiredFields": [],
63	"fields": [
64	{
65	"name": "to",
66	"type": "string",
67	"required": true
68	},
69	{
70	"name": "subject",
71	"type": "string",
72	"required": true
73	},
74	{
75	"name": "html",
76	"type": "string",
77	"required": false
78	},
79	{
80	"name": "text",
81	"type": "string",
82	"required": false
83	},
84	{
85	"name": "provider",
86	"type": "string",
87	"required": false
88	},
89	{
90	"name": "allowFallback",
91	"type": "boolean",
92	"required": false
93	}
94	],
95	"notes": [
96	"Provide exactly the inner execute body. Do not wrap it again in domain or capability fields."
97	],
98	"dtoName": "SendEmailDto",
99	"requestExample": {
100	"to": "maya@example.com",
101	"subject": "Hello from AgentRouter",
102	"html": "<p>Hello</p>",
103	"provider": "resend",
104	"allowFallback": true
105	}
106	}
107	}