trickroom / Docs
Sign in
API reference/assistants

Create an assistant candidate version

Application-scoped assistant control plane. External pipelines, dataset ingestion, and training run in the builder's infrastructure. Eval suites run fixture tool-mode jobs or disposable offline Linux desktops through Temporal. Metrics/artifacts are externally reported; reference URLs are never fetched. Model credentials are write-only. Pull subscriptions replay unacknowledged events. Resource lists return up to 200 recent records; trigger lists return an ID next_cursor for after, and message and delivery feeds use sequence cursors.

POST/v1/applications/{id}/assistants/{assistantId}/versions

Authorization

Authorizationstringrequired

Bearer tak_… — an application API key. Keep it on your backend; all resources are scoped to that application.

Create an application key →

Path parameters

idstringrequired

Min length: 1

assistantIdstringrequired

Min length: 1

Body application/json

definitionobjectrequired
Object fields
instructionsstringrequired

Min length: 1 · Max length: 12000

model_version_idstring | null

Default: null

modelstring | null

Default: null

reasoning_effortstring

Allowed: "none""minimal""low""medium""high""xhigh""max"

max_output_tokensinteger

Minimum: 1 · Maximum: 128000

execution_modestring

Allowed: "tools""computer"

Default: "tools"

web_accessboolean

Default: false

connections"user"

Response

201Create an assistant candidate version
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

idstringrequired

Min length: 1

created_atstringrequired

Format: date-time · Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

assistant_idstringrequired

Min length: 1

definition_jsonobjectrequired
Object fields
instructionsstringrequired

Min length: 1 · Max length: 12000

model_version_idstring | null

Default: null

modelstring | null

Default: null

reasoning_effortstring

Allowed: "none""minimal""low""medium""high""xhigh""max"

max_output_tokensinteger

Minimum: 1 · Maximum: 128000

execution_modestring

Allowed: "tools""computer"

Default: "tools"

web_accessboolean

Default: false

connections"user"
4XX400 invalid input; 401 missing/revoked credentials; 403 disallowed operation/application; 404 missing or inaccessible resource; 409 conflicting submission/version/state; 413 body too large; 415 unsupported content type. Inspect error.code, not message text.
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired
Object fields
codestringrequired
messagestringrequired
request_idstringrequired

Additional keys: any

5XX500 unexpected failure or 503 unavailable dependency. A failed response does not prove that a submission was not committed. Retry job/flow admission with the same key and body.
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired
Object fields
codestringrequired
messagestringrequired
request_idstringrequired

Additional keys: any