Propose (automation)
POST
/api/v1/automations/assistant/proposeRequest body
intentstringrequiredautomation_idstringgrapharraynodesarrayedgesarray
historyarray<object>rolestringyou | mayacontentstring
Request
POST
/api/v1/automations/assistant/proposecurl -X POST 'https://app.mailyte.com/api/v1/automations/assistant/propose' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"intent": "<string>",
"automation_id": "<string>",
"graph": [],
"history": []
}'const response = await fetch('https://app.mailyte.com/api/v1/automations/assistant/propose', {
method: 'POST',
headers: {
Authorization: 'Bearer mk_live_YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"intent": "<string>",
"automation_id": "<string>",
"graph": [],
"history": []
}),
});
const { data } = await response.json();import requests
response = requests.post(
"https://app.mailyte.com/api/v1/automations/assistant/propose",
headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
json={
"intent": "<string>",
"automation_id": "<string>",
"graph": [],
"history": []
},
)
data = response.json()["data"]<?php
$response = Http::withToken('mk_live_YOUR_API_KEY')
->post('https://app.mailyte.com/api/v1/automations/assistant/propose', [
'intent' => '<string>',
'automation_id' => '<string>',
'graph' => [],
'history' => [],
]);
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/automations/assistant/propose")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
"intent": "<string>",
"automation_id": "<string>",
"graph": [],
"history": []
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Success.
dataobjectsummarystringWhat the proposed journey does, in a sentence or two.
graphobjectThe proposed journey, shaped exactly like a recipe: apply it with PUT /automations/{automation}. Not saved.
nodesarray<object>edgesarray<object>
unresolvedarray<string>Ids of steps left for the caller to finish, such as a sender or list Maya could not choose.
repairsintegerHow many times the proposal was corrected before it passed validation.
Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait. |
Every status, with what causes it and what to do, is on the error reference.