# QBusiness API

> QBusiness API on Apizie: 55 endpoints (Batch Delete Document, Batch Put Document, Chat Sync, List Applications, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aws-qbusiness/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aws-qbusiness`
- Category: Cloud
- Status: byok
- Source: https://docs.aws.amazon.com/
- Page: https://apizie.tech/api/cloud/aws-qbusiness
- OpenAPI: https://apizie.tech/api/cloud/aws-qbusiness/openapi.json



## Endpoints

### Batch Delete Document
`POST https://apizie.tech/v1/cloud:aws-qbusiness/batch-delete-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |

### Batch Put Document
`POST https://apizie.tech/v1/cloud:aws-qbusiness/batch-put-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |

### Chat Sync
`POST https://apizie.tech/v1/cloud:aws-qbusiness/chat-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### List Applications
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-applications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Create Application
`POST https://apizie.tech/v1/cloud:aws-qbusiness/create-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### List Data Sources
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-data-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |

### Create Data Source
`POST https://apizie.tech/v1/cloud:aws-qbusiness/create-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |

### List Indices
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-indices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### Create Index
`POST https://apizie.tech/v1/cloud:aws-qbusiness/create-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### List Plugins
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-plugins` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### Create Plugin
`POST https://apizie.tech/v1/cloud:aws-qbusiness/create-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### List Retrievers
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-retrievers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### Create Retriever
`POST https://apizie.tech/v1/cloud:aws-qbusiness/create-retriever` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### Create User
`POST https://apizie.tech/v1/cloud:aws-qbusiness/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### List Web Experiences
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-web-experiences` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### Create Web Experience
`POST https://apizie.tech/v1/cloud:aws-qbusiness/create-web-experience` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### Get Application
`GET https://apizie.tech/v1/cloud:aws-qbusiness/get-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### Update Application
`POST https://apizie.tech/v1/cloud:aws-qbusiness/update-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### Delete Application
`POST https://apizie.tech/v1/cloud:aws-qbusiness/delete-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### Get Chat Controls Configuration
`GET https://apizie.tech/v1/cloud:aws-qbusiness/get-chat-controls-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### Update Chat Controls Configuration
`POST https://apizie.tech/v1/cloud:aws-qbusiness/update-chat-controls-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### Delete Chat Controls Configuration
`POST https://apizie.tech/v1/cloud:aws-qbusiness/delete-chat-controls-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### List Messages
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| conversationId | string | yes | Path parameter {conversationId} |

### Delete Conversation
`POST https://apizie.tech/v1/cloud:aws-qbusiness/delete-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| conversationId | string | yes | Path parameter {conversationId} |

### Get Data Source
`GET https://apizie.tech/v1/cloud:aws-qbusiness/get-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |
| dataSourceId | string | yes | Path parameter {dataSourceId} |

### Update Data Source
`POST https://apizie.tech/v1/cloud:aws-qbusiness/update-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |
| dataSourceId | string | yes | Path parameter {dataSourceId} |

### Delete Data Source
`POST https://apizie.tech/v1/cloud:aws-qbusiness/delete-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |
| dataSourceId | string | yes | Path parameter {dataSourceId} |

### Get Group
`GET https://apizie.tech/v1/cloud:aws-qbusiness/get-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |
| groupName | string | yes | Path parameter {groupName} |

### Delete Group
`POST https://apizie.tech/v1/cloud:aws-qbusiness/delete-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |
| groupName | string | yes | Path parameter {groupName} |

### Get Index
`GET https://apizie.tech/v1/cloud:aws-qbusiness/get-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |

### Update Index
`POST https://apizie.tech/v1/cloud:aws-qbusiness/update-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |

### Delete Index
`POST https://apizie.tech/v1/cloud:aws-qbusiness/delete-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |

### Get Plugin
`GET https://apizie.tech/v1/cloud:aws-qbusiness/get-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| pluginId | string | yes | Path parameter {pluginId} |

### Update Plugin
`POST https://apizie.tech/v1/cloud:aws-qbusiness/update-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| pluginId | string | yes | Path parameter {pluginId} |

### Delete Plugin
`POST https://apizie.tech/v1/cloud:aws-qbusiness/delete-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| pluginId | string | yes | Path parameter {pluginId} |

### Get Retriever
`GET https://apizie.tech/v1/cloud:aws-qbusiness/get-retriever` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| retrieverId | string | yes | Path parameter {retrieverId} |

### Update Retriever
`POST https://apizie.tech/v1/cloud:aws-qbusiness/update-retriever` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| retrieverId | string | yes | Path parameter {retrieverId} |

### Delete Retriever
`POST https://apizie.tech/v1/cloud:aws-qbusiness/delete-retriever` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| retrieverId | string | yes | Path parameter {retrieverId} |

### Get User
`GET https://apizie.tech/v1/cloud:aws-qbusiness/get-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| userId | string | yes | Path parameter {userId} |

### Update User
`POST https://apizie.tech/v1/cloud:aws-qbusiness/update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| userId | string | yes | Path parameter {userId} |

### Delete User
`POST https://apizie.tech/v1/cloud:aws-qbusiness/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| userId | string | yes | Path parameter {userId} |

### Get Web Experience
`GET https://apizie.tech/v1/cloud:aws-qbusiness/get-web-experience` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| webExperienceId | string | yes | Path parameter {webExperienceId} |

### Update Web Experience
`POST https://apizie.tech/v1/cloud:aws-qbusiness/update-web-experience` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| webExperienceId | string | yes | Path parameter {webExperienceId} |

### Delete Web Experience
`POST https://apizie.tech/v1/cloud:aws-qbusiness/delete-web-experience` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| webExperienceId | string | yes | Path parameter {webExperienceId} |

### List Conversations
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |

### List Data Source Sync Jobs
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-data-source-sync-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |
| dataSourceId | string | yes | Path parameter {dataSourceId} |

### List Documents
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |

### List Groups
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |

### Put Group
`POST https://apizie.tech/v1/cloud:aws-qbusiness/put-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |

### List Tags For Resource
`GET https://apizie.tech/v1/cloud:aws-qbusiness/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceARN | string | yes | Path parameter {resourceARN} |

### Tag Resource
`POST https://apizie.tech/v1/cloud:aws-qbusiness/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceARN | string | yes | Path parameter {resourceARN} |

### Untag Resource
`POST https://apizie.tech/v1/cloud:aws-qbusiness/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceARN | string | yes | Path parameter {resourceARN} |

### Put Feedback
`POST https://apizie.tech/v1/cloud:aws-qbusiness/put-feedback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| conversationId | string | yes | Path parameter {conversationId} |
| messageId | string | yes | Path parameter {messageId} |

### Start Data Source Sync Job
`POST https://apizie.tech/v1/cloud:aws-qbusiness/start-data-source-sync-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |
| dataSourceId | string | yes | Path parameter {dataSourceId} |

### Stop Data Source Sync Job
`POST https://apizie.tech/v1/cloud:aws-qbusiness/stop-data-source-sync-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| applicationId | string | yes | Path parameter {applicationId} |
| indexId | string | yes | Path parameter {indexId} |
| dataSourceId | string | yes | Path parameter {dataSourceId} |

## Example
```
curl "https://apizie.tech/v1/cloud:aws-qbusiness/batch-delete-document" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the QBusiness API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aws-qbusiness/batch-delete-document with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the QBusiness API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. QBusiness itself also needs your own key from amazonaws.com.

### Can AI agents use the QBusiness API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aws-qbusiness.

### What is the status of the QBusiness API?
Needs your own provider key (bring your own key)