openapi: 3.1.0 info: title: >- Llama Stack Specification - Deprecated APIs version: v1 description: >- This is the specification of the Llama Stack that provides a set of endpoints and their corresponding interfaces that are tailored to best leverage Llama Models. **⚠️ DEPRECATED**: Legacy APIs that may be removed in future versions. Use for migration reference only. servers: - url: http://any-hosted-llama-stack.com paths: /v1/agents: get: responses: '200': description: A PaginatedResponse. content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: List all agents. description: List all agents. parameters: - name: start_index in: query description: The index to start the pagination from. required: false schema: type: integer - name: limit in: query description: The number of agents to return. required: false schema: type: integer deprecated: true post: responses: '200': description: >- An AgentCreateResponse with the agent ID. content: application/json: schema: $ref: '#/components/schemas/AgentCreateResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: >- Create an agent with the given configuration. description: >- Create an agent with the given configuration. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAgentRequest' required: true deprecated: true /v1/agents/{agent_id}: get: responses: '200': description: An Agent of the agent. content: application/json: schema: $ref: '#/components/schemas/Agent' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: Describe an agent by its ID. description: Describe an agent by its ID. parameters: - name: agent_id in: path description: ID of the agent. required: true schema: type: string deprecated: true delete: responses: '200': description: OK '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: >- Delete an agent by its ID and its associated sessions and turns. description: >- Delete an agent by its ID and its associated sessions and turns. parameters: - name: agent_id in: path description: The ID of the agent to delete. required: true schema: type: string deprecated: true /v1/agents/{agent_id}/session: post: responses: '200': description: An AgentSessionCreateResponse. content: application/json: schema: $ref: '#/components/schemas/AgentSessionCreateResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: Create a new session for an agent. description: Create a new session for an agent. parameters: - name: agent_id in: path description: >- The ID of the agent to create the session for. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAgentSessionRequest' required: true deprecated: true /v1/agents/{agent_id}/session/{session_id}: get: responses: '200': description: A Session. content: application/json: schema: $ref: '#/components/schemas/Session' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: Retrieve an agent session by its ID. description: Retrieve an agent session by its ID. parameters: - name: session_id in: path description: The ID of the session to get. required: true schema: type: string - name: agent_id in: path description: >- The ID of the agent to get the session for. required: true schema: type: string - name: turn_ids in: query description: >- (Optional) List of turn IDs to filter the session by. required: false schema: type: array items: type: string deprecated: true delete: responses: '200': description: OK '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: >- Delete an agent session by its ID and its associated turns. description: >- Delete an agent session by its ID and its associated turns. parameters: - name: session_id in: path description: The ID of the session to delete. required: true schema: type: string - name: agent_id in: path description: >- The ID of the agent to delete the session for. required: true schema: type: string deprecated: true /v1/agents/{agent_id}/session/{session_id}/turn: post: responses: '200': description: >- If stream=False, returns a Turn object. If stream=True, returns an SSE event stream of AgentTurnResponseStreamChunk. content: application/json: schema: $ref: '#/components/schemas/Turn' text/event-stream: schema: $ref: '#/components/schemas/AgentTurnResponseStreamChunk' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: Create a new turn for an agent. description: Create a new turn for an agent. parameters: - name: agent_id in: path description: >- The ID of the agent to create the turn for. required: true schema: type: string - name: session_id in: path description: >- The ID of the session to create the turn for. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAgentTurnRequest' required: true deprecated: true /v1/agents/{agent_id}/session/{session_id}/turn/{turn_id}: get: responses: '200': description: A Turn. content: application/json: schema: $ref: '#/components/schemas/Turn' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: Retrieve an agent turn by its ID. description: Retrieve an agent turn by its ID. parameters: - name: agent_id in: path description: The ID of the agent to get the turn for. required: true schema: type: string - name: session_id in: path description: >- The ID of the session to get the turn for. required: true schema: type: string - name: turn_id in: path description: The ID of the turn to get. required: true schema: type: string deprecated: true /v1/agents/{agent_id}/session/{session_id}/turn/{turn_id}/resume: post: responses: '200': description: >- A Turn object if stream is False, otherwise an AsyncIterator of AgentTurnResponseStreamChunk objects. content: application/json: schema: $ref: '#/components/schemas/Turn' text/event-stream: schema: $ref: '#/components/schemas/AgentTurnResponseStreamChunk' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: >- Resume an agent turn with executed tool call responses. description: >- Resume an agent turn with executed tool call responses. When a Turn has the status `awaiting_input` due to pending input from client side tool calls, this endpoint can be used to submit the outputs from the tool calls once they are ready. parameters: - name: agent_id in: path description: The ID of the agent to resume. required: true schema: type: string - name: session_id in: path description: The ID of the session to resume. required: true schema: type: string - name: turn_id in: path description: The ID of the turn to resume. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ResumeAgentTurnRequest' required: true deprecated: true /v1/agents/{agent_id}/session/{session_id}/turn/{turn_id}/step/{step_id}: get: responses: '200': description: An AgentStepResponse. content: application/json: schema: $ref: '#/components/schemas/AgentStepResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: Retrieve an agent step by its ID. description: Retrieve an agent step by its ID. parameters: - name: agent_id in: path description: The ID of the agent to get the step for. required: true schema: type: string - name: session_id in: path description: >- The ID of the session to get the step for. required: true schema: type: string - name: turn_id in: path description: The ID of the turn to get the step for. required: true schema: type: string - name: step_id in: path description: The ID of the step to get. required: true schema: type: string deprecated: true /v1/agents/{agent_id}/sessions: get: responses: '200': description: A PaginatedResponse. content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: List all session(s) of a given agent. description: List all session(s) of a given agent. parameters: - name: agent_id in: path description: >- The ID of the agent to list sessions for. required: true schema: type: string - name: start_index in: query description: The index to start the pagination from. required: false schema: type: integer - name: limit in: query description: The number of sessions to return. required: false schema: type: integer deprecated: true /v1/datasetio/append-rows/{dataset_id}: post: responses: '200': description: OK '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - DatasetIO summary: Append rows to a dataset. description: Append rows to a dataset. parameters: - name: dataset_id in: path description: >- The ID of the dataset to append the rows to. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AppendRowsRequest' required: true deprecated: true /v1/datasetio/iterrows/{dataset_id}: get: responses: '200': description: A PaginatedResponse. content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - DatasetIO summary: >- Get a paginated list of rows from a dataset. description: >- Get a paginated list of rows from a dataset. Uses offset-based pagination where: - start_index: The starting index (0-based). If None, starts from beginning. - limit: Number of items to return. If None or -1, returns all items. The response includes: - data: List of items for the current page. - has_more: Whether there are more items available after this set. parameters: - name: dataset_id in: path description: >- The ID of the dataset to get the rows from. required: true schema: type: string - name: start_index in: query description: >- Index into dataset for the first row to get. Get all rows if None. required: false schema: type: integer - name: limit in: query description: The number of rows to get. required: false schema: type: integer deprecated: true /v1/datasets: get: responses: '200': description: A ListDatasetsResponse. content: application/json: schema: $ref: '#/components/schemas/ListDatasetsResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Datasets summary: List all datasets. description: List all datasets. parameters: [] deprecated: true post: responses: '200': description: A Dataset. content: application/json: schema: $ref: '#/components/schemas/Dataset' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Datasets summary: Register a new dataset. description: Register a new dataset. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterDatasetRequest' required: true deprecated: true /v1/datasets/{dataset_id}: get: responses: '200': description: A Dataset. content: application/json: schema: $ref: '#/components/schemas/Dataset' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Datasets summary: Get a dataset by its ID. description: Get a dataset by its ID. parameters: - name: dataset_id in: path description: The ID of the dataset to get. required: true schema: type: string deprecated: true delete: responses: '200': description: OK '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Datasets summary: Unregister a dataset by its ID. description: Unregister a dataset by its ID. parameters: - name: dataset_id in: path description: The ID of the dataset to unregister. required: true schema: type: string deprecated: true /v1/eval/benchmarks: get: responses: '200': description: A ListBenchmarksResponse. content: application/json: schema: $ref: '#/components/schemas/ListBenchmarksResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Benchmarks summary: List all benchmarks. description: List all benchmarks. parameters: [] deprecated: true post: responses: '200': description: OK '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Benchmarks summary: Register a benchmark. description: Register a benchmark. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterBenchmarkRequest' required: true deprecated: true /v1/eval/benchmarks/{benchmark_id}: get: responses: '200': description: A Benchmark. content: application/json: schema: $ref: '#/components/schemas/Benchmark' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Benchmarks summary: Get a benchmark by its ID. description: Get a benchmark by its ID. parameters: - name: benchmark_id in: path description: The ID of the benchmark to get. required: true schema: type: string deprecated: true delete: responses: '200': description: OK '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Benchmarks summary: Unregister a benchmark. description: Unregister a benchmark. parameters: - name: benchmark_id in: path description: The ID of the benchmark to unregister. required: true schema: type: string deprecated: true /v1/eval/benchmarks/{benchmark_id}/evaluations: post: responses: '200': description: >- EvaluateResponse object containing generations and scores. content: application/json: schema: $ref: '#/components/schemas/EvaluateResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Eval summary: Evaluate a list of rows on a benchmark. description: Evaluate a list of rows on a benchmark. parameters: - name: benchmark_id in: path description: >- The ID of the benchmark to run the evaluation on. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EvaluateRowsRequest' required: true deprecated: true /v1/eval/benchmarks/{benchmark_id}/jobs: post: responses: '200': description: >- The job that was created to run the evaluation. content: application/json: schema: $ref: '#/components/schemas/Job' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Eval summary: Run an evaluation on a benchmark. description: Run an evaluation on a benchmark. parameters: - name: benchmark_id in: path description: >- The ID of the benchmark to run the evaluation on. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RunEvalRequest' required: true deprecated: true /v1/eval/benchmarks/{benchmark_id}/jobs/{job_id}: get: responses: '200': description: The status of the evaluation job. content: application/json: schema: $ref: '#/components/schemas/Job' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Eval summary: Get the status of a job. description: Get the status of a job. parameters: - name: benchmark_id in: path description: >- The ID of the benchmark to run the evaluation on. required: true schema: type: string - name: job_id in: path description: The ID of the job to get the status of. required: true schema: type: string deprecated: true delete: responses: '200': description: OK '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Eval summary: Cancel a job. description: Cancel a job. parameters: - name: benchmark_id in: path description: >- The ID of the benchmark to run the evaluation on. required: true schema: type: string - name: job_id in: path description: The ID of the job to cancel. required: true schema: type: string deprecated: true /v1/eval/benchmarks/{benchmark_id}/jobs/{job_id}/result: get: responses: '200': description: The result of the job. content: application/json: schema: $ref: '#/components/schemas/EvaluateResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Eval summary: Get the result of a job. description: Get the result of a job. parameters: - name: benchmark_id in: path description: >- The ID of the benchmark to run the evaluation on. required: true schema: type: string - name: job_id in: path description: The ID of the job to get the result of. required: true schema: type: string deprecated: true /v1/openai/v1/chat/completions: get: responses: '200': description: A ListOpenAIChatCompletionResponse. content: application/json: schema: $ref: '#/components/schemas/ListOpenAIChatCompletionResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Inference summary: List all chat completions. description: List all chat completions. parameters: - name: after in: query description: >- The ID of the last chat completion to return. required: false schema: type: string - name: limit in: query description: >- The maximum number of chat completions to return. required: false schema: type: integer - name: model in: query description: The model to filter by. required: false schema: type: string - name: order in: query description: >- The order to sort the chat completions by: "asc" or "desc". Defaults to "desc". required: false schema: $ref: '#/components/schemas/Order' deprecated: true post: responses: '200': description: An OpenAIChatCompletion. content: application/json: schema: oneOf: - $ref: '#/components/schemas/OpenAIChatCompletion' - $ref: '#/components/schemas/OpenAIChatCompletionChunk' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Inference summary: >- Generate an OpenAI-compatible chat completion for the given messages using the specified model. description: >- Generate an OpenAI-compatible chat completion for the given messages using the specified model. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenaiChatCompletionRequest' required: true deprecated: true /v1/openai/v1/chat/completions/{completion_id}: get: responses: '200': description: A OpenAICompletionWithInputMessages. content: application/json: schema: $ref: '#/components/schemas/OpenAICompletionWithInputMessages' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Inference summary: Describe a chat completion by its ID. description: Describe a chat completion by its ID. parameters: - name: completion_id in: path description: ID of the chat completion. required: true schema: type: string deprecated: true /v1/openai/v1/completions: post: responses: '200': description: An OpenAICompletion. content: application/json: schema: $ref: '#/components/schemas/OpenAICompletion' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Inference summary: >- Generate an OpenAI-compatible completion for the given prompt using the specified model. description: >- Generate an OpenAI-compatible completion for the given prompt using the specified model. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenaiCompletionRequest' required: true deprecated: true /v1/openai/v1/embeddings: post: responses: '200': description: >- An OpenAIEmbeddingsResponse containing the embeddings. content: application/json: schema: $ref: '#/components/schemas/OpenAIEmbeddingsResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Inference summary: >- Generate OpenAI-compatible embeddings for the given input using the specified model. description: >- Generate OpenAI-compatible embeddings for the given input using the specified model. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenaiEmbeddingsRequest' required: true deprecated: true /v1/openai/v1/files: get: responses: '200': description: >- An ListOpenAIFileResponse containing the list of files. content: application/json: schema: $ref: '#/components/schemas/ListOpenAIFileResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Files summary: >- Returns a list of files that belong to the user's organization. description: >- Returns a list of files that belong to the user's organization. parameters: - name: after in: query description: >- A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. required: false schema: type: string - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000. required: false schema: type: integer - name: order in: query description: >- Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. required: false schema: $ref: '#/components/schemas/Order' - name: purpose in: query description: >- Only return files with the given purpose. required: false schema: $ref: '#/components/schemas/OpenAIFilePurpose' deprecated: true post: responses: '200': description: >- An OpenAIFileObject representing the uploaded file. content: application/json: schema: $ref: '#/components/schemas/OpenAIFileObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Files summary: >- Upload a file that can be used across various endpoints. description: >- Upload a file that can be used across various endpoints. The file upload should be a multipart form request with: - file: The File object (not file name) to be uploaded. - purpose: The intended purpose of the uploaded file. - expires_after: Optional form values describing expiration for the file. parameters: [] requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary purpose: $ref: '#/components/schemas/OpenAIFilePurpose' expires_after: $ref: '#/components/schemas/ExpiresAfter' required: - file - purpose required: true deprecated: true /v1/openai/v1/files/{file_id}: get: responses: '200': description: >- An OpenAIFileObject containing file information. content: application/json: schema: $ref: '#/components/schemas/OpenAIFileObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Files summary: >- Returns information about a specific file. description: >- Returns information about a specific file. parameters: - name: file_id in: path description: >- The ID of the file to use for this request. required: true schema: type: string deprecated: true delete: responses: '200': description: >- An OpenAIFileDeleteResponse indicating successful deletion. content: application/json: schema: $ref: '#/components/schemas/OpenAIFileDeleteResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Files summary: Delete a file. description: Delete a file. parameters: - name: file_id in: path description: >- The ID of the file to use for this request. required: true schema: type: string deprecated: true /v1/openai/v1/files/{file_id}/content: get: responses: '200': description: >- The raw file content as a binary response. content: application/json: schema: $ref: '#/components/schemas/Response' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Files summary: >- Returns the contents of the specified file. description: >- Returns the contents of the specified file. parameters: - name: file_id in: path description: >- The ID of the file to use for this request. required: true schema: type: string deprecated: true /v1/openai/v1/models: get: responses: '200': description: A OpenAIListModelsResponse. content: application/json: schema: $ref: '#/components/schemas/OpenAIListModelsResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Models summary: List models using the OpenAI API. description: List models using the OpenAI API. parameters: [] deprecated: true /v1/openai/v1/moderations: post: responses: '200': description: A moderation object. content: application/json: schema: $ref: '#/components/schemas/ModerationObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Safety summary: >- Classifies if text and/or image inputs are potentially harmful. description: >- Classifies if text and/or image inputs are potentially harmful. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/RunModerationRequest' required: true deprecated: true /v1/openai/v1/responses: get: responses: '200': description: A ListOpenAIResponseObject. content: application/json: schema: $ref: '#/components/schemas/ListOpenAIResponseObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: List all OpenAI responses. description: List all OpenAI responses. parameters: - name: after in: query description: The ID of the last response to return. required: false schema: type: string - name: limit in: query description: The number of responses to return. required: false schema: type: integer - name: model in: query description: The model to filter responses by. required: false schema: type: string - name: order in: query description: >- The order to sort responses by when sorted by created_at ('asc' or 'desc'). required: false schema: $ref: '#/components/schemas/Order' deprecated: true post: responses: '200': description: A ListOpenAIResponseObject. content: application/json: schema: $ref: '#/components/schemas/ListOpenAIResponseObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: List all OpenAI responses. description: List all OpenAI responses. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ListOpenaiResponsesRequest' required: true deprecated: true /v1/openai/v1/responses/{response_id}: get: responses: '200': description: An OpenAIResponseObject. content: application/json: schema: $ref: '#/components/schemas/OpenAIResponseObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: Retrieve an OpenAI response by its ID. description: Retrieve an OpenAI response by its ID. parameters: - name: response_id in: path description: >- The ID of the OpenAI response to retrieve. required: true schema: type: string deprecated: true delete: responses: '200': description: An OpenAIDeleteResponseObject content: application/json: schema: $ref: '#/components/schemas/OpenAIDeleteResponseObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: Delete an OpenAI response by its ID. description: Delete an OpenAI response by its ID. parameters: - name: response_id in: path description: The ID of the OpenAI response to delete. required: true schema: type: string deprecated: true /v1/openai/v1/responses/{response_id}/input_items: get: responses: '200': description: An ListOpenAIResponseInputItem. content: application/json: schema: $ref: '#/components/schemas/ListOpenAIResponseInputItem' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Agents summary: >- List input items for a given OpenAI response. description: >- List input items for a given OpenAI response. parameters: - name: response_id in: path description: >- The ID of the response to retrieve input items for. required: true schema: type: string - name: after in: query description: >- An item ID to list items after, used for pagination. required: false schema: type: string - name: before in: query description: >- An item ID to list items before, used for pagination. required: false schema: type: string - name: include in: query description: >- Additional fields to include in the response. required: false schema: type: array items: type: string - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. required: false schema: type: integer - name: order in: query description: >- The order to return the input items in. Default is desc. required: false schema: $ref: '#/components/schemas/Order' deprecated: true /v1/openai/v1/vector_stores: get: responses: '200': description: >- A VectorStoreListResponse containing the list of vector stores. content: application/json: schema: $ref: '#/components/schemas/VectorStoreListResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Returns a list of vector stores. description: Returns a list of vector stores. parameters: - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. required: false schema: type: integer - name: order in: query description: >- Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. required: false schema: type: string - name: after in: query description: >- A cursor for use in pagination. `after` is an object ID that defines your place in the list. required: false schema: type: string - name: before in: query description: >- A cursor for use in pagination. `before` is an object ID that defines your place in the list. required: false schema: type: string deprecated: true post: responses: '200': description: >- A VectorStoreObject representing the created vector store. content: application/json: schema: $ref: '#/components/schemas/VectorStoreObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Creates a vector store. description: Creates a vector store. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenaiCreateVectorStoreRequest' required: true deprecated: true /v1/openai/v1/vector_stores/{vector_store_id}: get: responses: '200': description: >- A VectorStoreObject representing the vector store. content: application/json: schema: $ref: '#/components/schemas/VectorStoreObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Retrieves a vector store. description: Retrieves a vector store. parameters: - name: vector_store_id in: path description: The ID of the vector store to retrieve. required: true schema: type: string deprecated: true post: responses: '200': description: >- A VectorStoreObject representing the updated vector store. content: application/json: schema: $ref: '#/components/schemas/VectorStoreObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Updates a vector store. description: Updates a vector store. parameters: - name: vector_store_id in: path description: The ID of the vector store to update. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenaiUpdateVectorStoreRequest' required: true deprecated: true delete: responses: '200': description: >- A VectorStoreDeleteResponse indicating the deletion status. content: application/json: schema: $ref: '#/components/schemas/VectorStoreDeleteResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Delete a vector store. description: Delete a vector store. parameters: - name: vector_store_id in: path description: The ID of the vector store to delete. required: true schema: type: string deprecated: true /v1/openai/v1/vector_stores/{vector_store_id}/file_batches: post: responses: '200': description: >- A VectorStoreFileBatchObject representing the created file batch. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Create a vector store file batch. description: Create a vector store file batch. parameters: - name: vector_store_id in: path description: >- The ID of the vector store to create the file batch for. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenaiCreateVectorStoreFileBatchRequest' required: true deprecated: true /v1/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}: get: responses: '200': description: >- A VectorStoreFileBatchObject representing the file batch. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Retrieve a vector store file batch. description: Retrieve a vector store file batch. parameters: - name: batch_id in: path description: The ID of the file batch to retrieve. required: true schema: type: string - name: vector_store_id in: path description: >- The ID of the vector store containing the file batch. required: true schema: type: string deprecated: true /v1/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel: post: responses: '200': description: >- A VectorStoreFileBatchObject representing the cancelled file batch. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Cancels a vector store file batch. description: Cancels a vector store file batch. parameters: - name: batch_id in: path description: The ID of the file batch to cancel. required: true schema: type: string - name: vector_store_id in: path description: >- The ID of the vector store containing the file batch. required: true schema: type: string deprecated: true /v1/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files: get: responses: '200': description: >- A VectorStoreFilesListInBatchResponse containing the list of files in the batch. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFilesListInBatchResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: >- Returns a list of vector store files in a batch. description: >- Returns a list of vector store files in a batch. parameters: - name: batch_id in: path description: >- The ID of the file batch to list files from. required: true schema: type: string - name: vector_store_id in: path description: >- The ID of the vector store containing the file batch. required: true schema: type: string - name: after in: query description: >- A cursor for use in pagination. `after` is an object ID that defines your place in the list. required: false schema: type: string - name: before in: query description: >- A cursor for use in pagination. `before` is an object ID that defines your place in the list. required: false schema: type: string - name: filter in: query description: >- Filter by file status. One of in_progress, completed, failed, cancelled. required: false schema: type: string - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. required: false schema: type: integer - name: order in: query description: >- Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. required: false schema: type: string deprecated: true /v1/openai/v1/vector_stores/{vector_store_id}/files: get: responses: '200': description: >- A VectorStoreListFilesResponse containing the list of files. content: application/json: schema: $ref: '#/components/schemas/VectorStoreListFilesResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: List files in a vector store. description: List files in a vector store. parameters: - name: vector_store_id in: path description: >- The ID of the vector store to list files from. required: true schema: type: string - name: limit in: query description: >- (Optional) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. required: false schema: type: integer - name: order in: query description: >- (Optional) Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. required: false schema: type: string - name: after in: query description: >- (Optional) A cursor for use in pagination. `after` is an object ID that defines your place in the list. required: false schema: type: string - name: before in: query description: >- (Optional) A cursor for use in pagination. `before` is an object ID that defines your place in the list. required: false schema: type: string - name: filter in: query description: >- (Optional) Filter by file status to only return files with the specified status. required: false schema: $ref: '#/components/schemas/VectorStoreFileStatus' deprecated: true post: responses: '200': description: >- A VectorStoreFileObject representing the attached file. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Attach a file to a vector store. description: Attach a file to a vector store. parameters: - name: vector_store_id in: path description: >- The ID of the vector store to attach the file to. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenaiAttachFileToVectorStoreRequest' required: true deprecated: true /v1/openai/v1/vector_stores/{vector_store_id}/files/{file_id}: get: responses: '200': description: >- A VectorStoreFileObject representing the file. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Retrieves a vector store file. description: Retrieves a vector store file. parameters: - name: vector_store_id in: path description: >- The ID of the vector store containing the file to retrieve. required: true schema: type: string - name: file_id in: path description: The ID of the file to retrieve. required: true schema: type: string deprecated: true post: responses: '200': description: >- A VectorStoreFileObject representing the updated file. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileObject' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Updates a vector store file. description: Updates a vector store file. parameters: - name: vector_store_id in: path description: >- The ID of the vector store containing the file to update. required: true schema: type: string - name: file_id in: path description: The ID of the file to update. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenaiUpdateVectorStoreFileRequest' required: true deprecated: true delete: responses: '200': description: >- A VectorStoreFileDeleteResponse indicating the deletion status. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileDeleteResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Delete a vector store file. description: Delete a vector store file. parameters: - name: vector_store_id in: path description: >- The ID of the vector store containing the file to delete. required: true schema: type: string - name: file_id in: path description: The ID of the file to delete. required: true schema: type: string deprecated: true /v1/openai/v1/vector_stores/{vector_store_id}/files/{file_id}/content: get: responses: '200': description: >- A list of InterleavedContent representing the file contents. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileContentsResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: >- Retrieves the contents of a vector store file. description: >- Retrieves the contents of a vector store file. parameters: - name: vector_store_id in: path description: >- The ID of the vector store containing the file to retrieve. required: true schema: type: string - name: file_id in: path description: The ID of the file to retrieve. required: true schema: type: string deprecated: true /v1/openai/v1/vector_stores/{vector_store_id}/search: post: responses: '200': description: >- A VectorStoreSearchResponse containing the search results. content: application/json: schema: $ref: '#/components/schemas/VectorStoreSearchResponsePage' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Search for chunks in a vector store. description: >- Search for chunks in a vector store. Searches a vector store for relevant chunks based on a query and optional file attribute filters. parameters: - name: vector_store_id in: path description: The ID of the vector store to search. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenaiSearchVectorStoreRequest' required: true deprecated: true /v1/post-training/job/artifacts: get: responses: '200': description: A PostTrainingJobArtifactsResponse. content: application/json: schema: $ref: '#/components/schemas/PostTrainingJobArtifactsResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - PostTraining (Coming Soon) summary: Get the artifacts of a training job. description: Get the artifacts of a training job. parameters: - name: job_uuid in: query description: >- The UUID of the job to get the artifacts of. required: true schema: type: string deprecated: true /v1/post-training/job/cancel: post: responses: '200': description: OK '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - PostTraining (Coming Soon) summary: Cancel a training job. description: Cancel a training job. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelTrainingJobRequest' required: true deprecated: true /v1/post-training/job/status: get: responses: '200': description: A PostTrainingJobStatusResponse. content: application/json: schema: $ref: '#/components/schemas/PostTrainingJobStatusResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - PostTraining (Coming Soon) summary: Get the status of a training job. description: Get the status of a training job. parameters: - name: job_uuid in: query description: >- The UUID of the job to get the status of. required: true schema: type: string deprecated: true /v1/post-training/jobs: get: responses: '200': description: A ListPostTrainingJobsResponse. content: application/json: schema: $ref: '#/components/schemas/ListPostTrainingJobsResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - PostTraining (Coming Soon) summary: Get all training jobs. description: Get all training jobs. parameters: [] deprecated: true /v1/post-training/preference-optimize: post: responses: '200': description: A PostTrainingJob. content: application/json: schema: $ref: '#/components/schemas/PostTrainingJob' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - PostTraining (Coming Soon) summary: Run preference optimization of a model. description: Run preference optimization of a model. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/PreferenceOptimizeRequest' required: true deprecated: true /v1/post-training/supervised-fine-tune: post: responses: '200': description: A PostTrainingJob. content: application/json: schema: $ref: '#/components/schemas/PostTrainingJob' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - PostTraining (Coming Soon) summary: Run supervised fine-tuning of a model. description: Run supervised fine-tuning of a model. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/SupervisedFineTuneRequest' required: true deprecated: true /v1/telemetry/metrics/{metric_name}: post: responses: '200': description: A QueryMetricsResponse. content: application/json: schema: $ref: '#/components/schemas/QueryMetricsResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Telemetry summary: Query metrics. description: Query metrics. parameters: - name: metric_name in: path description: The name of the metric to query. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryMetricsRequest' required: true deprecated: true /v1/telemetry/spans: post: responses: '200': description: A QuerySpansResponse. content: application/json: schema: $ref: '#/components/schemas/QuerySpansResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Telemetry summary: Query spans. description: Query spans. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/QuerySpansRequest' required: true deprecated: true /v1/telemetry/spans/export: post: responses: '200': description: OK '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Telemetry summary: Save spans to a dataset. description: Save spans to a dataset. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/SaveSpansToDatasetRequest' required: true deprecated: true /v1/telemetry/spans/{span_id}/tree: post: responses: '200': description: A QuerySpanTreeResponse. content: application/json: schema: $ref: '#/components/schemas/QuerySpanTreeResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Telemetry summary: Get a span tree by its ID. description: Get a span tree by its ID. parameters: - name: span_id in: path description: The ID of the span to get the tree from. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GetSpanTreeRequest' required: true deprecated: true /v1/telemetry/traces: post: responses: '200': description: A QueryTracesResponse. content: application/json: schema: $ref: '#/components/schemas/QueryTracesResponse' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Telemetry summary: Query traces. description: Query traces. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryTracesRequest' required: true deprecated: true /v1/telemetry/traces/{trace_id}: get: responses: '200': description: A Trace. content: application/json: schema: $ref: '#/components/schemas/Trace' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Telemetry summary: Get a trace by its ID. description: Get a trace by its ID. parameters: - name: trace_id in: path description: The ID of the trace to get. required: true schema: type: string deprecated: true /v1/telemetry/traces/{trace_id}/spans/{span_id}: get: responses: '200': description: A Span. content: application/json: schema: $ref: '#/components/schemas/Span' '400': $ref: '#/components/responses/BadRequest400' '429': $ref: >- #/components/responses/TooManyRequests429 '500': $ref: >- #/components/responses/InternalServerError500 default: $ref: '#/components/responses/DefaultError' tags: - Telemetry summary: Get a span by its ID. description: Get a span by its ID. parameters: - name: trace_id in: path description: >- The ID of the trace to get the span from. required: true schema: type: string - name: span_id in: path description: The ID of the span to get. required: true schema: type: string deprecated: true jsonSchemaDialect: >- https://json-schema.org/draft/2020-12/schema components: schemas: Error: type: object properties: status: type: integer description: HTTP status code title: type: string description: >- Error title, a short summary of the error which is invariant for an error type detail: type: string description: >- Error detail, a longer human-readable description of the error instance: type: string description: >- (Optional) A URL which can be used to retrieve more information about the specific occurrence of the error additionalProperties: false required: - status - title - detail title: Error description: >- Error response from the API. Roughly follows RFC 7807. PaginatedResponse: type: object properties: data: type: array items: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: The list of items for the current page has_more: type: boolean description: >- Whether there are more items available after this set url: type: string description: The URL for accessing this list additionalProperties: false required: - data - has_more title: PaginatedResponse description: >- A generic paginated response that follows a simple format. AgentConfig: type: object properties: sampling_params: $ref: '#/components/schemas/SamplingParams' input_shields: type: array items: type: string output_shields: type: array items: type: string toolgroups: type: array items: $ref: '#/components/schemas/AgentTool' client_tools: type: array items: $ref: '#/components/schemas/ToolDef' tool_choice: type: string enum: - auto - required - none title: ToolChoice description: >- Whether tool use is required or automatic. This is a hint to the model which may not be followed. It depends on the Instruction Following capabilities of the model. deprecated: true tool_prompt_format: type: string enum: - json - function_tag - python_list title: ToolPromptFormat description: >- Prompt format for calling custom / zero shot tools. deprecated: true tool_config: $ref: '#/components/schemas/ToolConfig' max_infer_iters: type: integer default: 10 model: type: string description: >- The model identifier to use for the agent instructions: type: string description: The system instructions for the agent name: type: string description: >- Optional name for the agent, used in telemetry and identification enable_session_persistence: type: boolean default: false description: >- Optional flag indicating whether session data has to be persisted response_format: $ref: '#/components/schemas/ResponseFormat' description: Optional response format configuration additionalProperties: false required: - model - instructions title: AgentConfig description: Configuration for an agent. AgentTool: oneOf: - type: string - type: object properties: name: type: string args: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object additionalProperties: false required: - name - args title: AgentToolGroupWithArgs GrammarResponseFormat: type: object properties: type: type: string enum: - json_schema - grammar description: >- Must be "grammar" to identify this format type const: grammar default: grammar bnf: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- The BNF grammar specification the response should conform to additionalProperties: false required: - type - bnf title: GrammarResponseFormat description: >- Configuration for grammar-guided response generation. GreedySamplingStrategy: type: object properties: type: type: string const: greedy default: greedy description: >- Must be "greedy" to identify this sampling strategy additionalProperties: false required: - type title: GreedySamplingStrategy description: >- Greedy sampling strategy that selects the highest probability token at each step. JsonSchemaResponseFormat: type: object properties: type: type: string enum: - json_schema - grammar description: >- Must be "json_schema" to identify this format type const: json_schema default: json_schema json_schema: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- The JSON schema the response should conform to. In a Python SDK, this is often a `pydantic` model. additionalProperties: false required: - type - json_schema title: JsonSchemaResponseFormat description: >- Configuration for JSON schema-guided response generation. ResponseFormat: oneOf: - $ref: '#/components/schemas/JsonSchemaResponseFormat' - $ref: '#/components/schemas/GrammarResponseFormat' discriminator: propertyName: type mapping: json_schema: '#/components/schemas/JsonSchemaResponseFormat' grammar: '#/components/schemas/GrammarResponseFormat' SamplingParams: type: object properties: strategy: oneOf: - $ref: '#/components/schemas/GreedySamplingStrategy' - $ref: '#/components/schemas/TopPSamplingStrategy' - $ref: '#/components/schemas/TopKSamplingStrategy' discriminator: propertyName: type mapping: greedy: '#/components/schemas/GreedySamplingStrategy' top_p: '#/components/schemas/TopPSamplingStrategy' top_k: '#/components/schemas/TopKSamplingStrategy' description: The sampling strategy. max_tokens: type: integer default: 0 description: >- The maximum number of tokens that can be generated in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length. repetition_penalty: type: number default: 1.0 description: >- Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. stop: type: array items: type: string description: >- Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. additionalProperties: false required: - strategy title: SamplingParams description: Sampling parameters. ToolConfig: type: object properties: tool_choice: oneOf: - type: string enum: - auto - required - none title: ToolChoice description: >- Whether tool use is required or automatic. This is a hint to the model which may not be followed. It depends on the Instruction Following capabilities of the model. - type: string default: auto description: >- (Optional) Whether tool use is automatic, required, or none. Can also specify a tool name to use a specific tool. Defaults to ToolChoice.auto. tool_prompt_format: type: string enum: - json - function_tag - python_list description: >- (Optional) Instructs the model how to format tool calls. By default, Llama Stack will attempt to use a format that is best adapted to the model. - `ToolPromptFormat.json`: The tool calls are formatted as a JSON object. - `ToolPromptFormat.function_tag`: The tool calls are enclosed in a tag. - `ToolPromptFormat.python_list`: The tool calls are output as Python syntax -- a list of function calls. system_message_behavior: type: string enum: - append - replace description: >- (Optional) Config for how to override the default system prompt. - `SystemMessageBehavior.append`: Appends the provided system message to the default system prompt. - `SystemMessageBehavior.replace`: Replaces the default system prompt with the provided system message. The system message can include the string '{{function_definitions}}' to indicate where the function definitions should be inserted. default: append additionalProperties: false title: ToolConfig description: Configuration for tool use. ToolDef: type: object properties: name: type: string description: Name of the tool description: type: string description: >- (Optional) Human-readable description of what the tool does parameters: type: array items: $ref: '#/components/schemas/ToolParameter' description: >- (Optional) List of parameters this tool accepts metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) Additional metadata about the tool additionalProperties: false required: - name title: ToolDef description: >- Tool definition used in runtime contexts. ToolParameter: type: object properties: name: type: string description: Name of the parameter parameter_type: type: string description: >- Type of the parameter (e.g., string, integer) description: type: string description: >- Human-readable description of what the parameter does required: type: boolean default: true description: >- Whether this parameter is required for tool invocation items: type: object description: >- Type of the elements when parameter_type is array title: type: string description: (Optional) Title of the parameter default: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) Default value for the parameter if not provided additionalProperties: false required: - name - parameter_type - description - required title: ToolParameter description: Parameter definition for a tool. TopKSamplingStrategy: type: object properties: type: type: string const: top_k default: top_k description: >- Must be "top_k" to identify this sampling strategy top_k: type: integer description: >- Number of top tokens to consider for sampling. Must be at least 1 additionalProperties: false required: - type - top_k title: TopKSamplingStrategy description: >- Top-k sampling strategy that restricts sampling to the k most likely tokens. TopPSamplingStrategy: type: object properties: type: type: string const: top_p default: top_p description: >- Must be "top_p" to identify this sampling strategy temperature: type: number description: >- Controls randomness in sampling. Higher values increase randomness top_p: type: number default: 0.95 description: >- Cumulative probability threshold for nucleus sampling. Defaults to 0.95 additionalProperties: false required: - type title: TopPSamplingStrategy description: >- Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. CreateAgentRequest: type: object properties: agent_config: $ref: '#/components/schemas/AgentConfig' description: The configuration for the agent. additionalProperties: false required: - agent_config title: CreateAgentRequest AgentCreateResponse: type: object properties: agent_id: type: string description: Unique identifier for the created agent additionalProperties: false required: - agent_id title: AgentCreateResponse description: >- Response returned when creating a new agent. Agent: type: object properties: agent_id: type: string description: Unique identifier for the agent agent_config: $ref: '#/components/schemas/AgentConfig' description: Configuration settings for the agent created_at: type: string format: date-time description: Timestamp when the agent was created additionalProperties: false required: - agent_id - agent_config - created_at title: Agent description: >- An agent instance with configuration and metadata. CreateAgentSessionRequest: type: object properties: session_name: type: string description: The name of the session to create. additionalProperties: false required: - session_name title: CreateAgentSessionRequest AgentSessionCreateResponse: type: object properties: session_id: type: string description: >- Unique identifier for the created session additionalProperties: false required: - session_id title: AgentSessionCreateResponse description: >- Response returned when creating a new agent session. CompletionMessage: type: object properties: role: type: string const: assistant default: assistant description: >- Must be "assistant" to identify this as the model's response content: $ref: '#/components/schemas/InterleavedContent' description: The content of the model's response stop_reason: type: string enum: - end_of_turn - end_of_message - out_of_tokens description: >- Reason why the model stopped generating. Options are: - `StopReason.end_of_turn`: The model finished generating the entire response. - `StopReason.end_of_message`: The model finished generating but generated a partial response -- usually, a tool call. The user may call the tool and continue the conversation with the tool's response. - `StopReason.out_of_tokens`: The model ran out of token budget. tool_calls: type: array items: $ref: '#/components/schemas/ToolCall' description: >- List of tool calls. Each tool call is a ToolCall object. additionalProperties: false required: - role - content - stop_reason title: CompletionMessage description: >- A message containing the model's (assistant) response in a chat conversation. ImageContentItem: type: object properties: type: type: string const: image default: image description: >- Discriminator type of the content item. Always "image" image: type: object properties: url: $ref: '#/components/schemas/URL' description: >- A URL of the image or data URL in the format of data:image/{type};base64,{data}. Note that URL could have length limits. data: type: string contentEncoding: base64 description: base64 encoded image data as string additionalProperties: false description: >- Image as a base64 encoded string or an URL additionalProperties: false required: - type - image title: ImageContentItem description: A image content item InferenceStep: type: object properties: turn_id: type: string description: The ID of the turn. step_id: type: string description: The ID of the step. started_at: type: string format: date-time description: The time the step started. completed_at: type: string format: date-time description: The time the step completed. step_type: type: string enum: - inference - tool_execution - shield_call - memory_retrieval title: StepType description: Type of the step in an agent turn. const: inference default: inference model_response: $ref: '#/components/schemas/CompletionMessage' description: The response from the LLM. additionalProperties: false required: - turn_id - step_id - step_type - model_response title: InferenceStep description: An inference step in an agent turn. InterleavedContent: oneOf: - type: string - $ref: '#/components/schemas/InterleavedContentItem' - type: array items: $ref: '#/components/schemas/InterleavedContentItem' InterleavedContentItem: oneOf: - $ref: '#/components/schemas/ImageContentItem' - $ref: '#/components/schemas/TextContentItem' discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' MemoryRetrievalStep: type: object properties: turn_id: type: string description: The ID of the turn. step_id: type: string description: The ID of the step. started_at: type: string format: date-time description: The time the step started. completed_at: type: string format: date-time description: The time the step completed. step_type: type: string enum: - inference - tool_execution - shield_call - memory_retrieval title: StepType description: Type of the step in an agent turn. const: memory_retrieval default: memory_retrieval vector_db_ids: type: string description: >- The IDs of the vector databases to retrieve context from. inserted_context: $ref: '#/components/schemas/InterleavedContent' description: >- The context retrieved from the vector databases. additionalProperties: false required: - turn_id - step_id - step_type - vector_db_ids - inserted_context title: MemoryRetrievalStep description: >- A memory retrieval step in an agent turn. SafetyViolation: type: object properties: violation_level: $ref: '#/components/schemas/ViolationLevel' description: Severity level of the violation user_message: type: string description: >- (Optional) Message to convey to the user about the violation metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- Additional metadata including specific violation codes for debugging and telemetry additionalProperties: false required: - violation_level - metadata title: SafetyViolation description: >- Details of a safety violation detected by content moderation. Session: type: object properties: session_id: type: string description: >- Unique identifier for the conversation session session_name: type: string description: Human-readable name for the session turns: type: array items: $ref: '#/components/schemas/Turn' description: >- List of all turns that have occurred in this session started_at: type: string format: date-time description: Timestamp when the session was created additionalProperties: false required: - session_id - session_name - turns - started_at title: Session description: >- A single session of an interaction with an Agentic System. ShieldCallStep: type: object properties: turn_id: type: string description: The ID of the turn. step_id: type: string description: The ID of the step. started_at: type: string format: date-time description: The time the step started. completed_at: type: string format: date-time description: The time the step completed. step_type: type: string enum: - inference - tool_execution - shield_call - memory_retrieval title: StepType description: Type of the step in an agent turn. const: shield_call default: shield_call violation: $ref: '#/components/schemas/SafetyViolation' description: The violation from the shield call. additionalProperties: false required: - turn_id - step_id - step_type title: ShieldCallStep description: A shield call step in an agent turn. TextContentItem: type: object properties: type: type: string const: text default: text description: >- Discriminator type of the content item. Always "text" text: type: string description: Text content additionalProperties: false required: - type - text title: TextContentItem description: A text content item ToolCall: type: object properties: call_id: type: string tool_name: oneOf: - type: string enum: - brave_search - wolfram_alpha - photogen - code_interpreter title: BuiltinTool - type: string arguments: oneOf: - type: string - type: object additionalProperties: oneOf: - type: string - type: integer - type: number - type: boolean - type: 'null' - type: array items: oneOf: - type: string - type: integer - type: number - type: boolean - type: 'null' - type: object additionalProperties: oneOf: - type: string - type: integer - type: number - type: boolean - type: 'null' arguments_json: type: string additionalProperties: false required: - call_id - tool_name - arguments title: ToolCall ToolExecutionStep: type: object properties: turn_id: type: string description: The ID of the turn. step_id: type: string description: The ID of the step. started_at: type: string format: date-time description: The time the step started. completed_at: type: string format: date-time description: The time the step completed. step_type: type: string enum: - inference - tool_execution - shield_call - memory_retrieval title: StepType description: Type of the step in an agent turn. const: tool_execution default: tool_execution tool_calls: type: array items: $ref: '#/components/schemas/ToolCall' description: The tool calls to execute. tool_responses: type: array items: $ref: '#/components/schemas/ToolResponse' description: The tool responses from the tool calls. additionalProperties: false required: - turn_id - step_id - step_type - tool_calls - tool_responses title: ToolExecutionStep description: A tool execution step in an agent turn. ToolResponse: type: object properties: call_id: type: string description: >- Unique identifier for the tool call this response is for tool_name: oneOf: - type: string enum: - brave_search - wolfram_alpha - photogen - code_interpreter title: BuiltinTool - type: string description: Name of the tool that was invoked content: $ref: '#/components/schemas/InterleavedContent' description: The response content from the tool metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) Additional metadata about the tool response additionalProperties: false required: - call_id - tool_name - content title: ToolResponse description: Response from a tool invocation. ToolResponseMessage: type: object properties: role: type: string const: tool default: tool description: >- Must be "tool" to identify this as a tool response call_id: type: string description: >- Unique identifier for the tool call this response is for content: $ref: '#/components/schemas/InterleavedContent' description: The response content from the tool additionalProperties: false required: - role - call_id - content title: ToolResponseMessage description: >- A message representing the result of a tool invocation. Turn: type: object properties: turn_id: type: string description: >- Unique identifier for the turn within a session session_id: type: string description: >- Unique identifier for the conversation session input_messages: type: array items: oneOf: - $ref: '#/components/schemas/UserMessage' - $ref: '#/components/schemas/ToolResponseMessage' description: >- List of messages that initiated this turn steps: type: array items: oneOf: - $ref: '#/components/schemas/InferenceStep' - $ref: '#/components/schemas/ToolExecutionStep' - $ref: '#/components/schemas/ShieldCallStep' - $ref: '#/components/schemas/MemoryRetrievalStep' discriminator: propertyName: step_type mapping: inference: '#/components/schemas/InferenceStep' tool_execution: '#/components/schemas/ToolExecutionStep' shield_call: '#/components/schemas/ShieldCallStep' memory_retrieval: '#/components/schemas/MemoryRetrievalStep' description: >- Ordered list of processing steps executed during this turn output_message: $ref: '#/components/schemas/CompletionMessage' description: >- The model's generated response containing content and metadata output_attachments: type: array items: type: object properties: content: oneOf: - type: string - $ref: '#/components/schemas/InterleavedContentItem' - type: array items: $ref: '#/components/schemas/InterleavedContentItem' - $ref: '#/components/schemas/URL' description: The content of the attachment. mime_type: type: string description: The MIME type of the attachment. additionalProperties: false required: - content - mime_type title: Attachment description: An attachment to an agent turn. description: >- (Optional) Files or media attached to the agent's response started_at: type: string format: date-time description: Timestamp when the turn began completed_at: type: string format: date-time description: >- (Optional) Timestamp when the turn finished, if completed additionalProperties: false required: - turn_id - session_id - input_messages - steps - output_message - started_at title: Turn description: >- A single turn in an interaction with an Agentic System. URL: type: object properties: uri: type: string description: The URL string pointing to the resource additionalProperties: false required: - uri title: URL description: A URL reference to external content. UserMessage: type: object properties: role: type: string const: user default: user description: >- Must be "user" to identify this as a user message content: $ref: '#/components/schemas/InterleavedContent' description: >- The content of the message, which can include text and other media context: $ref: '#/components/schemas/InterleavedContent' description: >- (Optional) This field is used internally by Llama Stack to pass RAG context. This field may be removed in the API in the future. additionalProperties: false required: - role - content title: UserMessage description: >- A message from the user in a chat conversation. ViolationLevel: type: string enum: - info - warn - error title: ViolationLevel description: Severity level of a safety violation. CreateAgentTurnRequest: type: object properties: messages: type: array items: oneOf: - $ref: '#/components/schemas/UserMessage' - $ref: '#/components/schemas/ToolResponseMessage' description: List of messages to start the turn with. stream: type: boolean description: >- (Optional) If True, generate an SSE event stream of the response. Defaults to False. documents: type: array items: type: object properties: content: oneOf: - type: string - $ref: '#/components/schemas/InterleavedContentItem' - type: array items: $ref: '#/components/schemas/InterleavedContentItem' - $ref: '#/components/schemas/URL' description: The content of the document. mime_type: type: string description: The MIME type of the document. additionalProperties: false required: - content - mime_type title: Document description: A document to be used by an agent. description: >- (Optional) List of documents to create the turn with. toolgroups: type: array items: $ref: '#/components/schemas/AgentTool' description: >- (Optional) List of toolgroups to create the turn with, will be used in addition to the agent's config toolgroups for the request. tool_config: $ref: '#/components/schemas/ToolConfig' description: >- (Optional) The tool configuration to create the turn with, will be used to override the agent's tool_config. additionalProperties: false required: - messages title: CreateAgentTurnRequest AgentTurnResponseEvent: type: object properties: payload: oneOf: - $ref: '#/components/schemas/AgentTurnResponseStepStartPayload' - $ref: '#/components/schemas/AgentTurnResponseStepProgressPayload' - $ref: '#/components/schemas/AgentTurnResponseStepCompletePayload' - $ref: '#/components/schemas/AgentTurnResponseTurnStartPayload' - $ref: '#/components/schemas/AgentTurnResponseTurnCompletePayload' - $ref: '#/components/schemas/AgentTurnResponseTurnAwaitingInputPayload' discriminator: propertyName: event_type mapping: step_start: '#/components/schemas/AgentTurnResponseStepStartPayload' step_progress: '#/components/schemas/AgentTurnResponseStepProgressPayload' step_complete: '#/components/schemas/AgentTurnResponseStepCompletePayload' turn_start: '#/components/schemas/AgentTurnResponseTurnStartPayload' turn_complete: '#/components/schemas/AgentTurnResponseTurnCompletePayload' turn_awaiting_input: '#/components/schemas/AgentTurnResponseTurnAwaitingInputPayload' description: >- Event-specific payload containing event data additionalProperties: false required: - payload title: AgentTurnResponseEvent description: >- An event in an agent turn response stream. AgentTurnResponseStepCompletePayload: type: object properties: event_type: type: string enum: - step_start - step_complete - step_progress - turn_start - turn_complete - turn_awaiting_input const: step_complete default: step_complete description: Type of event being reported step_type: type: string enum: - inference - tool_execution - shield_call - memory_retrieval description: Type of step being executed step_id: type: string description: >- Unique identifier for the step within a turn step_details: oneOf: - $ref: '#/components/schemas/InferenceStep' - $ref: '#/components/schemas/ToolExecutionStep' - $ref: '#/components/schemas/ShieldCallStep' - $ref: '#/components/schemas/MemoryRetrievalStep' discriminator: propertyName: step_type mapping: inference: '#/components/schemas/InferenceStep' tool_execution: '#/components/schemas/ToolExecutionStep' shield_call: '#/components/schemas/ShieldCallStep' memory_retrieval: '#/components/schemas/MemoryRetrievalStep' description: Complete details of the executed step additionalProperties: false required: - event_type - step_type - step_id - step_details title: AgentTurnResponseStepCompletePayload description: >- Payload for step completion events in agent turn responses. AgentTurnResponseStepProgressPayload: type: object properties: event_type: type: string enum: - step_start - step_complete - step_progress - turn_start - turn_complete - turn_awaiting_input const: step_progress default: step_progress description: Type of event being reported step_type: type: string enum: - inference - tool_execution - shield_call - memory_retrieval description: Type of step being executed step_id: type: string description: >- Unique identifier for the step within a turn delta: oneOf: - $ref: '#/components/schemas/TextDelta' - $ref: '#/components/schemas/ImageDelta' - $ref: '#/components/schemas/ToolCallDelta' discriminator: propertyName: type mapping: text: '#/components/schemas/TextDelta' image: '#/components/schemas/ImageDelta' tool_call: '#/components/schemas/ToolCallDelta' description: >- Incremental content changes during step execution additionalProperties: false required: - event_type - step_type - step_id - delta title: AgentTurnResponseStepProgressPayload description: >- Payload for step progress events in agent turn responses. AgentTurnResponseStepStartPayload: type: object properties: event_type: type: string enum: - step_start - step_complete - step_progress - turn_start - turn_complete - turn_awaiting_input const: step_start default: step_start description: Type of event being reported step_type: type: string enum: - inference - tool_execution - shield_call - memory_retrieval description: Type of step being executed step_id: type: string description: >- Unique identifier for the step within a turn metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) Additional metadata for the step additionalProperties: false required: - event_type - step_type - step_id title: AgentTurnResponseStepStartPayload description: >- Payload for step start events in agent turn responses. AgentTurnResponseStreamChunk: type: object properties: event: $ref: '#/components/schemas/AgentTurnResponseEvent' description: >- Individual event in the agent turn response stream additionalProperties: false required: - event title: AgentTurnResponseStreamChunk description: Streamed agent turn completion response. "AgentTurnResponseTurnAwaitingInputPayload": type: object properties: event_type: type: string enum: - step_start - step_complete - step_progress - turn_start - turn_complete - turn_awaiting_input const: turn_awaiting_input default: turn_awaiting_input description: Type of event being reported turn: $ref: '#/components/schemas/Turn' description: >- Turn data when waiting for external tool responses additionalProperties: false required: - event_type - turn title: >- AgentTurnResponseTurnAwaitingInputPayload description: >- Payload for turn awaiting input events in agent turn responses. AgentTurnResponseTurnCompletePayload: type: object properties: event_type: type: string enum: - step_start - step_complete - step_progress - turn_start - turn_complete - turn_awaiting_input const: turn_complete default: turn_complete description: Type of event being reported turn: $ref: '#/components/schemas/Turn' description: >- Complete turn data including all steps and results additionalProperties: false required: - event_type - turn title: AgentTurnResponseTurnCompletePayload description: >- Payload for turn completion events in agent turn responses. AgentTurnResponseTurnStartPayload: type: object properties: event_type: type: string enum: - step_start - step_complete - step_progress - turn_start - turn_complete - turn_awaiting_input const: turn_start default: turn_start description: Type of event being reported turn_id: type: string description: >- Unique identifier for the turn within a session additionalProperties: false required: - event_type - turn_id title: AgentTurnResponseTurnStartPayload description: >- Payload for turn start events in agent turn responses. ImageDelta: type: object properties: type: type: string const: image default: image description: >- Discriminator type of the delta. Always "image" image: type: string contentEncoding: base64 description: The incremental image data as bytes additionalProperties: false required: - type - image title: ImageDelta description: >- An image content delta for streaming responses. TextDelta: type: object properties: type: type: string const: text default: text description: >- Discriminator type of the delta. Always "text" text: type: string description: The incremental text content additionalProperties: false required: - type - text title: TextDelta description: >- A text content delta for streaming responses. ToolCallDelta: type: object properties: type: type: string const: tool_call default: tool_call description: >- Discriminator type of the delta. Always "tool_call" tool_call: oneOf: - type: string - $ref: '#/components/schemas/ToolCall' description: >- Either an in-progress tool call string or the final parsed tool call parse_status: type: string enum: - started - in_progress - failed - succeeded description: Current parsing status of the tool call additionalProperties: false required: - type - tool_call - parse_status title: ToolCallDelta description: >- A tool call content delta for streaming responses. ResumeAgentTurnRequest: type: object properties: tool_responses: type: array items: $ref: '#/components/schemas/ToolResponse' description: >- The tool call responses to resume the turn with. stream: type: boolean description: Whether to stream the response. additionalProperties: false required: - tool_responses title: ResumeAgentTurnRequest AgentStepResponse: type: object properties: step: oneOf: - $ref: '#/components/schemas/InferenceStep' - $ref: '#/components/schemas/ToolExecutionStep' - $ref: '#/components/schemas/ShieldCallStep' - $ref: '#/components/schemas/MemoryRetrievalStep' discriminator: propertyName: step_type mapping: inference: '#/components/schemas/InferenceStep' tool_execution: '#/components/schemas/ToolExecutionStep' shield_call: '#/components/schemas/ShieldCallStep' memory_retrieval: '#/components/schemas/MemoryRetrievalStep' description: >- The complete step data and execution details additionalProperties: false required: - step title: AgentStepResponse description: >- Response containing details of a specific agent step. AppendRowsRequest: type: object properties: rows: type: array items: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: The rows to append to the dataset. additionalProperties: false required: - rows title: AppendRowsRequest Dataset: type: object properties: identifier: type: string provider_resource_id: type: string provider_id: type: string type: type: string enum: - model - shield - vector_db - dataset - scoring_function - benchmark - tool - tool_group - prompt const: dataset default: dataset description: >- Type of resource, always 'dataset' for datasets purpose: type: string enum: - post-training/messages - eval/question-answer - eval/messages-answer description: >- Purpose of the dataset indicating its intended use source: oneOf: - $ref: '#/components/schemas/URIDataSource' - $ref: '#/components/schemas/RowsDataSource' discriminator: propertyName: type mapping: uri: '#/components/schemas/URIDataSource' rows: '#/components/schemas/RowsDataSource' description: >- Data source configuration for the dataset metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: Additional metadata for the dataset additionalProperties: false required: - identifier - provider_id - type - purpose - source - metadata title: Dataset description: >- Dataset resource for storing and accessing training or evaluation data. RowsDataSource: type: object properties: type: type: string const: rows default: rows rows: type: array items: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- The dataset is stored in rows. E.g. - [ {"messages": [{"role": "user", "content": "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}]} ] additionalProperties: false required: - type - rows title: RowsDataSource description: A dataset stored in rows. URIDataSource: type: object properties: type: type: string const: uri default: uri uri: type: string description: >- The dataset can be obtained from a URI. E.g. - "https://mywebsite.com/mydata.jsonl" - "lsfs://mydata.jsonl" - "data:csv;base64,{base64_content}" additionalProperties: false required: - type - uri title: URIDataSource description: >- A dataset that can be obtained from a URI. ListDatasetsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Dataset' description: List of datasets additionalProperties: false required: - data title: ListDatasetsResponse description: Response from listing datasets. DataSource: oneOf: - $ref: '#/components/schemas/URIDataSource' - $ref: '#/components/schemas/RowsDataSource' discriminator: propertyName: type mapping: uri: '#/components/schemas/URIDataSource' rows: '#/components/schemas/RowsDataSource' RegisterDatasetRequest: type: object properties: purpose: type: string enum: - post-training/messages - eval/question-answer - eval/messages-answer description: >- The purpose of the dataset. One of: - "post-training/messages": The dataset contains a messages column with list of messages for post-training. { "messages": [ {"role": "user", "content": "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}, ] } - "eval/question-answer": The dataset contains a question column and an answer column for evaluation. { "question": "What is the capital of France?", "answer": "Paris" } - "eval/messages-answer": The dataset contains a messages column with list of messages and an answer column for evaluation. { "messages": [ {"role": "user", "content": "Hello, my name is John Doe."}, {"role": "assistant", "content": "Hello, John Doe. How can I help you today?"}, {"role": "user", "content": "What's my name?"}, ], "answer": "John Doe" } source: $ref: '#/components/schemas/DataSource' description: >- The data source of the dataset. Ensure that the data source schema is compatible with the purpose of the dataset. Examples: - { "type": "uri", "uri": "https://mywebsite.com/mydata.jsonl" } - { "type": "uri", "uri": "lsfs://mydata.jsonl" } - { "type": "uri", "uri": "data:csv;base64,{base64_content}" } - { "type": "uri", "uri": "huggingface://llamastack/simpleqa?split=train" } - { "type": "rows", "rows": [ { "messages": [ {"role": "user", "content": "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}, ] } ] } metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- The metadata for the dataset. - E.g. {"description": "My dataset"}. dataset_id: type: string description: >- The ID of the dataset. If not provided, an ID will be generated. additionalProperties: false required: - purpose - source title: RegisterDatasetRequest Benchmark: type: object properties: identifier: type: string provider_resource_id: type: string provider_id: type: string type: type: string enum: - model - shield - vector_db - dataset - scoring_function - benchmark - tool - tool_group - prompt const: benchmark default: benchmark description: The resource type, always benchmark dataset_id: type: string description: >- Identifier of the dataset to use for the benchmark evaluation scoring_functions: type: array items: type: string description: >- List of scoring function identifiers to apply during evaluation metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: Metadata for this evaluation task additionalProperties: false required: - identifier - provider_id - type - dataset_id - scoring_functions - metadata title: Benchmark description: >- A benchmark resource for evaluating model performance. ListBenchmarksResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Benchmark' additionalProperties: false required: - data title: ListBenchmarksResponse RegisterBenchmarkRequest: type: object properties: benchmark_id: type: string description: The ID of the benchmark to register. dataset_id: type: string description: >- The ID of the dataset to use for the benchmark. scoring_functions: type: array items: type: string description: >- The scoring functions to use for the benchmark. provider_benchmark_id: type: string description: >- The ID of the provider benchmark to use for the benchmark. provider_id: type: string description: >- The ID of the provider to use for the benchmark. metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: The metadata to use for the benchmark. additionalProperties: false required: - benchmark_id - dataset_id - scoring_functions title: RegisterBenchmarkRequest AgentCandidate: type: object properties: type: type: string const: agent default: agent config: $ref: '#/components/schemas/AgentConfig' description: >- The configuration for the agent candidate. additionalProperties: false required: - type - config title: AgentCandidate description: An agent candidate for evaluation. AggregationFunctionType: type: string enum: - average - weighted_average - median - categorical_count - accuracy title: AggregationFunctionType description: >- Types of aggregation functions for scoring results. BasicScoringFnParams: type: object properties: type: $ref: '#/components/schemas/ScoringFnParamsType' const: basic default: basic description: >- The type of scoring function parameters, always basic aggregation_functions: type: array items: $ref: '#/components/schemas/AggregationFunctionType' description: >- Aggregation functions to apply to the scores of each row additionalProperties: false required: - type - aggregation_functions title: BasicScoringFnParams description: >- Parameters for basic scoring function configuration. BenchmarkConfig: type: object properties: eval_candidate: oneOf: - $ref: '#/components/schemas/ModelCandidate' - $ref: '#/components/schemas/AgentCandidate' discriminator: propertyName: type mapping: model: '#/components/schemas/ModelCandidate' agent: '#/components/schemas/AgentCandidate' description: The candidate to evaluate. scoring_params: type: object additionalProperties: $ref: '#/components/schemas/ScoringFnParams' description: >- Map between scoring function id and parameters for each scoring function you want to run num_examples: type: integer description: >- (Optional) The number of examples to evaluate. If not provided, all examples in the dataset will be evaluated additionalProperties: false required: - eval_candidate - scoring_params title: BenchmarkConfig description: >- A benchmark configuration for evaluation. LLMAsJudgeScoringFnParams: type: object properties: type: $ref: '#/components/schemas/ScoringFnParamsType' const: llm_as_judge default: llm_as_judge description: >- The type of scoring function parameters, always llm_as_judge judge_model: type: string description: >- Identifier of the LLM model to use as a judge for scoring prompt_template: type: string description: >- (Optional) Custom prompt template for the judge model judge_score_regexes: type: array items: type: string description: >- Regexes to extract the answer from generated response aggregation_functions: type: array items: $ref: '#/components/schemas/AggregationFunctionType' description: >- Aggregation functions to apply to the scores of each row additionalProperties: false required: - type - judge_model - judge_score_regexes - aggregation_functions title: LLMAsJudgeScoringFnParams description: >- Parameters for LLM-as-judge scoring function configuration. ModelCandidate: type: object properties: type: type: string const: model default: model model: type: string description: The model ID to evaluate. sampling_params: $ref: '#/components/schemas/SamplingParams' description: The sampling parameters for the model. system_message: $ref: '#/components/schemas/SystemMessage' description: >- (Optional) The system message providing instructions or context to the model. additionalProperties: false required: - type - model - sampling_params title: ModelCandidate description: A model candidate for evaluation. RegexParserScoringFnParams: type: object properties: type: $ref: '#/components/schemas/ScoringFnParamsType' const: regex_parser default: regex_parser description: >- The type of scoring function parameters, always regex_parser parsing_regexes: type: array items: type: string description: >- Regex to extract the answer from generated response aggregation_functions: type: array items: $ref: '#/components/schemas/AggregationFunctionType' description: >- Aggregation functions to apply to the scores of each row additionalProperties: false required: - type - parsing_regexes - aggregation_functions title: RegexParserScoringFnParams description: >- Parameters for regex parser scoring function configuration. ScoringFnParams: oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' - $ref: '#/components/schemas/RegexParserScoringFnParams' - $ref: '#/components/schemas/BasicScoringFnParams' discriminator: propertyName: type mapping: llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' regex_parser: '#/components/schemas/RegexParserScoringFnParams' basic: '#/components/schemas/BasicScoringFnParams' ScoringFnParamsType: type: string enum: - llm_as_judge - regex_parser - basic title: ScoringFnParamsType description: >- Types of scoring function parameter configurations. SystemMessage: type: object properties: role: type: string const: system default: system description: >- Must be "system" to identify this as a system message content: $ref: '#/components/schemas/InterleavedContent' description: >- The content of the "system prompt". If multiple system messages are provided, they are concatenated. The underlying Llama Stack code may also add other system messages (for example, for formatting tool definitions). additionalProperties: false required: - role - content title: SystemMessage description: >- A system message providing instructions or context to the model. EvaluateRowsRequest: type: object properties: input_rows: type: array items: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: The rows to evaluate. scoring_functions: type: array items: type: string description: >- The scoring functions to use for the evaluation. benchmark_config: $ref: '#/components/schemas/BenchmarkConfig' description: The configuration for the benchmark. additionalProperties: false required: - input_rows - scoring_functions - benchmark_config title: EvaluateRowsRequest EvaluateResponse: type: object properties: generations: type: array items: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: The generations from the evaluation. scores: type: object additionalProperties: $ref: '#/components/schemas/ScoringResult' description: The scores from the evaluation. additionalProperties: false required: - generations - scores title: EvaluateResponse description: The response from an evaluation. ScoringResult: type: object properties: score_rows: type: array items: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- The scoring result for each row. Each row is a map of column name to value. aggregated_results: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: Map of metric name to aggregated value additionalProperties: false required: - score_rows - aggregated_results title: ScoringResult description: A scoring result for a single row. RunEvalRequest: type: object properties: benchmark_config: $ref: '#/components/schemas/BenchmarkConfig' description: The configuration for the benchmark. additionalProperties: false required: - benchmark_config title: RunEvalRequest Job: type: object properties: job_id: type: string description: Unique identifier for the job status: type: string enum: - completed - in_progress - failed - scheduled - cancelled description: Current execution status of the job additionalProperties: false required: - job_id - status title: Job description: >- A job execution instance with status tracking. Order: type: string enum: - asc - desc title: Order description: Sort order for paginated responses. ListOpenAIChatCompletionResponse: type: object properties: data: type: array items: type: object properties: id: type: string description: The ID of the chat completion choices: type: array items: $ref: '#/components/schemas/OpenAIChoice' description: List of choices object: type: string const: chat.completion default: chat.completion description: >- The object type, which will be "chat.completion" created: type: integer description: >- The Unix timestamp in seconds when the chat completion was created model: type: string description: >- The model that was used to generate the chat completion input_messages: type: array items: $ref: '#/components/schemas/OpenAIMessageParam' additionalProperties: false required: - id - choices - object - created - model - input_messages title: OpenAICompletionWithInputMessages description: >- List of chat completion objects with their input messages has_more: type: boolean description: >- Whether there are more completions available beyond this list first_id: type: string description: ID of the first completion in this list last_id: type: string description: ID of the last completion in this list object: type: string const: list default: list description: >- Must be "list" to identify this as a list response additionalProperties: false required: - data - has_more - first_id - last_id - object title: ListOpenAIChatCompletionResponse description: >- Response from listing OpenAI-compatible chat completions. OpenAIAssistantMessageParam: type: object properties: role: type: string const: assistant default: assistant description: >- Must be "assistant" to identify this as the model's response content: oneOf: - type: string - type: array items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' description: The content of the model's response name: type: string description: >- (Optional) The name of the assistant message participant. tool_calls: type: array items: $ref: '#/components/schemas/OpenAIChatCompletionToolCall' description: >- List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object. additionalProperties: false required: - role title: OpenAIAssistantMessageParam description: >- A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. "OpenAIChatCompletionContentPartImageParam": type: object properties: type: type: string const: image_url default: image_url description: >- Must be "image_url" to identify this as image content image_url: $ref: '#/components/schemas/OpenAIImageURL' description: >- Image URL specification and processing details additionalProperties: false required: - type - image_url title: >- OpenAIChatCompletionContentPartImageParam description: >- Image content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionContentPartParam: oneOf: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' - $ref: '#/components/schemas/OpenAIFile' discriminator: propertyName: type mapping: text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' file: '#/components/schemas/OpenAIFile' OpenAIChatCompletionContentPartTextParam: type: object properties: type: type: string const: text default: text description: >- Must be "text" to identify this as text content text: type: string description: The text content of the message additionalProperties: false required: - type - text title: OpenAIChatCompletionContentPartTextParam description: >- Text content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionToolCall: type: object properties: index: type: integer description: >- (Optional) Index of the tool call in the list id: type: string description: >- (Optional) Unique identifier for the tool call type: type: string const: function default: function description: >- Must be "function" to identify this as a function call function: $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' description: (Optional) Function call details additionalProperties: false required: - type title: OpenAIChatCompletionToolCall description: >- Tool call specification for OpenAI-compatible chat completion responses. OpenAIChatCompletionToolCallFunction: type: object properties: name: type: string description: (Optional) Name of the function to call arguments: type: string description: >- (Optional) Arguments to pass to the function as a JSON string additionalProperties: false title: OpenAIChatCompletionToolCallFunction description: >- Function call details for OpenAI-compatible tool calls. OpenAIChoice: type: object properties: message: oneOf: - $ref: '#/components/schemas/OpenAIUserMessageParam' - $ref: '#/components/schemas/OpenAISystemMessageParam' - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - $ref: '#/components/schemas/OpenAIToolMessageParam' - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' discriminator: propertyName: role mapping: user: '#/components/schemas/OpenAIUserMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' assistant: '#/components/schemas/OpenAIAssistantMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' developer: '#/components/schemas/OpenAIDeveloperMessageParam' description: The message from the model finish_reason: type: string description: The reason the model stopped generating index: type: integer description: The index of the choice logprobs: $ref: '#/components/schemas/OpenAIChoiceLogprobs' description: >- (Optional) The log probabilities for the tokens in the message additionalProperties: false required: - message - finish_reason - index title: OpenAIChoice description: >- A choice from an OpenAI-compatible chat completion response. OpenAIChoiceLogprobs: type: object properties: content: type: array items: $ref: '#/components/schemas/OpenAITokenLogProb' description: >- (Optional) The log probabilities for the tokens in the message refusal: type: array items: $ref: '#/components/schemas/OpenAITokenLogProb' description: >- (Optional) The log probabilities for the tokens in the message additionalProperties: false title: OpenAIChoiceLogprobs description: >- The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. OpenAIDeveloperMessageParam: type: object properties: role: type: string const: developer default: developer description: >- Must be "developer" to identify this as a developer message content: oneOf: - type: string - type: array items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' description: The content of the developer message name: type: string description: >- (Optional) The name of the developer message participant. additionalProperties: false required: - role - content title: OpenAIDeveloperMessageParam description: >- A message from the developer in an OpenAI-compatible chat completion request. OpenAIFile: type: object properties: type: type: string const: file default: file file: $ref: '#/components/schemas/OpenAIFileFile' additionalProperties: false required: - type - file title: OpenAIFile OpenAIFileFile: type: object properties: file_data: type: string file_id: type: string filename: type: string additionalProperties: false title: OpenAIFileFile OpenAIImageURL: type: object properties: url: type: string description: >- URL of the image to include in the message detail: type: string description: >- (Optional) Level of detail for image processing. Can be "low", "high", or "auto" additionalProperties: false required: - url title: OpenAIImageURL description: >- Image URL specification for OpenAI-compatible chat completion messages. OpenAIMessageParam: oneOf: - $ref: '#/components/schemas/OpenAIUserMessageParam' - $ref: '#/components/schemas/OpenAISystemMessageParam' - $ref: '#/components/schemas/OpenAIAssistantMessageParam' - $ref: '#/components/schemas/OpenAIToolMessageParam' - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' discriminator: propertyName: role mapping: user: '#/components/schemas/OpenAIUserMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' assistant: '#/components/schemas/OpenAIAssistantMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' developer: '#/components/schemas/OpenAIDeveloperMessageParam' OpenAISystemMessageParam: type: object properties: role: type: string const: system default: system description: >- Must be "system" to identify this as a system message content: oneOf: - type: string - type: array items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' description: >- The content of the "system prompt". If multiple system messages are provided, they are concatenated. The underlying Llama Stack code may also add other system messages (for example, for formatting tool definitions). name: type: string description: >- (Optional) The name of the system message participant. additionalProperties: false required: - role - content title: OpenAISystemMessageParam description: >- A system message providing instructions or context to the model. OpenAITokenLogProb: type: object properties: token: type: string bytes: type: array items: type: integer logprob: type: number top_logprobs: type: array items: $ref: '#/components/schemas/OpenAITopLogProb' additionalProperties: false required: - token - logprob - top_logprobs title: OpenAITokenLogProb description: >- The log probability for a token from an OpenAI-compatible chat completion response. OpenAIToolMessageParam: type: object properties: role: type: string const: tool default: tool description: >- Must be "tool" to identify this as a tool response tool_call_id: type: string description: >- Unique identifier for the tool call this response is for content: oneOf: - type: string - type: array items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' description: The response content from the tool additionalProperties: false required: - role - tool_call_id - content title: OpenAIToolMessageParam description: >- A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. OpenAITopLogProb: type: object properties: token: type: string bytes: type: array items: type: integer logprob: type: number additionalProperties: false required: - token - logprob title: OpenAITopLogProb description: >- The top log probability for a token from an OpenAI-compatible chat completion response. OpenAIUserMessageParam: type: object properties: role: type: string const: user default: user description: >- Must be "user" to identify this as a user message content: oneOf: - type: string - type: array items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartParam' description: >- The content of the message, which can include text and other media name: type: string description: >- (Optional) The name of the user message participant. additionalProperties: false required: - role - content title: OpenAIUserMessageParam description: >- A message from the user in an OpenAI-compatible chat completion request. OpenAIJSONSchema: type: object properties: name: type: string description: Name of the schema description: type: string description: (Optional) Description of the schema strict: type: boolean description: >- (Optional) Whether to enforce strict adherence to the schema schema: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: (Optional) The JSON schema definition additionalProperties: false required: - name title: OpenAIJSONSchema description: >- JSON schema specification for OpenAI-compatible structured response format. OpenAIResponseFormatJSONObject: type: object properties: type: type: string const: json_object default: json_object description: >- Must be "json_object" to indicate generic JSON object response format additionalProperties: false required: - type title: OpenAIResponseFormatJSONObject description: >- JSON object response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatJSONSchema: type: object properties: type: type: string const: json_schema default: json_schema description: >- Must be "json_schema" to indicate structured JSON response format json_schema: $ref: '#/components/schemas/OpenAIJSONSchema' description: >- The JSON schema specification for the response additionalProperties: false required: - type - json_schema title: OpenAIResponseFormatJSONSchema description: >- JSON schema response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatParam: oneOf: - $ref: '#/components/schemas/OpenAIResponseFormatText' - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' discriminator: propertyName: type mapping: text: '#/components/schemas/OpenAIResponseFormatText' json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' OpenAIResponseFormatText: type: object properties: type: type: string const: text default: text description: >- Must be "text" to indicate plain text response format additionalProperties: false required: - type title: OpenAIResponseFormatText description: >- Text response format for OpenAI-compatible chat completion requests. OpenaiChatCompletionRequest: type: object properties: model: type: string description: >- The identifier of the model to use. The model must be registered with Llama Stack and available via the /models endpoint. messages: type: array items: $ref: '#/components/schemas/OpenAIMessageParam' description: List of messages in the conversation. frequency_penalty: type: number description: >- (Optional) The penalty for repeated tokens. function_call: oneOf: - type: string - type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: (Optional) The function call to use. functions: type: array items: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: (Optional) List of functions to use. logit_bias: type: object additionalProperties: type: number description: (Optional) The logit bias to use. logprobs: type: boolean description: (Optional) The log probabilities to use. max_completion_tokens: type: integer description: >- (Optional) The maximum number of tokens to generate. max_tokens: type: integer description: >- (Optional) The maximum number of tokens to generate. n: type: integer description: >- (Optional) The number of completions to generate. parallel_tool_calls: type: boolean description: >- (Optional) Whether to parallelize tool calls. presence_penalty: type: number description: >- (Optional) The penalty for repeated tokens. response_format: $ref: '#/components/schemas/OpenAIResponseFormatParam' description: (Optional) The response format to use. seed: type: integer description: (Optional) The seed to use. stop: oneOf: - type: string - type: array items: type: string description: (Optional) The stop tokens to use. stream: type: boolean description: >- (Optional) Whether to stream the response. stream_options: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: (Optional) The stream options to use. temperature: type: number description: (Optional) The temperature to use. tool_choice: oneOf: - type: string - type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: (Optional) The tool choice to use. tools: type: array items: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: (Optional) The tools to use. top_logprobs: type: integer description: >- (Optional) The top log probabilities to use. top_p: type: number description: (Optional) The top p to use. user: type: string description: (Optional) The user to use. additionalProperties: false required: - model - messages title: OpenaiChatCompletionRequest OpenAIChatCompletion: type: object properties: id: type: string description: The ID of the chat completion choices: type: array items: $ref: '#/components/schemas/OpenAIChoice' description: List of choices object: type: string const: chat.completion default: chat.completion description: >- The object type, which will be "chat.completion" created: type: integer description: >- The Unix timestamp in seconds when the chat completion was created model: type: string description: >- The model that was used to generate the chat completion additionalProperties: false required: - id - choices - object - created - model title: OpenAIChatCompletion description: >- Response from an OpenAI-compatible chat completion request. OpenAIChatCompletionChunk: type: object properties: id: type: string description: The ID of the chat completion choices: type: array items: $ref: '#/components/schemas/OpenAIChunkChoice' description: List of choices object: type: string const: chat.completion.chunk default: chat.completion.chunk description: >- The object type, which will be "chat.completion.chunk" created: type: integer description: >- The Unix timestamp in seconds when the chat completion was created model: type: string description: >- The model that was used to generate the chat completion additionalProperties: false required: - id - choices - object - created - model title: OpenAIChatCompletionChunk description: >- Chunk from a streaming response to an OpenAI-compatible chat completion request. OpenAIChoiceDelta: type: object properties: content: type: string description: (Optional) The content of the delta refusal: type: string description: (Optional) The refusal of the delta role: type: string description: (Optional) The role of the delta tool_calls: type: array items: $ref: '#/components/schemas/OpenAIChatCompletionToolCall' description: (Optional) The tool calls of the delta additionalProperties: false title: OpenAIChoiceDelta description: >- A delta from an OpenAI-compatible chat completion streaming response. OpenAIChunkChoice: type: object properties: delta: $ref: '#/components/schemas/OpenAIChoiceDelta' description: The delta from the chunk finish_reason: type: string description: The reason the model stopped generating index: type: integer description: The index of the choice logprobs: $ref: '#/components/schemas/OpenAIChoiceLogprobs' description: >- (Optional) The log probabilities for the tokens in the message additionalProperties: false required: - delta - finish_reason - index title: OpenAIChunkChoice description: >- A chunk choice from an OpenAI-compatible chat completion streaming response. OpenAICompletionWithInputMessages: type: object properties: id: type: string description: The ID of the chat completion choices: type: array items: $ref: '#/components/schemas/OpenAIChoice' description: List of choices object: type: string const: chat.completion default: chat.completion description: >- The object type, which will be "chat.completion" created: type: integer description: >- The Unix timestamp in seconds when the chat completion was created model: type: string description: >- The model that was used to generate the chat completion input_messages: type: array items: $ref: '#/components/schemas/OpenAIMessageParam' additionalProperties: false required: - id - choices - object - created - model - input_messages title: OpenAICompletionWithInputMessages OpenaiCompletionRequest: type: object properties: model: type: string description: >- The identifier of the model to use. The model must be registered with Llama Stack and available via the /models endpoint. prompt: oneOf: - type: string - type: array items: type: string - type: array items: type: integer - type: array items: type: array items: type: integer description: The prompt to generate a completion for. best_of: type: integer description: >- (Optional) The number of completions to generate. echo: type: boolean description: (Optional) Whether to echo the prompt. frequency_penalty: type: number description: >- (Optional) The penalty for repeated tokens. logit_bias: type: object additionalProperties: type: number description: (Optional) The logit bias to use. logprobs: type: boolean description: (Optional) The log probabilities to use. max_tokens: type: integer description: >- (Optional) The maximum number of tokens to generate. n: type: integer description: >- (Optional) The number of completions to generate. presence_penalty: type: number description: >- (Optional) The penalty for repeated tokens. seed: type: integer description: (Optional) The seed to use. stop: oneOf: - type: string - type: array items: type: string description: (Optional) The stop tokens to use. stream: type: boolean description: >- (Optional) Whether to stream the response. stream_options: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: (Optional) The stream options to use. temperature: type: number description: (Optional) The temperature to use. top_p: type: number description: (Optional) The top p to use. user: type: string description: (Optional) The user to use. guided_choice: type: array items: type: string prompt_logprobs: type: integer suffix: type: string description: >- (Optional) The suffix that should be appended to the completion. additionalProperties: false required: - model - prompt title: OpenaiCompletionRequest OpenAICompletion: type: object properties: id: type: string choices: type: array items: $ref: '#/components/schemas/OpenAICompletionChoice' created: type: integer model: type: string object: type: string const: text_completion default: text_completion additionalProperties: false required: - id - choices - created - model - object title: OpenAICompletion description: >- Response from an OpenAI-compatible completion request. OpenAICompletionChoice: type: object properties: finish_reason: type: string text: type: string index: type: integer logprobs: $ref: '#/components/schemas/OpenAIChoiceLogprobs' additionalProperties: false required: - finish_reason - text - index title: OpenAICompletionChoice description: >- A choice from an OpenAI-compatible completion response. OpenaiEmbeddingsRequest: type: object properties: model: type: string description: >- The identifier of the model to use. The model must be an embedding model registered with Llama Stack and available via the /models endpoint. input: oneOf: - type: string - type: array items: type: string description: >- Input text to embed, encoded as a string or array of strings. To embed multiple inputs in a single request, pass an array of strings. encoding_format: type: string description: >- (Optional) The format to return the embeddings in. Can be either "float" or "base64". Defaults to "float". dimensions: type: integer description: >- (Optional) The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models. user: type: string description: >- (Optional) A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. additionalProperties: false required: - model - input title: OpenaiEmbeddingsRequest OpenAIEmbeddingData: type: object properties: object: type: string const: embedding default: embedding description: >- The object type, which will be "embedding" embedding: oneOf: - type: array items: type: number - type: string description: >- The embedding vector as a list of floats (when encoding_format="float") or as a base64-encoded string (when encoding_format="base64") index: type: integer description: >- The index of the embedding in the input list additionalProperties: false required: - object - embedding - index title: OpenAIEmbeddingData description: >- A single embedding data object from an OpenAI-compatible embeddings response. OpenAIEmbeddingUsage: type: object properties: prompt_tokens: type: integer description: The number of tokens in the input total_tokens: type: integer description: The total number of tokens used additionalProperties: false required: - prompt_tokens - total_tokens title: OpenAIEmbeddingUsage description: >- Usage information for an OpenAI-compatible embeddings response. OpenAIEmbeddingsResponse: type: object properties: object: type: string const: list default: list description: The object type, which will be "list" data: type: array items: $ref: '#/components/schemas/OpenAIEmbeddingData' description: List of embedding data objects model: type: string description: >- The model that was used to generate the embeddings usage: $ref: '#/components/schemas/OpenAIEmbeddingUsage' description: Usage information additionalProperties: false required: - object - data - model - usage title: OpenAIEmbeddingsResponse description: >- Response from an OpenAI-compatible embeddings request. OpenAIFilePurpose: type: string enum: - assistants - batch title: OpenAIFilePurpose description: >- Valid purpose values for OpenAI Files API. ListOpenAIFileResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/OpenAIFileObject' description: List of file objects has_more: type: boolean description: >- Whether there are more files available beyond this page first_id: type: string description: >- ID of the first file in the list for pagination last_id: type: string description: >- ID of the last file in the list for pagination object: type: string const: list default: list description: The object type, which is always "list" additionalProperties: false required: - data - has_more - first_id - last_id - object title: ListOpenAIFileResponse description: >- Response for listing files in OpenAI Files API. OpenAIFileObject: type: object properties: object: type: string const: file default: file description: The object type, which is always "file" id: type: string description: >- The file identifier, which can be referenced in the API endpoints bytes: type: integer description: The size of the file, in bytes created_at: type: integer description: >- The Unix timestamp (in seconds) for when the file was created expires_at: type: integer description: >- The Unix timestamp (in seconds) for when the file expires filename: type: string description: The name of the file purpose: type: string enum: - assistants - batch description: The intended purpose of the file additionalProperties: false required: - object - id - bytes - created_at - expires_at - filename - purpose title: OpenAIFileObject description: >- OpenAI File object as defined in the OpenAI Files API. ExpiresAfter: type: object properties: anchor: type: string const: created_at seconds: type: integer additionalProperties: false required: - anchor - seconds title: ExpiresAfter description: >- Control expiration of uploaded files. Params: - anchor, must be "created_at" - seconds, must be int between 3600 and 2592000 (1 hour to 30 days) OpenAIFileDeleteResponse: type: object properties: id: type: string description: The file identifier that was deleted object: type: string const: file default: file description: The object type, which is always "file" deleted: type: boolean description: >- Whether the file was successfully deleted additionalProperties: false required: - id - object - deleted title: OpenAIFileDeleteResponse description: >- Response for deleting a file in OpenAI Files API. Response: type: object title: Response OpenAIModel: type: object properties: id: type: string object: type: string const: model default: model created: type: integer owned_by: type: string additionalProperties: false required: - id - object - created - owned_by title: OpenAIModel description: A model from OpenAI. OpenAIListModelsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/OpenAIModel' additionalProperties: false required: - data title: OpenAIListModelsResponse RunModerationRequest: type: object properties: input: oneOf: - type: string - type: array items: type: string description: >- Input (or inputs) to classify. Can be a single string, an array of strings, or an array of multi-modal input objects similar to other models. model: type: string description: >- The content moderation model you would like to use. additionalProperties: false required: - input - model title: RunModerationRequest ModerationObject: type: object properties: id: type: string description: >- The unique identifier for the moderation request. model: type: string description: >- The model used to generate the moderation results. results: type: array items: $ref: '#/components/schemas/ModerationObjectResults' description: A list of moderation objects additionalProperties: false required: - id - model - results title: ModerationObject description: A moderation object. ModerationObjectResults: type: object properties: flagged: type: boolean description: >- Whether any of the below categories are flagged. categories: type: object additionalProperties: type: boolean description: >- A list of the categories, and whether they are flagged or not. category_applied_input_types: type: object additionalProperties: type: array items: type: string description: >- A list of the categories along with the input type(s) that the score applies to. category_scores: type: object additionalProperties: type: number description: >- A list of the categories along with their scores as predicted by model. user_message: type: string metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object additionalProperties: false required: - flagged - metadata title: ModerationObjectResults description: A moderation object. ListOpenAIResponseObject: type: object properties: data: type: array items: $ref: '#/components/schemas/OpenAIResponseObjectWithInput' description: >- List of response objects with their input context has_more: type: boolean description: >- Whether there are more results available beyond this page first_id: type: string description: >- Identifier of the first item in this page last_id: type: string description: Identifier of the last item in this page object: type: string const: list default: list description: Object type identifier, always "list" additionalProperties: false required: - data - has_more - first_id - last_id - object title: ListOpenAIResponseObject description: >- Paginated list of OpenAI response objects with navigation metadata. OpenAIResponseAnnotationCitation: type: object properties: type: type: string const: url_citation default: url_citation description: >- Annotation type identifier, always "url_citation" end_index: type: integer description: >- End position of the citation span in the content start_index: type: integer description: >- Start position of the citation span in the content title: type: string description: Title of the referenced web resource url: type: string description: URL of the referenced web resource additionalProperties: false required: - type - end_index - start_index - title - url title: OpenAIResponseAnnotationCitation description: >- URL citation annotation for referencing external web resources. "OpenAIResponseAnnotationContainerFileCitation": type: object properties: type: type: string const: container_file_citation default: container_file_citation container_id: type: string end_index: type: integer file_id: type: string filename: type: string start_index: type: integer additionalProperties: false required: - type - container_id - end_index - file_id - filename - start_index title: >- OpenAIResponseAnnotationContainerFileCitation OpenAIResponseAnnotationFileCitation: type: object properties: type: type: string const: file_citation default: file_citation description: >- Annotation type identifier, always "file_citation" file_id: type: string description: Unique identifier of the referenced file filename: type: string description: Name of the referenced file index: type: integer description: >- Position index of the citation within the content additionalProperties: false required: - type - file_id - filename - index title: OpenAIResponseAnnotationFileCitation description: >- File citation annotation for referencing specific files in response content. OpenAIResponseAnnotationFilePath: type: object properties: type: type: string const: file_path default: file_path file_id: type: string index: type: integer additionalProperties: false required: - type - file_id - index title: OpenAIResponseAnnotationFilePath OpenAIResponseAnnotations: oneOf: - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' discriminator: propertyName: type mapping: file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' OpenAIResponseError: type: object properties: code: type: string description: >- Error code identifying the type of failure message: type: string description: >- Human-readable error message describing the failure additionalProperties: false required: - code - message title: OpenAIResponseError description: >- Error details for failed OpenAI response requests. OpenAIResponseInput: oneOf: - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - $ref: '#/components/schemas/OpenAIResponseMessage' "OpenAIResponseInputFunctionToolCallOutput": type: object properties: call_id: type: string output: type: string type: type: string const: function_call_output default: function_call_output id: type: string status: type: string additionalProperties: false required: - call_id - output - type title: >- OpenAIResponseInputFunctionToolCallOutput description: >- This represents the output of a function call that gets passed back to the model. OpenAIResponseInputMessageContent: oneOf: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' discriminator: propertyName: type mapping: input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' OpenAIResponseInputMessageContentImage: type: object properties: detail: oneOf: - type: string const: low - type: string const: high - type: string const: auto default: auto description: >- Level of detail for image processing, can be "low", "high", or "auto" type: type: string const: input_image default: input_image description: >- Content type identifier, always "input_image" image_url: type: string description: (Optional) URL of the image content additionalProperties: false required: - detail - type title: OpenAIResponseInputMessageContentImage description: >- Image content for input messages in OpenAI response format. OpenAIResponseInputMessageContentText: type: object properties: text: type: string description: The text content of the input message type: type: string const: input_text default: input_text description: >- Content type identifier, always "input_text" additionalProperties: false required: - text - type title: OpenAIResponseInputMessageContentText description: >- Text content for input messages in OpenAI response format. OpenAIResponseMCPApprovalRequest: type: object properties: arguments: type: string id: type: string name: type: string server_label: type: string type: type: string const: mcp_approval_request default: mcp_approval_request additionalProperties: false required: - arguments - id - name - server_label - type title: OpenAIResponseMCPApprovalRequest description: >- A request for human approval of a tool invocation. OpenAIResponseMCPApprovalResponse: type: object properties: approval_request_id: type: string approve: type: boolean type: type: string const: mcp_approval_response default: mcp_approval_response id: type: string reason: type: string additionalProperties: false required: - approval_request_id - approve - type title: OpenAIResponseMCPApprovalResponse description: A response to an MCP approval request. OpenAIResponseMessage: type: object properties: content: oneOf: - type: string - type: array items: $ref: '#/components/schemas/OpenAIResponseInputMessageContent' - type: array items: $ref: '#/components/schemas/OpenAIResponseOutputMessageContent' role: oneOf: - type: string const: system - type: string const: developer - type: string const: user - type: string const: assistant type: type: string const: message default: message id: type: string status: type: string additionalProperties: false required: - content - role - type title: OpenAIResponseMessage description: >- Corresponds to the various Message types in the Responses API. They are all under one type because the Responses API gives them all the same "type" value, and there is no way to tell them apart in certain scenarios. OpenAIResponseObjectWithInput: type: object properties: created_at: type: integer description: >- Unix timestamp when the response was created error: $ref: '#/components/schemas/OpenAIResponseError' description: >- (Optional) Error details if the response generation failed id: type: string description: Unique identifier for this response model: type: string description: Model identifier used for generation object: type: string const: response default: response description: >- Object type identifier, always "response" output: type: array items: $ref: '#/components/schemas/OpenAIResponseOutput' description: >- List of generated output items (messages, tool calls, etc.) parallel_tool_calls: type: boolean default: false description: >- Whether tool calls can be executed in parallel previous_response_id: type: string description: >- (Optional) ID of the previous response in a conversation status: type: string description: >- Current status of the response generation temperature: type: number description: >- (Optional) Sampling temperature used for generation text: $ref: '#/components/schemas/OpenAIResponseText' description: >- Text formatting configuration for the response top_p: type: number description: >- (Optional) Nucleus sampling parameter used for generation truncation: type: string description: >- (Optional) Truncation strategy applied to the response input: type: array items: $ref: '#/components/schemas/OpenAIResponseInput' description: >- List of input items that led to this response additionalProperties: false required: - created_at - id - model - object - output - parallel_tool_calls - status - text - input title: OpenAIResponseObjectWithInput description: >- OpenAI response object extended with input context information. OpenAIResponseOutput: oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' discriminator: propertyName: type mapping: message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' OpenAIResponseOutputMessageContent: type: object properties: text: type: string type: type: string const: output_text default: output_text annotations: type: array items: $ref: '#/components/schemas/OpenAIResponseAnnotations' additionalProperties: false required: - text - type - annotations title: >- OpenAIResponseOutputMessageContentOutputText "OpenAIResponseOutputMessageFileSearchToolCall": type: object properties: id: type: string description: Unique identifier for this tool call queries: type: array items: type: string description: List of search queries executed status: type: string description: >- Current status of the file search operation type: type: string const: file_search_call default: file_search_call description: >- Tool call type identifier, always "file_search_call" results: type: array items: type: object properties: attributes: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) Key-value attributes associated with the file file_id: type: string description: >- Unique identifier of the file containing the result filename: type: string description: Name of the file containing the result score: type: number description: >- Relevance score for this search result (between 0 and 1) text: type: string description: Text content of the search result additionalProperties: false required: - attributes - file_id - filename - score - text title: >- OpenAIResponseOutputMessageFileSearchToolCallResults description: >- Search results returned by the file search operation. description: >- (Optional) Search results returned by the file search operation additionalProperties: false required: - id - queries - status - type title: >- OpenAIResponseOutputMessageFileSearchToolCall description: >- File search tool call output message for OpenAI responses. "OpenAIResponseOutputMessageFunctionToolCall": type: object properties: call_id: type: string description: Unique identifier for the function call name: type: string description: Name of the function being called arguments: type: string description: >- JSON string containing the function arguments type: type: string const: function_call default: function_call description: >- Tool call type identifier, always "function_call" id: type: string description: >- (Optional) Additional identifier for the tool call status: type: string description: >- (Optional) Current status of the function call execution additionalProperties: false required: - call_id - name - arguments - type title: >- OpenAIResponseOutputMessageFunctionToolCall description: >- Function tool call output message for OpenAI responses. OpenAIResponseOutputMessageMCPCall: type: object properties: id: type: string description: Unique identifier for this MCP call type: type: string const: mcp_call default: mcp_call description: >- Tool call type identifier, always "mcp_call" arguments: type: string description: >- JSON string containing the MCP call arguments name: type: string description: Name of the MCP method being called server_label: type: string description: >- Label identifying the MCP server handling the call error: type: string description: >- (Optional) Error message if the MCP call failed output: type: string description: >- (Optional) Output result from the successful MCP call additionalProperties: false required: - id - type - arguments - name - server_label title: OpenAIResponseOutputMessageMCPCall description: >- Model Context Protocol (MCP) call output message for OpenAI responses. OpenAIResponseOutputMessageMCPListTools: type: object properties: id: type: string description: >- Unique identifier for this MCP list tools operation type: type: string const: mcp_list_tools default: mcp_list_tools description: >- Tool call type identifier, always "mcp_list_tools" server_label: type: string description: >- Label identifying the MCP server providing the tools tools: type: array items: type: object properties: input_schema: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- JSON schema defining the tool's input parameters name: type: string description: Name of the tool description: type: string description: >- (Optional) Description of what the tool does additionalProperties: false required: - input_schema - name title: MCPListToolsTool description: >- Tool definition returned by MCP list tools operation. description: >- List of available tools provided by the MCP server additionalProperties: false required: - id - type - server_label - tools title: OpenAIResponseOutputMessageMCPListTools description: >- MCP list tools output message containing available tools from an MCP server. "OpenAIResponseOutputMessageWebSearchToolCall": type: object properties: id: type: string description: Unique identifier for this tool call status: type: string description: >- Current status of the web search operation type: type: string const: web_search_call default: web_search_call description: >- Tool call type identifier, always "web_search_call" additionalProperties: false required: - id - status - type title: >- OpenAIResponseOutputMessageWebSearchToolCall description: >- Web search tool call output message for OpenAI responses. OpenAIResponseText: type: object properties: format: type: object properties: type: oneOf: - type: string const: text - type: string const: json_schema - type: string const: json_object description: >- Must be "text", "json_schema", or "json_object" to identify the format type name: type: string description: >- The name of the response format. Only used for json_schema. schema: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- The JSON schema the response should conform to. In a Python SDK, this is often a `pydantic` model. Only used for json_schema. description: type: string description: >- (Optional) A description of the response format. Only used for json_schema. strict: type: boolean description: >- (Optional) Whether to strictly enforce the JSON schema. If true, the response must match the schema exactly. Only used for json_schema. additionalProperties: false required: - type description: >- (Optional) Text format configuration specifying output format requirements additionalProperties: false title: OpenAIResponseText description: >- Text response configuration for OpenAI responses. OpenAIResponseInputTool: oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' discriminator: propertyName: type mapping: web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseInputToolMCP' OpenAIResponseInputToolFileSearch: type: object properties: type: type: string const: file_search default: file_search description: >- Tool type identifier, always "file_search" vector_store_ids: type: array items: type: string description: >- List of vector store identifiers to search within filters: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) Additional filters to apply to the search max_num_results: type: integer default: 10 description: >- (Optional) Maximum number of search results to return (1-50) ranking_options: type: object properties: ranker: type: string description: >- (Optional) Name of the ranking algorithm to use score_threshold: type: number default: 0.0 description: >- (Optional) Minimum relevance score threshold for results additionalProperties: false description: >- (Optional) Options for ranking and scoring search results additionalProperties: false required: - type - vector_store_ids title: OpenAIResponseInputToolFileSearch description: >- File search tool configuration for OpenAI response inputs. OpenAIResponseInputToolFunction: type: object properties: type: type: string const: function default: function description: Tool type identifier, always "function" name: type: string description: Name of the function that can be called description: type: string description: >- (Optional) Description of what the function does parameters: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) JSON schema defining the function's parameters strict: type: boolean description: >- (Optional) Whether to enforce strict parameter validation additionalProperties: false required: - type - name title: OpenAIResponseInputToolFunction description: >- Function tool configuration for OpenAI response inputs. OpenAIResponseInputToolMCP: type: object properties: type: type: string const: mcp default: mcp description: Tool type identifier, always "mcp" server_label: type: string description: Label to identify this MCP server server_url: type: string description: URL endpoint of the MCP server headers: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) HTTP headers to include when connecting to the server require_approval: oneOf: - type: string const: always - type: string const: never - type: object properties: always: type: array items: type: string description: >- (Optional) List of tool names that always require approval never: type: array items: type: string description: >- (Optional) List of tool names that never require approval additionalProperties: false title: ApprovalFilter description: >- Filter configuration for MCP tool approval requirements. default: never description: >- Approval requirement for tool calls ("always", "never", or filter) allowed_tools: oneOf: - type: array items: type: string - type: object properties: tool_names: type: array items: type: string description: >- (Optional) List of specific tool names that are allowed additionalProperties: false title: AllowedToolsFilter description: >- Filter configuration for restricting which MCP tools can be used. description: >- (Optional) Restriction on which tools can be used from this server additionalProperties: false required: - type - server_label - server_url - require_approval title: OpenAIResponseInputToolMCP description: >- Model Context Protocol (MCP) tool configuration for OpenAI response inputs. OpenAIResponseInputToolWebSearch: type: object properties: type: oneOf: - type: string const: web_search - type: string const: web_search_preview - type: string const: web_search_preview_2025_03_11 default: web_search description: Web search tool type variant to use search_context_size: type: string default: medium description: >- (Optional) Size of search context, must be "low", "medium", or "high" additionalProperties: false required: - type title: OpenAIResponseInputToolWebSearch description: >- Web search tool configuration for OpenAI response inputs. CreateOpenaiResponseRequest: type: object properties: input: oneOf: - type: string - type: array items: $ref: '#/components/schemas/OpenAIResponseInput' description: Input message(s) to create the response. model: type: string description: The underlying LLM used for completions. instructions: type: string previous_response_id: type: string description: >- (Optional) if specified, the new response will be a continuation of the previous response. This can be used to easily fork-off new responses from existing responses. store: type: boolean stream: type: boolean temperature: type: number text: $ref: '#/components/schemas/OpenAIResponseText' tools: type: array items: $ref: '#/components/schemas/OpenAIResponseInputTool' include: type: array items: type: string description: >- (Optional) Additional fields to include in the response. max_infer_iters: type: integer additionalProperties: false required: - input - model title: CreateOpenaiResponseRequest OpenAIResponseObject: type: object properties: created_at: type: integer description: >- Unix timestamp when the response was created error: $ref: '#/components/schemas/OpenAIResponseError' description: >- (Optional) Error details if the response generation failed id: type: string description: Unique identifier for this response model: type: string description: Model identifier used for generation object: type: string const: response default: response description: >- Object type identifier, always "response" output: type: array items: $ref: '#/components/schemas/OpenAIResponseOutput' description: >- List of generated output items (messages, tool calls, etc.) parallel_tool_calls: type: boolean default: false description: >- Whether tool calls can be executed in parallel previous_response_id: type: string description: >- (Optional) ID of the previous response in a conversation status: type: string description: >- Current status of the response generation temperature: type: number description: >- (Optional) Sampling temperature used for generation text: $ref: '#/components/schemas/OpenAIResponseText' description: >- Text formatting configuration for the response top_p: type: number description: >- (Optional) Nucleus sampling parameter used for generation truncation: type: string description: >- (Optional) Truncation strategy applied to the response additionalProperties: false required: - created_at - id - model - object - output - parallel_tool_calls - status - text title: OpenAIResponseObject description: >- Complete OpenAI response object containing generation results and metadata. OpenAIResponseContentPartOutputText: type: object properties: type: type: string const: output_text default: output_text text: type: string additionalProperties: false required: - type - text title: OpenAIResponseContentPartOutputText OpenAIResponseContentPartRefusal: type: object properties: type: type: string const: refusal default: refusal refusal: type: string additionalProperties: false required: - type - refusal title: OpenAIResponseContentPartRefusal OpenAIResponseObjectStream: oneOf: - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone' - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' discriminator: propertyName: type mapping: response.created: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated' response.output_item.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded' response.output_item.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone' response.output_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta' response.output_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone' response.function_call_arguments.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta' response.function_call_arguments.done: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone' response.web_search_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress' response.web_search_call.searching: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching' response.web_search_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted' response.mcp_list_tools.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress' response.mcp_list_tools.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed' response.mcp_list_tools.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted' response.mcp_call.arguments.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta' response.mcp_call.arguments.done: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone' response.mcp_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress' response.mcp_call.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed' response.mcp_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted' response.content_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded' response.content_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone' response.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' "OpenAIResponseObjectStreamResponseCompleted": type: object properties: response: $ref: '#/components/schemas/OpenAIResponseObject' description: The completed response object type: type: string const: response.completed default: response.completed description: >- Event type identifier, always "response.completed" additionalProperties: false required: - response - type title: >- OpenAIResponseObjectStreamResponseCompleted description: >- Streaming event indicating a response has been completed. "OpenAIResponseObjectStreamResponseContentPartAdded": type: object properties: response_id: type: string description: >- Unique identifier of the response containing this content item_id: type: string description: >- Unique identifier of the output item containing this content part part: oneOf: - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' discriminator: propertyName: type mapping: output_text: '#/components/schemas/OpenAIResponseContentPartOutputText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' description: The content part that was added sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.content_part.added default: response.content_part.added description: >- Event type identifier, always "response.content_part.added" additionalProperties: false required: - response_id - item_id - part - sequence_number - type title: >- OpenAIResponseObjectStreamResponseContentPartAdded description: >- Streaming event for when a new content part is added to a response item. "OpenAIResponseObjectStreamResponseContentPartDone": type: object properties: response_id: type: string description: >- Unique identifier of the response containing this content item_id: type: string description: >- Unique identifier of the output item containing this content part part: oneOf: - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' discriminator: propertyName: type mapping: output_text: '#/components/schemas/OpenAIResponseContentPartOutputText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' description: The completed content part sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.content_part.done default: response.content_part.done description: >- Event type identifier, always "response.content_part.done" additionalProperties: false required: - response_id - item_id - part - sequence_number - type title: >- OpenAIResponseObjectStreamResponseContentPartDone description: >- Streaming event for when a content part is completed. "OpenAIResponseObjectStreamResponseCreated": type: object properties: response: $ref: '#/components/schemas/OpenAIResponseObject' description: The newly created response object type: type: string const: response.created default: response.created description: >- Event type identifier, always "response.created" additionalProperties: false required: - response - type title: >- OpenAIResponseObjectStreamResponseCreated description: >- Streaming event indicating a new response has been created. "OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta": type: object properties: delta: type: string description: >- Incremental function call arguments being added item_id: type: string description: >- Unique identifier of the function call being updated output_index: type: integer description: >- Index position of the item in the output list sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.function_call_arguments.delta default: response.function_call_arguments.delta description: >- Event type identifier, always "response.function_call_arguments.delta" additionalProperties: false required: - delta - item_id - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta description: >- Streaming event for incremental function call argument updates. "OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone": type: object properties: arguments: type: string description: >- Final complete arguments JSON string for the function call item_id: type: string description: >- Unique identifier of the completed function call output_index: type: integer description: >- Index position of the item in the output list sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.function_call_arguments.done default: response.function_call_arguments.done description: >- Event type identifier, always "response.function_call_arguments.done" additionalProperties: false required: - arguments - item_id - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone description: >- Streaming event for when function call arguments are completed. "OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta": type: object properties: delta: type: string item_id: type: string output_index: type: integer sequence_number: type: integer type: type: string const: response.mcp_call.arguments.delta default: response.mcp_call.arguments.delta additionalProperties: false required: - delta - item_id - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta "OpenAIResponseObjectStreamResponseMcpCallArgumentsDone": type: object properties: arguments: type: string item_id: type: string output_index: type: integer sequence_number: type: integer type: type: string const: response.mcp_call.arguments.done default: response.mcp_call.arguments.done additionalProperties: false required: - arguments - item_id - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseMcpCallArgumentsDone "OpenAIResponseObjectStreamResponseMcpCallCompleted": type: object properties: sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.mcp_call.completed default: response.mcp_call.completed description: >- Event type identifier, always "response.mcp_call.completed" additionalProperties: false required: - sequence_number - type title: >- OpenAIResponseObjectStreamResponseMcpCallCompleted description: Streaming event for completed MCP calls. "OpenAIResponseObjectStreamResponseMcpCallFailed": type: object properties: sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.mcp_call.failed default: response.mcp_call.failed description: >- Event type identifier, always "response.mcp_call.failed" additionalProperties: false required: - sequence_number - type title: >- OpenAIResponseObjectStreamResponseMcpCallFailed description: Streaming event for failed MCP calls. "OpenAIResponseObjectStreamResponseMcpCallInProgress": type: object properties: item_id: type: string description: Unique identifier of the MCP call output_index: type: integer description: >- Index position of the item in the output list sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.mcp_call.in_progress default: response.mcp_call.in_progress description: >- Event type identifier, always "response.mcp_call.in_progress" additionalProperties: false required: - item_id - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseMcpCallInProgress description: >- Streaming event for MCP calls in progress. "OpenAIResponseObjectStreamResponseMcpListToolsCompleted": type: object properties: sequence_number: type: integer type: type: string const: response.mcp_list_tools.completed default: response.mcp_list_tools.completed additionalProperties: false required: - sequence_number - type title: >- OpenAIResponseObjectStreamResponseMcpListToolsCompleted "OpenAIResponseObjectStreamResponseMcpListToolsFailed": type: object properties: sequence_number: type: integer type: type: string const: response.mcp_list_tools.failed default: response.mcp_list_tools.failed additionalProperties: false required: - sequence_number - type title: >- OpenAIResponseObjectStreamResponseMcpListToolsFailed "OpenAIResponseObjectStreamResponseMcpListToolsInProgress": type: object properties: sequence_number: type: integer type: type: string const: response.mcp_list_tools.in_progress default: response.mcp_list_tools.in_progress additionalProperties: false required: - sequence_number - type title: >- OpenAIResponseObjectStreamResponseMcpListToolsInProgress "OpenAIResponseObjectStreamResponseOutputItemAdded": type: object properties: response_id: type: string description: >- Unique identifier of the response containing this output item: oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' discriminator: propertyName: type mapping: message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' description: >- The output item that was added (message, tool call, etc.) output_index: type: integer description: >- Index position of this item in the output list sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.output_item.added default: response.output_item.added description: >- Event type identifier, always "response.output_item.added" additionalProperties: false required: - response_id - item - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseOutputItemAdded description: >- Streaming event for when a new output item is added to the response. "OpenAIResponseObjectStreamResponseOutputItemDone": type: object properties: response_id: type: string description: >- Unique identifier of the response containing this output item: oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' discriminator: propertyName: type mapping: message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' description: >- The completed output item (message, tool call, etc.) output_index: type: integer description: >- Index position of this item in the output list sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.output_item.done default: response.output_item.done description: >- Event type identifier, always "response.output_item.done" additionalProperties: false required: - response_id - item - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseOutputItemDone description: >- Streaming event for when an output item is completed. "OpenAIResponseObjectStreamResponseOutputTextDelta": type: object properties: content_index: type: integer description: Index position within the text content delta: type: string description: Incremental text content being added item_id: type: string description: >- Unique identifier of the output item being updated output_index: type: integer description: >- Index position of the item in the output list sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.output_text.delta default: response.output_text.delta description: >- Event type identifier, always "response.output_text.delta" additionalProperties: false required: - content_index - delta - item_id - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseOutputTextDelta description: >- Streaming event for incremental text content updates. "OpenAIResponseObjectStreamResponseOutputTextDone": type: object properties: content_index: type: integer description: Index position within the text content text: type: string description: >- Final complete text content of the output item item_id: type: string description: >- Unique identifier of the completed output item output_index: type: integer description: >- Index position of the item in the output list sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.output_text.done default: response.output_text.done description: >- Event type identifier, always "response.output_text.done" additionalProperties: false required: - content_index - text - item_id - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseOutputTextDone description: >- Streaming event for when text output is completed. "OpenAIResponseObjectStreamResponseWebSearchCallCompleted": type: object properties: item_id: type: string description: >- Unique identifier of the completed web search call output_index: type: integer description: >- Index position of the item in the output list sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.web_search_call.completed default: response.web_search_call.completed description: >- Event type identifier, always "response.web_search_call.completed" additionalProperties: false required: - item_id - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseWebSearchCallCompleted description: >- Streaming event for completed web search calls. "OpenAIResponseObjectStreamResponseWebSearchCallInProgress": type: object properties: item_id: type: string description: Unique identifier of the web search call output_index: type: integer description: >- Index position of the item in the output list sequence_number: type: integer description: >- Sequential number for ordering streaming events type: type: string const: response.web_search_call.in_progress default: response.web_search_call.in_progress description: >- Event type identifier, always "response.web_search_call.in_progress" additionalProperties: false required: - item_id - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseWebSearchCallInProgress description: >- Streaming event for web search calls in progress. "OpenAIResponseObjectStreamResponseWebSearchCallSearching": type: object properties: item_id: type: string output_index: type: integer sequence_number: type: integer type: type: string const: response.web_search_call.searching default: response.web_search_call.searching additionalProperties: false required: - item_id - output_index - sequence_number - type title: >- OpenAIResponseObjectStreamResponseWebSearchCallSearching ListOpenaiResponsesRequest: type: object properties: after: type: string description: The ID of the last response to return. limit: type: integer description: The number of responses to return. model: type: string description: The model to filter responses by. order: type: string enum: - asc - desc description: >- The order to sort responses by when sorted by created_at ('asc' or 'desc'). additionalProperties: false title: ListOpenaiResponsesRequest OpenAIDeleteResponseObject: type: object properties: id: type: string description: >- Unique identifier of the deleted response object: type: string const: response default: response description: >- Object type identifier, always "response" deleted: type: boolean default: true description: Deletion confirmation flag, always True additionalProperties: false required: - id - object - deleted title: OpenAIDeleteResponseObject description: >- Response object confirming deletion of an OpenAI response. ListOpenAIResponseInputItem: type: object properties: data: type: array items: $ref: '#/components/schemas/OpenAIResponseInput' description: List of input items object: type: string const: list default: list description: Object type identifier, always "list" additionalProperties: false required: - data - object title: ListOpenAIResponseInputItem description: >- List container for OpenAI response input items. VectorStoreFileCounts: type: object properties: completed: type: integer description: >- Number of files that have been successfully processed cancelled: type: integer description: >- Number of files that had their processing cancelled failed: type: integer description: Number of files that failed to process in_progress: type: integer description: >- Number of files currently being processed total: type: integer description: >- Total number of files in the vector store additionalProperties: false required: - completed - cancelled - failed - in_progress - total title: VectorStoreFileCounts description: >- File processing status counts for a vector store. VectorStoreListResponse: type: object properties: object: type: string default: list description: Object type identifier, always "list" data: type: array items: $ref: '#/components/schemas/VectorStoreObject' description: List of vector store objects first_id: type: string description: >- (Optional) ID of the first vector store in the list for pagination last_id: type: string description: >- (Optional) ID of the last vector store in the list for pagination has_more: type: boolean default: false description: >- Whether there are more vector stores available beyond this page additionalProperties: false required: - object - data - has_more title: VectorStoreListResponse description: Response from listing vector stores. VectorStoreObject: type: object properties: id: type: string description: Unique identifier for the vector store object: type: string default: vector_store description: >- Object type identifier, always "vector_store" created_at: type: integer description: >- Timestamp when the vector store was created name: type: string description: (Optional) Name of the vector store usage_bytes: type: integer default: 0 description: >- Storage space used by the vector store in bytes file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' description: >- File processing status counts for the vector store status: type: string default: completed description: Current status of the vector store expires_after: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) Expiration policy for the vector store expires_at: type: integer description: >- (Optional) Timestamp when the vector store will expire last_active_at: type: integer description: >- (Optional) Timestamp of last activity on the vector store metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- Set of key-value pairs that can be attached to the vector store additionalProperties: false required: - id - object - created_at - usage_bytes - file_counts - status - metadata title: VectorStoreObject description: OpenAI Vector Store object. OpenaiCreateVectorStoreRequest: type: object properties: name: type: string description: A name for the vector store. file_ids: type: array items: type: string description: >- A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files. expires_after: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- The expiration policy for a vector store. chunking_strategy: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- Set of 16 key-value pairs that can be attached to an object. embedding_model: type: string description: >- The embedding model to use for this vector store. embedding_dimension: type: integer description: >- The dimension of the embedding vectors (default: 384). provider_id: type: string description: >- The ID of the provider to use for this vector store. additionalProperties: false title: OpenaiCreateVectorStoreRequest OpenaiUpdateVectorStoreRequest: type: object properties: name: type: string description: The name of the vector store. expires_after: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- The expiration policy for a vector store. metadata: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- Set of 16 key-value pairs that can be attached to an object. additionalProperties: false title: OpenaiUpdateVectorStoreRequest VectorStoreDeleteResponse: type: object properties: id: type: string description: >- Unique identifier of the deleted vector store object: type: string default: vector_store.deleted description: >- Object type identifier for the deletion response deleted: type: boolean default: true description: >- Whether the deletion operation was successful additionalProperties: false required: - id - object - deleted title: VectorStoreDeleteResponse description: Response from deleting a vector store. VectorStoreChunkingStrategy: oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' VectorStoreChunkingStrategyAuto: type: object properties: type: type: string const: auto default: auto description: >- Strategy type, always "auto" for automatic chunking additionalProperties: false required: - type title: VectorStoreChunkingStrategyAuto description: >- Automatic chunking strategy for vector store files. VectorStoreChunkingStrategyStatic: type: object properties: type: type: string const: static default: static description: >- Strategy type, always "static" for static chunking static: $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' description: >- Configuration parameters for the static chunking strategy additionalProperties: false required: - type - static title: VectorStoreChunkingStrategyStatic description: >- Static chunking strategy with configurable parameters. VectorStoreChunkingStrategyStaticConfig: type: object properties: chunk_overlap_tokens: type: integer default: 400 description: >- Number of tokens to overlap between adjacent chunks max_chunk_size_tokens: type: integer default: 800 description: >- Maximum number of tokens per chunk, must be between 100 and 4096 additionalProperties: false required: - chunk_overlap_tokens - max_chunk_size_tokens title: VectorStoreChunkingStrategyStaticConfig description: >- Configuration for static chunking strategy. OpenaiCreateVectorStoreFileBatchRequest: type: object properties: file_ids: type: array items: type: string description: >- A list of File IDs that the vector store should use. attributes: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) Key-value attributes to store with the files. chunking_strategy: $ref: '#/components/schemas/VectorStoreChunkingStrategy' description: >- (Optional) The chunking strategy used to chunk the file(s). Defaults to auto. additionalProperties: false required: - file_ids title: OpenaiCreateVectorStoreFileBatchRequest VectorStoreFileBatchObject: type: object properties: id: type: string description: Unique identifier for the file batch object: type: string default: vector_store.file_batch description: >- Object type identifier, always "vector_store.file_batch" created_at: type: integer description: >- Timestamp when the file batch was created vector_store_id: type: string description: >- ID of the vector store containing the file batch status: $ref: '#/components/schemas/VectorStoreFileStatus' description: >- Current processing status of the file batch file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' description: >- File processing status counts for the batch additionalProperties: false required: - id - object - created_at - vector_store_id - status - file_counts title: VectorStoreFileBatchObject description: OpenAI Vector Store File Batch object. VectorStoreFileStatus: oneOf: - type: string const: completed - type: string const: in_progress - type: string const: cancelled - type: string const: failed VectorStoreFileLastError: type: object properties: code: oneOf: - type: string const: server_error - type: string const: rate_limit_exceeded description: >- Error code indicating the type of failure message: type: string description: >- Human-readable error message describing the failure additionalProperties: false required: - code - message title: VectorStoreFileLastError description: >- Error information for failed vector store file processing. VectorStoreFileObject: type: object properties: id: type: string description: Unique identifier for the file object: type: string default: vector_store.file description: >- Object type identifier, always "vector_store.file" attributes: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- Key-value attributes associated with the file chunking_strategy: oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' description: >- Strategy used for splitting the file into chunks created_at: type: integer description: >- Timestamp when the file was added to the vector store last_error: $ref: '#/components/schemas/VectorStoreFileLastError' description: >- (Optional) Error information if file processing failed status: $ref: '#/components/schemas/VectorStoreFileStatus' description: Current processing status of the file usage_bytes: type: integer default: 0 description: Storage space used by this file in bytes vector_store_id: type: string description: >- ID of the vector store containing this file additionalProperties: false required: - id - object - attributes - chunking_strategy - created_at - status - usage_bytes - vector_store_id title: VectorStoreFileObject description: OpenAI Vector Store File object. VectorStoreFilesListInBatchResponse: type: object properties: object: type: string default: list description: Object type identifier, always "list" data: type: array items: $ref: '#/components/schemas/VectorStoreFileObject' description: >- List of vector store file objects in the batch first_id: type: string description: >- (Optional) ID of the first file in the list for pagination last_id: type: string description: >- (Optional) ID of the last file in the list for pagination has_more: type: boolean default: false description: >- Whether there are more files available beyond this page additionalProperties: false required: - object - data - has_more title: VectorStoreFilesListInBatchResponse description: >- Response from listing files in a vector store file batch. VectorStoreListFilesResponse: type: object properties: object: type: string default: list description: Object type identifier, always "list" data: type: array items: $ref: '#/components/schemas/VectorStoreFileObject' description: List of vector store file objects first_id: type: string description: >- (Optional) ID of the first file in the list for pagination last_id: type: string description: >- (Optional) ID of the last file in the list for pagination has_more: type: boolean default: false description: >- Whether there are more files available beyond this page additionalProperties: false required: - object - data - has_more title: VectorStoreListFilesResponse description: >- Response from listing files in a vector store. OpenaiAttachFileToVectorStoreRequest: type: object properties: file_id: type: string description: >- The ID of the file to attach to the vector store. attributes: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- The key-value attributes stored with the file, which can be used for filtering. chunking_strategy: $ref: '#/components/schemas/VectorStoreChunkingStrategy' description: >- The chunking strategy to use for the file. additionalProperties: false required: - file_id title: OpenaiAttachFileToVectorStoreRequest OpenaiUpdateVectorStoreFileRequest: type: object properties: attributes: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- The updated key-value attributes to store with the file. additionalProperties: false required: - attributes title: OpenaiUpdateVectorStoreFileRequest VectorStoreFileDeleteResponse: type: object properties: id: type: string description: Unique identifier of the deleted file object: type: string default: vector_store.file.deleted description: >- Object type identifier for the deletion response deleted: type: boolean default: true description: >- Whether the deletion operation was successful additionalProperties: false required: - id - object - deleted title: VectorStoreFileDeleteResponse description: >- Response from deleting a vector store file. VectorStoreContent: type: object properties: type: type: string const: text description: >- Content type, currently only "text" is supported text: type: string description: The actual text content additionalProperties: false required: - type - text title: VectorStoreContent description: >- Content item from a vector store file or search result. VectorStoreFileContentsResponse: type: object properties: file_id: type: string description: Unique identifier for the file filename: type: string description: Name of the file attributes: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- Key-value attributes associated with the file content: type: array items: $ref: '#/components/schemas/VectorStoreContent' description: List of content items from the file additionalProperties: false required: - file_id - filename - attributes - content title: VectorStoreFileContentsResponse description: >- Response from retrieving the contents of a vector store file. OpenaiSearchVectorStoreRequest: type: object properties: query: oneOf: - type: string - type: array items: type: string description: >- The query string or array for performing the search. filters: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- Filters based on file attributes to narrow the search results. max_num_results: type: integer description: >- Maximum number of results to return (1 to 50 inclusive, default 10). ranking_options: type: object properties: ranker: type: string description: >- (Optional) Name of the ranking algorithm to use score_threshold: type: number default: 0.0 description: >- (Optional) Minimum relevance score threshold for results additionalProperties: false description: >- Ranking options for fine-tuning the search results. rewrite_query: type: boolean description: >- Whether to rewrite the natural language query for vector search (default false) search_mode: type: string description: >- The search mode to use - "keyword", "vector", or "hybrid" (default "vector") additionalProperties: false required: - query title: OpenaiSearchVectorStoreRequest VectorStoreSearchResponse: type: object properties: file_id: type: string description: >- Unique identifier of the file containing the result filename: type: string description: Name of the file containing the result score: type: number description: Relevance score for this search result attributes: type: object additionalProperties: oneOf: - type: string - type: number - type: boolean description: >- (Optional) Key-value attributes associated with the file content: type: array items: $ref: '#/components/schemas/VectorStoreContent' description: >- List of content items matching the search query additionalProperties: false required: - file_id - filename - score - content title: VectorStoreSearchResponse description: Response from searching a vector store. VectorStoreSearchResponsePage: type: object properties: object: type: string default: vector_store.search_results.page description: >- Object type identifier for the search results page search_query: type: string description: >- The original search query that was executed data: type: array items: $ref: '#/components/schemas/VectorStoreSearchResponse' description: List of search result objects has_more: type: boolean default: false description: >- Whether there are more results available beyond this page next_page: type: string description: >- (Optional) Token for retrieving the next page of results additionalProperties: false required: - object - search_query - data - has_more title: VectorStoreSearchResponsePage description: >- Paginated response from searching a vector store. Checkpoint: type: object properties: identifier: type: string description: Unique identifier for the checkpoint created_at: type: string format: date-time description: >- Timestamp when the checkpoint was created epoch: type: integer description: >- Training epoch when the checkpoint was saved post_training_job_id: type: string description: >- Identifier of the training job that created this checkpoint path: type: string description: >- File system path where the checkpoint is stored training_metrics: $ref: '#/components/schemas/PostTrainingMetric' description: >- (Optional) Training metrics associated with this checkpoint additionalProperties: false required: - identifier - created_at - epoch - post_training_job_id - path title: Checkpoint description: Checkpoint created during training runs. PostTrainingJobArtifactsResponse: type: object properties: job_uuid: type: string description: Unique identifier for the training job checkpoints: type: array items: $ref: '#/components/schemas/Checkpoint' description: >- List of model checkpoints created during training additionalProperties: false required: - job_uuid - checkpoints title: PostTrainingJobArtifactsResponse description: Artifacts of a finetuning job. PostTrainingMetric: type: object properties: epoch: type: integer description: Training epoch number train_loss: type: number description: Loss value on the training dataset validation_loss: type: number description: Loss value on the validation dataset perplexity: type: number description: >- Perplexity metric indicating model confidence additionalProperties: false required: - epoch - train_loss - validation_loss - perplexity title: PostTrainingMetric description: >- Training metrics captured during post-training jobs. CancelTrainingJobRequest: type: object properties: job_uuid: type: string description: The UUID of the job to cancel. additionalProperties: false required: - job_uuid title: CancelTrainingJobRequest PostTrainingJobStatusResponse: type: object properties: job_uuid: type: string description: Unique identifier for the training job status: type: string enum: - completed - in_progress - failed - scheduled - cancelled description: Current status of the training job scheduled_at: type: string format: date-time description: >- (Optional) Timestamp when the job was scheduled started_at: type: string format: date-time description: >- (Optional) Timestamp when the job execution began completed_at: type: string format: date-time description: >- (Optional) Timestamp when the job finished, if completed resources_allocated: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) Information about computational resources allocated to the job checkpoints: type: array items: $ref: '#/components/schemas/Checkpoint' description: >- List of model checkpoints created during training additionalProperties: false required: - job_uuid - status - checkpoints title: PostTrainingJobStatusResponse description: Status of a finetuning job. ListPostTrainingJobsResponse: type: object properties: data: type: array items: type: object properties: job_uuid: type: string additionalProperties: false required: - job_uuid title: PostTrainingJob additionalProperties: false required: - data title: ListPostTrainingJobsResponse DPOAlignmentConfig: type: object properties: beta: type: number description: Temperature parameter for the DPO loss loss_type: $ref: '#/components/schemas/DPOLossType' default: sigmoid description: The type of loss function to use for DPO additionalProperties: false required: - beta - loss_type title: DPOAlignmentConfig description: >- Configuration for Direct Preference Optimization (DPO) alignment. DPOLossType: type: string enum: - sigmoid - hinge - ipo - kto_pair title: DPOLossType DataConfig: type: object properties: dataset_id: type: string description: >- Unique identifier for the training dataset batch_size: type: integer description: Number of samples per training batch shuffle: type: boolean description: >- Whether to shuffle the dataset during training data_format: $ref: '#/components/schemas/DatasetFormat' description: >- Format of the dataset (instruct or dialog) validation_dataset_id: type: string description: >- (Optional) Unique identifier for the validation dataset packed: type: boolean default: false description: >- (Optional) Whether to pack multiple samples into a single sequence for efficiency train_on_input: type: boolean default: false description: >- (Optional) Whether to compute loss on input tokens as well as output tokens additionalProperties: false required: - dataset_id - batch_size - shuffle - data_format title: DataConfig description: >- Configuration for training data and data loading. DatasetFormat: type: string enum: - instruct - dialog title: DatasetFormat description: Format of the training dataset. EfficiencyConfig: type: object properties: enable_activation_checkpointing: type: boolean default: false description: >- (Optional) Whether to use activation checkpointing to reduce memory usage enable_activation_offloading: type: boolean default: false description: >- (Optional) Whether to offload activations to CPU to save GPU memory memory_efficient_fsdp_wrap: type: boolean default: false description: >- (Optional) Whether to use memory-efficient FSDP wrapping fsdp_cpu_offload: type: boolean default: false description: >- (Optional) Whether to offload FSDP parameters to CPU additionalProperties: false title: EfficiencyConfig description: >- Configuration for memory and compute efficiency optimizations. OptimizerConfig: type: object properties: optimizer_type: $ref: '#/components/schemas/OptimizerType' description: >- Type of optimizer to use (adam, adamw, or sgd) lr: type: number description: Learning rate for the optimizer weight_decay: type: number description: >- Weight decay coefficient for regularization num_warmup_steps: type: integer description: Number of steps for learning rate warmup additionalProperties: false required: - optimizer_type - lr - weight_decay - num_warmup_steps title: OptimizerConfig description: >- Configuration parameters for the optimization algorithm. OptimizerType: type: string enum: - adam - adamw - sgd title: OptimizerType description: >- Available optimizer algorithms for training. TrainingConfig: type: object properties: n_epochs: type: integer description: Number of training epochs to run max_steps_per_epoch: type: integer default: 1 description: Maximum number of steps to run per epoch gradient_accumulation_steps: type: integer default: 1 description: >- Number of steps to accumulate gradients before updating max_validation_steps: type: integer default: 1 description: >- (Optional) Maximum number of validation steps per epoch data_config: $ref: '#/components/schemas/DataConfig' description: >- (Optional) Configuration for data loading and formatting optimizer_config: $ref: '#/components/schemas/OptimizerConfig' description: >- (Optional) Configuration for the optimization algorithm efficiency_config: $ref: '#/components/schemas/EfficiencyConfig' description: >- (Optional) Configuration for memory and compute optimizations dtype: type: string default: bf16 description: >- (Optional) Data type for model parameters (bf16, fp16, fp32) additionalProperties: false required: - n_epochs - max_steps_per_epoch - gradient_accumulation_steps title: TrainingConfig description: >- Comprehensive configuration for the training process. PreferenceOptimizeRequest: type: object properties: job_uuid: type: string description: The UUID of the job to create. finetuned_model: type: string description: The model to fine-tune. algorithm_config: $ref: '#/components/schemas/DPOAlignmentConfig' description: The algorithm configuration. training_config: $ref: '#/components/schemas/TrainingConfig' description: The training configuration. hyperparam_search_config: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: The hyperparam search configuration. logger_config: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: The logger configuration. additionalProperties: false required: - job_uuid - finetuned_model - algorithm_config - training_config - hyperparam_search_config - logger_config title: PreferenceOptimizeRequest PostTrainingJob: type: object properties: job_uuid: type: string additionalProperties: false required: - job_uuid title: PostTrainingJob AlgorithmConfig: oneOf: - $ref: '#/components/schemas/LoraFinetuningConfig' - $ref: '#/components/schemas/QATFinetuningConfig' discriminator: propertyName: type mapping: LoRA: '#/components/schemas/LoraFinetuningConfig' QAT: '#/components/schemas/QATFinetuningConfig' LoraFinetuningConfig: type: object properties: type: type: string const: LoRA default: LoRA description: Algorithm type identifier, always "LoRA" lora_attn_modules: type: array items: type: string description: >- List of attention module names to apply LoRA to apply_lora_to_mlp: type: boolean description: Whether to apply LoRA to MLP layers apply_lora_to_output: type: boolean description: >- Whether to apply LoRA to output projection layers rank: type: integer description: >- Rank of the LoRA adaptation (lower rank = fewer parameters) alpha: type: integer description: >- LoRA scaling parameter that controls adaptation strength use_dora: type: boolean default: false description: >- (Optional) Whether to use DoRA (Weight-Decomposed Low-Rank Adaptation) quantize_base: type: boolean default: false description: >- (Optional) Whether to quantize the base model weights additionalProperties: false required: - type - lora_attn_modules - apply_lora_to_mlp - apply_lora_to_output - rank - alpha title: LoraFinetuningConfig description: >- Configuration for Low-Rank Adaptation (LoRA) fine-tuning. QATFinetuningConfig: type: object properties: type: type: string const: QAT default: QAT description: Algorithm type identifier, always "QAT" quantizer_name: type: string description: >- Name of the quantization algorithm to use group_size: type: integer description: Size of groups for grouped quantization additionalProperties: false required: - type - quantizer_name - group_size title: QATFinetuningConfig description: >- Configuration for Quantization-Aware Training (QAT) fine-tuning. SupervisedFineTuneRequest: type: object properties: job_uuid: type: string description: The UUID of the job to create. training_config: $ref: '#/components/schemas/TrainingConfig' description: The training configuration. hyperparam_search_config: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: The hyperparam search configuration. logger_config: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: The logger configuration. model: type: string description: The model to fine-tune. checkpoint_dir: type: string description: The directory to save checkpoint(s) to. algorithm_config: $ref: '#/components/schemas/AlgorithmConfig' description: The algorithm configuration. additionalProperties: false required: - job_uuid - training_config - hyperparam_search_config - logger_config title: SupervisedFineTuneRequest QueryMetricsRequest: type: object properties: start_time: type: integer description: The start time of the metric to query. end_time: type: integer description: The end time of the metric to query. granularity: type: string description: The granularity of the metric to query. query_type: type: string enum: - range - instant description: The type of query to perform. label_matchers: type: array items: type: object properties: name: type: string description: The name of the label to match value: type: string description: The value to match against operator: type: string enum: - '=' - '!=' - =~ - '!~' description: >- The comparison operator to use for matching default: '=' additionalProperties: false required: - name - value - operator title: MetricLabelMatcher description: >- A matcher for filtering metrics by label values. description: >- The label matchers to apply to the metric. additionalProperties: false required: - start_time - query_type title: QueryMetricsRequest MetricDataPoint: type: object properties: timestamp: type: integer description: >- Unix timestamp when the metric value was recorded value: type: number description: >- The numeric value of the metric at this timestamp unit: type: string additionalProperties: false required: - timestamp - value - unit title: MetricDataPoint description: >- A single data point in a metric time series. MetricLabel: type: object properties: name: type: string description: The name of the label value: type: string description: The value of the label additionalProperties: false required: - name - value title: MetricLabel description: A label associated with a metric. MetricSeries: type: object properties: metric: type: string description: The name of the metric labels: type: array items: $ref: '#/components/schemas/MetricLabel' description: >- List of labels associated with this metric series values: type: array items: $ref: '#/components/schemas/MetricDataPoint' description: >- List of data points in chronological order additionalProperties: false required: - metric - labels - values title: MetricSeries description: A time series of metric data points. QueryMetricsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/MetricSeries' description: >- List of metric series matching the query criteria additionalProperties: false required: - data title: QueryMetricsResponse description: >- Response containing metric time series data. QueryCondition: type: object properties: key: type: string description: The attribute key to filter on op: $ref: '#/components/schemas/QueryConditionOp' description: The comparison operator to apply value: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: The value to compare against additionalProperties: false required: - key - op - value title: QueryCondition description: A condition for filtering query results. QueryConditionOp: type: string enum: - eq - ne - gt - lt title: QueryConditionOp description: >- Comparison operators for query conditions. QuerySpansRequest: type: object properties: attribute_filters: type: array items: $ref: '#/components/schemas/QueryCondition' description: >- The attribute filters to apply to the spans. attributes_to_return: type: array items: type: string description: The attributes to return in the spans. max_depth: type: integer description: The maximum depth of the tree. additionalProperties: false required: - attribute_filters - attributes_to_return title: QuerySpansRequest Span: type: object properties: span_id: type: string description: Unique identifier for the span trace_id: type: string description: >- Unique identifier for the trace this span belongs to parent_span_id: type: string description: >- (Optional) Unique identifier for the parent span, if this is a child span name: type: string description: >- Human-readable name describing the operation this span represents start_time: type: string format: date-time description: Timestamp when the operation began end_time: type: string format: date-time description: >- (Optional) Timestamp when the operation finished, if completed attributes: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) Key-value pairs containing additional metadata about the span additionalProperties: false required: - span_id - trace_id - name - start_time title: Span description: >- A span representing a single operation within a trace. QuerySpansResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Span' description: >- List of spans matching the query criteria additionalProperties: false required: - data title: QuerySpansResponse description: Response containing a list of spans. SaveSpansToDatasetRequest: type: object properties: attribute_filters: type: array items: $ref: '#/components/schemas/QueryCondition' description: >- The attribute filters to apply to the spans. attributes_to_save: type: array items: type: string description: The attributes to save to the dataset. dataset_id: type: string description: >- The ID of the dataset to save the spans to. max_depth: type: integer description: The maximum depth of the tree. additionalProperties: false required: - attribute_filters - attributes_to_save - dataset_id title: SaveSpansToDatasetRequest GetSpanTreeRequest: type: object properties: attributes_to_return: type: array items: type: string description: The attributes to return in the tree. max_depth: type: integer description: The maximum depth of the tree. additionalProperties: false title: GetSpanTreeRequest SpanStatus: type: string enum: - ok - error title: SpanStatus description: >- The status of a span indicating whether it completed successfully or with an error. SpanWithStatus: type: object properties: span_id: type: string description: Unique identifier for the span trace_id: type: string description: >- Unique identifier for the trace this span belongs to parent_span_id: type: string description: >- (Optional) Unique identifier for the parent span, if this is a child span name: type: string description: >- Human-readable name describing the operation this span represents start_time: type: string format: date-time description: Timestamp when the operation began end_time: type: string format: date-time description: >- (Optional) Timestamp when the operation finished, if completed attributes: type: object additionalProperties: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array - type: object description: >- (Optional) Key-value pairs containing additional metadata about the span status: $ref: '#/components/schemas/SpanStatus' description: >- (Optional) The current status of the span additionalProperties: false required: - span_id - trace_id - name - start_time title: SpanWithStatus description: A span that includes status information. QuerySpanTreeResponse: type: object properties: data: type: object additionalProperties: $ref: '#/components/schemas/SpanWithStatus' description: >- Dictionary mapping span IDs to spans with status information additionalProperties: false required: - data title: QuerySpanTreeResponse description: >- Response containing a tree structure of spans. QueryTracesRequest: type: object properties: attribute_filters: type: array items: $ref: '#/components/schemas/QueryCondition' description: >- The attribute filters to apply to the traces. limit: type: integer description: The limit of traces to return. offset: type: integer description: The offset of the traces to return. order_by: type: array items: type: string description: The order by of the traces to return. additionalProperties: false title: QueryTracesRequest Trace: type: object properties: trace_id: type: string description: Unique identifier for the trace root_span_id: type: string description: >- Unique identifier for the root span that started this trace start_time: type: string format: date-time description: Timestamp when the trace began end_time: type: string format: date-time description: >- (Optional) Timestamp when the trace finished, if completed additionalProperties: false required: - trace_id - root_span_id - start_time title: Trace description: >- A trace representing the complete execution path of a request across multiple operations. QueryTracesResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Trace' description: >- List of traces matching the query criteria additionalProperties: false required: - data title: QueryTracesResponse description: Response containing a list of traces. responses: BadRequest400: description: The request was invalid or malformed content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 400 title: Bad Request detail: The request was invalid or malformed TooManyRequests429: description: >- The client has sent too many requests in a given amount of time content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 429 title: Too Many Requests detail: >- You have exceeded the rate limit. Please try again later. InternalServerError500: description: >- The server encountered an unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 500 title: Internal Server Error detail: >- An unexpected error occurred. Our team has been notified. DefaultError: description: An unexpected error occurred content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 0 title: Error detail: An unexpected error occurred security: - Default: [] tags: - name: Agents description: > APIs for creating and interacting with agentic systems. ## Deprecated APIs > **⚠️ DEPRECATED**: These APIs are provided for migration reference and will be removed in future versions. Not recommended for new projects. ### Migration Guidance If you are using deprecated versions of the Agents or Responses APIs, please migrate to: - **Responses API**: Use the stable v1 Responses API endpoints x-displayName: Agents - name: Benchmarks description: '' - name: DatasetIO description: '' - name: Datasets description: '' - name: Eval description: '' x-displayName: >- Llama Stack Evaluation API for running evaluations on model and agent candidates. - name: Files description: '' - name: Inference description: >- This API provides the raw interface to the underlying models. Two kinds of models are supported: - LLM models: these models generate "raw" and "chat" (conversational) completions. - Embedding models: these models generate embeddings to be used for semantic search. x-displayName: >- Llama Stack Inference API for generating completions, chat completions, and embeddings. - name: Models description: '' - name: PostTraining (Coming Soon) description: '' - name: Safety description: '' - name: Telemetry description: '' - name: VectorIO description: '' x-tagGroups: - name: Operations tags: - Agents - Benchmarks - DatasetIO - Datasets - Eval - Files - Inference - Models - PostTraining (Coming Soon) - Safety - Telemetry - VectorIO