Harmony

https://docs.harmony.io/
Admin
Harmony is an AI-powered IT service management platform that unifies service desk ticketing, asset...
Tokens:138,099
Snippets:2,252
Trust Score:7.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /faq/faq/getting-started.md

Source: https://docs.harmony.io/faq/faq/getting-started.md

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

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

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

### Method
GET

### Endpoint
https://docs.harmony.io/faq/faq/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 /integrations/saas-applications/bring-your-own-app/bring-your-own-app-users.md

Source: https://docs.harmony.io/integrations/saas-applications/bring-your-own-app/bring-your-own-app-users.md

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

```APIDOC
## GET /integrations/saas-applications/bring-your-own-app/bring-your-own-app-users.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/integrations/saas-applications/bring-your-own-app/bring-your-own-app-users.md

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

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

### Query Documentation via HTTP GET

Source: https://docs.harmony.io/ai-agents/access-control

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

```http
GET https://docs.harmony.io/ai-agents/access-control.md?ask=<question>&goal=<endgoal>
```

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

### GET /faq/faq/overview.md

Source: https://docs.harmony.io/faq/faq/overview.md

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

```APIDOC
## GET /faq/faq/overview.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/faq/faq/overview.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.
```

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

### GET /sso-setup/sso-configuration.md

Source: https://docs.harmony.io/sso-setup/sso-configuration

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /sso-setup/sso-configuration.md

### Description
Performs a dynamic query against the documentation page to retrieve answers, excerpts, and sources based on a user question.

### Method
GET

### Endpoint
https://docs.harmony.io/sso-setup/sso-configuration.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 context.
```

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

### GET /settings/configuring-integration-sync-and-credentials.md

Source: https://docs.harmony.io/settings/configuring-integration-sync-and-credentials.md

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

```APIDOC
## GET /settings/configuring-integration-sync-and-credentials.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.harmony.io/settings/configuring-integration-sync-and-credentials.md

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

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

### GET /integrations/saas-applications/netsuite.md

Source: https://docs.harmony.io/integrations/saas-applications/netsuite.md

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

```APIDOC
## GET /integrations/saas-applications/netsuite.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/integrations/saas-applications/netsuite.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.
```

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

### GET /getting-started.md

Source: https://docs.harmony.io/getting-started

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

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

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

### Method
GET

### Endpoint
https://docs.harmony.io/getting-started.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 context.
```

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

### GET /people-management/employee-sync-external-status-data.md

Source: https://docs.harmony.io/people-management/employee-sync-external-status-data.md

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

```APIDOC
## GET /people-management/employee-sync-external-status-data.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/people-management/employee-sync-external-status-data.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.
```

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

### GET /getting-started/welcome.md

Source: https://docs.harmony.io/getting-started/welcome.md

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

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

### Description
Perform a dynamic query against the documentation to receive a direct answer and relevant excerpts.

### Method
GET

### Endpoint
https://docs.harmony.io/getting-started/welcome.md

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

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

### GET /integrations/saas-applications/salesforce.md

Source: https://docs.harmony.io/integrations/saas-applications/salesforce.md

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

```APIDOC
## GET /integrations/saas-applications/salesforce.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/integrations/saas-applications/salesforce.md

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

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

### GET /ai-agents/getting-started.md

Source: https://docs.harmony.io/ai-agents/getting-started

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

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

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

### Method
GET

### Endpoint
https://docs.harmony.io/ai-agents/getting-started.md

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

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

### GET /getting-started/navigating-the-interface.md

Source: https://docs.harmony.io/getting-started/navigating-the-interface.md

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

```APIDOC
## GET /getting-started/navigating-the-interface.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/getting-started/navigating-the-interface.md

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

### Request Example
GET https://docs.harmony.io/getting-started/navigating-the-interface.md?ask=How+do+I+navigate+the+interface?&goal=Learn+the+basics
```

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

### GET /integrations/saas-applications/intercom.md

Source: https://docs.harmony.io/integrations/saas-applications/intercom.md

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

```APIDOC
## GET /integrations/saas-applications/intercom.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/integrations/saas-applications/intercom.md

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

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

### GET /getting-started/managing-your-profile-and-preferences.md

Source: https://docs.harmony.io/getting-started/managing-your-profile-and-preferences.md

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

```APIDOC
## GET /getting-started/managing-your-profile-and-preferences.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/getting-started/managing-your-profile-and-preferences.md

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

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

### GET /asset-management/viewing-device-hardware-details-disk-battery.md

Source: https://docs.harmony.io/asset-management/viewing-device-hardware-details-disk-battery.md

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

```APIDOC
## GET /asset-management/viewing-device-hardware-details-disk-battery.md

### Description
Perform an HTTP GET request on the current page URL with the `ask` query parameter to retrieve information dynamically from the documentation.

### Method
GET

### Endpoint
https://docs.harmony.io/asset-management/viewing-device-hardware-details-disk-battery.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/getting-started-with-harmony-dashboard.md

Source: https://docs.harmony.io/getting-started/getting-started-with-harmony-dashboard.md

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

