One

https://www.withone.ai/docs
Admin
One is a platform that connects AI agents to 250+ apps with production-ready actions, enabling...
Tokens:100,757
Snippets:565
Trust Score:4.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install MCP CLI

Source: https://www.withone.ai/docs/mcp

Install the One CLI globally and initialize the MCP server configuration. The CLI will guide you through setting up the server for various compatible agents.

```bash
npm install -g @withone/cli
one init
```

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

### Get One CLI Usage Guide

Source: https://www.withone.ai/docs/cli

Retrieve the full CLI usage guide, either for all topics or a specific topic like 'overview', 'actions', or 'flows'. Can also output as structured JSON for AI agents.

```bash
one guide                 # full guide (all topics)
one guide overview        # setup, --agent flag, discovery workflow
one guide actions         # search, knowledge, execute workflow
one guide flows           # multi-step API workflows

one --agent guide         # full guide as structured JSON
one --agent guide flows   # single topic as JSON
```

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

### Install One CLI

Source: https://www.withone.ai/docs/getting-started

Install the One CLI globally using npm. This is the first step to using One.

```bash
npm i -g @withone/cli
```

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

### Install @withone/auth Package

Source: https://www.withone.ai/docs/auth/setup

Install the @withone/auth npm package for your project.

```bash
npm install @withone/auth
```

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

### Install MCP Package

Source: https://www.withone.ai/docs/mcp

Install the @withone/mcp package for manual server configuration. Ensure the ONE_SECRET environment variable is set.

```bash
npm install @withone/mcp
```

```bash
ONE_SECRET=your-one-secret-key
```

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

### Install One CLI

Source: https://www.withone.ai/docs/cli

Install the One CLI globally or using npx. Requires Node.js 18+.

```bash
npx @withone/cli@latest init
```

```bash
npm install -g @withone/cli
one init
```

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

### AI Agent Guide Command

Source: https://www.withone.ai/docs/cli

For AI agents with only the 'one' binary, this command provides the full usage guide as structured JSON, useful for self-bootstrapping.

```bash
one --agent guide
```

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

### Webhook Relay Configuration Response Example

Source: https://www.withone.ai/docs/api-reference/webhook-relay/get_webhook_relay_config

This JSON object represents a successful response containing the webhook relay configuration, including form data for setup.

```json
{
  "formData": [
    {
      "label": "string",
      "name": "string",
      "options": [
        null
      ],
      "placeholder": "string",
      "type": "string"
    }
  ]
}
```

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

### Quick Start: Send an Email with Gmail

Source: https://www.withone.ai/docs/cli

A sequence of commands to connect Gmail, search for the 'send email' action, read its documentation, and execute it.

```bash
# Connect a platform
one add gmail
```

```bash
# See what you're connected to
one list
```

```bash
# Search for actions you can take
one actions search gmail "send email" -t execute
```

```bash
# Read the docs for an action
one actions knowledge gmail <actionId>
```

```bash
# Execute it
one actions execute gmail <actionId> <connectionKey> \
  -d '{"to": "jane@example.com", "subject": "Hello", "body": "Sent from my AI agent"}'
```

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

### Install Auth Skill for AI Agent

Source: https://www.withone.ai/docs/auth

Install the Auth skill for your AI coding agent to automatically set up backend endpoints, frontend components, and connection handling.

```bash
npx skills add withoneai/auth
```

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

### Successful Response Example

Source: https://www.withone.ai/docs/api-reference/webhook-relay/list_relay_events

This is an example of a successful response when listing relay events. It includes pagination details and a list of event rows.

```json
{
  "page": 0,
  "pages": 0,
  "rows": [
    {
      "active": true,
      "changeLog": {},
      "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
      "createdAt": "2019-08-24T14:15:22Z",
      "deleted": true,
      "eventType": "string",
      "headers": null,
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "metadata": null,
      "payload": null,
      "platform": "string",
      "signatureValid": true,
      "tags": [
        "string"
      ],
      "timestamp": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
      "version": "string"
    }
  ],
  "total": 0
}
```

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

### Passthrough Request Example (cURL)

Source: https://www.withone.ai/docs/api-reference/passthrough/passthrough

This example demonstrates how to make a POST request to the passthrough endpoint using cURL. Ensure you replace 'string' with your actual secret token and payload.

