Docupilot

https://help.docupilot.app
Admin
Docupilot is a document automation and generation platform that enables users to create...
Tokens:46,234
Snippets:688
Trust Score:8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Split Helper Examples

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Examples of splitting strings using default commas, custom separators, and regular expressions.

```text
{{#each (split items)}}
  {{this}}
{{/each}}
```

```text
{{#each (split people "|")}}
  {{this}}
{{/each}}
```

```text
{{#each (split text (regex "\d+" "g"))}}
  {{this}}
{{/each}}
```

--------------------------------

### Query documentation via HTTP GET

Source: https://help.docupilot.app/collaborating-with-multiple-users/manage-and-delete-users.md

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve information dynamically.

```http
GET https://help.docupilot.app/collaborating-with-multiple-users/manage-and-delete-users.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /create-document/bulk-create.md

Source: https://help.docupilot.app/create-document/bulk-create.md

Query the documentation dynamically by performing an HTTP GET request on the page URL.

```APIDOC
## GET /create-document/bulk-create.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://help.docupilot.app/create-document/bulk-create.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /account-setup-and-administration/managing-your-org/login-methods/okta-sso.md

Source: https://help.docupilot.app/account-setup-and-administration/managing-your-org/login-methods/okta-sso.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /account-setup-and-administration/managing-your-org/login-methods/okta-sso.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://help.docupilot.app/account-setup-and-administration/managing-your-org/login-methods/okta-sso.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Data and Output Examples

Source: https://help.docupilot.app/document-template/ms-word-powerpoint-document.md

Input data and resulting output for address field handling.

```text
customer_name = John Doe
city = NY
country = US
```

```text
John Doe,
NY, US
```

```text
customer_name = John Doe
street = WinWood St.
city = NY
country = US
```

```text
John Doe,
WinWood St.,
NY, US
```

--------------------------------

### GET /account-setup-and-administration/setting-up-your-account.md

Source: https://help.docupilot.app/account-setup-and-administration/setting-up-your-account.md

Queries the documentation page for specific information using natural language questions.

```APIDOC
## GET /account-setup-and-administration/setting-up-your-account.md

### Description
Perform a query against the documentation page to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://help.docupilot.app/account-setup-and-administration/setting-up-your-account.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://help.docupilot.app/deliveries/signnow.md

Perform an HTTP GET request to the documentation URL to retrieve answers to specific questions.

```http
GET https://help.docupilot.app/deliveries/signnow.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Set and Get Syntax

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Basic syntax for defining and retrieving variables.

```text
{{set "variable_name" "value"}}
{{get "variable_name"}}
```

--------------------------------

### GET /settings/api-settings.md

Source: https://help.docupilot.app/settings/api-settings.md

Query the documentation dynamically by performing an HTTP GET request to the page URL with specific parameters.

```APIDOC
## GET /settings/api-settings.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://help.docupilot.app/settings/api-settings.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **response** (string) - Contains a direct answer to the question and relevant excerpts and sources from the documentation.
```

--------------------------------

### GET /create-document/api-and-webhook-integration.md

Source: https://help.docupilot.app/create-document/api-and-webhook-integration.md

Queries the documentation dynamically by asking a question related to the content.

```APIDOC
## GET /create-document/api-and-webhook-integration.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://help.docupilot.app/create-document/api-and-webhook-integration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### Sample Template Syntax

Source: https://help.docupilot.app/create-document/api-and-webhook-integration.md

Example of a template using Handlebars syntax for merge fields.

```handlebars
Hello {{name}},

{{email}}
{{address}} {{state}} {{country}}
```

--------------------------------

### Email Message Template Example

Source: https://help.docupilot.app/deliveries/esignature.md

Example of an email body template using dynamic tokens for personalization.

```text
Dear valued {{client_name}},

Please find the contract "Contract-AcmeCorp-{{client_company}}" as discussed
and sign it at the earliest possibility.
```

--------------------------------

### GET /account-setup-and-administration/user-profile-and-account-security.md

Source: https://help.docupilot.app/account-setup-and-administration/user-profile-and-account-security.md

Queries the documentation for specific information by providing a question and an optional end goal.

```APIDOC
## GET /account-setup-and-administration/user-profile-and-account-security.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://help.docupilot.app/account-setup-and-administration/user-profile-and-account-security.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /account-setup-and-administration/managing-your-org/login-methods.md

