Octen · Schema

AnswerChunk

A streaming chunk of an Answer response. Returned when `stream=true`. The `type` field indicates the chunk kind: `queries`, `search_done`, `content`, `finish`, `usage`.

SearchWeb SearchArtificial IntelligenceLLMEmbeddingsContent ExtractionModel GatewayMCPAgentsDeep ResearchCompany

Properties

Name Type Description
type string The type of this streaming chunk. The `queries` type contains the auto-generated sub-queries.
request_id string The unique identifier for this request.
object string The object type, always `chat.completion.chunk` for streaming responses.
created number Unix timestamp (in seconds) of when the chunk was created.
model string The model used for this completion.
queries array Auto-generated sub-queries. Present only in `queries` type chunks.
choices array Incremental choices. Present in `content` and `finish` chunks.
search_results array Search results grouped by query. Present in `search_done` chunks.
meta object
View JSON Schema on GitHub

JSON Schema

octen-ai-answer-chunk-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/octen-ai/json-schema/octen-ai-answer-chunk-schema.json",
  "title": "AnswerChunk",
  "description": "A streaming chunk of an Answer response. Returned when `stream=true`. The `type` field indicates the chunk kind: `queries`, `search_done`, `content`, `finish`, `usage`.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/octen-ai-answer-api-openapi.yml#/components/schemas/AnswerChunk",
  "type": "object",
  "required": [
    "request_id",
    "object",
    "created",
    "model"
  ],
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "queries",
        "search_done",
        "content",
        "finish",
        "usage"
      ],
      "description": "The type of this streaming chunk. The `queries` type contains the auto-generated sub-queries."
    },
    "request_id": {
      "type": "string",
      "description": "The unique identifier for this request."
    },
    "object": {
      "type": "string",
      "enum": [
        "chat.completion.chunk"
      ],
      "description": "The object type, always `chat.completion.chunk` for streaming responses."
    },
    "created": {
      "type": "number",
      "description": "Unix timestamp (in seconds) of when the chunk was created."
    },
    "model": {
      "type": "string",
      "description": "The model used for this completion."
    },
    "queries": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Auto-generated sub-queries. Present only in `queries` type chunks."
    },
    "choices": {
      "type": "array",
      "description": "Incremental choices. Present in `content` and `finish` chunks.",
      "items": {
        "$ref": "#/$defs/ChatCompletionChunkChoice"
      }
    },
    "search_results": {
      "type": "array",
      "description": "Search results grouped by query. Present in `search_done` chunks.",
      "items": {
        "$ref": "#/$defs/SearchResultGroup"
      }
    },
    "meta": {
      "$ref": "#/$defs/AnswerMeta"
    }
  },
  "$defs": {
    "AnswerMeta": {
      "type": "object",
      "description": "Metadata for the Answer response.",
      "properties": {
        "usage": {
          "$ref": "#/$defs/SynthesisUsage"
        },
        "latency": {
          "type": "integer",
          "description": "Total request latency in milliseconds."
        }
      }
    },
    "ChatCompletionChunkChoice": {
      "type": "object",
      "description": "A single choice in a streaming chunk.",
      "properties": {
        "index": {
          "type": "integer",
          "description": "The index of this choice. Usually 0."
        },
        "delta": {
          "$ref": "#/$defs/ChatCompletionDelta"
        },
        "finish_reason": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "stop",
            "length",
            "tool_calls",
            "content_filter",
            "error",
            null
          ],
          "description": "The reason generation stopped. `null` for intermediate chunks; set in the `finish` chunk."
        },
        "logprobs": {
          "$ref": "#/$defs/ChatLogprobs"
        }
      }
    },
    "ChatCompletionDelta": {
      "type": "object",
      "description": "Incremental content in a streaming chunk. Contains only the new fields for this chunk.",
      "properties": {
        "role": {
          "type": "string",
          "enum": [
            "assistant"
          ],
          "description": "The role. Typically included in the first chunk."
        },
        "content": {
          "type": "string",
          "description": "Incremental text content."
        },
        "tool_calls": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ChatToolCallDelta"
          },
          "description": "Incremental tool call data."
        }
      }
    },
    "ChatLogprobs": {
      "type": [
        "object",
        "null"
      ],
      "description": "Log probability information for the output tokens. Present only when `logprobs` is `true`, otherwise `null`.",
      "properties": {
        "content": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {
              "token": {
                "type": "string",
                "description": "The token text."
              },
              "logprob": {
                "type": "number",
                "description": "The log probability of this token."
              },
              "bytes": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "integer"
                },
                "description": "UTF-8 byte representation."
              },
              "top_logprobs": {
                "type": "array",
                "description": "The top candidate tokens at this position, same structure.",
                "items": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "ChatToolCallDelta": {
      "type": "object",
      "description": "Incremental tool call data in a streaming chunk. The first chunk for a tool call includes `id`, `type`, and `function.name`. Subsequent chunks append to `function.arguments`.",
      "properties": {
        "index": {
          "type": "number",
          "description": "The index of this tool call in the tool_calls array."
        },
        "id": {
          "type": "string",
          "description": "The tool call ID. Only present in the first chunk for this tool call."
        },
        "type": {
          "type": "string",
          "enum": [
            "function"
          ],
          "description": "The type of tool call."
        },
        "function": {
          "type": "object",
          "description": "Incremental function call data.",
          "properties": {
            "name": {
              "type": "string",
              "description": "The function name. Only present in the first chunk for this tool call."
            },
            "arguments": {
              "type": "string",
              "description": "Incremental JSON string of the function arguments. Concatenate across chunks to build the complete arguments."
            }
          }
        }
      }
    },
    "SearchResult": {
      "type": "object",
      "description": "A single search result.",
      "properties": {
        "title": {
          "type": "string",
          "description": "The title of the result page."
        },
        "url": {
          "type": "string",
          "description": "The URL of the result page."
        },
        "highlight": {
          "type": "string",
          "description": "Query-relevant highlight snippets. Returned only if highlight.enable is true."
        },
        "full_content": {
          "type": "string",
          "description": "Full raw page content. Returned only if full_content.enable is true."
        },
        "authors": {
          "type": "string",
          "description": "Website name or author."
        },
        "time_published": {
          "type": "string",
          "format": "date-time",
          "description": "Publish time in ISO 8601."
        },
        "time_last_crawled": {
          "type": "string",
          "format": "date-time",
          "description": "Last crawl time in ISO 8601."
        },
        "favicon": {
          "type": "string",
          "description": "The favicon URL of the result site."
        },
        "cover_image": {
          "type": "object",
          "description": "The page cover image. Returned only when `include_images` is true and the page has a cover image.",
          "properties": {
            "url": {
              "type": "string",
              "description": "The cover image URL."
            },
            "description": {
              "type": "string",
              "description": "Text description of the cover image."
            }
          }
        },
        "images": {
          "type": "array",
          "description": "In-body images of the page, in order of appearance. Returned only when `include_images` is true.",
          "items": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "description": "The image URL."
              },
              "description": {
                "type": "string",
                "description": "Text description of the image."
              }
            }
          }
        }
      }
    },
    "SearchResultGroup": {
      "type": "object",
      "description": "A group of search results for a single sub-query.",
      "properties": {
        "query": {
          "type": "string",
          "description": "The sub-query that produced these results."
        },
        "results": {
          "type": "array",
          "description": "The search results for this sub-query.",
          "items": {
            "$ref": "#/$defs/SearchResult"
          }
        },
        "latency": {
          "type": "integer",
          "description": "Search latency for this query in milliseconds."
        }
      }
    },
    "SynthesisUsage": {
      "type": "object",
      "description": "Token usage information for the Answer response. When `stream=true`, this is only present in the `usage` type chunk.",
      "required": [
        "num_search_queries",
        "prompt_tokens",
        "completion_tokens",
        "total_tokens"
      ],
      "properties": {
        "num_search_queries": {
          "type": "integer",
          "description": "Total number of search queries executed across all sub-queries."
        },
        "prompt_tokens": {
          "type": "integer",
          "description": "Number of input tokens."
        },
        "completion_tokens": {
          "type": "integer",
          "description": "Number of output tokens."
        },
        "total_tokens": {
          "type": "integer",
          "description": "Total tokens used (prompt_tokens + completion_tokens)."
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/octen-ai-answer-chunk"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.