```curl
curl -X POST "https://api.withone.ai/v1/passthrough/string" \
  -H "X-One-Secret: " \
  -H "Content-Type: application/octet-stream" \
  -d 'string'
```

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

### Get Action Documentation

Source: https://www.withone.ai/docs/cli

Retrieve detailed documentation for a specific API action, including parameters, validation rules, and request/response formats.

```bash
one actions knowledge shopify 67890abcdef
```

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

### Get Project AI Skill (cURL)

Source: https://www.withone.ai/docs/api-reference/ai-skills/get_project_ai_skill

Use this cURL command to make a GET request to retrieve details of an AI skill for a given project. Ensure you replace placeholder IDs with your actual organization, project, and skill IDs. The `X-One-Secret` header is required for authentication.

```curl
curl -X GET "https://api.withone.ai/v1/ai-skills/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/0" \
  -H "X-One-Secret: "
```

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

### Create Relay Endpoint cURL Example

Source: https://www.withone.ai/docs/api-reference/webhook-relay/create_relay_endpoint

Use this cURL command to create a new relay endpoint. Ensure you replace 'string' with your actual connection key.

```curl
curl -X POST "https://api.withone.ai/v1/webhooks/relay" \
  -H "X-One-Secret: " \
  -H "Content-Type: application/json" \
  -d '{
    "connectionKey": "string"
  }'
```

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

### Initialize One Project

Source: https://www.withone.ai/docs/getting-started

Run the init command to log in and set up your workspace. This command handles account creation or login and workspace configuration.

```bash
one init
```

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

### List Webhook Relay Event Types (C#)

Source: https://www.withone.ai/docs/api-reference/webhook-relay/list_webhook_relay_event_types

An example in C# for fetching the list of supported webhook event types. This snippet uses `HttpClient` to make the GET request to the API.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

public class WebhookEventTypes
{
    public static async Task Main(string[] args)
    {
        using (HttpClient client = new HttpClient())
        {
            string url = "https://api.withone.ai/v1/webhooks/relay/event-types?platform=string";
            client.DefaultRequestHeaders.Add("X-One-Secret", "");

            try
            {
                HttpResponseMessage response = await client.GetAsync(url);
                response.EnsureSuccessStatusCode(); // Throw if status code is not 2xx

                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            }
            catch (HttpRequestException e)
            {
                Console.WriteLine($"Error fetching event types: {e.Message}");
            }
        }
    }
}
```

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

### List Webhook Relay Event Types (Python)

Source: https://www.withone.ai/docs/api-reference/webhook-relay/list_webhook_relay_event_types

A Python example for fetching the list of supported webhook event types. This script utilizes the `requests` library to make the GET request.

```python
import requests

url = "https://api.withone.ai/v1/webhooks/relay/event-types?platform=string"
headers = {
    "X-One-Secret": ""
}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    event_types = response.json()
    print(event_types)
except requests.exceptions.RequestException as e:
    print(f"Error fetching event types: {e}")
```

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

### List Webhook Relay Event Types (JavaScript)

Source: https://www.withone.ai/docs/api-reference/webhook-relay/list_webhook_relay_event_types

Example of how to list supported webhook event types using JavaScript. This snippet demonstrates making a GET request to the API endpoint.

```javascript
fetch("https://api.withone.ai/v1/webhooks/relay/event-types?platform=string", {
  method: "GET",
  headers: {
    "X-One-Secret": ""
  }
})
  .then(response => {
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json();
  })
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.error("Error fetching event types:", error);
  });