Source: https://help.docupilot.app/account-setup-and-administration/managing-your-org/login-methods.md

Queries the documentation dynamically by providing a question and an optional goal to receive a context-aware answer.

```APIDOC
## GET /account-setup-and-administration/managing-your-org/login-methods.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page or to get clarification.

### Method
GET

### Endpoint
https://help.docupilot.app/account-setup-and-administration/managing-your-org/login-methods.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /workflows/test-publish-and-version-workflows.md

Source: https://help.docupilot.app/workflows/test-publish-and-version-workflows.md

Perform an HTTP GET request on the current page URL to query the documentation dynamically.

```APIDOC
## GET /workflows/test-publish-and-version-workflows.md

### Description
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter to query the documentation dynamically.

### Method
GET

### Endpoint
https://help.docupilot.app/workflows/test-publish-and-version-workflows.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /account-setup-and-administration/managing-your-org/verified-domains.md

Source: https://help.docupilot.app/account-setup-and-administration/managing-your-org/verified-domains.md

Queries the documentation dynamically by asking a question related to the current page content.

```APIDOC
## GET /account-setup-and-administration/managing-your-org/verified-domains.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically when information is not explicitly present or clarification is needed.

### Method
GET

### Endpoint
https://help.docupilot.app/account-setup-and-administration/managing-your-org/verified-domains.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /getting-started.md

Source: https://help.docupilot.app/getting-started.md

Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer.

```APIDOC
## GET /getting-started.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically. This is useful when you need clarification or additional context not explicitly present in the page.

### Method
GET

### Endpoint
https://help.docupilot.app/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /deliveries/sftp.md

Source: https://help.docupilot.app/deliveries/sftp.md

Perform an HTTP GET request on the documentation page URL to query information dynamically using natural language.

```APIDOC
## GET /deliveries/sftp.md

### Description
Query the documentation dynamically by asking a question related to the content.

### Method
GET

### Endpoint
https://help.docupilot.app/deliveries/sftp.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /settings.md

Source: https://help.docupilot.app/settings.md

Queries the documentation dynamically by providing a specific question and an optional end goal.

```APIDOC
## GET /settings.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://help.docupilot.app/settings.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Request Example
GET https://help.docupilot.app/settings.md?ask=How do I manage API keys?&goal=Integrate with Zapier
```

--------------------------------

### GET /document-template/template-preferences.md

Source: https://help.docupilot.app/document-template/template-preferences.md

Perform an HTTP GET request on the current page URL to query the documentation dynamically.

```APIDOC
## GET /document-template/template-preferences.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for additional information.

### Method
GET

### Endpoint
https://help.docupilot.app/document-template/template-preferences.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /account-setup-and-administration/managing-your-org/login-methods/microsoft-entra-id-sso.md

Source: https://help.docupilot.app/account-setup-and-administration/managing-your-org/login-methods/microsoft-entra-id-sso.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /account-setup-and-administration/managing-your-org/login-methods/microsoft-entra-id-sso.md

### Description
Perform a query against the documentation to receive a direct answer, relevant excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://help.docupilot.app/account-setup-and-administration/managing-your-org/login-methods/microsoft-entra-id-sso.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### GET /content-library.md

Source: https://help.docupilot.app/content-library.md

Perform an HTTP GET request to query the documentation dynamically for specific information or context.

```APIDOC
## GET /content-library.md

### Description
Queries the documentation dynamically to retrieve answers and relevant excerpts based on a natural language question.

### Method
GET

### Endpoint
https://help.docupilot.app/content-library.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### GET /settings/manage-subscription.md

Source: https://help.docupilot.app/settings/manage-subscription.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /settings/manage-subscription.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://help.docupilot.app/settings/manage-subscription.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### GET /esignatures/envelope-actions.md

Source: https://help.docupilot.app/esignatures/envelope-actions.md

Query the documentation dynamically by asking a question related to envelope actions.

```APIDOC
## GET /esignatures/envelope-actions.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically using natural language.

### Method
GET

### Endpoint
https://help.docupilot.app/esignatures/envelope-actions.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Conditional logic examples

Source: https://help.docupilot.app/document-template/excel-file-xlsx.md

