Skip to content

Post Processing

Use an API key or REST OAuth access token. Scopes and your current workspace permissions apply together. All examples are illustrative.

Create post-processing profile

POST /api/external/v1/post-processing/profiles

Scope: post-processing:write

Saves configuration directly; no call, tool test or message delivery is executed. At an unchanged URL, omit a header's value to keep its secret. Remove the header from the list to delete it. At a new URL, explicitly clear or replace stored authentication.

Request body · application/json

Field Type Required Description
profile object Yes Profile name, defaults and assignments.
configuration object Yes Settings for this resource. Send the complete editable configuration when updating.
profile — fields
Field Type Required Description
name string Yes Display name.
Rules: up to 120 characters
defaultProfile boolean No Whether this is a default profile. Omission or null means false.
scope string Yes Where this profile applies. Explicit Agent or Flow assignments are listed in assignments.
Rules: pattern ALL\|SELECTED\|UNASSIGNED
assignments List of object Yes Agents or Flows assigned to this profile. Send an empty list for no explicit assignments.
Rules: up to 1000 entries; no duplicates
transferFromProfileIds List of string (uuid) No Source profile IDs authorizing an assignment transfer. Read current assignments first.
Rules: up to 1000 entries; no duplicates
assignments — fields
Field Type Required Description
ownerType string Yes Type of resource assigned to this profile.
Rules: at least 1 character; pattern AGENT\|FLOW
ownerId string (uuid) Yes ID of the assigned Agent or Flow in this workspace.
configuration — fields
Field Type Required Description
summaryPrompt string No Custom instructions for creating the call summary. Inherited default prompts are not returned.
Rules: up to 64000 characters
summaryEmailEnabled boolean No Enable summary emails.
skipSummaryEmailWhenCallerDidNotSpeak boolean No Skip the summary email if the caller did not speak.
skipSummaryWebhookWhenCallerDidNotSpeak boolean No Skip the summary webhook if the caller did not speak.
summaryEmailSubjectTemplate string No Subject template for the summary email.
Rules: up to 4000 characters
summaryEmailBodyTemplate string No Body template for the summary email.
Rules: up to 64000 characters
summaryEmailRecipients List of string (email) No Recipient addresses for summary emails.
Rules: up to 100 entries
summaryEmailCcRecipients List of string (email) No CC addresses for summary emails.
Rules: up to 100 entries
summaryWebhook object Yes Webhook settings for delivering call summaries.
summaryPromptIncludeFacts boolean No Include collected conversation facts when creating the summary.
summaryPromptIncludeConversationHistory boolean No Include the conversation history when creating the summary.
summaryPromptIncludeToolInvocations boolean No Include tool calls when creating the summary.
summaryEmailExecutionMode string No When to send the summary email.
Values: ALWAYS, CONDITIONAL
summaryEmailExecutionCondition string No Condition checked before sending a summary email in conditional mode.
Rules: up to 64000 characters
summaryWebhookExecutionMode string No When to call the summary webhook.
Values: ALWAYS, CONDITIONAL
summaryWebhookExecutionCondition string No Condition checked before calling the summary webhook in conditional mode.
Rules: up to 64000 characters
summaryWebhook — fields
Field Type Required Description
enabled boolean No Enable this outgoing lookup or webhook.
url string (uri) No Destination URL. Changing it requires clearing or replacing stored authentication.
Rules: up to 4096 characters
Example: "https://example.com/webhook"
timeoutMs integer (int64) No Time limit for the outgoing request, in milliseconds.
Rules: 1–60000
Example: 5000
contentType string No Content-Type of the outgoing request body.
Rules: up to 255 characters
Example: "application/json"
queryParameters List of object No Query parameters for the outgoing request. Supported template variables come from the matching variables catalog.
Rules: up to 100 entries
formFields List of object No Named fields for a form-encoded webhook request.
Rules: up to 100 entries
headers List of object No HTTP request headers. Stored secret values are hidden.
Rules: up to 100 entries
bodyTemplate string No Webhook request body template using post-processing variables.
Rules: up to 64000 characters
clearAuthentication boolean No Remove the stored OAuth connection when true. Omit or send false to keep it.
Rules: write-only
queryParameters — fields
Field Type Required Description
key string No Name of the variable or parameter.
value string No Value or template for this parameter.
formFields — fields
Field Type Required Description
key string No Name of the variable or parameter.
value string No Value or template for this parameter.
headers — fields
Field Type Required Description
name string Yes HTTP header name, such as Authorization.
Rules: up to 128 characters
value string No New header value. Omit it to keep the stored value at an unchanged target.
Rules: up to 8192 characters; write-only		 
{
  "profile": {
    "name": "Service",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": []
  },
  "configuration": {
    "summaryPrompt": "Summarize the call.",
    "summaryEmailEnabled": false,
    "summaryWebhook": {
      "enabled": false,
      "headers": []
    }
  }
}