```

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

### Add a New Platform Connection

Source: https://www.withone.ai/docs/cli

Connect a new platform to One CLI by initiating the OAuth flow. Platform names should be in kebab-case.

```bash
one add shopify
```

```bash
one add hub-spot
```

```bash
one add gmail
```

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

### Browse Available Platforms

Source: https://www.withone.ai/docs/cli

View all supported platforms, with options to filter by category or output in JSON format for machine readability.

```bash
one platforms              # all platforms
```

```bash
one platforms -c "CRM"     # filter by category
```

```bash
one platforms --json       # machine-readable output
```

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

### One CLI Workflow Overview

Source: https://www.withone.ai/docs/cli

Illustrates the typical interaction pattern with the One CLI for managing platform connections and executing actions.

```bash
one list                    → What am I connected to?
```

```bash
one actions search          → What can I do?
```

```bash
one actions knowledge       → How do I do it?
```

```bash
one actions execute         → Do it.
```

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

### Relay Endpoint Response Example

Source: https://www.withone.ai/docs/api-reference/webhook-relay/list_relay_endpoints

This is an example of a successful response when listing relay endpoints. It includes details about each endpoint's configuration and status.

```json
{
  "page": 0,
  "pages": 0,
  "rows": [
    {
      "actions": [
        {
          "eventFilters": [
            "string"
          ],
          "hasSecret": true,
          "type": "url",
          "url": "string"
        }
      ],
      "active": true,
      "changeLog": {},
      "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
      "createdAt": "2019-08-24T14:15:22Z",
      "deleted": true,
      "description": "string",
      "eventFilters": [
        "string"
      ],
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "metadata": {},
      "tags": [
        "string"
      ],
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
      "version": "string",
      "warning": "string",
      "webhookPayload": {}
    }
  ],
  "total": 0
}
```

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

### Successful Response Body Example

Source: https://www.withone.ai/docs/api-reference/webhook-relay/list_relay_event_deliveries

This is an example of a successful response when listing relay event deliveries. It details each attempt made to deliver the webhook.

```json
[
  {
    "actionIndex": 0,
    "attempt": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "deliveredAt": "2019-08-24T14:15:22Z",
    "endpointId": "c8d2c7e1-e4b1-4108-9e29-3429a36a1ef3",
    "error": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "relayEventId": "d8c58787-3b0f-4f6f-951a-7f9512f2de2e",
    "responseBody": "string",
    "status": "string",
    "statusCode": 0
  }
]
```

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

### List Available Actions

Source: https://www.withone.ai/docs/api-reference/actions/list_actions

Returns a paginated list of all available connectors (platforms) on One. Use query parameters to filter by platform name, category, or key. Each connector includes metadata like supported auth methods, available tools count, and status.

```APIDOC
## GET /v1/available-actions

### Description
Returns a paginated list of all available connectors (platforms) on One. Use query parameters to filter by platform name, category, or key. Each connector includes metadata like supported auth methods, available tools count, and status.

### Method
GET

### Endpoint
/v1/available-actions

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **size** (integer) - Optional - The number of items per page.
- **platformName** (string) - Optional - Filter by platform name.
- **category** (string) - Optional - Filter by platform category.
- **key** (string) - Optional - Filter by platform key.

### Response
#### Success Response (200)
- **page** (integer) - The current page number.
- **pages** (integer) - The total number of pages.
- **rows** (array) - An array of connector objects.
  - **key** (string) - The unique key of the connector.
  - **method** (string) - The HTTP method used by the connector (e.g., OPTIONS, GET, POST).
  - **modelName** (string) - The name of the model associated with the connector.
  - **path** (string) - The API path for the connector.
  - **title** (string) - The display title of the connector.
- **total** (integer) - The total number of connectors available.

### Request Example
```
curl -X GET "https://api.withone.ai/v1/available-actions?platformName=example"
     -H "X-One-Secret: YOUR_API_KEY"
```

### Response Example
```json
{
  "page": 0,
  "pages": 1,
  "rows": [
    {
      "key": "example_connector",
      "method": "GET",
      "modelName": "example_model",
      "path": "/v1/connectors/example",
      "title": "Example Connector"
    }
  ],
  "total": 1
}
```
```

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

### Search Available Actions Response

Source: https://www.withone.ai/docs/api-reference/actions/search_actions

This is an example of a successful response when searching for available actions. It lists actions with their key, knowledge, method, path, system ID, and tags.

```json
[
  {
    "key": "string",
    "knowledge": "string",
    "method": "OPTIONS",
    "path": "string",
    "systemId": "string",
    "tags": [
      "string"
    ],
    "title": "string"
  }
]
```

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

### List Available Connectors Response

Source: https://www.withone.ai/docs/api-reference/actions/list_actions

This is an example of the JSON response when listing available connectors. It includes pagination details and a list of connector objects, each with its key, method, model name, path, and title.

```json
{
  "page": 0,
  "pages": 0,
  "rows": [
    {
      "key": "string",
      "method": "OPTIONS",
      "modelName": "string",
      "path": "string",
      "title": "string"
    }
  ],
  "total": 0
}
```

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

### List available integrations

Source: https://www.withone.ai/docs/auth/management

Lists all integrations that are available to be configured.

```APIDOC
## List available integrations

