Console API

AI providers

6 endpoints.

GET/api/v1/admin/ai/providers

List AI provider configs

Parameters

Name	In	Type	Description
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_AiProviderData__

Field Type Description

request_idrequired string

success true default true

datarequired

AiProviderData[]

AiProviderData[] fields

Field	Type	Description
`id`required	`string`
`name`required	`string`
`provider`required	`string`
`model`required	`string`
`max_tokens`required	`integer`
`temperature`required	`number`
`cache_enabled`required	`boolean`
`metadata`	`object`
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/ai/providers/{name}

Get AI provider config by name

Parameters

Name	In	Type	Description
`name`required	path	`string`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_AiProviderData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AiProviderData`	AiProviderData fields AiProviderData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

PATCH/api/v1/admin/ai/providers/{name}

Update AI provider config

Partial update keyed by `name`. Cache invalidates immediately for this process; other replicas pick up changes within ~60s.

Parameters

Name	In	Type	Description
`name`required	path	`string`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonAiProviderPatchBody

Field	Type	Description
`provider`	`string \| null`
`model`	`string \| null`
`max_tokens`	`integer \| null`
`temperature`	`number \| null`
`cache_enabled`	`boolean \| null`
`metadata`	`object \| null`

Responses

200Successful Response

application/jsonSuccessResponse_AiProviderData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AiProviderData`	AiProviderData fields AiProviderData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/ai/providers

List AI provider configs

Parameters

Name	In	Type	Description
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_AiProviderData__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AiProviderData[]`	AiProviderData[] fields AiProviderData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/ai/providers/{name}

Get AI provider config by name

Parameters

Name	In	Type	Description
`name`required	path	`string`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_AiProviderData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AiProviderData`	AiProviderData fields AiProviderData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

PATCH/api/v1/ai/providers/{name}

Update AI provider config

Partial update keyed by `name`. Cache invalidates immediately for this process; other replicas pick up changes within ~60s.

Parameters

Name	In	Type	Description
`name`required	path	`string`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonAiProviderPatchBody

AiProviderPatchBody, expanded above.

Responses

200Successful Response

application/jsonSuccessResponse_AiProviderData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AiProviderData`	AiProviderData fields AiProviderData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.