Response 201

Created.

Header Type Description
Cache-Control string The response must not be cached.
Example: no-store
Location string Path of the created resource.
ETag string Current revision. Send unchanged, including quotes, as If-Match when required.
Example: "revision-from-get"

application/json

Field Type Description
profile object Profile name, defaults and assignments.
configuration object Settings for this resource. Send the complete editable configuration when updating.
profile — fields
Field Type Description
id string (uuid) Resource ID in your workspace.
Example: "00000000-0000-0000-0000-000000000001"
name string Display name.
defaultProfile boolean Whether this is a default profile. Omission or null means false.
scope string Where this profile applies. Explicit Agent or Flow assignments are listed in assignments.
assignments List of object Agents or Flows assigned to this profile. Send an empty list for no explicit assignments.
Rules: no duplicates
version integer (int64) Current resource version. Use the response ETag when updating or deleting.
assignments — fields
Field Type Description
ownerType string Type of resource assigned to this profile.
Rules: at least 1 character; pattern AGENT\|FLOW
ownerId string (uuid) ID of the assigned Agent or Flow in this workspace.
configuration — fields
Field Type Description
summaryPrompt string Custom instructions for creating the call summary. Inherited default prompts are not returned.
Rules: up to 64000 characters
summaryEmailEnabled boolean Enable summary emails.
skipSummaryEmailWhenCallerDidNotSpeak boolean Skip the summary email if the caller did not speak.
skipSummaryWebhookWhenCallerDidNotSpeak boolean Skip the summary webhook if the caller did not speak.
summaryEmailSubjectTemplate string Subject template for the summary email.
Rules: up to 4000 characters
summaryEmailBodyTemplate string Body template for the summary email.
Rules: up to 64000 characters
summaryEmailRecipients List of string (email) Recipient addresses for summary emails.
Rules: up to 100 entries
summaryEmailCcRecipients List of string (email) CC addresses for summary emails.
Rules: up to 100 entries
summaryWebhook object Webhook settings for delivering call summaries.
summaryPromptIncludeFacts boolean Include collected conversation facts when creating the summary.
summaryPromptIncludeConversationHistory boolean Include the conversation history when creating the summary.
summaryPromptIncludeToolInvocations boolean Include tool calls when creating the summary.
summaryEmailExecutionMode string When to send the summary email.
Values: ALWAYS, CONDITIONAL
summaryEmailExecutionCondition string Condition checked before sending a summary email in conditional mode.
Rules: up to 64000 characters
summaryWebhookExecutionMode string When to call the summary webhook.
Values: ALWAYS, CONDITIONAL
summaryWebhookExecutionCondition string Condition checked before calling the summary webhook in conditional mode.
Rules: up to 64000 characters
summaryWebhook — fields
Field Type Description
enabled boolean Enable this outgoing lookup or webhook.
url string (uri) Destination URL. Changing it requires clearing or replacing stored authentication.
Rules: up to 4096 characters
Example: "https://example.com/webhook"
timeoutMs integer (int64) Time limit for the outgoing request, in milliseconds.
Rules: 1–60000
Example: 5000
contentType string Content-Type of the outgoing request body.
Rules: up to 255 characters
Example: "application/json"
queryParameters List of object Query parameters for the outgoing request. Supported template variables come from the matching variables catalog.
Rules: up to 100 entries
formFields List of object Named fields for a form-encoded webhook request.
Rules: up to 100 entries
headers List of object HTTP request headers. Stored secret values are hidden.
Rules: up to 100 entries
bodyTemplate string Webhook request body template using post-processing variables.
Rules: up to 64000 characters
oauthConfigured boolean Whether an outgoing OAuth connection is stored.
queryParameters — fields
Field Type Description
key string Name of the variable or parameter.
value string Value or template for this parameter.
formFields — fields
Field Type Description
key string Name of the variable or parameter.
value string Value or template for this parameter.
headers — fields
Field Type Description
name string HTTP header name, such as Authorization.
Rules: up to 128 characters
configured boolean Whether a header value is stored. 
{
  "profile": {
    "id": "00000000-0000-0000-0000-000000000001",
    "name": "NuvoCar",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": [],
    "version": 1
  },
  "configuration": {
    "summaryPrompt": "string",
    "summaryEmailEnabled": false,
    "skipSummaryEmailWhenCallerDidNotSpeak": false,
    "skipSummaryWebhookWhenCallerDidNotSpeak": false,
    "summaryEmailSubjectTemplate": "string",
    "summaryEmailBodyTemplate": "string",
    "summaryEmailRecipients": [],
    "summaryEmailCcRecipients": [],
    "summaryWebhook": {
      "enabled": false,
      "url": "https://example.com/webhook",
      "timeoutMs": 5000,
      "contentType": "application/json",
      "queryParameters": [],
      "formFields": [],
      "headers": [],
      "bodyTemplate": "string",
      "oauthConfigured": false
    },
    "summaryPromptIncludeFacts": false,
    "summaryPromptIncludeConversationHistory": false,
    "summaryPromptIncludeToolInvocations": false,
    "summaryEmailExecutionMode": "ALWAYS",
    "summaryEmailExecutionCondition": "string",
    "summaryWebhookExecutionMode": "ALWAYS",
    "summaryWebhookExecutionCondition": "string"
  }
}
Error responses
Status Meaning
400 Invalid input, unsupported selection or time range.
401 Missing, expired or invalid credential. The body may be empty.
403 Required scope or current user permission missing. The body may be empty.
409 Missing/stale revision or dependency/routing conflict. Read again before retrying.
429 Shared workspace budget exceeded. Honor Retry-After; do not blindly replay uncertain writes.
503 Temporarily unavailable. Check uncertain writes before retrying.