Common patterns for conditional display in Excel cells.

```text
{{#if show_payment_details}}
ACH to {{acNumber}}
{{/if}}
```

```text
{{#if (payment_status == "paid")}}
payment cleared
{{/if}}
```

```text
{{#if (payment_status != "paid")}}
unpaid
{{/if}}
```

--------------------------------

### Query Documentation via HTTP

Source: https://help.docupilot.app/create-document/data-capture-form.md

Perform an HTTP GET request to retrieve information from the documentation dynamically.

```http
GET https://help.docupilot.app/create-document/data-capture-form.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /account-setup-and-administration/managing-your-org/user-management.md

Source: https://help.docupilot.app/account-setup-and-administration/managing-your-org/user-management.md

Queries the documentation for specific information regarding user management by providing a question and an optional goal.

```APIDOC
## GET /account-setup-and-administration/managing-your-org/user-management.md

### Description
Queries the documentation dynamically to retrieve information about user management, such as inviting users, transferring ownership, or deactivating accounts.

### Method
GET

### Endpoint
https://help.docupilot.app/account-setup-and-administration/managing-your-org/user-management.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask about user management.
- **goal** (string) - Optional - The broader end goal the user is trying to accomplish to help tailor the response.
```

--------------------------------

### API Response Examples

Source: https://help.docupilot.app/create-document/api-and-webhook-integration.md

Expected JSON responses based on delivery configuration and query parameters.

```json
{
    "status": "success",
    "data": null
}
```

```json
{
    "status": "success",
    "data": {
        "file_url": "https://docupilot-documents.s3.amazonaws.com/temp/1a2cadd4-33f7-4f0c-9d9a-3e87803d3e7b/contract.pdf?AWSAccessKeyId=AKIAJTKZBQI56EOPGLFQ&Signature=BHG3mejXO3f1ymBcZVjMB04Sr6U%3D&Expires=1530277229",
        "file_name": "contract.pdf"
    }
}
```

--------------------------------

### Python API Integration

Source: https://help.docupilot.app/create-document/api-and-webhook-integration.md

Example using the requests library to send a POST request to the Docupilot API.

```python
import requests

# update your API Endpoint URL here
api_endpoint = "https://api.docupilot.app/documents/create/46ac75c3/5e7d03ec"

payload = {
  "customer_name":"John",
  "customer_email":"john@example.com",
  "line_items":[
    {
      "description":"Design",
      "quantity":1,
      "price":"230"
    },
    {
      "description":"Development",
      "quantity":4,
      "price":"130"
    }
  ]
}
headers = {
  'Content-Type': "application/json"
}

response = requests.post(api_endpoint, data=payload, headers=headers)

