Skip to main content

SessionCreateIn

textTextnullable

Optional first message: what the end user says. When given, the session's first turn starts right away and its task_id is returned.

Possible values: non-empty and <= 32000 characters

attachments object[]nullable

Media to attach to this turn (up to 10 items). null or an empty list means no media.

Possible values: <= 10

  • Array [
  • file_idstring<uuid>nullable

    Identifier of an owned file created via POST /v1/files. Provide exactly one of file_id or file_data.

    file_dataFile Datanullable

    Base64-encoded file bytes (a data:…;base64, prefix is accepted and ignored). Provide exactly one of file_id or file_data.

  • ]
  • capabilitiesstring[]nullable

    Open only these capabilities in this session: the assistant uses no other, and a capability added later never reaches it. An empty list leaves the assistant only its conversation — and its memory of the user, which every session keeps. Leave out both this and exclude_capabilities to open every capability. Fixed for the session's life.

    Possible values: [search, deep_research, understanding, image_generation, video_generation, music_generation, documents]

    exclude_capabilitiesstring[]nullable

    Open every capability but these in this session. A capability added later opens in the sessions created after it is added; this one keeps the ones it was created with. Send this or capabilities, not both. Fixed for the session's life.

    Possible values: [search, deep_research, understanding, image_generation, video_generation, music_generation, documents]

    output_formatOutput Format

    Reply form for this session, fixed for its life: a2ui for UI data, with the words the reply says outside that UI as plain text, or markdown for formatted text. Defaults to a2ui.

    Possible values: [a2ui, markdown]

    Default value: a2ui
    SessionCreateIn
    {
    "text": "Find three quiet cafés near Union Square that are open after 8 pm."
    }