Error body

Field Type Description
status integer HTTP status code.
error string Description of the error.
details any Additional error details, when available.
Rules: null allowed
code string Machine-readable error code.
params object Additional values associated with the error code.
fieldErrors object Validation errors grouped by input field.

For 429 or 503, honor the Retry-After header (seconds). Check uncertain writes before retrying.

List post-processing profiles

GET /api/external/v1/post-processing/profiles

Scope: post-processing:read

Parameters

Name Location Type Required Description
page Query integer (int32) No Page index, starting at 0.
Rules: 0–100000
Default: 0
size Query integer (int32) No Results per page.
Rules: 1–100
Default: 25

Response 200

Success.

Header Type Description
Cache-Control string The response must not be cached.
Example: no-store

application/json

Field Type Description
items List of object Results on this page.
page integer (int32) Current page index, starting at 0.
size integer (int32) Number of results requested per page.
totalElements integer (int64) Total number of matching results.
totalPages integer (int32) Total number of result pages.
items — fields
Field Type Description
id string (uuid) Resource ID in your workspace.
name string Display name.
defaultProfile boolean Whether this is a default profile. Omission or null means false.
scope string Where this profile applies. Explicit Agent or Flow assignments are listed in assignments.
version integer (int64) Current resource version. Use the response ETag when updating or deleting. 
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "name": "NuvoCar",
      "defaultProfile": false,
      "scope": "UNASSIGNED",
      "version": 1
    }
  ],
  "page": 0,
  "size": 25,
  "totalElements": 1,
  "totalPages": 1
}
Error responses
Status Meaning
400 Invalid input, unsupported selection or time range.
401 Missing, expired or invalid credential. The body may be empty.
403 Required scope or current user permission missing. The body may be empty.
429 Shared workspace budget exceeded. Honor Retry-After; do not blindly replay uncertain writes.
503 Temporarily unavailable. Check uncertain writes before retrying.

