Pre Processing¶

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

Create pre-processing profile¶

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

Scope: pre-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

FieldsExample

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
`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`
`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
`headers`	List of `object`	No	HTTP request headers. Stored secret values are hidden. Rules: up to 100 entries
`responseMode`	`string`	No	How to process the lookup response: keep it, map fields or run a script. Rules: up to 64 characters
`responseMappings`	List of `object`	No	Map response values to named output fields. Rules: up to 100 entries
`responseScript`	`string`	No	Script for transforming the external response. Rules: up to 64000 characters
`greetingTemplate`	`string`	No	Greeting template using the context returned by pre-processing. 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.

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

responseMappings — fields

Field	Type	Required	Description
`responsePath`	`string`	No	Path to the value in the external response.
`outputKey`	`string`	No	Name of the context variable receiving the mapped value.

{
  "profile": {
    "name": "Service",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": []
  },
  "configuration": {
    "enabled": false,
    "responseMode": "WHOLE_RESPONSE",
    "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

FieldsExample

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
`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`
`queryParameters`	List of `object`	Query parameters for the outgoing request. Supported template variables come from the matching variables catalog. Rules: up to 100 entries
`headers`	List of `object`	HTTP request headers. Stored secret values are hidden. Rules: up to 100 entries
`responseMode`	`string`	How to process the lookup response: keep it, map fields or run a script. Rules: up to 64 characters
`responseMappings`	List of `object`	Map response values to named output fields. Rules: up to 100 entries
`responseScript`	`string`	Script for transforming the external response. Rules: up to 64000 characters
`greetingTemplate`	`string`	Greeting template using the context returned by pre-processing. 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.

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.

responseMappings — fields

Field	Type	Description
`responsePath`	`string`	Path to the value in the external response.
`outputKey`	`string`	Name of the context variable receiving the mapped value.

{
  "profile": {
    "id": "00000000-0000-0000-0000-000000000001",
    "name": "NuvoCar",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": [],
    "version": 1
  },
  "configuration": {
    "enabled": false,
    "url": "https://example.com/webhook",
    "timeoutMs": 5000,
    "queryParameters": [],
    "headers": [],
    "responseMode": "string",
    "responseMappings": [],
    "responseScript": "string",
    "greetingTemplate": "string",
    "oauthConfigured": false
  }
}

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 pre-processing profiles¶

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

Scope: pre-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

FieldsExample

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 pre-processing profile¶

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

Scope: pre-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 pre-processing profile¶

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

Scope: pre-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

FieldsExample

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
`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`
`queryParameters`	List of `object`	Query parameters for the outgoing request. Supported template variables come from the matching variables catalog. Rules: up to 100 entries
`headers`	List of `object`	HTTP request headers. Stored secret values are hidden. Rules: up to 100 entries
`responseMode`	`string`	How to process the lookup response: keep it, map fields or run a script. Rules: up to 64 characters
`responseMappings`	List of `object`	Map response values to named output fields. Rules: up to 100 entries
`responseScript`	`string`	Script for transforming the external response. Rules: up to 64000 characters
`greetingTemplate`	`string`	Greeting template using the context returned by pre-processing. 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.

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.

responseMappings — fields

Field	Type	Description
`responsePath`	`string`	Path to the value in the external response.
`outputKey`	`string`	Name of the context variable receiving the mapped value.

{
  "profile": {
    "id": "00000000-0000-0000-0000-000000000001",
    "name": "NuvoCar",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": [],
    "version": 1
  },
  "configuration": {
    "enabled": false,
    "url": "https://example.com/webhook",
    "timeoutMs": 5000,
    "queryParameters": [],
    "headers": [],
    "responseMode": "string",
    "responseMappings": [],
    "responseScript": "string",
    "greetingTemplate": "string",
    "oauthConfigured": false
  }
}

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 pre-processing profile¶

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

Scope: pre-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

FieldsExample

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
`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`
`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
`headers`	List of `object`	No	HTTP request headers. Stored secret values are hidden. Rules: up to 100 entries
`responseMode`	`string`	No	How to process the lookup response: keep it, map fields or run a script. Rules: up to 64 characters
`responseMappings`	List of `object`	No	Map response values to named output fields. Rules: up to 100 entries
`responseScript`	`string`	No	Script for transforming the external response. Rules: up to 64000 characters
`greetingTemplate`	`string`	No	Greeting template using the context returned by pre-processing. 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.

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

responseMappings — fields

Field	Type	Required	Description
`responsePath`	`string`	No	Path to the value in the external response.
`outputKey`	`string`	No	Name of the context variable receiving the mapped value.

{
  "profile": {
    "name": "Service",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": []
  },
  "configuration": {
    "enabled": false,
    "responseMode": "WHOLE_RESPONSE",
    "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

FieldsExample

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
`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`
`queryParameters`	List of `object`	Query parameters for the outgoing request. Supported template variables come from the matching variables catalog. Rules: up to 100 entries
`headers`	List of `object`	HTTP request headers. Stored secret values are hidden. Rules: up to 100 entries
`responseMode`	`string`	How to process the lookup response: keep it, map fields or run a script. Rules: up to 64 characters
`responseMappings`	List of `object`	Map response values to named output fields. Rules: up to 100 entries
`responseScript`	`string`	Script for transforming the external response. Rules: up to 64000 characters
`greetingTemplate`	`string`	Greeting template using the context returned by pre-processing. 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.

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.

responseMappings — fields

Field	Type	Description
`responsePath`	`string`	Path to the value in the external response.
`outputKey`	`string`	Name of the context variable receiving the mapped value.

{
  "profile": {
    "id": "00000000-0000-0000-0000-000000000001",
    "name": "NuvoCar",
    "defaultProfile": false,
    "scope": "UNASSIGNED",
    "assignments": [],
    "version": 1
  },
  "configuration": {
    "enabled": false,
    "url": "https://example.com/webhook",
    "timeoutMs": 5000,
    "queryParameters": [],
    "headers": [],
    "responseMode": "string",
    "responseMappings": [],
    "responseScript": "string",
    "greetingTemplate": "string",
    "oauthConfigured": false
  }
}

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 pre-processing variables¶

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

Scope: pre-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

FieldsExample

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.