# OSDB REST API v1 API

> OSDB REST API v1 API on Apizie: 10 endpoints (List actions, Describe action, Execute action, Action help, …) returned as clean JSON through one API key. 10 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `dev-tools:openlinksw-osdb`
- Category: Dev Tools
- Status: live
- Source: https://openlinksw.com
- Page: https://zieapi.vercel.app/api/dev-tools/openlinksw-osdb
- OpenAPI: https://zieapi.vercel.app/api/dev-tools/openlinksw-osdb/openapi.json

An OpenAPI description of the OpenLink Smart Data Bot REST API v1

## Endpoints

### List actions
`GET https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/list-actions`

| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceId | string | yes | Service ID of the service for which actions are to be listed |

### Describe action
`GET https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/describe-action`

| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceId | string | yes | Service ID of the service supporting the action. |
| actionId | string | yes | Action ID of the action to describe. |

### Execute action
`POST https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/execute-action`

| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceId | string | yes | Service ID of the service supporting the action. |
| actionId | string | yes | Action ID of the action to execute. |
| body | object | no | JSON request body |

### Action help
`GET https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/action-help`

| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceId | string | yes | Service ID of the service supporting the action. |
| actionId | string | yes | Action ID of the action for which help text is being requested. |

### Login
`GET https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/login`

### Logout
`GET https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/logout`

### List services
`GET https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/list-services`

### Load service
`POST https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/load-service`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Describe service
`GET https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/describe-service`

| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceId | string | yes | Service ID of the service to describe. |

### Unload service
`POST https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/unload-service`

| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceId | string | yes | Service ID of the service to be unloaded |

## Example
```
curl "https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/list-actions" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the OSDB REST API v1 API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/dev-tools:openlinksw-osdb/list-actions with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the OSDB REST API v1 API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the OSDB REST API v1 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 dev-tools:openlinksw-osdb.

### What is the status of the OSDB REST API v1 API?
Live: works with just an Apizie key