### Description
Lists all integrations that are available to be configured.

### Method
GET

### Endpoint
`/v1/available-connectors?authkit=true`

### Parameters
#### Query Parameters
- **authkit** (boolean) - Required - Set to `true` to list integrations for the AuthKit.

### Response
#### Success Response (200)
- **integrations** (array) - A list of available integration objects.
```

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

### Successful Response Example

Source: https://www.withone.ai/docs/api-reference/webhook-relay/list_webhook_relay_event_types

This is an example of a successful response when listing webhook relay event types. It returns a JSON array of strings, where each string is a supported event type.

```json
[
  "string"
]
```

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

### Create a Multi-step Workflow

Source: https://www.withone.ai/docs/cli

Define and create a reusable multi-step workflow by providing a JSON definition. This example creates a 'welcome-customer' flow that finds a customer via Stripe and sends an email via Gmail.

```bash
# Create a flow
one flow create welcome-customer --definition '{ 
  "key": "welcome-customer",
  "name": "Welcome New Customer",
  "version": "1",
  "inputs": {
    "stripeKey": { "type": "string", "required": true, "connection": { "platform": "stripe" } },
    "gmailKey": { "type": "string", "required": true, "connection": { "platform": "gmail" } },
    "email": { "type": "string", "required": true }
  },
  "steps": [
    {
      "id": "find", "name": "Find customer", "type": "action",
      "action": { "platform": "stripe", "actionId": "<actionId>", "connectionKey": "$.input.stripeKey",
        "data": { "query": "email:{{$.input.email}}" } }
    },
    {
      "id": "send", "name": "Send email", "type": "action",
      "if": "$.steps.find.response.data.length > 0",
      "action": { "platform": "gmail", "actionId": "<actionId>", "connectionKey": "$.input.gmailKey",
        "data": { "to": "{{$.input.email}}", "subject": "Welcome!", "body": "Thanks for joining." } }
    }
  ] 
}'
```

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

### Explore One CLI Commands

Source: https://www.withone.ai/docs/getting-started

Run the onboard command to discover all available CLI commands, learn how to search for actions, and execute them across connected apps.

```bash
one onboard
```

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

### Get Organization AI Skill (cURL)

Source: https://www.withone.ai/docs/api-reference/ai-skills/get_org_ai_skill

Use this cURL command to make a GET request to retrieve a specific AI skill's details for a given organization. Ensure you replace `{org_id}` and `{id}` with the actual IDs and provide your secret token.

```curl
curl -X GET "https://api.withone.ai/v1/ai-skills/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/0" \
  -H "X-One-Secret: "
```

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

### Get Organization Webhook Subscription

Source: https://www.withone.ai/docs/api-reference/webhook-subscriptions/get_org_webhook_subscription

Returns details for a single webhook subscription.

```APIDOC
## Get Org Webhook Subscription

### Description
Returns details for a single webhook subscription.

### Method
GET

### Endpoint
`/v1/webhooks/subscriptions/organizations/{org_id}/{id}`

### Parameters
#### Header Parameters
- **X-One-Secret** (string) - Required - The secret token for authentication.

#### Path Parameters
- **org_id** (string) - Required - Organization ID (Format: uuid)
- **id** (string) - Required - Subscription ID (Format: uuid)

### Response
#### Success Response (200)
- **active** (boolean) - Indicates if the subscription is active.
- **changeLog** (object) - Contains information about changes.
- **createdAt** (string) - The timestamp when the subscription was created.
- **deleted** (boolean) - Indicates if the subscription is deleted.
- **description** (string) - A description of the subscription.
- **events** (array) - A list of events the subscription is configured for.
- **id** (string) - The unique identifier of the subscription.
- **metadata** (object) - Additional metadata for the subscription.
- **organizationId** (string) - The ID of the organization the subscription belongs to.
- **projectId** (string) - The ID of the project the subscription belongs to.
- **tags** (array) - Tags associated with the subscription.
- **updatedAt** (string) - The timestamp when the subscription was last updated.
- **url** (string) - The URL to which webhook events will be sent.
- **userId** (string) - The ID of the user who created the subscription.
- **version** (string) - The version of the webhook subscription.

