List tuning options per engine and language

GET

/v1/adapters/stt/info/spec

curl --request GET \
  --url https://example.com/v1/adapters/stt/info/spec \
  --header 'Authorization: Bearer <token>'

Which tuning options apply to each engine / language pair: the grammar parameters that alter recognition, the class tokens the engine understands, and the filters applicable to the transcript. Both filters accept a comma-separated set; omitting one means no filter on it.

Authorizations

• bearerAuth

Parameters

Query Parameters

engines

string

Comma-separated engine names.

languages

string

Comma-separated language codes.

limit

integer

<= 500

Page size, max 500 (default 100); a larger value is rejected with 400.

offset

integer

Responses

200

The matching engine / language tuning options.

Media typeapplication/json

object

items

required

Array<object>

object

engine

required

string

language

required

string

specs

required

Array<object>

object

key

required

Which kind of tuning option this entry lists.

string

Allowed values: grammar_parameters class_tokens filters

value

required

grammar_parameters carries objects; class_tokens and filters carry plain strings.

Array

One of:

string

string

object

object

name

required

Parameter key, e.g. “auto_punctuation”.

string

description

required

string

regex

required

Validation pattern for the value; empty when unconstrained.

string

total

required

Total engine / language pairs matching the filters.

integer format: int64

limit

required

Page size applied to this request.

integer

offset

required

Offset applied to this request.

integer

has_more

required

Whether records beyond this page match the query.

boolean

Example

{
  "items": [
    {
      "specs": [
        {
          "key": "grammar_parameters"
        }
      ]
    }
  ]
}

400

Invalid request body or parameters

Media typeapplication/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

Registered machine code — generic ERRxxx by status class (ERR001–ERR020 reserved); entity-prefixed codes (SCN1xx) appear only inside validation details; registry in docs/specifications/error-envelope-design.md, append-only, never renumbered

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

401

Missing or invalid credentials

Media typeapplication/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

Registered machine code — generic ERRxxx by status class (ERR001–ERR020 reserved); entity-prefixed codes (SCN1xx) appear only inside validation details; registry in docs/specifications/error-envelope-design.md, append-only, never renumbered

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

403

Caller has no access

Media typeapplication/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

Registered machine code — generic ERRxxx by status class (ERR001–ERR020 reserved); entity-prefixed codes (SCN1xx) appear only inside validation details; registry in docs/specifications/error-envelope-design.md, append-only, never renumbered

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

500

Internal server error

Media typeapplication/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

Registered machine code — generic ERRxxx by status class (ERR001–ERR020 reserved); entity-prefixed codes (SCN1xx) appear only inside validation details; registry in docs/specifications/error-envelope-design.md, append-only, never renumbered

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}