Send a message to the AI assistant for a project

POST

/v1/projects/{projectId}/ai/chat

Sends a message to the AI assistant in the context of the specified project. The assistant can answer questions about the project’s services, messaging topics, and their relationships. An optional conversation history can be provided to maintain context.

Authorizations

• SessionAuth
• ApiKeyAuth

Parameters

Path Parameters

projectId

required

An identifier (e.g., my-project-a1b2c)

string

>= 8 characters <= 60 characters /^[a-z0-9][a-z0-9-]*[a-z0-9]$/

Request Body ^required

object

messages

required

The full conversation history including the latest user message

Array<object>

object

role

required

The role of the message author (e.g. “user” or “assistant”)

string

content

required

The message content

string

Responses

200

The AI assistant response

object

message

required

object

role

required

The role of the message author (e.g. “user” or “assistant”)

string

content

required

The message content

string

401

Unauthorized, authentication required

Standard error response

object

status

required

HTTP status code

integer

Example

400

code

required

Machine-readable error code in snake_case

string

Allowed values: bad_request unauthorized payment_required forbidden not_found conflict rate_limited internal_error project_not_found project_limit_reached service_not_found service_name_conflict subscription_not_found customer_not_found insufficient_ai_credits invalid_billing_cycle validation_failed resource_already_exists public_share_token_not_found

message

required

Error message

string

Example

Validation failed

details

Additional error details

string

Example

Project name must be between 3 and 60 characters

404

Project not found

Standard error response

object

status

required

HTTP status code

integer

Example

400

code

required

Machine-readable error code in snake_case

string

Allowed values: bad_request unauthorized payment_required forbidden not_found conflict rate_limited internal_error project_not_found project_limit_reached service_not_found service_name_conflict subscription_not_found customer_not_found insufficient_ai_credits invalid_billing_cycle validation_failed resource_already_exists public_share_token_not_found

message

required

Error message

string

Example

Validation failed

details

Additional error details

string

Example

Project name must be between 3 and 60 characters

429

Too many requests

Rate limit exceeded error response

object

status

required

HTTP status code

integer

Example

429

code

required

Machine-readable error code in snake_case

string

Allowed values: bad_request unauthorized payment_required forbidden not_found conflict rate_limited internal_error project_not_found project_limit_reached service_not_found service_name_conflict subscription_not_found customer_not_found insufficient_ai_credits invalid_billing_cycle validation_failed resource_already_exists public_share_token_not_found

message

required

Error message

string

Example

Too many requests

retryAfter

required

Number of seconds until the client can retry

integer

Example

60

Headers

Retry-After

integer

Number of seconds to wait before retrying

500

Internal server error

Standard error response

object

status

required

HTTP status code

integer

Example

400

code

required

Machine-readable error code in snake_case

string

Allowed values: bad_request unauthorized payment_required forbidden not_found conflict rate_limited internal_error project_not_found project_limit_reached service_not_found service_name_conflict subscription_not_found customer_not_found insufficient_ai_credits invalid_billing_cycle validation_failed resource_already_exists public_share_token_not_found

message

required

Error message

string

Example

Validation failed

details

Additional error details

string

Example

Project name must be between 3 and 60 characters