Create product

Create a new product. Key values must give one value for each attribute of the key in force: the product key when the body sends one, else the key of the organization. A MEMBER creates a product only when one of its user groups grants all products and allows product.create. See Products.

POST /products

Create product

cURL

curl --request POST \
  --url https://api.galtea.ai/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Sample Product",
  "description": "Sample product description",
  "organizationId": "org_123",
  "userGroupIds": [
    "ug_123"
  ],
  "riskLevel": "HIGH",
  "operatorType": "PROVIDER",
  "interactionMode": "CONVERSATIONAL",
  "primaryTask": "QUESTION_ANSWERING_RAG",
  "capabilities": "Can process and analyze data",
  "inabilities": "Cannot process sensitive financial data",
  "policies": "Must comply with data protection regulations",
  "otelInputSourceRule": {
    "spanName": "ExecuteActivity:add_user_message",
    "attribute": "app.arguments",
    "path": "$[0].message.content",
    "predicate": {
      "path": "$[0].message.role",
      "equals": "user"
    }
  },
  "otelOutputSourceRule": {
    "spanName": "ExecuteActivity:save_reply",
    "attribute": "app.arguments",
    "path": "$[0].message.content",
    "predicate": {
      "path": "$[0].message.role",
      "equals": "assistant"
    }
  },
  "autoCloseScope": "ALL",
  "autoCloseInactivityMinutes": 30,
  "closedSessionInferenceCreationPolicy": "REOPEN_AND_REEVALUATE",
  "tags": [
    "internal",
    "beta"
  ],
  "otelProductKey": [
    "service.namespace",
    "service.name"
  ],
  "otelProductKeyValues": {
    "service.namespace": "robot2",
    "service.name": "plan-de-cuenta"
  },
  "otelVersionAttributes": [
    "service.version",
    "app.prompt.version"
  ]
}
'

201

