# ArtifactsClient API

> ArtifactsClient API on Apizie: 19 endpoints (Batch execution of DDL Payload., Batch execution of DDL Payload., Get all databases in a workspace., List all Artifacts of a type in a database., …) 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://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-synapse-microsoft-synapse`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://zieapi.vercel.app/api/cloud/azure-synapse-microsoft-synapse
- OpenAPI: https://zieapi.vercel.app/api/cloud/azure-synapse-microsoft-synapse/openapi.json

SyMS API Service Client.

## Endpoints

### Batch execution of DDL Payload.
`POST https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/execute-change` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| api-version | string | no | The Synapse client API Version. |
| body | object | yes | JSON request body |

### Batch execution of DDL Payload.
`POST https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/execute-change-with-validation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| validationType | string | yes | Validation Type - Currently only IDWValidation is supported |
| api-version | string | no | The Synapse client API Version. |
| body | object | yes | JSON request body |

### Get all databases in a workspace.
`GET https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/list-databases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| api-version | string | no | The Synapse client API Version. |
| continuationToken | string | no | Continuation token to get next page. |
| maxPageSize | integer | no | Max page size. |

### List all Artifacts of a type in a database.
`GET https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/list-artifacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| artifactType | string | yes | Artifact type. |
| api-version | string | no | The Synapse client API Version. |
| continuationToken | string | no | Continuation token to get next page. |
| maxPageSize | integer | no | Max page size. |

### List all artifacts in schema by type.
`GET https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/list-artifacts-in-schema-by-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| schemaName | string | yes | Schema name. |
| artifactType | string | yes | Artifact type. |
| api-version | string | no | The Synapse client API Version. |
| continuationToken | string | no | Continuation token to get next page. |
| maxPageSize | integer | no | Max page size. |

### List all partition information for a table.
`GET https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/list-partition-infos-for-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| tableName | string | yes | Table name. |
| api-version | string | no | The Synapse client API Version. |
| continuationToken | string | no | Continuation token to get next page. |
| maxPageSize | integer | no | Max page size. |

### List all partition information for a view.
`GET https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/list-partition-infos-for-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| viewName | string | yes | View name. |
| api-version | string | no | The Synapse client API Version. |
| continuationToken | string | no | Continuation token to get next page. |
| maxPageSize | integer | no | Max page size. |

### List all partition information for table in schema.
`GET https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/list-partition-infos-for-schema-and-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| schemaName | string | yes | Schema name. |
| tableName | string | yes | Table name. |
| api-version | string | no | The Synapse client API Version. |
| continuationToken | string | no | Continuation token to get next page. |
| maxPageSize | integer | no | Max page size. |

### List all partition information for a view in schema.
`GET https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/list-partition-infos-for-schema-and-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| schemaName | string | yes | Schema name. |
| viewName | string | yes | View name. |
| api-version | string | no | The Synapse client API Version. |
| continuationToken | string | no | Continuation token to get next page. |
| maxPageSize | integer | no | Max page size. |

### Get details about a database.
`GET https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/get-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| api-version | string | no | The Synapse client API Version. |

### Put a database.
`POST https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/put-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| api-version | string | no | The Synapse client API Version. |
| body | object | yes | JSON request body |

### Delete a database.
`POST https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/delete-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| api-version | string | no | The Synapse client API Version. |

### Get an artifact from database.
`GET https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/get-artifact-from-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| artifactType | string | yes | Artifact type. |
| artifactName | string | yes | Artifact name. |
| api-version | string | no | The Synapse client API Version. |

### Put an artifact in a Database.
`POST https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/put-artifact-in-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| artifactType | string | yes | Artifact type. |
| artifactName | string | yes | Artifact name. |
| api-version | string | no | The Synapse client API Version. |
| continuationToken | string | no | Continuation token to get next page. |
| maxPageSize | integer | no | Max page size. |
| body | object | yes | JSON request body |

### Delete an artifact in a Database.
`POST https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/delete-artifact-for-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| artifactType | string | yes | Artifact type |
| artifactName | string | yes | Artifact name. |
| api-version | string | no | The Synapse client API Version. |

### Get an artifact from schema.
`GET https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/get-artifact-from-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| schemaName | string | yes | Schema name. |
| artifactType | string | yes | Artifact type. |
| artifactName | string | yes | Artifact name. |
| api-version | string | no | The Synapse client API Version. |

### Create or Update an artifact in a schema.
`POST https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/put-artifact-in-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| schemaName | string | yes | Schema name. |
| artifactType | string | yes | Artifact type. |
| artifactName | string | yes | Artifact name. |
| api-version | string | no | The Synapse client API Version. |
| body | object | yes | JSON request body |

### Delete an artifact from Schema.
`POST https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/delete-artifact-from-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| databaseName | string | yes | Database name. |
| schemaName | string | yes | Schema name. |
| artifactType | string | yes | Artifact type. |
| artifactName | string | yes | Artifact name. |
| api-version | string | no | The Synapse client API Version. |

### Get the status of validation by operation Id.
`GET https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/get-sy-msoperation-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`. |
| operationId | string | yes | Operation Id. |
| api-version | string | no | The Synapse client API Version. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/execute-change" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the ArtifactsClient API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:azure-synapse-microsoft-synapse/execute-change with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the ArtifactsClient API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-synapse-microsoft-synapse.

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