Error body

Field Type Description
status integer HTTP status code.
error string Description of the error.
details any Additional error details, when available.
Rules: null allowed
code string Machine-readable error code.
params object Additional values associated with the error code.
fieldErrors object Validation errors grouped by input field.

For 429 or 503, honor the Retry-After header (seconds). Check uncertain writes before retrying.

Delete post-processing profile

DELETE /api/external/v1/post-processing/profiles/{id}

Scope: post-processing:write

Read the resource first. Send its current ETag, including quotes, in If-Match.

Parameters

Name Location Type Required Description
id Path string (uuid) Yes Resource identifier in the bound workspace.
If-Match Header string Yes ETag from the preceding read, including quotes.
Example: "revision-from-get"

Response 204

Deleted; no response body.

Header Type Description
Cache-Control string The response must not be cached.
Example: no-store
Error responses
Status Meaning
400 Invalid input, unsupported selection or time range.
401 Missing, expired or invalid credential. The body may be empty.
403 Required scope or current user permission missing. The body may be empty.
404 Resource is unavailable in the bound workspace.
409 Missing/stale revision or dependency/routing conflict. Read again before retrying.
429 Shared workspace budget exceeded. Honor Retry-After; do not blindly replay uncertain writes.
503 Temporarily unavailable. Check uncertain writes before retrying.

Error body

Field Type Description
status integer HTTP status code.
error string Description of the error.
details any Additional error details, when available.
Rules: null allowed
code string Machine-readable error code.
params object Additional values associated with the error code.
fieldErrors object Validation errors grouped by input field.

For 429 or 503, honor the Retry-After header (seconds). Check uncertain writes before retrying.

Read post-processing profile

GET /api/external/v1/post-processing/profiles/{id}

Scope: post-processing:read

Parameters

Name Location Type Required Description
id Path string (uuid) Yes Resource identifier in the bound workspace.

Response 200

Success.

Header Type Description
Cache-Control string The response must not be cached.
Example: no-store
ETag string Current revision. Send unchanged, including quotes, as If-Match when required.
Example: "revision-from-get"

application/json

