Skip to content

Commit 4809959

Browse files
octavia-bot[bot]ian-at-airbyte
octavia-bot[bot]
and
ian-at-airbyte
authored
docs: sync agent connector docs from airbyte-agent-connectors repo (#74739)
Co-authored-by: ian-at-airbyte <187576150+ian-at-airbyte@users.noreply.github.com>
1 parent 2f35857 commit 4809959

3 files changed

Lines changed: 1869 additions & 0 deletions

File tree

‎docs/ai-agents/connectors/clickup-api/AUTH.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Clickup-Api authentication
2+
3+
This page documents the authentication and configuration options for the Clickup-Api agent connector.
4+
5+
## Authentication
6+
7+
### Open source execution
8+
9+
In open source mode, you provide API credentials directly to the connector.
10+
11+
#### OAuth
12+
This authentication method isn't available for this connector.
13+
14+
#### Token
15+
16+
`credentials` fields you need:
17+
18+
| Field Name | Type | Required | Description |
19+
|------------|------|----------|-------------|
20+
| `api_key` | `str` | Yes | Your ClickUp personal API token |
21+
22+
Example request:
23+
24+
```python
25+
from airbyte_agent_clickup_api import ClickupApiConnector
26+
from airbyte_agent_clickup_api.models import ClickupApiAuthConfig
27+
28+
connector = ClickupApiConnector(
29+
auth_config=ClickupApiAuthConfig(
30+
api_key="<Your ClickUp personal API token>"
31+
)
32+
)
33+
```
34+
35+
### Hosted execution
36+
37+
In hosted mode, you first create a connector via the Airbyte API (providing your OAuth or Token credentials), then execute operations using either the Python SDK or API. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
38+
39+
#### OAuth
40+
This authentication method isn't available for this connector.
41+
42+
#### Bring your own OAuth flow
43+
This authentication method isn't available for this connector.
44+
45+
#### Token
46+
Create a connector with Token credentials.
47+
48+
49+
`credentials` fields you need:
50+
51+
| Field Name | Type | Required | Description |
52+
|------------|------|----------|-------------|
53+
| `api_key` | `str` | Yes | Your ClickUp personal API token |
54+
55+
Example request:
56+
57+
58+
```bash
59+
curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
60+
-H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
61+
-H "Content-Type: application/json" \
62+
-d '{
63+
"customer_name": "<CUSTOMER_NAME>",
64+
"connector_type": "Clickup-Api",
65+
"name": "My Clickup-Api Connector",
66+
"credentials": {
67+
"api_key": "<Your ClickUp personal API token>"
68+
}
69+
}'
70+
```
71+
72+
#### Execution
73+
74+
After creating the connector, execute operations using either the Python SDK or API.
75+
If your Airbyte client can access multiple organizations, include `organization_id` in `AirbyteAuthConfig` and `X-Organization-Id` in raw API calls.
76+
77+
**Python SDK**
78+
79+
```python
80+
from airbyte_agent_clickup_api import ClickupApiConnector, AirbyteAuthConfig
81+
82+
connector = ClickupApiConnector(
83+
auth_config=AirbyteAuthConfig(
84+
customer_name="<your_customer_name>",
85+
organization_id="<your_organization_id>", # Optional for multi-org clients
86+
airbyte_client_id="<your-client-id>",
87+
airbyte_client_secret="<your-client-secret>"
88+
)
89+
)
90+
91+
@agent.tool_plain # assumes you're using Pydantic AI
92+
@ClickupApiConnector.tool_utils
93+
async def clickup_api_execute(entity: str, action: str, params: dict | None = None):
94+
return await connector.execute(entity, action, params or {})
95+
```
96+
97+
**API**
98+
99+
```bash
100+
curl -X POST 'https://api.airbyte.ai/api/v1/integrations/connectors/<connector_id>/execute' \
101+
-H 'Authorization: Bearer <YOUR_BEARER_TOKEN>' \
102+
-H 'X-Organization-Id: <YOUR_ORGANIZATION_ID>' \
103+
-H 'Content-Type: application/json' \
104+
-d '{"entity": "<entity>", "action": "<action>", "params": {}}'
105+
```
106+
107+

‎docs/ai-agents/connectors/clickup-api/README.md‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# Clickup-Api
2+
3+
The Clickup-Api agent connector is a Python package that equips AI agents to interact with Clickup-Api through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.
4+
5+
ClickUp is a productivity platform that provides project management, task tracking, docs, goals,
6+
and time tracking for teams. This connector provides access to workspaces, spaces, folders, lists,
7+
tasks (including workspace-wide search), comments, goals, views, time tracking, members, and docs.
8+
9+
10+
## Example questions
11+
12+
The Clickup-Api connector is optimized to handle prompts like these.
13+
14+
- List all workspaces I have access to
15+
- Show me the spaces in my workspace
16+
- List the folders in a space
17+
- Show me the lists in a folder
18+
- Get the tasks in a list
19+
- Get details for a specific task
20+
- Search for tasks containing 'bug' across my workspace
21+
- Find all urgent priority tasks in my workspace
22+
- Show me tasks assigned to a specific user
23+
- List comments on a task
24+
- Get threaded replies on a comment
25+
- Create a comment on a task
26+
- Update a comment to mark it resolved
27+
- List all goals in my workspace
28+
- Get details for a specific goal
29+
- Show me all workspace-level views
30+
- Get tasks matching a saved view
31+
- List time entries for my workspace this week
32+
- Get details for a specific time entry
33+
- Show me the members assigned to a task
34+
- List all docs in my workspace
35+
- Get details for a specific doc
36+
- What tasks are overdue in my workspace?
37+
- Which tasks were updated in the last 24 hours?
38+
- Show me all high-priority tasks across all projects
39+
- How much time has been tracked this week?
40+
- What are the most commented tasks?
41+
42+
## Unsupported questions
43+
44+
The Clickup-Api connector isn't currently able to handle prompts like these.
45+
46+
- Delete a task
47+
- Delete a comment
48+
- Delete a goal
49+
50+
## Installation
51+
52+
```bash
53+
uv pip install airbyte-agent-clickup-api
54+
```
55+
56+
## Usage
57+
58+
Connectors can run in open source or hosted mode.
59+
60+
### Open source
61+
62+
In open source mode, you provide API credentials directly to the connector.
63+
64+
```python
65+
from airbyte_agent_clickup_api import ClickupApiConnector
66+
from airbyte_agent_clickup_api.models import ClickupApiAuthConfig
67+
68+
connector = ClickupApiConnector(
69+
auth_config=ClickupApiAuthConfig(
70+
api_key="<Your ClickUp personal API token>"
71+
)
72+
)
73+
74+
@agent.tool_plain # assumes you're using Pydantic AI
75+
@ClickupApiConnector.tool_utils
76+
async def clickup_api_execute(entity: str, action: str, params: dict | None = None):
77+
return await connector.execute(entity, action, params or {})
78+
```
79+
80+
### Hosted
81+
82+
In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.
83+
If your Airbyte client can access multiple organizations, also set `organization_id`.
84+
85+
This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
86+
87+
```python
88+
from airbyte_agent_clickup_api import ClickupApiConnector, AirbyteAuthConfig
89+
90+
connector = ClickupApiConnector(
91+
auth_config=AirbyteAuthConfig(
92+
customer_name="<your_customer_name>",
93+
organization_id="<your_organization_id>", # Optional for multi-org clients
94+
airbyte_client_id="<your-client-id>",
95+
airbyte_client_secret="<your-client-secret>"
96+
)
97+
)
98+
99+
@agent.tool_plain # assumes you're using Pydantic AI
100+
@ClickupApiConnector.tool_utils
101+
async def clickup_api_execute(entity: str, action: str, params: dict | None = None):
102+
return await connector.execute(entity, action, params or {})
103+
```
104+
105+
## Full documentation
106+
107+
### Entities and actions
108+
109+
This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
110+
111+
| Entity | Actions |
112+
|--------|---------|
113+
| User | [Get](./REFERENCE.md#user-get) |
114+
| Teams | [List](./REFERENCE.md#teams-list) |
115+
| Spaces | [List](./REFERENCE.md#spaces-list), [Get](./REFERENCE.md#spaces-get) |
116+
| Folders | [List](./REFERENCE.md#folders-list), [Get](./REFERENCE.md#folders-get) |
117+
| Lists | [List](./REFERENCE.md#lists-list), [Get](./REFERENCE.md#lists-get) |
118+
| Tasks | [List](./REFERENCE.md#tasks-list), [Get](./REFERENCE.md#tasks-get), [API Search](./REFERENCE.md#tasks-api_search) |
119+
| Comments | [List](./REFERENCE.md#comments-list), [Create](./REFERENCE.md#comments-create), [Get](./REFERENCE.md#comments-get), [Update](./REFERENCE.md#comments-update) |
120+
| Goals | [List](./REFERENCE.md#goals-list), [Get](./REFERENCE.md#goals-get) |
121+
| Views | [List](./REFERENCE.md#views-list), [Get](./REFERENCE.md#views-get) |
122+
| View Tasks | [List](./REFERENCE.md#view-tasks-list) |
123+
| Time Tracking | [List](./REFERENCE.md#time-tracking-list), [Get](./REFERENCE.md#time-tracking-get) |
124+
| Members | [List](./REFERENCE.md#members-list) |
125+
| Docs | [List](./REFERENCE.md#docs-list), [Get](./REFERENCE.md#docs-get) |
126+
127+
128+
### Authentication
129+
130+
For all authentication options, see the connector's [authentication documentation](AUTH.md).
131+
132+
### Clickup-Api API docs
133+
134+
See the official [Clickup-Api API reference](https://developer.clickup.com/reference).
135+
136+
## Version information
137+
138+
- **Package version:** 0.1.1
139+
- **Connector version:** 0.1.2
140+
- **Generated with Connector SDK commit SHA:** c85ace5313e3ad989630f02e22f036f6a93a8270
141+
- **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/clickup-api/CHANGELOG.md)

0 commit comments

Comments
 (0)