createRunRequest

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
assistant_id	string	The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.
model	string	The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated wi
instructions	string	Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.
tools	array	Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.
metadata	object	Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/createRunRequest",
  "title": "createRunRequest",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "assistant_id": {
      "description": "The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.",
      "type": "string"
    },
    "model": {
      "description": "The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.",
      "type": "string",
      "nullable": true
    },
    "instructions": {
      "description": "Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.",
      "type": "string",
      "nullable": true
    },
    "tools": {
      "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.",
      "nullable": true,
      "type": "array",
      "maxItems": 20,
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/assistantToolsCode"
          },
          {
            "$ref": "#/components/schemas/assistantToolsRetrieval"
          },
          {
            "$ref": "#/components/schemas/assistantToolsFunction"
          }
        ]
      }
    },
    "metadata": {
      "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n",
      "type": "object",
      "nullable": true
    }
  },
  "required": [
    "thread_id",
    "assistant_id"
  ]
}