Field Type Description
profile object Profile name, defaults and assignments.
configuration object Settings for this resource. Send the complete editable configuration when updating.
profile — fields
Field Type Description
id string (uuid) Resource ID in your workspace.
Example: "00000000-0000-0000-0000-000000000001"
name string Display name.
defaultProfile boolean Whether this is a default profile. Omission or null means false.
scope string Where this profile applies. Explicit Agent or Flow assignments are listed in assignments.
assignments List of object Agents or Flows assigned to this profile. Send an empty list for no explicit assignments.
Rules: no duplicates
version integer (int64) Current resource version. Use the response ETag when updating or deleting.
assignments — fields
Field Type Description
ownerType string Type of resource assigned to this profile.
Rules: at least 1 character; pattern AGENT\|FLOW
ownerId string (uuid) ID of the assigned Agent or Flow in this workspace.
configuration — fields
Field Type Description
summaryPrompt string Custom instructions for creating the call summary. Inherited default prompts are not returned.
Rules: up to 64000 characters
summaryEmailEnabled boolean Enable summary emails.
skipSummaryEmailWhenCallerDidNotSpeak boolean Skip the summary email if the caller did not speak.
skipSummaryWebhookWhenCallerDidNotSpeak boolean Skip the summary webhook if the caller did not speak.
summaryEmailSubjectTemplate string Subject template for the summary email.
Rules: up to 4000 characters
summaryEmailBodyTemplate string Body template for the summary email.
Rules: up to 64000 characters
summaryEmailRecipients List of string (email) Recipient addresses for summary emails.
Rules: up to 100 entries
summaryEmailCcRecipients List of string (email) CC addresses for summary emails.
Rules: up to 100 entries
summaryWebhook object Webhook settings for delivering call summaries.
summaryPromptIncludeFacts boolean Include collected conversation facts when creating the summary.
summaryPromptIncludeConversationHistory boolean Include the conversation history when creating the summary.
summaryPromptIncludeToolInvocations boolean Include tool calls when creating the summary.
summaryEmailExecutionMode string When to send the summary email.
Values: ALWAYS, CONDITIONAL
summaryEmailExecutionCondition string Condition checked before sending a summary email in conditional mode.
Rules: up to 64000 characters
summaryWebhookExecutionMode string When to call the summary webhook.
Values: ALWAYS, CONDITIONAL
summaryWebhookExecutionCondition string Condition checked before calling the summary webhook in conditional mode.
Rules: up to 64000 characters
summaryWebhook — fields
Field Type Description
enabled boolean Enable this outgoing lookup or webhook.
url string (uri) Destination URL. Changing it requires clearing or replacing stored authentication.
Rules: up to 4096 characters
Example: "https://example.com/webhook"
timeoutMs integer (int64) Time limit for the outgoing request, in milliseconds.
Rules: 1–60000
Example: 5000
contentType string Content-Type of the outgoing request body.
Rules: up to 255 characters
Example: "application/json"
queryParameters List of object Query parameters for the outgoing request. Supported template variables come from the matching variables catalog.
Rules: up to 100 entries
formFields List of object Named fields for a form-encoded webhook request.
Rules: up to 100 entries
headers List of object HTTP request headers. Stored secret values are hidden.
Rules: up to 100 entries
bodyTemplate string Webhook request body template using post-processing variables.
Rules: up to 64000 characters
oauthConfigured boolean Whether an outgoing OAuth connection is stored.
queryParameters — fields
Field Type Description
key string Name of the variable or parameter.
value string Value or template for this parameter.
formFields — fields
Field Type Description
key string Name of the variable or parameter.
value string Value or template for this parameter.
headers — fields
Field Type Description
name string HTTP header name, such as Authorization.
Rules: up to 128 characters
configured boolean Whether a header value is stored. 
{
  "profile": {
    "id": "00000000-0000-0000-0000-000000000001",
    "name": "NuvoCar",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": [],
    "version": 1
  },
  "configuration": {
    "summaryPrompt": "string",
    "summaryEmailEnabled": false,
    "skipSummaryEmailWhenCallerDidNotSpeak": false,
    "skipSummaryWebhookWhenCallerDidNotSpeak": false,
    "summaryEmailSubjectTemplate": "string",
    "summaryEmailBodyTemplate": "string",
    "summaryEmailRecipients": [],
    "summaryEmailCcRecipients": [],
    "summaryWebhook": {
      "enabled": false,
      "url": "https://example.com/webhook",
      "timeoutMs": 5000,
      "contentType": "application/json",
      "queryParameters": [],
      "formFields": [],
      "headers": [],
      "bodyTemplate": "string",
      "oauthConfigured": false
    },
    "summaryPromptIncludeFacts": false,
    "summaryPromptIncludeConversationHistory": false,
    "summaryPromptIncludeToolInvocations": false,
    "summaryEmailExecutionMode": "ALWAYS",
    "summaryEmailExecutionCondition": "string",
    "summaryWebhookExecutionMode": "ALWAYS",
    "summaryWebhookExecutionCondition": "string"
  }
}
Error responses
Status Meaning
400 Invalid input, unsupported selection or time range.
401 Missing, expired or invalid credential. The body may be empty.
403 Required scope or current user permission missing. The body may be empty.
404 Resource is unavailable in the bound workspace.
429 Shared workspace budget exceeded. Honor Retry-After; do not blindly replay uncertain writes.
503 Temporarily unavailable. Check uncertain writes before retrying.

Error body

Field Type Description
status integer HTTP status code.
error string Description of the error.
details any Additional error details, when available.
Rules: null allowed
code string Machine-readable error code.
params object Additional values associated with the error code.
fieldErrors object Validation errors grouped by input field.

For 429 or 503, honor the Retry-After header (seconds). Check uncertain writes before retrying.