{
  "id": "prod_123",
  "organizationId": "org_123",
  "userId": "user_123",
  "name": "Sample Product",
  "description": "Sample product description",
  "riskLevel": "HIGH",
  "operatorType": "PROVIDER",
  "interactionMode": "CONVERSATIONAL",
  "primaryTask": "QUESTION_ANSWERING_RAG",
  "capabilities": "Can process and analyze data",
  "inabilities": "Cannot process sensitive financial data",
  "policies": "Must comply with data protection regulations",
  "otelInputSourceRule": {
    "spanName": "ExecuteActivity:add_user_message",
    "attribute": "app.arguments",
    "path": "$[0].message.content",
    "predicate": {
      "path": "$[0].message.role",
      "equals": "user"
    }
  },
  "otelOutputSourceRule": {
    "spanName": "ExecuteActivity:save_reply",
    "attribute": "app.arguments",
    "path": "$[0].message.content",
    "predicate": {
      "path": "$[0].message.role",
      "equals": "assistant"
    }
  },
  "autoCloseScope": "ALL",
  "autoCloseInactivityMinutes": 30,
  "closedSessionInferenceCreationPolicy": "REOPEN_AND_REEVALUATE",
  "tags": [
    "internal",
    "beta"
  ],
  "otelProductKey": [
    "service.namespace",
    "service.name"
  ],
  "otelProductKeyValues": {
    "service.namespace": "robot2",
    "service.name": "plan-de-cuenta"
  },
  "otelVersionAttributes": [
    "service.version",
    "app.prompt.version"
  ],
  "source": "banking",
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Headers

Prefer · string

Send return=minimal to get no body back from a write and skip reading the resource: a create answers 201 with only Location, and an update answers 204.

Example:

"return=minimal"

Body

application/json

name · string · required

Example:

"Sample Product"

description · string · required

Example:

"Sample product description"

organizationId · string | null

The organization the product belongs to. Omit it or send null for the organization of the caller.

Example:

"org_123"

userGroupIds · string[]

User groups of the product organization that the new product is linked to, which grants it to their members. The caller must be allowed to update each group.

Maximum array length: 100

Minimum string length: 1

Example:

["ug_123"]

riskLevel · enum<string> | null

EU AI Act risk classification. PROHIBITED: banned AI use cases. GPAI: general-purpose AI. GPAI_SYSTEMIC: GPAI with systemic risk. HIGH: high-risk AI system. SPECIAL_SYSTEM: special-category system.

Available options: PROHIBITED, GPAI, GPAI_SYSTEMIC, HIGH, SPECIAL_SYSTEM, null

Example:

"HIGH"

operatorType · enum<string> | null

EU AI Act operator role classification.

Available options: AUTHORISED_REPRESENTATIVE, DEPLOYER, DISTRIBUTER, IMPORTER, PRODUCT_MANUFACTURER, PROVIDER, null

Example:

"PROVIDER"

interactionMode · enum<string> | null

Who consumes the product's output. CONVERSATIONAL: a person exchanges several turns with it. HUMAN_DIRECT: a person reads the output directly, with no dialogue. PROGRAMMATIC: another system consumes it and no person reads it directly. The onboarding AI suggests a value; the owner can change or clear it. Null means unclassified.

Available options: CONVERSATIONAL, HUMAN_DIRECT, PROGRAMMATIC, null

Example:

"CONVERSATIONAL"

primaryTask · enum<string> | null

The one dominant task the product performs on its input. The onboarding AI suggests a value; the owner can change or clear it. Null means unclassified.

Available options: CONVERSATIONAL_ASSISTANCE, QUESTION_ANSWERING_RAG, DOCUMENT_EXTRACTION, DOCUMENT_GENERATION, SUMMARIZATION, CLASSIFICATION, TRANSLATION, CORRECTION, AGENTIC_WORKFLOW, OTHER, null

Example:

"QUESTION_ANSWERING_RAG"

capabilities · string | null

Example:

"Can process and analyze data"

inabilities · string | null

Example:

"Cannot process sensitive financial data"

policies · string | null

Example:

"Must comply with data protection regulations"

otelInputSourceRule · object | null

Recover a turn's user-visible input for products whose user message lives on a non-LLM span. Set per organization, product or version. The version rule wins, then the product rule. Per span it applies only when no LLM input is present. Per turn the value it extracts IS the turn input, ahead of every fallback, and the turn input is EMPTY when the rule extracts nothing from any span of the turn. The two directions resolve independently. Null uses the rule of the organization.

Show child attributes

Example:

{
  "spanName": "ExecuteActivity:add_user_message",
  "attribute": "app.arguments",
  "path": "$[0].message.content",
  "predicate": {
    "path": "$[0].message.role",
    "equals": "user"
  }
}

otelOutputSourceRule · object | null

Recover a turn's user-visible output for templated or non-LLM replies whose final answer lives on a non-LLM span. Set per organization, product or version. The version rule wins, then the product rule. Per span it applies only when no LLM output is present. Per turn the value it extracts IS the turn output, ahead of every fallback, and the turn output is EMPTY when the rule extracts nothing from any span of the turn. The two directions resolve independently. Null uses the rule of the organization.

Show child attributes

Example:

{
  "spanName": "ExecuteActivity:save_reply",
  "attribute": "app.arguments",
  "path": "$[0].message.content",
  "predicate": {
    "path": "$[0].message.role",
    "equals": "assistant"
  }
}

autoCloseScope · enum<string> · default: ALL

Which sessions the product-level auto-close sweep considers. ALL (default) closes both production and development sessions; PRODUCTION only production sessions; DEVELOPMENT only development (test) sessions; NONE disables auto-close.

Available options: NONE, DEVELOPMENT, PRODUCTION, ALL

Example:

"ALL"

autoCloseInactivityMinutes · integer · default: 30

Minutes of inactivity after which an eligible session is auto-closed.

Required range: x >= 1

Example:

30

closedSessionInferenceCreationPolicy · enum<string> · default: REOPEN_AND_REEVALUATE

What happens when a new trace is created for an already-closed session. REOPEN_AND_REEVALUATE (the default) stores the trace, returns the session to PENDING and marks its existing monitor evaluations OUTDATED so a monitor scores the session again once it closes for good. A development session reopens the same way, without monitor evaluations to outdate. IGNORE drops the trace silently. REJECT returns an error.

Available options: REJECT, IGNORE, REOPEN_AND_REEVALUATE

Example:

"REOPEN_AND_REEVALUATE"

tags · string[]

Free-form labels for organizing products. Normalized to lowercase and trimmed on save.

Example:

["internal", "beta"]

otelProductKey · string[] | null

This product's own key, 1 to 10 resource attribute names. Null makes the product follow the key of its organization, including every later change of it.

Example:

["service.namespace", "service.name"]

otelProductKeyValues · object | null

One value for each attribute of the key in force, as a map of attribute name to text. A trace resource with no galtea.version.id and no galtea.product.id that carries these values on its resource attributes is routed to this product. Its facts come from its galtea.version.fact.* attributes, else from the version attributes in force. A resource must carry every attribute of the key to match. The values must be unique among the live products of the organization, or the request answers 409. Null clears them.

Show child attributes

Example:

{
  "service.namespace": "robot2",
  "service.name": "plan-de-cuenta"
}

otelVersionAttributes · string[] | null

This product's own list of the resource attributes whose values make up a version, 1 to 32 names. Each fact keeps the attribute name as its key. A name cannot start with "galtea." or be "customer.id". Null makes the product follow the list of its organization, including every later change of it. An empty list is refused.

Example:

["service.version", "app.prompt.version"]

Response

201

application/json

Product created successfully. On Prefer: return=minimal, or when the read after the write fails, the answer has no body.

id · string

Example:

"prod_123"

organizationId · string

Example:

"org_123"

userId · string | null

Example:

"user_123"

name · string

Example:

"Sample Product"

description · string

Example:

"Sample product description"

riskLevel · enum<string> | null

EU AI Act risk classification. PROHIBITED: banned AI use cases. GPAI: general-purpose AI. GPAI_SYSTEMIC: GPAI with systemic risk. HIGH: high-risk AI system. SPECIAL_SYSTEM: special-category system.

Available options: PROHIBITED, GPAI, GPAI_SYSTEMIC, HIGH, SPECIAL_SYSTEM, null

Example:

"HIGH"

operatorType · enum<string> | null

EU AI Act operator role classification.

Available options: AUTHORISED_REPRESENTATIVE, DEPLOYER, DISTRIBUTER, IMPORTER, PRODUCT_MANUFACTURER, PROVIDER, null

Example:

"PROVIDER"

interactionMode · enum<string> | null

Who consumes the product's output. CONVERSATIONAL: a person exchanges several turns with it. HUMAN_DIRECT: a person reads the output directly, with no dialogue. PROGRAMMATIC: another system consumes it and no person reads it directly. The onboarding AI suggests a value; the owner can change or clear it. Null means unclassified.

Available options: CONVERSATIONAL, HUMAN_DIRECT, PROGRAMMATIC, null

Example:

"CONVERSATIONAL"

primaryTask · enum<string> | null

The one dominant task the product performs on its input. The onboarding AI suggests a value; the owner can change or clear it. Null means unclassified.

Available options: CONVERSATIONAL_ASSISTANCE, QUESTION_ANSWERING_RAG, DOCUMENT_EXTRACTION, DOCUMENT_GENERATION, SUMMARIZATION, CLASSIFICATION, TRANSLATION, CORRECTION, AGENTIC_WORKFLOW, OTHER, null

Example:

"QUESTION_ANSWERING_RAG"

capabilities · string | null

Example:

"Can process and analyze data"

inabilities · string | null

Example:

"Cannot process sensitive financial data"

policies · string | null

Example:

"Must comply with data protection regulations"

otelInputSourceRule · object | null

Recover a turn's user-visible input for products whose user message lives on a non-LLM span. Set per organization, product or version. The version rule wins, then the product rule. Per span it applies only when no LLM input is present. Per turn the value it extracts IS the turn input, ahead of every fallback, and the turn input is EMPTY when the rule extracts nothing from any span of the turn. The two directions resolve independently. Null uses the rule of the organization.

Show child attributes

Example:

{
  "spanName": "ExecuteActivity:add_user_message",
  "attribute": "app.arguments",
  "path": "$[0].message.content",
  "predicate": {
    "path": "$[0].message.role",
    "equals": "user"
  }
}

otelOutputSourceRule · object | null

Recover a turn's user-visible output for templated or non-LLM replies whose final answer lives on a non-LLM span. Set per organization, product or version. The version rule wins, then the product rule. Per span it applies only when no LLM output is present. Per turn the value it extracts IS the turn output, ahead of every fallback, and the turn output is EMPTY when the rule extracts nothing from any span of the turn. The two directions resolve independently. Null uses the rule of the organization.

Show child attributes

Example:

{
  "spanName": "ExecuteActivity:save_reply",
  "attribute": "app.arguments",
  "path": "$[0].message.content",
  "predicate": {
    "path": "$[0].message.role",
    "equals": "assistant"
  }
}

autoCloseScope · enum<string> · default: ALL

Which sessions the product-level auto-close sweep considers. ALL (default) closes both production and development sessions; PRODUCTION only production sessions; DEVELOPMENT only development (test) sessions; NONE disables auto-close.

Available options: NONE, DEVELOPMENT, PRODUCTION, ALL

Example:

"ALL"

autoCloseInactivityMinutes · integer · default: 30

Minutes of inactivity after which an eligible session is auto-closed.

Required range: x >= 1

Example:

30

closedSessionInferenceCreationPolicy · enum<string> · default: REOPEN_AND_REEVALUATE

What happens when a new trace is created for an already-closed session. REOPEN_AND_REEVALUATE (the default) stores the trace, returns the session to PENDING and marks its existing monitor evaluations OUTDATED so a monitor scores the session again once it closes for good. A development session reopens the same way, without monitor evaluations to outdate. IGNORE drops the trace silently. REJECT returns an error.

Available options: REJECT, IGNORE, REOPEN_AND_REEVALUATE

Example:

"REOPEN_AND_REEVALUATE"

tags · string[]

Free-form labels for organizing products. Normalized to lowercase and trimmed on save.

Example:

["internal", "beta"]

otelProductKey · string[] | null

This product's own key, 1 to 10 resource attribute names. Null makes the product follow the key of its organization, including every later change of it.

Example:

["service.namespace", "service.name"]

otelProductKeyValues · object | null

One value for each attribute of the key in force, as a map of attribute name to text. A trace resource with no galtea.version.id and no galtea.product.id that carries these values on its resource attributes is routed to this product. Its facts come from its galtea.version.fact.* attributes, else from the version attributes in force. A resource must carry every attribute of the key to match. The values must be unique among the live products of the organization, or the request answers 409. Null clears them.

Show child attributes

Example:

{
  "service.namespace": "robot2",
  "service.name": "plan-de-cuenta"
}

otelVersionAttributes · string[] | null

This product's own list of the resource attributes whose values make up a version, 1 to 32 names. Each fact keeps the attribute name as its key. A name cannot start with "galtea." or be "customer.id". Null makes the product follow the list of its organization, including every later change of it. An empty list is refused.

Example:

["service.version", "app.prompt.version"]

source · string | null · read-only

Demo key the product was cloned from (e.g. "banking"); null for user-created products. Server-stamped on demo-clone; not client-writable.

Example:

"banking"

createdAt · string<date-time>

deletedAt · string<date-time> | null