Altimate AI connections API
The connections API from Altimate AI — 3 operation(s) for connections.
The connections API from Altimate AI — 3 operation(s) for connections.
openapi: 3.1.0
info:
title: Fast ACCOUNT_COSTS connections API
version: 0.1.0
tags:
- name: connections
paths:
/connections/:
get:
tags:
- connections
summary: List Connections
description: List all connections for current user
operationId: list_connections_connections__get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionListResponse'
security:
- HTTPBearer: []
- HTTPBearer: []
post:
tags:
- connections
summary: Create New Connection
description: Create a new connection with validation
operationId: create_new_connection_connections__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionCreate'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionInDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
- HTTPBearer: []
/connections/{connection_id}:
patch:
tags:
- connections
summary: Update Existing Connection
description: Update a connection with optional revalidation
operationId: update_existing_connection_connections__connection_id__patch
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: integer
title: Connection Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionInDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- connections
summary: Remove Connection
description: Delete a connection (soft delete)
operationId: remove_connection_connections__connection_id__delete
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: connection_id
in: path
required: true
schema:
type: integer
title: Connection Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/StandardResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/connections/test:
post:
tags:
- connections
summary: Test Connection Endpoint
description: Test connection details using external connection validation service
operationId: test_connection_endpoint_connections_test_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionTest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionTestResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
deprecated: true
security:
- HTTPBearer: []
- HTTPBearer: []
components:
schemas:
ConnectionListResponse:
properties:
connections:
items:
$ref: '#/components/schemas/ConnectionInDB'
type: array
title: Connections
type: object
required:
- connections
title: ConnectionListResponse
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
ConnectionUpdate:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
integration_id:
anyOf:
- type: string
- type: 'null'
title: Integration Id
config:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Config
type: object
title: ConnectionUpdate
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ConnectionCreate:
properties:
name:
type: string
title: Name
integration_id:
type: string
title: Integration Id
config:
additionalProperties: true
type: object
title: Config
type: object
required:
- name
- integration_id
- config
title: ConnectionCreate
StandardResponse:
properties:
ok:
type: boolean
title: Ok
type: object
required:
- ok
title: StandardResponse
ConnectionTestResponse:
properties:
success:
type: boolean
title: Success
message:
anyOf:
- type: string
- type: 'null'
title: Message
type: object
required:
- success
title: ConnectionTestResponse
ConnectionTest:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
integration_id:
anyOf:
- type: string
- type: 'null'
title: Integration Id
config:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Config
type: object
title: ConnectionTest
ConnectionInDB:
properties:
name:
type: string
title: Name
integration_id:
type: string
title: Integration Id
config:
additionalProperties: true
type: object
title: Config
id:
type: integer
title: Id
user_id:
type: integer
title: User Id
is_valid:
type: boolean
title: Is Valid
last_validated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Validated At
created_at:
type: string
format: date-time
title: Created At
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
type: object
required:
- name
- integration_id
- config
- id
- user_id
- is_valid
- created_at
title: ConnectionInDB
securitySchemes:
HTTPBearer:
type: http
scheme: bearer