Create Interaction

POST

/v1/interactions

curl --request POST \
  --url https://router.telem.ai/v1/interactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "user_id": "example", "user_input": {}, "preprocessor_names": [ "example" ], "postprocessor_names": [ "example" ], "metadata": {}, "search": { "tier": "minimalist", "fields": [ "example" ], "providers": { "include": [ "example" ], "exclude": [ "example" ] }, "provider_overrides": { "additionalProperty": {} }, "num_results": 1, "include_raw": false, "include_full_content": false } }'

• Public demo router (see Authentication for credential guidance)

Authorizations

• HTTPBearer

Request Body^required

Media typeapplication/json

InteractionRequest

object

session_id

Any of:

string

string format: uuid

null

null

user_id

Any of:

string

string

null

null

user_input

Any of:

object

object

key

additional properties

any

Array<object>

Array<object>

object

key

additional properties

any

preprocessor_names

Any of:

Array<string>

Array<string>

null

null

postprocessor_names

Any of:

Array<string>

Array<string>

null

null

metadata

Metadata

object

key

additional properties

any

search

Any of:

SearchOptions

SearchOptions

object

tier

Any of:

string

string

Allowed values: minimalist default extended max

null

null

fields

Any of:

Array<string>

Array<string>

null

null

providers

Any of:

SearchProvidersFilter

SearchProvidersFilter

object

include

Any of:

Array<string>

Array<string>

null

null

exclude

Any of:

Array<string>

Array<string>

null

null

null

null

provider_overrides

Any of:

object

object

key

additional properties

object

key

additional properties

any

null

null

num_results

Any of:

integer

integer

>= 1 <= 20

null

null

include_raw

Include Raw

boolean

include_full_content

Include Full Content

boolean

null

null

Responses

200

Successful Response

Media typeapplication/json

InteractionResponse

object

instance_id

required

Instance Id

string

session_id

required

Session Id

string format: uuid

interaction_id

required

Interaction Id

string format: uuid

trajectory_id

Any of:

string

string format: uuid

null

null

parent_trajectory_id

Any of:

string

string format: uuid

null

null

trajectory_goal

Any of:

string

string

null

null

status

required

Status

string

preprocessor_runs

required

Preprocessor Runs

Array<object>

PreprocessorRunResult

object

id

Any of:

string

string format: uuid

null

null

preprocessor_name

required

Preprocessor Name

string

status

required

Status

string

batch_index

Batch Index

integer

0

query

Query

string

""

request_payload

required

Request Payload

object

key

additional properties

any

output_payload

Any of:

object

object

key

additional properties

any

null

null

raw_payload

Any of:

object

object

key

additional properties

any

null

null

error

Any of:

object

object

key

additional properties

any

null

null

latency_ms

Any of:

integer

integer

null

null

postprocessor_runs

required

Postprocessor Runs

Array<object>

PostprocessorRunResult

object

id

Any of:

string

string format: uuid

null

null

postprocessor_name

required

Postprocessor Name

string

status

required

Status

string

batch_index

Batch Index

integer

0

query

Query

string

""

preprocessor_run_ids

Preprocessor Run Ids

Array<string>

output_payload

required

Output Payload

object

key

additional properties

any

error

Any of:

object

object

key

additional properties

any

null

null

latency_ms

Any of:

integer

integer

null

null

created_at

required

Created At

string format: date-time

completed_at

Any of:

string

string format: date-time

null

null

normalized_schema_version

Any of:

integer

integer

null

null

Example

{
  "preprocessor_runs": [
    {
      "batch_index": 0,
      "query": ""
    }
  ],
  "postprocessor_runs": [
    {
      "batch_index": 0,
      "query": ""
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}