print(response.text)
```

--------------------------------

### GET /document-template.md

Source: https://help.docupilot.app/document-template.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /document-template.md

### Description
Queries the documentation dynamically by asking a question. The response provides a direct answer along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://help.docupilot.app/document-template.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### Conditional Logic Syntax Examples

Source: https://help.docupilot.app/document-template/document-builder.md

Syntax patterns for conditional statements using if-else logic.

```text
{{#if (a == b)}} a and b are same {{else if (c != d)}} c and d are not same {{/if}}
```

```text
{{#if (count > 3)}} count is greater than 3{{/if}}
```

```text
{{#if (item in "apple, ball")}} is apple or ball{{/if}}
```

```text
{{#if (a == b or a == c)}} a is same as b or c {{/if}}
```

```text
{{#if (color == "red" or color == "blue")}}this is either red or blue{{/if}}
```

```text
{{#if (color == "red" and item == "ball")}}this is a red ball{{/if}}
```

```text
{{#if ((color == "red" and item == "ball") or (color == "blue" and item == "hat")))}}this is either a red ball or a blue hat{{/if}}
```

```text
{{#if (color in "red, blue")}}this is either red or blue{{/if}
```

```text
{{#if ("red, blue" contains color)}}this is either red or blue{{/if}}
```

--------------------------------

### Number Formatting Examples

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Various configurations for formatting numbers using different separators and precision settings.

```text
{{format_number price thousand_separator="." precision="0"}}
```

```text
{{format_number invoice_total thousand_separator="." decimal_separator="," precision="3"}}
```

```text
{{format_number number precision="2"}}
```

```text
{{format_number number decimal_separator=","}}
```

```text
{{format_number number output_format="in"}}
```

```text
{{format_number number output_format="in" thousand_separator="," decimal_separator="." precision="2"}}
```

--------------------------------

### GET /document-template/ms-word-powerpoint-document.md

Source: https://help.docupilot.app/document-template/ms-word-powerpoint-document.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /document-template/ms-word-powerpoint-document.md

### Description
Perform a query against the documentation to receive a direct answer and relevant excerpts based on the provided question.

### Method
GET

### Endpoint
https://help.docupilot.app/document-template/ms-word-powerpoint-document.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /folders-and-templates-management/share-templates-and-folders.md

Source: https://help.docupilot.app/folders-and-templates-management/share-templates-and-folders.md

Queries the documentation page for specific information by providing a question and an optional goal.

```APIDOC
## GET /folders-and-templates-management/share-templates-and-folders.md

### Description
Queries the documentation dynamically by asking a question related to the content.

### Method
GET

### Endpoint
https://help.docupilot.app/folders-and-templates-management/share-templates-and-folders.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /developers.md

Source: https://help.docupilot.app/developers

Queries the documentation dynamically by providing a specific question and an optional end goal.

```APIDOC
## GET /developers.md

### Description
Perform a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://help.docupilot.app/developers.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /create-document.md

Source: https://help.docupilot.app/create-document.md

Queries the documentation dynamically by providing a question and an optional goal to retrieve relevant information.

```APIDOC
## GET /create-document.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically when information is not explicitly present or further clarification is needed.

### Method
GET

### Endpoint
https://help.docupilot.app/create-document.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question written in natural language.
- **goal** (string) - Optional - The broader end goal you are trying to accomplish to help tailor the response.
```

--------------------------------

### GET /deliveries/signnow.md

Source: https://help.docupilot.app/deliveries/signnow.md

Query the documentation dynamically to retrieve information about SignNow delivery configurations.

```APIDOC
## GET /deliveries/signnow.md

### Description
Perform an HTTP GET request on the current page URL to ask questions about the documentation content.

### Method
GET

### Endpoint
https://help.docupilot.app/deliveries/signnow.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask regarding the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Date Formatting Examples

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Common usage patterns for formatting dates, including locale-specific output and time offsets.

```text
{{format_date _date format="DD-MM-YY"}}
```

```text
{{format_date _date format="MMMM DD YYYY" locale="fr"}}
```

```text
{{format_date _date format="MMMM DD YYYY" locale="en" offset="+1years"}}
```

```text
{{format_date _date offset="+1years"}}
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://help.docupilot.app/workflows/create-and-build-a-workflow.md

Use this request to ask questions about the documentation dynamically by appending query parameters to the page URL.

```http
GET https://help.docupilot.app/workflows/create-and-build-a-workflow.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /deliveries/hellosign.md

Source: https://help.docupilot.app/deliveries/hellosign.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a natural language question.

```APIDOC
## GET /deliveries/hellosign.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://help.docupilot.app/deliveries/hellosign.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.

### Response
- The response contains a direct answer to the question along with relevant excerpts and sources from the documentation.
```

--------------------------------

### GET /deliveries/webhook.md

Source: https://help.docupilot.app/deliveries/webhook.md

Query the documentation dynamically by asking a question related to the webhook delivery configuration.

```APIDOC
## GET /deliveries/webhook.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically using natural language.

### Method
GET

### Endpoint
https://help.docupilot.app/deliveries/webhook.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal you are trying to accomplish.
```

--------------------------------

### Replace Numbers with a Symbol

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Example of replacing numeric sequences with a symbol.

```text
{{replace text (regex "[0-9]+" "g") "$"}}
```

```text
text = "1239HomeAlone42"
```

```text
$HomeAlone$
```

--------------------------------

### GET /document-template/excel-file-xlsx.md

Source: https://help.docupilot.app/document-template/excel-file-xlsx.md

Performs a dynamic query against the documentation page to retrieve answers or context.

```APIDOC
## GET /document-template/excel-file-xlsx.md

### Description
Performs a dynamic query against the current documentation page to retrieve answers to specific questions or to get context for a broader goal.

### Method
GET

### Endpoint
https://help.docupilot.app/document-template/excel-file-xlsx.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Replace Specific Word

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Example of replacing a specific word within a string.

```text
{{replace text find replace}}
```

```text
text = "Mary Ross"
find = "Ross"
replace = "Jane"
```

```text
Mary Jane
```

--------------------------------

### Handling Empty Lines

Source: https://help.docupilot.app/document-template/ms-word-powerpoint-document.md

Example showing how conditional logic can result in empty lines when fields are missing.

```handlebars
{{customer_name}},
{{#if address}}{{address}},{{/if}}
{{city}}, {{country}}
```

--------------------------------

### GET /settings/workspace.md

Source: https://help.docupilot.app/settings/workspace.md

Queries the documentation for specific information regarding workspace settings by providing a question and an optional goal.

```APIDOC
## GET /settings/workspace.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources related to workspace settings.

### Method
GET

### Endpoint
https://help.docupilot.app/settings/workspace.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask in natural language.
- **goal** (string) - Optional - The broader end goal the user is trying to accomplish to help tailor the response.
```

--------------------------------

### GET /folders-and-templates-management.md

Source: https://help.docupilot.app/folders-and-templates-management.md

Queries the documentation for information regarding folders and templates management by providing a specific question and an optional goal.

```APIDOC
## GET /folders-and-templates-management.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, and sources related to folders and templates management.

### Method
GET

### Endpoint
https://help.docupilot.app/folders-and-templates-management.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /integrations.md

Source: https://help.docupilot.app/integrations.md

Perform a query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /integrations.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the page.

### Method
GET

### Endpoint
https://help.docupilot.app/integrations.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://help.docupilot.app/integrations.md

Use this request format to dynamically query documentation when specific information is not found on the current page.

```http
GET https://help.docupilot.app/integrations.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Replace Characters Using Regex

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Example of using a regex pattern to replace characters.

```text
{{replace input (regex "[a]" "g") "e"}}
```

```text
input = "Ragax"
```

```text
Regex
```

--------------------------------

### Conditional Logic Syntax

Source: https://help.docupilot.app/document-template/excel-file-xlsx.md

Examples of using if-conditions with logical operators like 'or', 'and', '!=', and 'in' to control output.

```handlebars
{{#if (status == "open" or status == "on-hold" or status == "under review")}}
Payment is pending
{{/if}}
```

```handlebars
{{#if (status != "open" and status != "on-hold")}}
Payment is not pending
{{/if}}
```

```handlebars
{{#if (status == "open" and priority == "high")}}
High priority open task
{{/if}}
```

```handlebars
{{#if (payment_status != "paid")}}Please Clear the Dues within 30 days
{{/if}}
```

```handlebars
{{#if (status in "open,pending")}}In Progress... Please stay tuned for further updates.
{{/if}}
```

--------------------------------

### GET /deliveries/email.md

Source: https://help.docupilot.app/deliveries/email.md

Queries the documentation page dynamically using a natural language question and an optional goal.

```APIDOC
## GET /deliveries/email.md

### Description
Perform a query against the documentation page to retrieve answers, excerpts, or related information.

### Method
GET

### Endpoint
https://help.docupilot.app/deliveries/email.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /test-your-document-template.md

Source: https://help.docupilot.app/test-your-document-template.md

Performs a natural language query against the documentation page to retrieve answers and relevant excerpts.

```APIDOC
## GET /test-your-document-template.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically using natural language.

### Method
GET

### Endpoint
https://help.docupilot.app/test-your-document-template.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /frequently-asked-questions-faqs.md

Source: https://help.docupilot.app/frequently-asked-questions-faqs.md

Performs a dynamic query against the documentation page to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /frequently-asked-questions-faqs.md

### Description
Performs a dynamic query against the documentation page to retrieve answers and relevant excerpts based on a specific question and optional goal.

### Method
GET

### Endpoint
https://help.docupilot.app/frequently-asked-questions-faqs.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### GET /workflows/workflow-modules-and-mapping.md

Source: https://help.docupilot.app/workflows/workflow-modules-and-mapping.md

Queries the documentation page for specific information using a natural language question and an optional goal.

```APIDOC
## GET /workflows/workflow-modules-and-mapping.md

### Description
Queries the current documentation page to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://help.docupilot.app/workflows/workflow-modules-and-mapping.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### GET /workflows/troubleshoot-workflows.md

Source: https://help.docupilot.app/workflows/troubleshoot-workflows.md

Performs a query against the documentation to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /workflows/troubleshoot-workflows.md

### Description
Perform a query against the documentation page to retrieve answers and relevant excerpts. This is useful when information is not explicitly present in the current page or when clarification is needed.

### Method
GET

### Endpoint
https://help.docupilot.app/workflows/troubleshoot-workflows.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the answer context.
```

--------------------------------

### GET /folders-and-templates-management/manage-templates.md

Source: https://help.docupilot.app/folders-and-templates-management/manage-templates.md

Performs a dynamic query against the documentation page to retrieve answers based on a specific question and optional goal.

```APIDOC
## GET /folders-and-templates-management/manage-templates.md

### Description
Queries the documentation dynamically to retrieve information not explicitly covered in the static content. This is useful for clarifying concepts or finding related documentation sections.

### Method
GET

### Endpoint
https://help.docupilot.app/folders-and-templates-management/manage-templates.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /workflows/manage-workflows.md

Source: https://help.docupilot.app/workflows/manage-workflows.md

Queries the documentation dynamically by providing a question and an optional goal to receive a tailored response with relevant excerpts.

```APIDOC
## GET /workflows/manage-workflows.md

### Description
Queries the documentation dynamically to retrieve answers and relevant excerpts based on a specific question and an optional goal.

### Method
GET

### Endpoint
https://help.docupilot.app/workflows/manage-workflows.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Request Example
GET https://help.docupilot.app/workflows/manage-workflows.md?ask=How do I restore a workflow?&goal=workflow management
```

--------------------------------

### GET /readme.md

Source: https://help.docupilot.app/readme.md

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /readme.md

### Description
Queries the documentation dynamically to retrieve information not explicitly found in the current page.

### Method
GET

### Endpoint
https://help.docupilot.app/readme.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /workflows.md

Source: https://help.docupilot.app/workflows.md

Perform a query against the documentation to retrieve answers, excerpts, or context related to the workflows documentation.

```APIDOC
## GET /workflows.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page or to get clarification on specific topics.

### Method
GET

### Endpoint
https://help.docupilot.app/workflows.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### Make Authenticated API Request

Source: https://help.docupilot.app/developers/api-overview.md

Example of a cURL request using the base64-encoded credentials in the Authorization header.

```bash
// making an API request
curl -X GET \
  https://api-us1.docupilot.app/accounts/user/me/ \
  -H 'Authorization: Bearer <Base64 encoded API credentials>'
```

--------------------------------

### Strip Helper Examples

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Various ways to use the strip helper to remove whitespace or specific characters from different sides of a string.

```text
{{strip text}}
```

```text
{{strip text "-"}}
```

```text
{{strip text "0" side="left"}}
```

```text
{{strip "text" "%" side="right"}}
```

--------------------------------

### GET /deliveries/yousign.md

Source: https://help.docupilot.app/deliveries/yousign.md

Queries the documentation page dynamically to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /deliveries/yousign.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically. This is useful when you need clarification, additional context, or information not explicitly present in the current page.

### Method
GET

### Endpoint
https://help.docupilot.app/deliveries/yousign.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### GET /account-setup-and-administration/managing-your-org.md

Source: https://help.docupilot.app/account-setup-and-administration/managing-your-org.md

Queries the documentation dynamically by providing a specific question and an optional end goal to receive a tailored response with relevant excerpts.

```APIDOC
## GET /account-setup-and-administration/managing-your-org.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

### Method
GET

### Endpoint
https://help.docupilot.app/account-setup-and-administration/managing-your-org.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate, specific question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /collaborating-with-multiple-users.md

Source: https://help.docupilot.app/collaborating-with-multiple-users.md

Perform a query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /collaborating-with-multiple-users.md

### Description
Queries the documentation dynamically to retrieve information not explicitly covered in the current page.

### Method
GET

### Endpoint
https://help.docupilot.app/collaborating-with-multiple-users.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Extract Numbers via Replacement

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Example of masking numbers within a string using regex.

```text
{{replace text (regex "[0-9]+" "g") "*"}}
```

```text
text = "My number is 456 and my ID is 7890."
```

```text
My number is *** and my ID is ****.
```

--------------------------------

### GET /document-template/advanced-usage.md

Source: https://help.docupilot.app/document-template/advanced-usage.md

Perform a query against the documentation to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /document-template/advanced-usage.md

### Description
Queries the documentation dynamically to retrieve information not explicitly found in the current page. This allows AI agents or users to ask specific questions with an optional broader goal context.

### Method
GET

### Endpoint
https://help.docupilot.app/document-template/advanced-usage.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate, specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### GET /workflows/workflow-runs.md

Source: https://help.docupilot.app/workflows/workflow-runs.md

Queries the documentation for specific information regarding workflow runs by providing a question and an optional goal.

```APIDOC
## GET /workflows/workflow-runs.md

### Description
Perform a query against the documentation to retrieve information about workflow runs, statuses, or investigation steps.

### Method
GET

### Endpoint
https://help.docupilot.app/workflows/workflow-runs.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question regarding workflow runs.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question based on the documentation.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### GET /document-template/formatting-your-data.md

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Performs a query against the documentation to retrieve specific information or answers based on the provided question.

```APIDOC
## GET /document-template/formatting-your-data.md

### Description
Queries the documentation dynamically to retrieve answers or context related to the documentation content.

### Method
GET

### Endpoint
https://help.docupilot.app/document-template/formatting-your-data.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /document-template/document-builder.md

Source: https://help.docupilot.app/document-template/document-builder.md

Performs a dynamic query against the documentation page to retrieve answers based on a specific question and optional goal.

```APIDOC
## GET /document-template/document-builder.md

### Description
Performs a dynamic query against the current documentation page to retrieve a direct answer and relevant excerpts.

### Method
GET

### Endpoint
https://help.docupilot.app/document-template/document-builder.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Replace Lowercase Letters with Asterisks

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Example of replacing all lowercase letters with asterisks using regex.

```text
{{replace text (regex "[a-z]" "g") "*"}}
```

```text
text = "MaryJane123"
```

```text
M***J***123
```

--------------------------------

### GET /deliveries/google-drive.md

Source: https://help.docupilot.app/deliveries/google-drive.md

Queries the documentation page dynamically to retrieve answers, excerpts, or context related to the Google Drive delivery configuration.

```APIDOC
## GET /deliveries/google-drive.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://help.docupilot.app/deliveries/google-drive.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **response** (string) - A direct answer to the question along with relevant excerpts and sources from the documentation.
```

--------------------------------

### Replace Multiple Occurrences with Regex

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Example of using regex to match and replace multiple occurrences dynamically.

```text
{{replace text (regex "[0-9]+" "g") "#"}}
```

```text
text = "ID12345XYZ678"
```

```text
ID#XYZ#
```

--------------------------------

### Number to Words Usage Examples

Source: https://help.docupilot.app/document-template/formatting-your-data.md

Various implementations of the number_to_words helper for different currency and language formatting requirements.

```text
{{number_to_words number}}
```

```text
{{capitalize (number_to_words amount suffix="dollars" decimal_suffix="cents")}}
```

```text
{{number_to_words currency output_format="in" suffix="rupees" decimal_suffix="paise"}}
```

```text
{{number_to_words price output_format="in" suffix="rupees"}}
```

```text
{{number_to words price suffix="dollars"}}
```

```text
{{number_to_words input language="fr"}}
```

```text
{{number_to_words price suffix="Euros" decimal_suffix="Cents" language="de"}}
```

--------------------------------

### GET /integrations/airtable-extension.md

Source: https://help.docupilot.app/integrations/airtable-extension.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /integrations/airtable-extension.md

### Description
Perform a query against the documentation page to retrieve information not explicitly covered in the static content.

### Method
GET

### Endpoint
https://help.docupilot.app/integrations/airtable-extension.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Querying Documentation via HTTP

Source: https://help.docupilot.app/account-setup-and-administration/creating-workspaces.md

Perform an HTTP GET request to retrieve information from the documentation dynamically using the ask and goal parameters.

```http
GET https://help.docupilot.app/account-setup-and-administration/creating-workspaces.md?ask=<question>&goal=<endgoal>
```
Tokens:
Raw