OpenAI APIs · Schema

ToolCall

Artificial IntelligenceEmbeddingsImage GenerationLanguage ModelsSpeech

Properties

Name Type Description
id string The ID of the tool call
type string
function object
View JSON Schema on GitHub

JSON Schema

openai-apis-toolcall-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ToolCall",
  "title": "ToolCall",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the tool call"
    },
    "type": {
      "type": "string",
      "enum": [
        "function"
      ]
    },
    "function": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the function to call"
        },
        "arguments": {
          "type": "string",
          "description": "The arguments to call the function with as JSON"
        }
      }
    }
  }
}