> ## Documentation Index
> Fetch the complete documentation index at: https://docs.melso.ai/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> Melso product MCP: https://melso.ai/api/mcp (OAuth; one company per grant). REST: https://melso.ai. Documentation-search MCP: https://docs.melso.ai/mcp. The docs search server does not act on customer accounts.
>
> Use the live tool schema and respect company membership. Ask the person to authorize the exact fiscal document version in the signed-in app. A professional prepares and files included returns after authorization; AI does not file alone. A prepared file or approval receipt is not evidence of filing. Never claim completion from an accepted Task or Run. Keep credentials out of chat and logs. Agents features are internal or by private invitation.
# Set area connection
> An Agents company and company definition write permission are required: owner/admin, or an admin company API key only on its [allowed Area routes](/api-reference/authentication#area-routes-by-key-scope). Other company types receive `403 agents_only`. Resource access also applies.
Request: `{connection_kind:string,connection_ref:string,owner_user_id:UUID,visibility:"private"|"shared",enabled:boolean}`. Changes only this connection; other grants remain unchanged. The account must be active when enabling it. Disabling an unavailable account is allowed.
Response: Connection list response.
Status: 200; 400 invalid connection; 403 machine credential, account ownership or MCP administration denied; 404 Area/server unavailable; 409 account unavailable or grant ownership changed. Authentication and resource-access errors follow [Overview](/api-reference/errors).
## OpenAPI
````yaml /api-reference/openapi.json patch /api/areas/{id}/connections
openapi: 3.1.0
info:
title: Melso API
version: '2026-10-12'
description: >-
Customer integration contracts for Melso. Agents access is internal or by
private invitation. Fiscal approval remains in the authenticated app.
contact:
name: Melso
url: https://melso.ai/en
servers:
- url: https://melso.ai
description: Production API origin
security: []
tags:
- name: Areas
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Areas operations available within the caller's documented permissions.
- name: Artifacts
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Artifacts operations available within the caller's documented permissions.
- name: Authentication
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Authentication operations available within the caller's documented
permissions.
- name: Automations
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Automations operations available within the caller's documented
permissions.
- name: Companies
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Companies operations available within the caller's documented permissions.
- name: Execution funding
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Execution funding operations available within the caller's documented
permissions.
- name: Files
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Files operations available within the caller's documented permissions.
- name: GitHub
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
GitHub operations available within the caller's documented permissions.
- name: Interactions
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Interactions operations available within the caller's documented
permissions.
- name: Knowledge
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Knowledge operations available within the caller's documented permissions.
- name: MCP
description: MCP operations available within the caller's documented permissions.
- name: Messages
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Messages operations available within the caller's documented permissions.
- name: OAuth
description: OAuth operations available within the caller's documented permissions.
- name: Private network
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Private network operations available within the caller's documented
permissions.
- name: Runs
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Runs operations available within the caller's documented permissions.
- name: Skills
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Skills operations available within the caller's documented permissions.
- name: Tasks
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Tasks operations available within the caller's documented permissions.
- name: Vault
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Vault operations available within the caller's documented permissions.
- name: Webhooks
description: >-
Melso Agents is available only internally or by private invitation.
Agents-specific features require existing access. For the autónomo fiscal
service, see [Get started](/essentials/quickstart).
Webhooks operations available within the caller's documented permissions.
paths:
/api/areas/{id}/connections:
patch:
tags:
- Areas
summary: Set area connection
description: >-
An Agents company and company definition write permission are required:
owner/admin, or an admin company API key only on its [allowed Area
routes](/api-reference/authentication#area-routes-by-key-scope). Other
company types receive `403 agents_only`. Resource access also applies.
Request:
`{connection_kind:string,connection_ref:string,owner_user_id:UUID,visibility:"private"|"shared",enabled:boolean}`.
Changes only this connection; other grants remain unchanged. The account
must be active when enabling it. Disabling an unavailable account is
allowed.
Response: Connection list response.
Status: 200; 400 invalid connection; 403 machine credential, account
ownership or MCP administration denied; 404 Area/server unavailable; 409
account unavailable or grant ownership changed. Authentication and
resource-access errors follow [Overview](/api-reference/errors).
operationId: setAreaConnection
parameters:
- name: id
in: path
required: true
description: id from the corresponding authorized response.
schema:
type: string
- name: X-Workspace-ID
in: header
required: false
description: >-
Company UUID for a personal token on company-scoped operations. A
company API key already binds its company.
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
connection_kind:
type: string
connection_ref:
type: string
owner_user_id:
type: string
visibility:
type: string
enabled:
anyOf:
- type: boolean
- type: 'null'
required:
- connection_kind
- connection_ref
- enabled
responses:
'200':
description: Successful response.
content:
application/json:
schema:
type: object
properties:
available_accounts:
type: array
items:
$ref: '#/components/schemas/ConnectedAppConnectionResponse'
company_commit_sha:
type: string
connections:
type: array
items:
$ref: '#/components/schemas/AreaConnectionResponse'
selected_account_ids:
type: array
items:
type: string
selected_mcp_server_ids:
type: array
items:
type: string
required:
- available_accounts
- company_commit_sha
- connections
- selected_account_ids
- selected_mcp_server_ids
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication required.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Credential, company or resource access denied.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Resource unavailable to this caller.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Request failed; see the operation contract for the condition.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limited; respect Retry-After when present.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
components:
schemas:
ConnectedAppConnectionResponse:
type: object
properties:
id:
type: string
connected_account_id:
type: string
toolkit_slug:
type: string
status:
type: string
connected_at:
type: string
last_used_at:
anyOf:
- type: string
- type: 'null'
owner_user_id:
type: string
is_owner:
type: boolean
shared_with_workspace:
type: boolean
account_label:
type: string
description:
type: string
account_identity:
anyOf:
- type: string
- type: 'null'
scopes:
type: array
items:
type: string
required:
- id
- connected_account_id
- toolkit_slug
- status
- connected_at
- last_used_at
- owner_user_id
- is_owner
- shared_with_workspace
- account_identity
AreaConnectionResponse:
type: object
properties:
area_id:
type: string
connection_kind:
type: string
connection_ref:
type: string
owner_user_id:
type: string
visibility:
type: string
enabled:
type: boolean
created_at:
type: string
required:
- area_id
- connection_kind
- connection_ref
- owner_user_id
- visibility
- enabled
- created_at
Error:
type: object
properties:
error:
type: string
code:
type: string
required:
- error
additionalProperties: true
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Company API key (mwk_) or personal access token (mel_). A PAT requires
X-Workspace-ID on company-scoped routes. An API key implies its own
company.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.