Update post-processing profile

PUT /api/external/v1/post-processing/profiles/{id}

Scope: post-processing:write

Saves configuration directly; no call, tool test or message delivery is executed. Read the resource first. Send its current ETag, including quotes, in If-Match. Send the full editable configuration. Omitted settings can be reset. At an unchanged URL, omit a header's value to keep its secret. Remove the header from the list to delete it. At a new URL, explicitly clear or replace stored authentication.

Parameters

Name Location Type Required Description
id Path string (uuid) Yes Resource identifier in the bound workspace.
If-Match Header string Yes ETag from the preceding read, including quotes.
Example: "revision-from-get"

Request body · application/json

Field Type Required Description
profile object Yes Profile name, defaults and assignments.
configuration object Yes Settings for this resource. Send the complete editable configuration when updating.
profile — fields
Field Type Required Description
name string Yes Display name.
Rules: up to 120 characters
defaultProfile boolean No Whether this is a default profile. Omission or null means false.
scope string Yes Where this profile applies. Explicit Agent or Flow assignments are listed in assignments.
Rules: pattern ALL\|SELECTED\|UNASSIGNED
assignments List of object Yes Agents or Flows assigned to this profile. Send an empty list for no explicit assignments.
Rules: up to 1000 entries; no duplicates
transferFromProfileIds List of string (uuid) No Source profile IDs authorizing an assignment transfer. Read current assignments first.
Rules: up to 1000 entries; no duplicates
assignments — fields
Field Type Required Description
ownerType string Yes Type of resource assigned to this profile.
Rules: at least 1 character; pattern AGENT\|FLOW
ownerId string (uuid) Yes ID of the assigned Agent or Flow in this workspace.
configuration — fields
Field Type Required Description
summaryPrompt string No Custom instructions for creating the call summary. Inherited default prompts are not returned.
Rules: up to 64000 characters
summaryEmailEnabled boolean No Enable summary emails.
skipSummaryEmailWhenCallerDidNotSpeak boolean No Skip the summary email if the caller did not speak.
skipSummaryWebhookWhenCallerDidNotSpeak boolean No Skip the summary webhook if the caller did not speak.
summaryEmailSubjectTemplate string No Subject template for the summary email.
Rules: up to 4000 characters
summaryEmailBodyTemplate string No Body template for the summary email.
Rules: up to 64000 characters
summaryEmailRecipients List of string (email) No Recipient addresses for summary emails.
Rules: up to 100 entries
summaryEmailCcRecipients List of string (email) No CC addresses for summary emails.
Rules: up to 100 entries
summaryWebhook object Yes Webhook settings for delivering call summaries.
summaryPromptIncludeFacts boolean No Include collected conversation facts when creating the summary.
summaryPromptIncludeConversationHistory boolean No Include the conversation history when creating the summary.
summaryPromptIncludeToolInvocations boolean No Include tool calls when creating the summary.
summaryEmailExecutionMode string No When to send the summary email.
Values: ALWAYS, CONDITIONAL
summaryEmailExecutionCondition string No Condition checked before sending a summary email in conditional mode.
Rules: up to 64000 characters
summaryWebhookExecutionMode string No When to call the summary webhook.
Values: ALWAYS, CONDITIONAL
summaryWebhookExecutionCondition string No Condition checked before calling the summary webhook in conditional mode.
Rules: up to 64000 characters
summaryWebhook — fields
Field Type Required Description
enabled boolean No Enable this outgoing lookup or webhook.
url string (uri) No Destination URL. Changing it requires clearing or replacing stored authentication.
Rules: up to 4096 characters
Example: "https://example.com/webhook"
timeoutMs integer (int64) No Time limit for the outgoing request, in milliseconds.
Rules: 1–60000
Example: 5000
contentType string No Content-Type of the outgoing request body.
Rules: up to 255 characters
Example: "application/json"
queryParameters List of object No Query parameters for the outgoing request. Supported template variables come from the matching variables catalog.
Rules: up to 100 entries
formFields List of object No Named fields for a form-encoded webhook request.
Rules: up to 100 entries
headers List of object No HTTP request headers. Stored secret values are hidden.
Rules: up to 100 entries
bodyTemplate string No Webhook request body template using post-processing variables.
Rules: up to 64000 characters
clearAuthentication boolean No Remove the stored OAuth connection when true. Omit or send false to keep it.
Rules: write-only
queryParameters — fields
Field Type Required Description
key string No Name of the variable or parameter.
value string No Value or template for this parameter.
formFields — fields
Field Type Required Description
key string No Name of the variable or parameter.
value string No Value or template for this parameter.
headers — fields
Field Type Required Description
name string Yes HTTP header name, such as Authorization.
Rules: up to 128 characters
value string No New header value. Omit it to keep the stored value at an unchanged target.
Rules: up to 8192 characters; write-only		 
{
  "profile": {
    "name": "Service",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": []
  },
  "configuration": {
    "summaryPrompt": "Summarize the call.",
    "summaryEmailEnabled": false,
    "summaryWebhook": {
      "enabled": false,
      "headers": []
    }
  }
}

