Skip to main content

Chat

This page is auto-generated from the formations OpenAPI spec. Do not edit manually — run pnpm generate-formations-resource-docs to regenerate.

Creates a chat within the formation's project, connected either to an AI provider or — by declaring no provider — to the project's default_model_route_id.

Syntax​

type: chat
properties:
  ai_provider_id: String
  name: String
  instructions: String
  model: String

Output​

The physical resource ID is the public ID of the created resource. Reference it from other resources with a ref expression:

      some_field:
        ref: MyChat

Properties​

ai_provider_id

Public ID of the AI provider to use for this chat. Omit (or declare null) to inherit the project's default_model_route_id, which requires the project to have one and cannot be combined with model.

Required: No Type: String Nullable: Yes

name

Human-readable label for the chat

Required: No Type: String Nullable: Yes

instructions

System message to set the assistant behaviour

Required: No Type: String Nullable: Yes

model

Model override; defaults to the AI provider's default model

Required: No Type: String Nullable: Yes