Changes to Create Or Update Session

Changed in 15 of the 44 revisions of this API.▲20●7○55

1. Jun 26, 2025a5693caa5db1○6
2. May 12, 2025088c2ebb8988○10
3. Mar 3, 20251f91c7da5438▲1○5
4. Mar 1, 20255760ee26a52a▲1○1
5. Feb 28, 20254d9d1f8b357a▲1○3
6. Feb 27, 2025bf9190a8aea0▲1○3
7. Feb 26, 2025e01e4f400de2▲6○3
8. Feb 25, 20251a338af95f85▲3○3
9. Feb 25, 20252f61540b4f3d▲4●6
10. Feb 24, 20250ddb64e7a598▲1○3
11. Feb 18, 2025854c2437e2f6▲1○3
12. Jan 27, 2025f87931a479bd●1○13
13. Jan 16, 2025ea124be3fdbc○1
14. Jan 16, 2025a707ace7212c▲1
15. Jan 16, 2025ea124be3fdbc○1

What changed

• Jun 26, 2025a5693caa5db1○6See the full diff
  • ○

    added the new optional request property recall_options/anyOf[subschema #1: VectorDocSearch]/include_embeddings

    new-optional-request-property

  • ○

    added the new optional request property recall_options/anyOf[subschema #2: TextOnlyDocSearch]/include_embeddings

    new-optional-request-property

  • ○

    added the new optional request property recall_options/anyOf[subschema #3: HybridDocSearch]/include_embeddings

    new-optional-request-property

  • ○

    added the optional property recall_options/anyOf[subschema #1: VectorDocSearch]/include_embeddings to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property recall_options/anyOf[subschema #2: TextOnlyDocSearch]/include_embeddings to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property recall_options/anyOf[subschema #3: HybridDocSearch]/include_embeddings to the response with the 201 status

    response-optional-property-added

• May 12, 2025088c2ebb8988○10See the full diff
  • ○

    added the new optional request property recall_options/anyOf[subschema #2: TextOnlyDocSearch]/trigram_similarity_threshold

    new-optional-request-property

  • ○

    added the new optional request property recall_options/anyOf[subschema #3: HybridDocSearch]/k_multiplier

    new-optional-request-property

  • ○

    added the new optional request property recall_options/anyOf[subschema #3: HybridDocSearch]/trigram_similarity_threshold

    new-optional-request-property

  • ○

    the confidence request property default value changed from 0 to 0.5

    request-property-default-value-changed

  • ○

    the confidence request property default value changed from 0 to 0.5

    request-property-default-value-changed

  • ○

    added the optional property recall_options/anyOf[subschema #2: TextOnlyDocSearch]/trigram_similarity_threshold to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property recall_options/anyOf[subschema #3: HybridDocSearch]/k_multiplier to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property recall_options/anyOf[subschema #3: HybridDocSearch]/trigram_similarity_threshold to the response with the 201 status

    response-optional-property-added

  • ○

    the confidence response's property default value changed from 0 to 0.5 for the status 201

    response-property-default-value-changed

  • ○

    the confidence response's property default value changed from 0 to 0.5 for the status 201

    response-property-default-value-changed

  This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

• Mar 3, 20251f91c7da5438▲1○5See the full diff
  • ▲

    the mode request property const value hybrid was added

    request-property-const-added

  • ○

    added VectorDocSearch TextOnlyDocSearch to the recall_options request property anyOf list

    request-property-any-of-added

  • ○

    the alpha request property default value changed from 0.75 to 0.5

    request-property-default-value-changed

  • ○

    added VectorDocSearch TextOnlyDocSearch to the recall_options response property anyOf list for the response status 201

    response-property-any-of-added

  • ○

    the mode response property const value hybrid was added for the status 201

    response-property-const-added

  • ○

    the alpha response's property default value changed from 0.75 to 0.5 for the status 201

    response-property-default-value-changed

  This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

• Mar 1, 20255760ee26a52a▲1○1See the full diff
  • ▲

    removed VectorDocSearch TextOnlyDocSearch from the recall_options request property anyOf list

    request-property-any-of-removed

  • ○

    removed VectorDocSearch TextOnlyDocSearch from the recall_options response property anyOf list for the response status 201

    response-property-any-of-removed

  This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

• Feb 28, 20254d9d1f8b357a▲1○3See the full diff
  • ▲

    removed RecallOptions from the recall_options request property anyOf list

    request-property-any-of-removed

  • ○

    added VectorDocSearch TextOnlyDocSearch HybridDocSearch to the recall_options request property anyOf list

    request-property-any-of-added

  • ○

    added VectorDocSearch TextOnlyDocSearch HybridDocSearch to the recall_options response property anyOf list for the response status 201

    response-property-any-of-added

  • ○

    removed RecallOptions from the recall_options response property anyOf list for the response status 201

    response-property-any-of-removed

  This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

• Feb 27, 2025bf9190a8aea0▲1○3See the full diff
  • ▲

    removed VectorDocSearch TextOnlyDocSearch HybridDocSearch from the recall_options request property anyOf list

    request-property-any-of-removed

  • ○

    added RecallOptions to the recall_options request property anyOf list

    request-property-any-of-added

  • ○

    added RecallOptions to the recall_options response property anyOf list for the response status 201

    response-property-any-of-added

  • ○

    removed VectorDocSearch TextOnlyDocSearch HybridDocSearch from the recall_options response property anyOf list for the response status 201

    response-property-any-of-removed

  This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

• Feb 26, 2025e01e4f400de2▲6○3See the full diff
  • ▲

    the recall_options/anyOf[subschema #1: VectorDocSearch]/max_query_length request property's min was increased to 100.00

    request-property-min-increased

  • ▲

    the recall_options/anyOf[subschema #2: TextOnlyDocSearch]/max_query_length request property's min was increased to 100.00

    request-property-min-increased

  • ▲

    the recall_options/anyOf[subschema #3: HybridDocSearch]/max_query_length request property's min was increased to 100.00

    request-property-min-increased

  • ▲

    the recall_options/anyOf[subschema #1: VectorDocSearch]/max_query_length response property's max was increased from 1000.00 to 10000.00 for the response status 201

    response-property-max-increased

  • ▲

    the recall_options/anyOf[subschema #2: TextOnlyDocSearch]/max_query_length response property's max was increased from 1000.00 to 10000.00 for the response status 201

    response-property-max-increased

  • ▲

    the recall_options/anyOf[subschema #3: HybridDocSearch]/max_query_length response property's max was increased from 1000.00 to 10000.00 for the response status 201

    response-property-max-increased

  • ○

    the recall_options/anyOf[subschema #1: VectorDocSearch]/max_query_length request property's max was increased from 1000.00 to 10000.00

    request-property-max-increased

  • ○

    the recall_options/anyOf[subschema #2: TextOnlyDocSearch]/max_query_length request property's max was increased from 1000.00 to 10000.00

    request-property-max-increased

  • ○

    the recall_options/anyOf[subschema #3: HybridDocSearch]/max_query_length request property's max was increased from 1000.00 to 10000.00

    request-property-max-increased

• Feb 25, 20251a338af95f85▲3○3See the full diff
  • ▲

    the lang response property const value en-US was removed for the status 201

    response-property-const-removed

  • ▲

    the lang response property const value en-US was removed for the status 201

    response-property-const-removed

  • ▲

    the lang response property const value en-US was removed for the status 201

    response-property-const-removed

  • ○

    the lang request property const value en-US was removed

    request-property-const-removed

  • ○

    the lang request property const value en-US was removed

    request-property-const-removed

  • ○

    the lang request property const value en-US was removed

    request-property-const-removed

• Feb 25, 20252f61540b4f3d▲4●6See the full diff
  • ▲

    removed the required property recall_options/anyOf[subschema #1: VectorDocSearch]/vector from the response with the 201 status

    response-required-property-removed

  • ▲

    removed the required property recall_options/anyOf[subschema #2: TextOnlyDocSearch]/text from the response with the 201 status

    response-required-property-removed

  • ▲

    removed the required property recall_options/anyOf[subschema #3: HybridDocSearch]/text from the response with the 201 status

    response-required-property-removed

  • ▲

    removed the required property recall_options/anyOf[subschema #3: HybridDocSearch]/vector from the response with the 201 status

    response-required-property-removed

  • ●

    removed the request property recall_options/anyOf[subschema #1: VectorDocSearch]/text

    request-property-removed

  • ●

    removed the request property recall_options/anyOf[subschema #1: VectorDocSearch]/vector

    request-property-removed

  • ●

    removed the request property recall_options/anyOf[subschema #2: TextOnlyDocSearch]/text

    request-property-removed

  • ●

    removed the request property recall_options/anyOf[subschema #3: HybridDocSearch]/text

    request-property-removed

  • ●

    removed the request property recall_options/anyOf[subschema #3: HybridDocSearch]/vector

    request-property-removed

  • ●

    removed the optional property recall_options/anyOf[subschema #1: VectorDocSearch]/text from the response with the 201 status

    response-optional-property-removed

• Feb 24, 20250ddb64e7a598▲1○3See the full diff
  • ▲

    removed RecallOptions from the recall_options request property anyOf list

    request-property-any-of-removed

  • ○

    added VectorDocSearch TextOnlyDocSearch HybridDocSearch to the recall_options request property anyOf list

    request-property-any-of-added

  • ○

    added VectorDocSearch TextOnlyDocSearch HybridDocSearch to the recall_options response property anyOf list for the response status 201

    response-property-any-of-added

  • ○

    removed RecallOptions from the recall_options response property anyOf list for the response status 201

    response-property-any-of-removed

  This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

• Feb 18, 2025854c2437e2f6▲1○3See the full diff
  • ▲

    response property system_template list-of-types was widened by adding types null to media type application/json of response 201

    response-property-list-of-types-widened

  • ○

    the system_template request property default value {%- if agent.name -%} You are {{agent.name}}.{{" "}} {%- endif -%} {%- if agent.about -%} About you: {{agent.about}}.{{" "}} {%- endif -%} {%- if user -%} You are talking to a user {%- if user.name -%}{{" "}} and their name is {{user.name}} {%- if user.about -%}. About the user: {{user.about}}.{%- else -%}.{%- endif -%} {%- endif -%} {%- endif -%} {{NEWLINE}} {%- if session.situation -%} Situation: {{session.situation}} {%- endif -%} {{NEWLINE+NEWLINE}} {%- if agent.instructions -%} Instructions:{{NEWLINE}} {%- if agent.instructions is string -%} {{agent.instructions}}{{NEWLINE}} {%- else -%} {%- for instruction in agent.instructions -%} - {{instruction}}{{NEWLINE}} {%- endfor -%} {%- endif -%} {{NEWLINE}} {%- endif -%} {%- if docs -%} Relevant documents:{{NEWLINE}} {%- for doc in docs -%} {{doc.title}}{{NEWLINE}} {%- if doc.content is string -%} {{doc.content}}{{NEWLINE}} {%- else -%} {%- for snippet in doc.content -%} {{snippet}}{{NEWLINE}} {%- endfor -%} {%- endif -%} {{"---"}} {%- endfor -%} {%- endif -%} was removed

    request-property-default-value-removed

  • ○

    request property system_template list-of-types was widened by adding types null to media type application/json

    request-property-list-of-types-widened

  • ○

    the system_template response's property default value {%- if agent.name -%} You are {{agent.name}}.{{" "}} {%- endif -%} {%- if agent.about -%} About you: {{agent.about}}.{{" "}} {%- endif -%} {%- if user -%} You are talking to a user {%- if user.name -%}{{" "}} and their name is {{user.name}} {%- if user.about -%}. About the user: {{user.about}}.{%- else -%}.{%- endif -%} {%- endif -%} {%- endif -%} {{NEWLINE}} {%- if session.situation -%} Situation: {{session.situation}} {%- endif -%} {{NEWLINE+NEWLINE}} {%- if agent.instructions -%} Instructions:{{NEWLINE}} {%- if agent.instructions is string -%} {{agent.instructions}}{{NEWLINE}} {%- else -%} {%- for instruction in agent.instructions -%} - {{instruction}}{{NEWLINE}} {%- endfor -%} {%- endif -%} {{NEWLINE}} {%- endif -%} {%- if docs -%} Relevant documents:{{NEWLINE}} {%- for doc in docs -%} {{doc.title}}{{NEWLINE}} {%- if doc.content is string -%} {{doc.content}}{{NEWLINE}} {%- else -%} {%- for snippet in doc.content -%} {{snippet}}{{NEWLINE}} {%- endfor -%} {%- endif -%} {{"---"}} {%- endfor -%} {%- endif -%} was removed for the status 201

    response-property-default-value-removed

• Jan 27, 2025f87931a479bd●1○13See the full diff
  • ●

    removed the optional property jobs from the response with the 201 status

    response-optional-property-removed

  • ○

    added the optional property auto_run_tools to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property context_overflow to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property forward_tool_calls to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property kind to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property metadata to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property recall_options to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property render_templates to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property situation to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property summary to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property system_template to the response with the 201 status

    response-optional-property-added

  • ○

    added the optional property token_budget to the response with the 201 status

    response-optional-property-added

  • ○

    added the required property created_at to the response with the 201 status

    response-required-property-added

  • ○

    the response required property id became read-only for the status 201

    response-required-property-became-read-only

  This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

• Jan 16, 2025ea124be3fdbc○1See the full diff
  • ○

    the recall_options/anyOf[subschema #1: RecallOptions]/confidence request property's min was decreased from 0.00 to -1.00

    request-property-min-decreased

  This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

• Jan 16, 2025a707ace7212c▲1See the full diff
  • ▲

    the recall_options/anyOf[subschema #1: RecallOptions]/confidence request property's min was increased to 0.00

    request-property-min-increased

• Jan 16, 2025ea124be3fdbc○1See the full diff
  • ○

    the recall_options/anyOf[subschema #1: RecallOptions]/confidence request property's min was decreased from 0.00 to -1.00

    request-property-min-decreased