Response 200

Success.

Header Type Description
Cache-Control string The response must not be cached.
Example: no-store
ETag string Current revision. Send unchanged, including quotes, as If-Match when required.
Example: "revision-from-get"

application/json

Field Type Description
profile object Profile name, defaults and assignments.
configuration object Settings for this resource. Send the complete editable configuration when updating.
profile — fields
Field Type Description
id string (uuid) Resource ID in your workspace.
Example: "00000000-0000-0000-0000-000000000001"
name string Display name.
defaultProfile boolean Whether this is a default profile. Omission or null means false.
scope string Where this profile applies. Explicit Agent or Flow assignments are listed in assignments.
assignments List of object Agents or Flows assigned to this profile. Send an empty list for no explicit assignments.
Rules: no duplicates
version integer (int64) Current resource version. Use the response ETag when updating or deleting.
assignments — fields
Field Type Description
ownerType string Type of resource assigned to this profile.
Rules: at least 1 character; pattern AGENT\|FLOW
ownerId string (uuid) ID of the assigned Agent or Flow in this workspace.
configuration — fields
Field Type Description
summaryPrompt string Custom instructions for creating the call summary. Inherited default prompts are not returned.
Rules: up to 64000 characters
summaryEmailEnabled boolean Enable summary emails.
skipSummaryEmailWhenCallerDidNotSpeak boolean Skip the summary email if the caller did not speak.
skipSummaryWebhookWhenCallerDidNotSpeak boolean Skip the summary webhook if the caller did not speak.
summaryEmailSubjectTemplate string Subject template for the summary email.
Rules: up to 4000 characters
summaryEmailBodyTemplate string Body template for the summary email.
Rules: up to 64000 characters
summaryEmailRecipients List of string (email) Recipient addresses for summary emails.
Rules: up to 100 entries
summaryEmailCcRecipients List of string (email) CC addresses for summary emails.
Rules: up to 100 entries
summaryWebhook object Webhook settings for delivering call summaries.
summaryPromptIncludeFacts boolean Include collected conversation facts when creating the summary.
summaryPromptIncludeConversationHistory boolean Include the conversation history when creating the summary.
summaryPromptIncludeToolInvocations boolean Include tool calls when creating the summary.
summaryEmailExecutionMode string When to send the summary email.
Values: ALWAYS, CONDITIONAL
summaryEmailExecutionCondition string Condition checked before sending a summary email in conditional mode.
Rules: up to 64000 characters
summaryWebhookExecutionMode string When to call the summary webhook.
Values: ALWAYS, CONDITIONAL
summaryWebhookExecutionCondition string Condition checked before calling the summary webhook in conditional mode.
Rules: up to 64000 characters
summaryWebhook — fields
Field Type Description
enabled boolean Enable this outgoing lookup or webhook.
url string (uri) Destination URL. Changing it requires clearing or replacing stored authentication.
Rules: up to 4096 characters
Example: "https://example.com/webhook"
timeoutMs integer (int64) Time limit for the outgoing request, in milliseconds.
Rules: 1–60000
Example: 5000
contentType string Content-Type of the outgoing request body.
Rules: up to 255 characters
Example: "application/json"
queryParameters List of object Query parameters for the outgoing request. Supported template variables come from the matching variables catalog.
Rules: up to 100 entries
formFields List of object Named fields for a form-encoded webhook request.
Rules: up to 100 entries
headers List of object HTTP request headers. Stored secret values are hidden.
Rules: up to 100 entries
bodyTemplate string Webhook request body template using post-processing variables.
Rules: up to 64000 characters
oauthConfigured boolean Whether an outgoing OAuth connection is stored.
queryParameters — fields
Field Type Description
key string Name of the variable or parameter.
value string Value or template for this parameter.
formFields — fields
Field Type Description
key string Name of the variable or parameter.
value string Value or template for this parameter.
headers — fields
Field Type Description
name string HTTP header name, such as Authorization.
Rules: up to 128 characters
configured boolean Whether a header value is stored. 
{
  "profile": {
    "id": "00000000-0000-0000-0000-000000000001",
    "name": "NuvoCar",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": [],
    "version": 1
  },
  "configuration": {
    "summaryPrompt": "string",
    "summaryEmailEnabled": false,
    "skipSummaryEmailWhenCallerDidNotSpeak": false,
    "skipSummaryWebhookWhenCallerDidNotSpeak": false,
    "summaryEmailSubjectTemplate": "string",
    "summaryEmailBodyTemplate": "string",
    "summaryEmailRecipients": [],
    "summaryEmailCcRecipients": [],
    "summaryWebhook": {
      "enabled": false,
      "url": "https://example.com/webhook",
      "timeoutMs": 5000,
      "contentType": "application/json",
      "queryParameters": [],
      "formFields": [],
      "headers": [],
      "bodyTemplate": "string",
      "oauthConfigured": false
    },
    "summaryPromptIncludeFacts": false,
    "summaryPromptIncludeConversationHistory": false,
    "summaryPromptIncludeToolInvocations": false,
    "summaryEmailExecutionMode": "ALWAYS",
    "summaryEmailExecutionCondition": "string",
    "summaryWebhookExecutionMode": "ALWAYS",
    "summaryWebhookExecutionCondition": "string"
  }
}
Error responses
Status Meaning
400 Invalid input, unsupported selection or time range.
401 Missing, expired or invalid credential. The body may be empty.
403 Required scope or current user permission missing. The body may be empty.
404 Resource is unavailable in the bound workspace.
409 Missing/stale revision or dependency/routing conflict. Read again before retrying.
429 Shared workspace budget exceeded. Honor Retry-After; do not blindly replay uncertain writes.
503 Temporarily unavailable. Check uncertain writes before retrying.

