Skip to main content
POST
Open the analyst for a fine-tuning job

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Path Parameters

jobId
string<uuid>
required

Fine-tuning job id.

Body

application/json

Open or continue an assistant conversation. An empty object returns the caller's conversation, if any; question asks (starting the conversation if needed); reset ends the current conversation.

question
string

A question for the assistant. Starts the caller's conversation when there is none, as its first turn; otherwise it is delivered to the existing conversation. Omitted, nothing is asked. At most 262,144 bytes (256 KiB) once surrounding whitespace is trimmed; a longer question is refused with 400 and nothing is asked.

reset
boolean
default:false

When true, ends the caller's current conversation: the assistant session is cancelled and stays readable, and the caller has no conversation until the next question.

Response

OK

created
boolean
required

True when this request started the conversation.

session
object

The caller's analyst conversation for the requested subject, when one exists.