```APIDOC
## GET /getting-started/getting-started-with-harmony-dashboard.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page. This allows for context-aware answers based on the provided question and goal.

### Method
GET

### Endpoint
https://docs.harmony.io/getting-started/getting-started-with-harmony-dashboard.md

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

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

### GET /integrations/identity-provider/jumpcloud-idp.md

Source: https://docs.harmony.io/integrations/identity-provider/jumpcloud-idp.md

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

```APIDOC
## GET /integrations/identity-provider/jumpcloud-idp.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/integrations/identity-provider/jumpcloud-idp.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 /getting-started/using-harmony-copilot.md

Source: https://docs.harmony.io/getting-started/using-harmony-copilot.md

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

```APIDOC
## GET /getting-started/using-harmony-copilot.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/getting-started/using-harmony-copilot.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 /ai-agents/getting-started/configuring-ai-agents.md

Source: https://docs.harmony.io/ai-agents/getting-started/configuring-ai-agents.md

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

```APIDOC
## GET /ai-agents/getting-started/configuring-ai-agents.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/ai-agents/getting-started/configuring-ai-agents.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.
```

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

### Query Documentation via HTTP GET

Source: https://docs.harmony.io/asset-management/windows-peripheral-and-display-discovery.md

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

```http
GET https://docs.harmony.io/asset-management/windows-peripheral-and-display-discovery.md?ask=<question>&goal=<endgoal>
```

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

### GET /ai-agents/access-control/idp-group-membership-query-blocks.md

Source: https://docs.harmony.io/ai-agents/access-control/idp-group-membership-query-blocks.md

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

```APIDOC
## GET /ai-agents/access-control/idp-group-membership-query-blocks.md

### Description
Query the documentation dynamically by asking a question to retrieve answers, excerpts, and sources.

### Method
GET

### Endpoint
https://docs.harmony.io/ai-agents/access-control/idp-group-membership-query-blocks.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 tailor the answer.
```

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

### Group Search Example

Source: https://docs.harmony.io/integrations/identity-provider/google-workspace.md

Example of a group email address used for searching within the Group Membership Management request type.

```text
engineering@company.com
```

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

### GET /getting-started/understanding-user-roles-and-permissions.md

Source: https://docs.harmony.io/getting-started/understanding-user-roles-and-permissions.md

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

```APIDOC
## GET /getting-started/understanding-user-roles-and-permissions.md

### Description
Queries the documentation page for specific information using natural language. This endpoint returns an answer along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://docs.harmony.io/getting-started/understanding-user-roles-and-permissions.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 context.
```

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

### GET /ai-agents/getting-started/working-with-ai-agents.md

Source: https://docs.harmony.io/ai-agents/getting-started/working-with-ai-agents.md

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

```APIDOC
## GET /ai-agents/getting-started/working-with-ai-agents.md

### Description
Perform an HTTP GET request on the documentation page URL to query information dynamically. This allows AI agents to retrieve specific answers and relevant documentation excerpts.

### Method
GET

### Endpoint
https://docs.harmony.io/ai-agents/getting-started/working-with-ai-agents.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.
```

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

### GET /api-references/tickets/query-tickets.md

Source: https://docs.harmony.io/api-references/tickets/query-tickets.md

Query the documentation dynamically by asking a question.

```APIDOC
## GET /api-references/tickets/query-tickets.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://docs.harmony.io/api-references/tickets/query-tickets.md

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

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

### Query Documentation via HTTP GET

Source: https://docs.harmony.io/ai-agents/hardware-management/low-storage-monitoring.md

Use this request to ask specific questions about low storage monitoring or hardware management.

```http
GET https://docs.harmony.io/ai-agents/hardware-management/low-storage-monitoring.md?ask=<question>&goal=<endgoal>
```

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

### GET /api/v1/tickets/

Source: https://docs.harmony.io/api-references/tickets/list-tickets.md

Retrieves a list of tickets from the Harmony.io API.

```APIDOC
## GET /api/v1/tickets/

### Description
Retrieves a list of tickets from the system.

### Method
GET

### Endpoint
/api/v1/tickets/
```

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

### GET /sso-setup/scim-configuration.md

Source: https://docs.harmony.io/sso-setup/scim-configuration

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

```APIDOC
## GET /sso-setup/scim-configuration.md

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

### Method
GET

### Endpoint
https://docs.harmony.io/sso-setup/scim-configuration.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 /service-desk-and-tickets/using-the-requests-dashboard.md

Source: https://docs.harmony.io/service-desk-and-tickets/using-the-requests-dashboard.md

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

```APIDOC
## GET /service-desk-and-tickets/using-the-requests-dashboard.md

### Description
Queries the documentation dynamically to retrieve information or clarification regarding the Requests dashboard or related topics.

### Method
GET

### Endpoint
https://docs.harmony.io/service-desk-and-tickets/using-the-requests-dashboard.md

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

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

### GET /api-references/api-documentation/introduction.md

Source: https://docs.harmony.io/api-references/api-documentation/introduction.md

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

```APIDOC
## GET /api-references/api-documentation/introduction.md

### Description
Performs a dynamic query against the documentation to retrieve answers and relevant excerpts based on a natural language question.

### Method
GET

### Endpoint
https://docs.harmony.io/api-references/api-documentation/introduction.md

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