Error body

Field Type Description
status integer HTTP status code.
error string Description of the error.
details any Additional error details, when available.
Rules: null allowed
code string Machine-readable error code.
params object Additional values associated with the error code.
fieldErrors object Validation errors grouped by input field.

For 429 or 503, honor the Retry-After header (seconds). Check uncertain writes before retrying.

Read post-processing variables

GET /api/external/v1/post-processing/variables

Scope: post-processing:read

Lists supported variable names and descriptions, without call data.

Response 200

Success.

Header Type Description
Cache-Control string The response must not be cached.
Example: no-store

application/json

Field Type Description
key string Name of the variable or parameter.
description string Meaning of this variable. 
[]
Error responses
Status Meaning
400 Invalid input, unsupported selection or time range.
401 Missing, expired or invalid credential. The body may be empty.
403 Required scope or current user permission missing. The body may be empty.
429 Shared workspace budget exceeded. Honor Retry-After; do not blindly replay uncertain writes.
503 Temporarily unavailable. Check uncertain writes before retrying.

Error body

Field Type Description
status integer HTTP status code.
error string Description of the error.
details any Additional error details, when available.
Rules: null allowed
code string Machine-readable error code.
params object Additional values associated with the error code.
fieldErrors object Validation errors grouped by input field.

For 429 or 503, honor the Retry-After header (seconds). Check uncertain writes before retrying.