### Request Example
```json
{
  "active": true,
  "changeLog": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "deleted": true,
  "description": "string",
  "events": [
    "string"
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata": {},
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "tags": [
    "string"
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "url": "string",
  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  "version": "string"
}
```

### Error Responses
- **400 Bad Request**: Returned when the request is malformed.
- **401 Unauthorized**: Returned when the request lacks valid authentication credentials.
- **404 Not Found**: Returned when the specified organization or subscription does not exist.
- **500 Internal Server Error**: Returned when an unexpected error occurs on the server.
```

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

### Add Gmail Integration

Source: https://www.withone.ai/docs/getting-started

Add Gmail as your first integration. This action will open a browser for Google account authorization.

```bash
one add gmail
```

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

### Get Relay Endpoint

Source: https://www.withone.ai/docs/api-reference/webhook-relay/get_relay_endpoint

Fetches the details of a single relay endpoint by its unique ID.

```APIDOC
## GET /v1/webhooks/relay/{id}

### Description
Returns details for a single relay endpoint.

### Method
GET

### Endpoint
`/v1/webhooks/relay/{id}`

### Parameters
#### Header Parameters
- **X-One-Secret** (string) - Required - The secret token for authentication.

#### Path Parameters
- **id** (string) - Required - The unique identifier (UUID) of the relay endpoint.

### Response
#### Success Response (200)
- **actions** (array) - List of actions associated with the relay endpoint.
  - **eventFilters** (array) - Filters for events.
  - **hasSecret** (boolean) - Indicates if the action has a secret.
  - **type** (string) - Type of the action (e.g., 'url').
  - **url** (string) - The URL for the action.
- **active** (boolean) - Indicates if the relay endpoint is active.
- **changeLog** (object) - Contains information about changes.
- **connectionId** (string) - The ID of the connection.
- **createdAt** (string) - The timestamp when the relay endpoint was created.
- **deleted** (boolean) - Indicates if the relay endpoint is deleted.
- **description** (string) - A description of the relay endpoint.
- **eventFilters** (array) - Filters for events at the endpoint level.
- **id** (string) - The unique identifier of the relay endpoint.
- **metadata** (object) - Additional metadata.
- **tags** (array) - Tags associated with the relay endpoint.
- **updatedAt** (string) - The timestamp when the relay endpoint was last updated.
- **url** (string) - The URL of the relay endpoint.
- **userId** (string) - The ID of the user who owns the relay endpoint.
- **version** (string) - The version of the relay endpoint configuration.
- **warning** (string) - Any warnings associated with the relay endpoint.
- **webhookPayload** (object) - The webhook payload.

### Request Example
```json
{
  "example": "request body"
}
```

### Response Example
```json
{
  "actions": [
    {
      "eventFilters": [
        "string"
      ],
      "hasSecret": true,
      "type": "url",
      "url": "string"
    }
  ],
  "active": true,
  "changeLog": {},
  "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
  "createdAt": "2019-08-24T14:15:22Z",
  "deleted": true,
  "description": "string",
  "eventFilters": [
    "string"
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata": {},
  "tags": [
    "string"
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "url": "string",
  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  "version": "string",
  "warning": "string",
  "webhookPayload": {}
}
```
```

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

### Execute One Action with Query Parameters

Source: https://www.withone.ai/docs/cli

Execute a specific action using its ID and connection key, with custom query parameters. Useful for filtering or specifying results.

```bash
one actions execute stripe <actionId> <connectionKey> \
  --query-params '{"limit": "10"}'
```

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

### Get Project Webhook Subscription

Source: https://www.withone.ai/docs/api-reference/webhook-subscriptions/get_project_webhook_subscription

Returns details for a webhook subscription scoped to a specific project.

```APIDOC
## GET /v1/webhooks/subscriptions/organizations/{org_id}/projects/{project_id}/{id}

### Description
Returns details for a webhook subscription scoped to a specific project.

### Method
GET

### Endpoint
`/v1/webhooks/subscriptions/organizations/{org_id}/projects/{project_id}/{id}`

### Authorization
- **X-One-Secret**: `<token>` (In: header)

