---
title: "Create a connector"
method: POST
path: "/v1/messaging/accounts/{accountId}/business-agent/connectors"
tags: ["Business Agent"]
---

# Create a connector

`POST /v1/messaging/accounts/{accountId}/business-agent/connectors`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/accounts/{accountId}/business-agent/connectors`
- Auth: HTTP bearer

Base URL plus how to authenticate (OAuth client credentials, API key or none). Names are unique per number. Not idempotent.

**Billing:** Request; paid actions are priced in credits (see GET /v1/messaging/prices) · **Rate limit:** 60/min

## Path parameters

- `accountId` string, required: WhatsApp social account id (the number must be managed through the Cloud API).

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Request body

- object
  - `name` string, required: Unique per number.
  - `base_url` string, uri, required: Public HTTPS URL reachable from Meta.
  - `auth_type` 'OAUTH2_CLIENT_CREDENTIALS' | 'API_KEY' | 'NONE', required
  - `auth_config` object
    - `api_key` object: Where the connector injects the API key on each call.
      - `headers` object[]
        - `value` string, required
        - `prefix` string
        - `field_name` string, required
      - `body_params` object[]
        - `value` string, required
        - `prefix` string
        - `field_name` string, required
      - `query_params` object[]
        - `value` string, required
        - `prefix` string
        - `field_name` string, required
    - `oauth2_client_credentials` object
      - `client_id` string, required
      - `token_url` string, uri, required
      - `client_secret` string, required
      - `scopes_to_request` string[]
      - `token_request_content_type` string
  - `description` string: Tell the agent what the service provides.
  - `connector_protocol` string
  - `requires_certificate` boolean
  - `user_auth_injection_config` object
    - `prefix` string
    - `location` string, required
    - `field_name` string, required

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
    - `name` string, required: Unique per number.
    - `base_url` string, uri, required: Public HTTPS URL reachable from Meta.
    - `auth_type` 'OAUTH2_CLIENT_CREDENTIALS' | 'API_KEY' | 'NONE', required
    - `auth_config` object
      - `api_key` object: Where the connector injects the API key on each call.
        - `headers` object[]
          - `value` string, required
          - `prefix` string
          - `field_name` string, required
        - `body_params` object[]
          - `value` string, required
          - `prefix` string
          - `field_name` string, required
        - `query_params` object[]
          - `value` string, required
          - `prefix` string
          - `field_name` string, required
      - `oauth2_client_credentials` object
        - `client_id` string, required
        - `token_url` string, uri, required
        - `client_secret` string, required
        - `scopes_to_request` string[]
        - `token_request_content_type` string
    - `description` string: Tell the agent what the service provides.
    - `connector_protocol` string
    - `requires_certificate` boolean
    - `user_auth_injection_config` object
      - `prefix` string
      - `location` string, required
      - `field_name` string, required
    - `id` string, required
    - `mtls_config` object
    - `mcp_tool_sync` object
    - `connection_status` object
      - `status` string: ACTIVE, PENDING_OAUTH, EXPIRED or ERROR.
      - `error_message` string
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)