OpenAI APIs · Schema

CreateRunRequest

Artificial IntelligenceEmbeddingsImage GenerationLanguage ModelsSpeech

Properties

Name Type Description
assistant_id string The ID of the assistant to use for this run
model string Override the model for this run
instructions string Override the instructions for this run
additional_instructions string Additional instructions appended to the assistant's instructions
tools array Override the tools for this run
metadata object Key-value metadata for the run
stream boolean Whether to stream the run
View JSON Schema on GitHub

JSON Schema

openai-apis-createrunrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateRunRequest",
  "title": "CreateRunRequest",
  "type": "object",
  "required": [
    "assistant_id"
  ],
  "properties": {
    "assistant_id": {
      "type": "string",
      "description": "The ID of the assistant to use for this run"
    },
    "model": {
      "type": "string",
      "description": "Override the model for this run"
    },
    "instructions": {
      "type": "string",
      "nullable": true,
      "description": "Override the instructions for this run"
    },
    "additional_instructions": {
      "type": "string",
      "nullable": true,
      "description": "Additional instructions appended to the assistant's instructions"
    },
    "tools": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Override the tools for this run"
    },
    "metadata": {
      "type": "object",
      "description": "Key-value metadata for the run"
    },
    "stream": {
      "type": "boolean",
      "description": "Whether to stream the run"
    }
  }
}