### Path Parameters
- **org_id** (string) - Required - Organization ID (Format: uuid)
- **project_id** (string) - Required - Project ID (Format: uuid)
- **id** (string) - Required - Subscription ID (Format: uuid)

### Response
#### Success Response (200)
- **active** (boolean) - Indicates if the subscription is active.
- **changeLog** (object) - Contains information about changes to the subscription.
- **createdAt** (string) - The timestamp when the subscription was created (ISO 8601 format).
- **deleted** (boolean) - Indicates if the subscription has been deleted.
- **description** (string) - A description of the webhook subscription.
- **events** (array) - A list of event types the subscription is configured to receive.
- **id** (string) - The unique identifier for the webhook subscription (uuid).
- **metadata** (object) - Additional metadata associated with the subscription.
- **organizationId** (string) - The ID of the organization the subscription belongs to (uuid).
- **projectId** (string) - The ID of the project the subscription belongs to (uuid).
- **tags** (array) - Tags associated with the subscription.
- **updatedAt** (string) - The timestamp when the subscription was last updated (ISO 8601 format).
- **url** (string) - The URL to which webhook events will be sent.
- **userId** (string) - The ID of the user who created the subscription (uuid).
- **version** (string) - The version of the webhook subscription.

### Request Example
```json
{
  "active": true,
  "changeLog": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "deleted": true,
  "description": "string",
  "events": [
    "string"
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata": {},
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "tags": [
    "string"
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "url": "string",
  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  "version": "string"
}
```

### Error Handling
#### 400 Bad Request
```json
{
  "code": 2001,
  "correlationId": "550e8400-e29b-41d4-a716-446655440000",
  "key": "http_error",
  "message": "Authentication required",
  "status": 401,
  "type": "http_error"
}
```

#### 401 Unauthorized
```json
{
  "code": 2001,
  "correlationId": "550e8400-e29b-41d4-a716-446655440000",
  "key": "http_error",
  "message": "Authentication required",
  "status": 401,
  "type": "http_error"
}
```

(Note: Other error codes like 402, 403, 404, 405, 408, 409, 422, 423, 429, 500, 501, 502, 503 may also be returned depending on the specific error scenario.)
```

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

### List Available Connectors (cURL)

Source: https://www.withone.ai/docs/api-reference/actions/list_actions

Use this endpoint to retrieve a paginated list of all available connectors. You can filter by platform name, category, or key. Each connector object contains metadata such as supported authentication methods and the count of available tools.

```curl
curl -X GET "https://api.withone.ai/v1/available-actions/string" \  -H "X-One-Secret: "
```

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

### Get Webhook Relay Configuration

Source: https://www.withone.ai/docs/api-reference/webhook-relay/get_webhook_relay_config

Fetches the webhook relay configuration for a specific connection definition.

```APIDOC
## GET /v1/webhooks/relay/config/{conn_def_id}

### Description
Returns the webhook relay configuration for a specific connection definition, including supported events and setup instructions.

### Method
GET

### Endpoint
`/v1/webhooks/relay/config/{conn_def_id}`

### Parameters
#### Path Parameters
- **conn_def_id** (integer) - Required - Connection definition ID

#### Headers
- **X-One-Secret** (string) - Required - Your secret token for authentication

### Response
#### Success Response (200)
- **formData** (array) - An array of form data objects, each containing details for configuring the relay.
  - **label** (string) - The label for the form field.
  - **name** (string) - The name of the form field.
  - **options** (array) - Optional list of options for the field (can be null).
  - **placeholder** (string) - Placeholder text for the input field.
  - **type** (string) - The type of the form field (e.g., 'text', 'select').

#### Error Response (401)
- **code** (integer) - Error code.
- **correlationId** (string) - Unique identifier for the request.
- **key** (string) - Error key.
- **message** (string) - Error message.
- **status** (integer) - HTTP status code.
- **type** (string) - Error type.
```

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

### Run MCP Server with Docker

Source: https://www.withone.ai/docs/mcp

Build a Docker image for the One MCP server and run it as a container. The ONE_SECRET environment variable must be provided during runtime.

```bash
docker build -t one-mcp-server .
docker run -e ONE_SECRET=your_one_secret_key one-mcp-server
```
Tokens:
Raw