llama-stack-mirror/docs/static/stainless-llama-stack-spec.yaml
Sébastien Han de4ed29310
chore: replace JSON requestBody block with query params
Signed-off-by: Sébastien Han <seb@redhat.com>
2025-11-14 09:56:18 +01:00

20480 lines
628 KiB
YAML

openapi: 3.1.0
info:
title: Llama Stack Specification - Stable & Experimental APIs
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.
**🔗 COMBINED**: This specification includes both stable production-ready APIs
and experimental pre-release APIs. Use stable APIs for production deployments
and experimental APIs for testing new features.
version: v1
servers:
- url: http://any-hosted-llama-stack.com
paths:
/v1/batches:
get:
responses:
'200':
description: A list of batch objects.
content:
application/json:
schema:
$ref: '#/components/schemas/ListBatchesResponse'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Batches
summary: List all batches for the current user.
description: List all batches for the current user.
parameters:
- name: after
in: query
description: >-
A cursor for pagination; returns batches after this batch ID.
required: false
schema:
type: string
- name: limit
in: query
description: >-
Number of batches to return (default 20, max 100).
required: true
schema:
type: integer
deprecated: false
post:
responses:
'200':
description: The created batch object.
content:
application/json:
schema:
$ref: '#/components/schemas/Batch'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Batches
summary: >-
Create a new batch for processing multiple API requests.
description: >-
Create a new batch for processing multiple API requests.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBatchRequest'
required: true
deprecated: false
/v1/batches/{batch_id}:
get:
responses:
'200':
description: The batch object.
content:
application/json:
schema:
$ref: '#/components/schemas/Batch'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Batches
summary: >-
Retrieve information about a specific batch.
description: >-
Retrieve information about a specific batch.
parameters:
- name: batch_id
in: path
description: The ID of the batch to retrieve.
required: true
schema:
type: string
deprecated: false
/v1/batches/{batch_id}/cancel:
post:
responses:
'200':
description: The updated batch object.
content:
application/json:
schema:
$ref: '#/components/schemas/Batch'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Batches
summary: Cancel a batch that is in progress.
description: Cancel a batch that is in progress.
parameters:
- name: batch_id
in: path
description: The ID of the batch to cancel.
required: true
schema:
type: string
deprecated: false
/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 chat completions.
description: List 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: false
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: Create chat completions.
description: >-
Create chat completions.
Generate an OpenAI-compatible chat completion for the given messages using
the specified model.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIChatCompletionRequestWithExtraBody'
required: true
deprecated: false
/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: Get chat completion.
description: >-
Get chat completion.
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: false
/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: Create completion.
description: >-
Create completion.
Generate an OpenAI-compatible completion for the given prompt using the specified
model.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody'
required: true
deprecated: false
/v1/conversations:
post:
responses:
'200':
description: The created conversation object.
content:
application/json:
schema:
$ref: '#/components/schemas/Conversation'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Conversations
summary: Create a conversation.
description: >-
Create a conversation.
Create a conversation.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateConversationRequest'
required: true
deprecated: false
/v1/conversations/{conversation_id}:
get:
responses:
'200':
description: The conversation object.
content:
application/json:
schema:
$ref: '#/components/schemas/Conversation'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Conversations
summary: Retrieve a conversation.
description: >-
Retrieve a conversation.
Get a conversation with the given ID.
parameters:
- name: conversation_id
in: path
description: The conversation identifier.
required: true
schema:
type: string
deprecated: false
post:
responses:
'200':
description: The updated conversation object.
content:
application/json:
schema:
$ref: '#/components/schemas/Conversation'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Conversations
summary: Update a conversation.
description: >-
Update a conversation.
Update a conversation's metadata with the given ID.
parameters:
- name: conversation_id
in: path
description: The conversation identifier.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateConversationRequest'
required: true
deprecated: false
delete:
responses:
'200':
description: The deleted conversation resource.
content:
application/json:
schema:
$ref: '#/components/schemas/ConversationDeletedResource'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Conversations
summary: Delete a conversation.
description: >-
Delete a conversation.
Delete a conversation with the given ID.
parameters:
- name: conversation_id
in: path
description: The conversation identifier.
required: true
schema:
type: string
deprecated: false
/v1/conversations/{conversation_id}/items:
get:
responses:
'200':
description: List of conversation items.
content:
application/json:
schema:
$ref: '#/components/schemas/ConversationItemList'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Conversations
summary: List items.
description: >-
List items.
List items in the conversation.
parameters:
- name: conversation_id
in: path
description: The conversation identifier.
required: true
schema:
type: string
- name: after
in: query
description: >-
An item ID to list items after, used in pagination.
required: false
schema:
type: string
- name: include
in: query
description: >-
Specify additional output data to include in the response.
required: false
schema:
type: array
items:
type: string
enum:
- web_search_call.action.sources
- code_interpreter_call.outputs
- computer_call_output.output.image_url
- file_search_call.results
- message.input_image.image_url
- message.output_text.logprobs
- reasoning.encrypted_content
title: ConversationItemInclude
description: >-
Specify additional output data to include in the model response.
- name: limit
in: query
description: >-
A limit on the number of objects to be returned (1-100, default 20).
required: false
schema:
type: integer
- name: order
in: query
description: >-
The order to return items in (asc or desc, default desc).
required: false
schema:
type: string
enum:
- asc
- desc
deprecated: false
post:
responses:
'200':
description: List of created items.
content:
application/json:
schema:
$ref: '#/components/schemas/ConversationItemList'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Conversations
summary: Create items.
description: >-
Create items.
Create items in the conversation.
parameters:
- name: conversation_id
in: path
description: The conversation identifier.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddItemsRequest'
required: true
deprecated: false
/v1/conversations/{conversation_id}/items/{item_id}:
get:
responses:
'200':
description: The conversation item.
content:
application/json:
schema:
$ref: '#/components/schemas/ConversationItem'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Conversations
summary: Retrieve an item.
description: >-
Retrieve an item.
Retrieve a conversation item.
parameters:
- name: conversation_id
in: path
description: The conversation identifier.
required: true
schema:
type: string
- name: item_id
in: path
description: The item identifier.
required: true
schema:
type: string
deprecated: false
delete:
responses:
'200':
description: The deleted item resource.
content:
application/json:
schema:
$ref: '#/components/schemas/ConversationItemDeletedResource'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Conversations
summary: Delete an item.
description: >-
Delete an item.
Delete a conversation item.
parameters:
- name: conversation_id
in: path
description: The conversation identifier.
required: true
schema:
type: string
- name: item_id
in: path
description: The item identifier.
required: true
schema:
type: string
deprecated: false
/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: Create embeddings.
description: >-
Create embeddings.
Generate OpenAI-compatible embeddings for the given input using the specified
model.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody'
required: true
deprecated: false
/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: List files.
description: >-
List files.
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: false
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 file.
description: >-
Upload file.
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: false
/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: Retrieve file.
description: >-
Retrieve file.
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: false
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 file.
description: Delete file.
parameters:
- name: file_id
in: path
description: >-
The ID of the file to use for this request.
required: true
schema:
type: string
deprecated: false
/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: Retrieve file content.
description: >-
Retrieve file content.
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: false
/v1/health:
get:
responses:
'200':
description: >-
Health information indicating if the service is operational.
content:
application/json:
schema:
$ref: '#/components/schemas/HealthInfo'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Inspect
summary: Get health status.
description: >-
Get health status.
Get the current health status of the service.
parameters: []
deprecated: false
/v1/inspect/routes:
get:
responses:
'200':
description: >-
Response containing information about all available routes.
content:
application/json:
schema:
$ref: '#/components/schemas/ListRoutesResponse'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Inspect
summary: List routes.
description: >-
List routes.
List all available API routes with their methods and implementing providers.
parameters:
- name: api_filter
in: query
description: >-
Optional filter to control which routes are returned. Can be an API level
('v1', 'v1alpha', 'v1beta') to show non-deprecated routes at that level,
or 'deprecated' to show deprecated routes across all levels. If not specified,
returns all non-deprecated routes.
required: false
schema:
type: string
enum:
- v1
- v1alpha
- v1beta
- deprecated
deprecated: false
/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: false
post:
responses:
'200':
description: A Model.
content:
application/json:
schema:
$ref: '#/components/schemas/Model'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Models
summary: Register model.
description: >-
Register model.
Register a model.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterModelRequest'
required: true
deprecated: true
/v1/models/{model_id}:
get:
responses:
'200':
description: A Model.
content:
application/json:
schema:
$ref: '#/components/schemas/Model'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Models
summary: Get model.
description: >-
Get model.
Get a model by its identifier.
parameters:
- name: model_id
in: path
description: The identifier of the model to get.
required: true
schema:
type: string
deprecated: false
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:
- Models
summary: Unregister model.
description: >-
Unregister model.
Unregister a model.
parameters:
- name: model_id
in: path
description: >-
The identifier of the model to unregister.
required: true
schema:
type: string
deprecated: true
/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: Create moderation.
description: >-
Create moderation.
Classifies if text and/or image inputs are potentially harmful.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RunModerationRequest'
required: true
deprecated: false
/v1/prompts:
get:
responses:
'200':
description: >-
A ListPromptsResponse containing all prompts.
content:
application/json:
schema:
$ref: '#/components/schemas/ListPromptsResponse'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Prompts
summary: List all prompts.
description: List all prompts.
parameters: []
deprecated: false
post:
responses:
'200':
description: The created Prompt resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Prompt'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Prompts
summary: Create prompt.
description: >-
Create prompt.
Create a new prompt.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePromptRequest'
required: true
deprecated: false
/v1/prompts/{prompt_id}:
get:
responses:
'200':
description: A Prompt resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Prompt'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Prompts
summary: Get prompt.
description: >-
Get prompt.
Get a prompt by its identifier and optional version.
parameters:
- name: prompt_id
in: path
description: The identifier of the prompt to get.
required: true
schema:
type: string
- name: version
in: query
description: >-
The version of the prompt to get (defaults to latest).
required: false
schema:
type: integer
deprecated: false
post:
responses:
'200':
description: >-
The updated Prompt resource with incremented version.
content:
application/json:
schema:
$ref: '#/components/schemas/Prompt'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Prompts
summary: Update prompt.
description: >-
Update prompt.
Update an existing prompt (increments version).
parameters:
- name: prompt_id
in: path
description: The identifier of the prompt to update.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePromptRequest'
required: true
deprecated: false
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:
- Prompts
summary: Delete prompt.
description: >-
Delete prompt.
Delete a prompt.
parameters:
- name: prompt_id
in: path
description: The identifier of the prompt to delete.
required: true
schema:
type: string
deprecated: false
/v1/prompts/{prompt_id}/set-default-version:
post:
responses:
'200':
description: >-
The prompt with the specified version now set as default.
content:
application/json:
schema:
$ref: '#/components/schemas/Prompt'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Prompts
summary: Set prompt version.
description: >-
Set prompt version.
Set which version of a prompt should be the default in get_prompt (latest).
parameters:
- name: prompt_id
in: path
description: The identifier of the prompt.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SetDefaultVersionRequest'
required: true
deprecated: false
/v1/prompts/{prompt_id}/versions:
get:
responses:
'200':
description: >-
A ListPromptsResponse containing all versions of the prompt.
content:
application/json:
schema:
$ref: '#/components/schemas/ListPromptsResponse'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Prompts
summary: List prompt versions.
description: >-
List prompt versions.
List all versions of a specific prompt.
parameters:
- name: prompt_id
in: path
description: >-
The identifier of the prompt to list versions for.
required: true
schema:
type: string
deprecated: false
/v1/providers:
get:
responses:
'200':
description: >-
A ListProvidersResponse containing information about all providers.
content:
application/json:
schema:
$ref: '#/components/schemas/ListProvidersResponse'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Providers
summary: List providers.
description: >-
List providers.
List all available providers.
parameters: []
deprecated: false
/v1/providers/{provider_id}:
get:
tags:
- Providers
summary: Inspect Provider
description: |-
Get provider.
Get detailed information about a specific provider.
operationId: inspect_provider_v1_providers__provider_id__get
responses:
'200':
description: A ProviderInfo object containing the provider's details.
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderInfo'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: provider_id
in: path
required: true
schema:
type: string
description: 'Path parameter: provider_id'
/v1/providers:
get:
tags:
- Providers
summary: List Providers
description: |-
List providers.
List all available providers.
operationId: list_providers_v1_providers_get
responses:
'200':
description: A ListProvidersResponse containing information about all providers.
content:
application/json:
schema:
$ref: '#/components/schemas/ListProvidersResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/responses:
post:
tags:
- Agents
summary: Create Openai Response
description: Create a model response.
operationId: create_openai_response_v1_responses_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/_responses_Request'
x-llama-stack-extra-body-params:
guardrails:
$defs:
ResponseGuardrailSpec:
description: |-
Specification for a guardrail to apply during response generation.
:param type: The type/identifier of the guardrail.
properties:
type:
title: Type
type: string
required:
- type
title: ResponseGuardrailSpec
type: object
anyOf:
- items:
anyOf:
- type: string
- $ref: '#/components/schemas/ResponseGuardrailSpec'
type: array
- type: 'null'
description: List of guardrails to apply during response generation. Guardrails provide safety and content moderation.
responses:
'200':
description: An OpenAIResponseObject.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIResponseObject'
text/event-stream:
schema:
$ref: '#/components/schemas/OpenAIResponseObjectStream'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
get:
tags:
- Agents
summary: List Openai Responses
description: List all responses.
operationId: list_openai_responses_v1_responses_get
parameters:
- name: after
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: After
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
default: 50
title: Limit
- name: model
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Model
- name: order
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/Order'
- type: 'null'
default: desc
title: Order
responses:
'200':
description: A ListOpenAIResponseObject.
content:
application/json:
schema:
$ref: '#/components/schemas/ListOpenAIResponseObject'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1/responses/{response_id}:
get:
tags:
- Agents
summary: Get Openai Response
description: Get a model response.
operationId: get_openai_response_v1_responses__response_id__get
responses:
'200':
description: An OpenAIResponseObject.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIResponseObject'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: response_id
in: path
required: true
schema:
type: string
description: 'Path parameter: response_id'
delete:
tags:
- Agents
summary: Delete Openai Response
description: Delete a response.
operationId: delete_openai_response_v1_responses__response_id__delete
responses:
'200':
description: An OpenAIDeleteResponseObject
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIDeleteResponseObject'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: response_id
in: path
required: true
schema:
type: string
description: 'Path parameter: response_id'
/v1/responses/{response_id}/input_items:
get:
tags:
- Agents
summary: List Openai Response Input Items
description: List input items.
operationId: list_openai_response_input_items_v1_responses__response_id__input_items_get
parameters:
- name: after
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: After
- name: before
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Before
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
default: 20
title: Limit
- name: order
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/Order'
- type: 'null'
default: desc
title: Order
- name: response_id
in: path
required: true
schema:
type: string
description: 'Path parameter: response_id'
- name: include
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Include
responses:
'200':
description: An ListOpenAIResponseInputItem.
content:
application/json:
schema:
$ref: '#/components/schemas/ListOpenAIResponseInputItem'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1/chat/completions/{completion_id}:
get:
tags:
- Inference
summary: Get Chat Completion
description: |-
Get chat completion.
Describe a chat completion by its ID.
operationId: get_chat_completion_v1_chat_completions__completion_id__get
responses:
'200':
description: A OpenAICompletionWithInputMessages.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAICompletionWithInputMessages'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: completion_id
in: path
required: true
schema:
type: string
description: 'Path parameter: completion_id'
/v1/chat/completions:
get:
tags:
- Inference
summary: List Chat Completions
description: List chat completions.
operationId: list_chat_completions_v1_chat_completions_get
parameters:
- name: after
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: After
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
default: 20
title: Limit
- name: model
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Model
- name: order
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/Order'
- type: 'null'
default: desc
title: Order
responses:
'200':
description: A ListOpenAIChatCompletionResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListOpenAIChatCompletionResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
tags:
- ScoringFunctions
summary: List all scoring functions.
description: List all scoring functions.
parameters: []
deprecated: false
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:
- ScoringFunctions
summary: Register a scoring function.
description: Register a scoring function.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterScoringFunctionRequest'
required: true
deprecated: true
/v1/scoring-functions/{scoring_fn_id}:
get:
responses:
'200':
description: An OpenAIChatCompletion.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIChatCompletion'
text/event-stream:
schema:
$ref: '#/components/schemas/OpenAIChatCompletionChunk'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
tags:
- ScoringFunctions
summary: Get a scoring function by its ID.
description: Get a scoring function by its ID.
parameters:
- name: scoring_fn_id
in: path
description: The ID of the scoring function to get.
required: true
schema:
type: string
deprecated: false
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:
- ScoringFunctions
summary: Unregister a scoring function.
description: Unregister a scoring function.
parameters:
- name: scoring_fn_id
in: path
description: >-
The ID of the scoring function to unregister.
required: true
schema:
type: string
deprecated: true
/v1/scoring/score:
post:
tags:
- Inference
summary: Openai Completion
description: |-
Create completion.
Generate an OpenAI-compatible completion for the given prompt using the specified model.
operationId: openai_completion_v1_completions_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody'
required: true
responses:
'200':
description: An OpenAICompletion.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAICompletion'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/embeddings:
post:
tags:
- Inference
summary: Openai Embeddings
description: |-
Create embeddings.
Generate OpenAI-compatible embeddings for the given input using the specified model.
operationId: openai_embeddings_v1_embeddings_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody'
required: true
responses:
'200':
description: An OpenAIEmbeddingsResponse containing the embeddings.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIEmbeddingsResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
tags:
- Shields
summary: List all shields.
description: List all shields.
parameters: []
deprecated: false
post:
responses:
'200':
description: A Shield.
content:
application/json:
schema:
$ref: '#/components/schemas/Shield'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- Shields
summary: Register a shield.
description: Register a shield.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterShieldRequest'
required: true
deprecated: true
/v1/shields/{identifier}:
get:
responses:
'200':
description: RerankResponse with indices sorted by relevance score (descending).
content:
application/json:
schema:
$ref: '#/components/schemas/RerankResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/health:
get:
tags:
- Shields
summary: Get a shield by its identifier.
description: Get a shield by its identifier.
parameters:
- name: identifier
in: path
description: The identifier of the shield to get.
required: true
schema:
type: string
deprecated: false
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:
- Shields
summary: Unregister a shield.
description: Unregister a shield.
parameters:
- name: identifier
in: path
description: >-
The identifier of the shield to unregister.
required: true
schema:
type: string
deprecated: true
/v1/tool-runtime/invoke:
post:
tags:
- Batches
summary: Cancel Batch
description: Cancel a batch that is in progress.
operationId: cancel_batch_v1_batches__batch_id__cancel_post
responses:
'200':
description: The updated batch object.
content:
application/json:
schema:
$ref: '#/components/schemas/Batch'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: tool_group_id
in: query
description: >-
The ID of the tool group to list tools for.
required: false
schema:
type: string
- name: mcp_endpoint
in: query
description: >-
The MCP endpoint to use for the tool group.
required: false
schema:
$ref: '#/components/schemas/URL'
deprecated: false
/v1/toolgroups:
get:
responses:
'200':
description: A ListToolGroupsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListToolGroupsResponse'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- ToolGroups
summary: List tool groups with optional provider.
description: List tool groups with optional provider.
parameters: []
deprecated: false
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:
- ToolGroups
summary: Register a tool group.
description: Register a tool group.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterToolGroupRequest'
required: true
deprecated: true
/v1/toolgroups/{toolgroup_id}:
get:
responses:
'200':
description: A ToolGroup.
content:
application/json:
schema:
$ref: '#/components/schemas/ToolGroup'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- ToolGroups
summary: Get a tool group by its ID.
description: Get a tool group by its ID.
parameters:
- name: toolgroup_id
in: path
description: The ID of the tool group to get.
required: true
schema:
type: string
deprecated: false
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:
- ToolGroups
summary: Unregister a tool group.
description: Unregister a tool group.
parameters:
- name: toolgroup_id
in: path
description: The ID of the tool group to unregister.
required: true
schema:
type: string
deprecated: true
/v1/tools:
get:
responses:
'200':
description: A ListToolDefsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListToolDefsResponse'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- ToolGroups
summary: List tools with optional tool group.
description: List tools with optional tool group.
parameters:
- name: toolgroup_id
in: query
description: >-
The ID of the tool group to list tools for.
required: false
schema:
type: string
deprecated: false
/v1/tools/{tool_name}:
get:
responses:
'200':
description: A ToolDef.
content:
application/json:
schema:
$ref: '#/components/schemas/ToolDef'
'400':
$ref: '#/components/responses/BadRequest400'
'429':
$ref: >-
#/components/responses/TooManyRequests429
'500':
$ref: >-
#/components/responses/InternalServerError500
default:
$ref: '#/components/responses/DefaultError'
tags:
- ToolGroups
summary: Get a tool by its name.
description: Get a tool by its name.
parameters:
- name: tool_name
in: path
description: The name of the tool to get.
required: true
schema:
type: string
deprecated: false
/v1/vector-io/insert:
post:
tags:
- Vector Io
summary: Insert Chunks
description: Insert chunks into a vector database.
operationId: insert_chunks_v1_vector_io_insert_post
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Chunk-Input'
title: Chunks
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1/vector_stores/{vector_store_id}/files:
post:
tags:
- Vector Io
summary: Openai Attach File To Vector Store
description: Attach a file to a vector store.
operationId: openai_attach_file_to_vector_store_v1_vector_stores__vector_store_id__files_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/_vector_stores_vector_store_id_files_Request'
responses:
'200':
description: A VectorStoreFileObject representing the attached file.
content:
application/json:
schema:
$ref: '#/components/schemas/VectorStoreFileObject'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
get:
tags:
- Vector Io
summary: Openai List Files In Vector Store
description: List files in a vector store.
operationId: openai_list_files_in_vector_store_v1_vector_stores__vector_store_id__files_get
parameters:
- name: after
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: After
- name: before
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Before
- name: filter
in: query
required: false
schema:
anyOf:
- const: completed
type: string
- const: in_progress
type: string
- const: cancelled
type: string
- const: failed
type: string
- type: 'null'
title: Filter
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
default: 20
title: Limit
- name: order
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
default: desc
title: Order
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
responses:
'200':
description: A VectorStoreListFilesResponse containing the list of files.
content:
application/json:
schema:
$ref: '#/components/schemas/VectorStoreListFilesResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel:
post:
tags:
- Vector Io
summary: Openai Cancel Vector Store File Batch
description: Cancels a vector store file batch.
operationId: openai_cancel_vector_store_file_batch_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':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
- name: batch_id
in: path
required: true
schema:
type: string
description: 'Path parameter: batch_id'
/v1/vector_stores:
post:
tags:
- Vector Io
summary: Openai Create Vector Store
description: |-
Creates a vector store.
Generate an OpenAI-compatible vector store with the given parameters.
operationId: openai_create_vector_store_v1_vector_stores_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody'
responses:
'200':
description: A VectorStoreObject representing the created vector store.
content:
application/json:
schema:
$ref: '#/components/schemas/VectorStoreObject'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
get:
tags:
- Vector Io
summary: Openai List Vector Stores
description: Returns a list of vector stores.
operationId: openai_list_vector_stores_v1_vector_stores_get
parameters:
- name: after
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: After
- name: before
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Before
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
default: 20
title: Limit
- name: order
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
default: desc
title: Order
responses:
'200':
description: A VectorStoreListResponse containing the list of vector stores.
content:
application/json:
schema:
$ref: '#/components/schemas/VectorStoreListResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1/vector_stores/{vector_store_id}/file_batches:
post:
tags:
- Vector Io
summary: Openai Create Vector Store File Batch
description: |-
Create a vector store file batch.
Generate an OpenAI-compatible vector store file batch for the given vector store.
operationId: openai_create_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody'
required: true
responses:
'200':
description: A VectorStoreFileBatchObject representing the created file batch.
content:
application/json:
schema:
$ref: '#/components/schemas/VectorStoreFileBatchObject'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
/v1/vector_stores/{vector_store_id}:
get:
tags:
- Vector Io
summary: Openai Retrieve Vector Store
description: Retrieves a vector store.
operationId: openai_retrieve_vector_store_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':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
post:
tags:
- Vector Io
summary: Openai Update Vector Store
description: Updates a vector store.
operationId: openai_update_vector_store_v1_vector_stores__vector_store_id__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_vector_stores_vector_store_id_Request'
required: true
responses:
'200':
description: A VectorStoreObject representing the updated vector store.
content:
application/json:
schema:
$ref: '#/components/schemas/VectorStoreObject'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
delete:
tags:
- Vector Io
summary: Openai Delete Vector Store
description: Delete a vector store.
operationId: openai_delete_vector_store_v1_vector_stores__vector_store_id__delete
responses:
'200':
description: A VectorStoreDeleteResponse indicating the deletion status.
content:
application/json:
schema:
$ref: '#/components/schemas/VectorStoreDeleteResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
/v1/vector_stores/{vector_store_id}/files/{file_id}:
get:
tags:
- Vector Io
summary: Openai Retrieve Vector Store File
description: Retrieves a vector store file.
operationId: openai_retrieve_vector_store_file_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':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
- name: file_id
in: path
required: true
schema:
type: string
description: 'Path parameter: file_id'
post:
tags:
- Vector Io
summary: Openai Update Vector Store File
description: Updates a vector store file.
operationId: openai_update_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_vector_stores_vector_store_id_files_file_id_Request'
required: true
responses:
'200':
description: A VectorStoreFileObject representing the updated file.
content:
application/json:
schema:
$ref: '#/components/schemas/VectorStoreFileObject'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
- name: file_id
in: path
required: true
schema:
type: string
description: 'Path parameter: file_id'
delete:
tags:
- Vector Io
summary: Openai Delete Vector Store File
description: Delete a vector store file.
operationId: openai_delete_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__delete
responses:
'200':
description: A VectorStoreFileDeleteResponse indicating the deletion status.
content:
application/json:
schema:
$ref: '#/components/schemas/VectorStoreFileDeleteResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
- name: file_id
in: path
required: true
schema:
type: string
description: 'Path parameter: file_id'
/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files:
get:
tags:
- Vector Io
summary: Openai List Files In Vector Store File Batch
description: Returns a list of vector store files in a batch.
operationId: openai_list_files_in_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__files_get
parameters:
- name: after
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: After
- name: before
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Before
- name: filter
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Filter
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
default: 20
title: Limit
- name: order
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
default: desc
title: Order
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
- name: batch_id
in: path
required: true
schema:
type: string
description: 'Path parameter: batch_id'
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'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}:
get:
tags:
- Vector Io
summary: Openai Retrieve Vector Store File Batch
description: Retrieve a vector store file batch.
operationId: openai_retrieve_vector_store_file_batch_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':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
- name: batch_id
in: path
required: true
schema:
type: string
description: 'Path parameter: batch_id'
/v1/vector_stores/{vector_store_id}/files/{file_id}/content:
get:
tags:
- Vector Io
summary: Openai Retrieve Vector Store File Contents
description: Retrieves the contents of a vector store file.
operationId: openai_retrieve_vector_store_file_contents_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':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
- name: file_id
in: path
required: true
schema:
type: string
description: 'Path parameter: file_id'
/v1/vector_stores/{vector_store_id}/search:
post:
tags:
- Vector Io
summary: Openai Search 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.
operationId: openai_search_vector_store_v1_vector_stores__vector_store_id__search_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_vector_stores_vector_store_id_search_Request'
required: true
responses:
'200':
description: A VectorStoreSearchResponse containing the search results.
content:
application/json:
schema:
$ref: '#/components/schemas/VectorStoreSearchResponsePage'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: vector_store_id
in: path
required: true
schema:
type: string
description: 'Path parameter: vector_store_id'
/v1/vector-io/query:
post:
tags:
- Vector Io
summary: Query Chunks
description: Query chunks from a vector database.
operationId: query_chunks_v1_vector_io_query_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_vector_io_query_Request'
required: true
responses:
'200':
description: A QueryChunksResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryChunksResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/models/{model_id}:
get:
tags:
- Models
summary: Get Model
description: |-
Get model.
Get a model by its identifier.
operationId: get_model_v1_models__model_id__get
responses:
'200':
description: A Model.
content:
application/json:
schema:
$ref: '#/components/schemas/Model'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: model_id
in: path
required: true
schema:
type: string
description: 'Path parameter: model_id'
delete:
tags:
- Models
summary: Unregister Model
description: |-
Unregister model.
Unregister a model.
operationId: unregister_model_v1_models__model_id__delete
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: model_id
in: path
required: true
schema:
type: string
description: 'Path parameter: model_id'
/v1/models:
get:
tags:
- Models
summary: Openai List Models
description: List models using the OpenAI API.
operationId: openai_list_models_v1_models_get
responses:
'200':
description: A OpenAIListModelsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIListModelsResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
post:
tags:
- Models
summary: Register Model
description: |-
Register model.
Register a model.
operationId: register_model_v1_models_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_models_Request'
required: true
responses:
'200':
description: A Model.
content:
application/json:
schema:
$ref: '#/components/schemas/Model'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/moderations:
post:
tags:
- Safety
summary: Run Moderation
description: |-
Create moderation.
Classifies if text and/or image inputs are potentially harmful.
operationId: run_moderation_v1_moderations_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_moderations_Request'
required: true
responses:
'200':
description: A moderation object.
content:
application/json:
schema:
$ref: '#/components/schemas/ModerationObject'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/safety/run-shield:
post:
tags:
- Safety
summary: Run Shield
description: |-
Run shield.
Run a shield.
operationId: run_shield_v1_safety_run_shield_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_safety_run_shield_Request'
required: true
responses:
'200':
description: A RunShieldResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/RunShieldResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/shields/{identifier}:
get:
tags:
- Shields
summary: Get Shield
description: Get a shield by its identifier.
operationId: get_shield_v1_shields__identifier__get
responses:
'200':
description: A Shield.
content:
application/json:
schema:
$ref: '#/components/schemas/Shield'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: identifier
in: path
required: true
schema:
type: string
description: 'Path parameter: identifier'
delete:
tags:
- Shields
summary: Unregister Shield
description: Unregister a shield.
operationId: unregister_shield_v1_shields__identifier__delete
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: identifier
in: path
required: true
schema:
type: string
description: 'Path parameter: identifier'
/v1/shields:
get:
tags:
- Shields
summary: List Shields
description: List all shields.
operationId: list_shields_v1_shields_get
responses:
'200':
description: >-
File contents, optionally with embeddings and metadata based on query
parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/VectorStoreFileContentResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$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
- name: include_embeddings
in: query
description: >-
Whether to include embedding vectors in the response.
required: false
schema:
$ref: '#/components/schemas/bool'
- name: include_metadata
in: query
description: >-
Whether to include chunk metadata in the response.
required: false
schema:
$ref: '#/components/schemas/bool'
deprecated: false
/v1/vector_stores/{vector_store_id}/search:
post:
tags:
- Shields
summary: Register Shield
description: Register a shield.
operationId: register_shield_v1_shields_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_shields_Request'
required: true
responses:
'200':
description: A Shield.
content:
application/json:
schema:
$ref: '#/components/schemas/Shield'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1beta/datasetio/append-rows/{dataset_id}:
post:
tags:
- Datasetio
summary: Append Rows
description: Append rows to a dataset.
operationId: append_rows_v1beta_datasetio_append_rows__dataset_id__post
requestBody:
content:
application/json:
schema:
items:
additionalProperties: true
type: object
type: array
title: Rows
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
description: 'Path parameter: dataset_id'
/v1beta/datasetio/iterrows/{dataset_id}:
get:
tags:
- Datasetio
summary: Iterrows
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.
operationId: iterrows_v1beta_datasetio_iterrows__dataset_id__get
parameters:
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Limit
- name: start_index
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Start Index
- name: dataset_id
in: path
required: true
schema:
type: string
description: 'Path parameter: dataset_id'
responses:
'200':
description: A PaginatedResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1beta/datasets/{dataset_id}:
get:
tags:
- Datasets
summary: Get Dataset
description: Get a dataset by its ID.
operationId: get_dataset_v1beta_datasets__dataset_id__get
responses:
'200':
description: A Dataset.
content:
application/json:
schema:
$ref: '#/components/schemas/Dataset'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
description: 'Path parameter: dataset_id'
delete:
tags:
- Datasets
summary: Unregister Dataset
description: Unregister a dataset by its ID.
operationId: unregister_dataset_v1beta_datasets__dataset_id__delete
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
description: 'Path parameter: dataset_id'
/v1beta/datasets:
get:
tags:
- Datasets
summary: List Datasets
description: List all datasets.
operationId: list_datasets_v1beta_datasets_get
responses:
'200':
description: A ListDatasetsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListDatasetsResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
post:
tags:
- Datasets
summary: Register Dataset
description: Register a new dataset.
operationId: register_dataset_v1beta_datasets_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_datasets_Request'
required: true
deprecated: true
/v1beta/datasets/{dataset_id}:
get:
responses:
'200':
description: A Dataset.
content:
application/json:
schema:
$ref: '#/components/schemas/Dataset'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/scoring/score:
post:
tags:
- Scoring
summary: Score
description: Score a list of rows.
operationId: score_v1_scoring_score_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_scoring_score_Request'
required: true
responses:
'200':
description: A ScoreResponse object containing rows and aggregated results.
content:
application/json:
schema:
$ref: '#/components/schemas/ScoreResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/scoring/score-batch:
post:
tags:
- Scoring
summary: Score Batch
description: Score a batch of rows.
operationId: score_batch_v1_scoring_score_batch_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_scoring_score_batch_Request'
required: true
responses:
'200':
description: A ScoreBatchResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ScoreBatchResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/scoring-functions/{scoring_fn_id}:
get:
tags:
- Scoring Functions
summary: Get Scoring Function
description: Get a scoring function by its ID.
operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get
responses:
'200':
description: A ScoringFn.
content:
application/json:
schema:
$ref: '#/components/schemas/ScoringFn'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: scoring_fn_id
in: path
required: true
schema:
type: string
description: 'Path parameter: scoring_fn_id'
delete:
tags:
- Scoring Functions
summary: Unregister Scoring Function
description: Unregister a scoring function.
operationId: unregister_scoring_function_v1_scoring_functions__scoring_fn_id__delete
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: scoring_fn_id
in: path
required: true
schema:
type: string
description: 'Path parameter: scoring_fn_id'
/v1/scoring-functions:
get:
tags:
- Scoring Functions
summary: List Scoring Functions
description: List all scoring functions.
operationId: list_scoring_functions_v1_scoring_functions_get
responses:
'200':
description: A ListScoringFunctionsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListScoringFunctionsResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
post:
tags:
- Scoring Functions
summary: Register Scoring Function
description: Register a scoring function.
operationId: register_scoring_function_v1_scoring_functions_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_register_scoring_function_v1_scoring_functions_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1alpha/eval/benchmarks/{benchmark_id}/evaluations:
post:
tags:
- Eval
summary: Evaluate Rows
description: Evaluate a list of rows on a benchmark.
operationId: evaluate_rows_v1alpha_eval_benchmarks__benchmark_id__evaluations_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_eval_benchmarks_benchmark_id_evaluations_Request'
required: true
responses:
'200':
description: EvaluateResponse object containing generations and scores.
content:
application/json:
schema:
$ref: '#/components/schemas/EvaluateResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: dataset_id
in: path
description: The ID of the dataset to unregister.
required: true
schema:
type: string
deprecated: true
/v1alpha/eval/benchmarks:
get:
tags:
- Benchmarks
summary: List Benchmarks
description: List all benchmarks.
operationId: list_benchmarks_v1alpha_eval_benchmarks_get
responses:
'200':
description: A ListBenchmarksResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListBenchmarksResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
post:
tags:
- Benchmarks
summary: Register Benchmark
description: Register a benchmark.
operationId: register_benchmark_v1alpha_eval_benchmarks_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterBenchmarkRequest'
required: true
deprecated: true
/v1alpha/eval/benchmarks/{benchmark_id}:
get:
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
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: false
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
/v1alpha/eval/benchmarks/{benchmark_id}/evaluations:
post:
tags:
- Post Training
summary: Cancel Training Job
description: Cancel a training job.
operationId: cancel_training_job_v1alpha_post_training_job_cancel_post
parameters:
- name: job_uuid
in: query
required: true
schema:
type: string
title: Job Uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1alpha/post-training/job/artifacts:
get:
tags:
- Post Training
summary: Get Training Job Artifacts
description: Get the artifacts of a training job.
operationId: get_training_job_artifacts_v1alpha_post_training_job_artifacts_get
parameters:
- name: job_uuid
in: query
required: true
schema:
type: string
title: Job Uuid
responses:
'200':
description: A PostTrainingJobArtifactsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/PostTrainingJobArtifactsResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1alpha/post-training/job/status:
get:
tags:
- Post Training
summary: Get Training Job Status
description: Get the status of a training job.
operationId: get_training_job_status_v1alpha_post_training_job_status_get
parameters:
- name: job_uuid
in: query
required: true
schema:
type: string
title: Job Uuid
responses:
'200':
description: A PostTrainingJobStatusResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/PostTrainingJobStatusResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1alpha/post-training/jobs:
get:
tags:
- Post Training
summary: Get Training Jobs
description: Get all training jobs.
operationId: get_training_jobs_v1alpha_post_training_jobs_get
responses:
'200':
description: A ListPostTrainingJobsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListPostTrainingJobsResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1alpha/post-training/preference-optimize:
post:
tags:
- Post Training
summary: Preference Optimize
description: Run preference optimization of a model.
operationId: preference_optimize_v1alpha_post_training_preference_optimize_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_post_training_preference_optimize_Request'
required: true
responses:
'200':
description: A PostTrainingJob.
content:
application/json:
schema:
$ref: '#/components/schemas/PostTrainingJob'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1alpha/post-training/supervised-fine-tune:
post:
tags:
- Post Training
summary: Supervised Fine Tune
description: Run supervised fine-tuning of a model.
operationId: supervised_fine_tune_v1alpha_post_training_supervised_fine_tune_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_post_training_supervised_fine_tune_Request'
required: true
responses:
'200':
description: A PostTrainingJob.
content:
application/json:
schema:
$ref: '#/components/schemas/PostTrainingJob'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/tools/{tool_name}:
get:
tags:
- Tool Groups
summary: Get Tool
description: Get a tool by its name.
operationId: get_tool_v1_tools__tool_name__get
responses:
'200':
description: A ToolDef.
content:
application/json:
schema:
$ref: '#/components/schemas/ToolDef'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: tool_name
in: path
required: true
schema:
type: string
description: 'Path parameter: tool_name'
/v1/toolgroups/{toolgroup_id}:
get:
tags:
- Tool Groups
summary: Get Tool Group
description: Get a tool group by its ID.
operationId: get_tool_group_v1_toolgroups__toolgroup_id__get
responses:
'200':
description: A ToolGroup.
content:
application/json:
schema:
$ref: '#/components/schemas/ToolGroup'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: toolgroup_id
in: path
required: true
schema:
type: string
description: 'Path parameter: toolgroup_id'
delete:
tags:
- Tool Groups
summary: Unregister Toolgroup
description: Unregister a tool group.
operationId: unregister_toolgroup_v1_toolgroups__toolgroup_id__delete
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: toolgroup_id
in: path
required: true
schema:
type: string
description: 'Path parameter: toolgroup_id'
/v1/toolgroups:
get:
tags:
- Tool Groups
summary: List Tool Groups
description: List tool groups with optional provider.
operationId: list_tool_groups_v1_toolgroups_get
responses:
'200':
description: A ListToolGroupsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListToolGroupsResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
post:
tags:
- Tool Groups
summary: Register Tool Group
description: Register a tool group.
operationId: register_tool_group_v1_toolgroups_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_register_tool_group_v1_toolgroups_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1/tools:
get:
tags:
- Tool Groups
summary: List Tools
description: List tools with optional tool group.
operationId: list_tools_v1_tools_get
parameters:
- name: toolgroup_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Toolgroup Id
responses:
'200':
description: A ListToolDefsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListToolDefsResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1/tool-runtime/invoke:
post:
tags:
- Tool Runtime
summary: Invoke Tool
description: Run a tool with the given arguments.
operationId: invoke_tool_v1_tool_runtime_invoke_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_tool_runtime_invoke_Request'
required: true
responses:
'200':
description: A ToolInvocationResult.
content:
application/json:
schema:
$ref: '#/components/schemas/ToolInvocationResult'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/tool-runtime/list-tools:
get:
tags:
- Tool Runtime
summary: List Runtime Tools
description: List all tools in the runtime.
operationId: list_runtime_tools_v1_tool_runtime_list_tools_get
parameters:
- name: tool_group_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Tool Group Id
- name: mcp_endpoint
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/URL'
- type: 'null'
title: Mcp Endpoint
responses:
'200':
description: A ListToolDefsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListToolDefsResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1/files/{file_id}:
get:
tags:
- Files
summary: Openai Retrieve File
description: |-
Retrieve file.
Returns information about a specific file.
operationId: openai_retrieve_file_v1_files__file_id__get
responses:
'200':
description: An OpenAIFileObject containing file information.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIFileObject'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: file_id
in: path
required: true
schema:
type: string
description: 'Path parameter: file_id'
delete:
tags:
- Files
summary: Openai Delete File
description: Delete file.
operationId: openai_delete_file_v1_files__file_id__delete
responses:
'200':
description: An OpenAIFileDeleteResponse indicating successful deletion.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIFileDeleteResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: file_id
in: path
required: true
schema:
type: string
description: 'Path parameter: file_id'
/v1/files:
get:
tags:
- Files
summary: Openai List Files
description: |-
List files.
Returns a list of files that belong to the user's organization.
operationId: openai_list_files_v1_files_get
parameters:
- name: after
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: After
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
default: 10000
title: Limit
- name: order
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/Order'
- type: 'null'
default: desc
title: Order
- name: purpose
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/OpenAIFilePurpose'
- type: 'null'
title: Purpose
responses:
'200':
description: An ListOpenAIFileResponse containing the list of files.
content:
application/json:
schema:
$ref: '#/components/schemas/ListOpenAIFileResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
post:
tags:
- Files
summary: Openai Upload File
description: |-
Upload file.
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.
operationId: openai_upload_file_v1_files_post
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_openai_upload_file_v1_files_post'
responses:
'200':
description: An OpenAIFileObject representing the uploaded file.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIFileObject'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1/files/{file_id}/content:
get:
tags:
- Files
summary: Openai Retrieve File Content
description: |-
Retrieve file content.
Returns the contents of the specified file.
operationId: openai_retrieve_file_content_v1_files__file_id__content_get
responses:
'200':
description: The raw file content as a binary response.
content:
application/json:
schema: {}
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: file_id
in: path
required: true
schema:
type: string
description: 'Path parameter: file_id'
/v1/prompts:
get:
tags:
- Prompts
summary: List Prompts
description: List all prompts.
operationId: list_prompts_v1_prompts_get
responses:
'200':
description: A ListPromptsResponse containing all prompts.
content:
application/json:
schema:
$ref: '#/components/schemas/ListPromptsResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
post:
tags:
- Prompts
summary: Create Prompt
description: |-
Create prompt.
Create a new prompt.
operationId: create_prompt_v1_prompts_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_prompts_Request'
required: true
responses:
'200':
description: The created Prompt resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Prompt'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/prompts/{prompt_id}:
delete:
tags:
- Prompts
summary: Delete Prompt
description: |-
Delete prompt.
Delete a prompt.
operationId: delete_prompt_v1_prompts__prompt_id__delete
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
parameters:
- name: prompt_id
in: path
required: true
schema:
type: string
description: 'Path parameter: prompt_id'
get:
tags:
- Prompts
summary: Get Prompt
description: |-
Get prompt.
Get a prompt by its identifier and optional version.
operationId: get_prompt_v1_prompts__prompt_id__get
parameters:
- name: version
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Version
- name: prompt_id
in: path
required: true
schema:
type: string
description: 'Path parameter: prompt_id'
responses:
'200':
description: A Prompt resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Prompt'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
post:
tags:
- Prompts
summary: Update Prompt
description: |-
Update prompt.
Update an existing prompt (increments version).
operationId: update_prompt_v1_prompts__prompt_id__post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/_prompts_prompt_id_Request'
responses:
'200':
description: The updated Prompt resource with incremented version.
content:
application/json:
schema:
$ref: '#/components/schemas/Prompt'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
parameters:
- name: prompt_id
in: path
required: true
schema:
type: string
description: 'Path parameter: prompt_id'
/v1/prompts/{prompt_id}/versions:
get:
tags:
- Prompts
summary: List Prompt Versions
description: |-
List prompt versions.
List all versions of a specific prompt.
operationId: list_prompt_versions_v1_prompts__prompt_id__versions_get
responses:
'200':
description: A ListPromptsResponse containing all versions of the prompt.
content:
application/json:
schema:
$ref: '#/components/schemas/ListPromptsResponse'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: prompt_id
in: path
required: true
schema:
type: string
description: 'Path parameter: prompt_id'
/v1/prompts/{prompt_id}/set-default-version:
post:
tags:
- Prompts
summary: Set Default Version
description: |-
Set prompt version.
Set which version of a prompt should be the default in get_prompt (latest).
operationId: set_default_version_v1_prompts__prompt_id__set_default_version_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_prompts_prompt_id_set_default_version_Request'
required: true
responses:
'200':
description: The prompt with the specified version now set as default.
content:
application/json:
schema:
$ref: '#/components/schemas/Prompt'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: prompt_id
in: path
required: true
schema:
type: string
description: 'Path parameter: prompt_id'
/v1/conversations/{conversation_id}/items:
post:
tags:
- Conversations
summary: Add Items
description: |-
Create items.
Create items in the conversation.
operationId: add_items_v1_conversations__conversation_id__items_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/_conversations_conversation_id_items_Request'
responses:
'200':
description: List of created items.
content:
application/json:
schema:
$ref: '#/components/schemas/ConversationItemList'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
parameters:
- name: conversation_id
in: path
required: true
schema:
type: string
description: 'Path parameter: conversation_id'
get:
tags:
- Conversations
summary: List Items
description: |-
List items.
List items in the conversation.
operationId: list_items_v1_conversations__conversation_id__items_get
parameters:
- name: after
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: After
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Limit
- name: order
in: query
required: false
schema:
anyOf:
- enum:
- asc
- desc
type: string
- type: 'null'
title: Order
- name: conversation_id
in: path
required: true
schema:
type: string
description: 'Path parameter: conversation_id'
- name: include
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/ConversationItemInclude'
- type: 'null'
title: Include
responses:
'200':
description: List of conversation items.
content:
application/json:
schema:
$ref: '#/components/schemas/ConversationItemList'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
/v1/conversations:
post:
tags:
- Conversations
summary: Create Conversation
description: |-
Create a conversation.
Create a conversation.
operationId: create_conversation_v1_conversations_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_conversations_Request'
required: true
responses:
'200':
description: The created conversation object.
content:
application/json:
schema:
$ref: '#/components/schemas/Conversation'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
/v1/conversations/{conversation_id}:
get:
tags:
- Conversations
summary: Get Conversation
description: |-
Retrieve a conversation.
Get a conversation with the given ID.
operationId: get_conversation_v1_conversations__conversation_id__get
responses:
'200':
description: The conversation object.
content:
application/json:
schema:
$ref: '#/components/schemas/Conversation'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: conversation_id
in: path
required: true
schema:
type: string
description: 'Path parameter: conversation_id'
post:
tags:
- Conversations
summary: Update Conversation
description: |-
Update a conversation.
Update a conversation's metadata with the given ID.
operationId: update_conversation_v1_conversations__conversation_id__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/_conversations_conversation_id_Request'
required: true
responses:
'200':
description: The updated conversation object.
content:
application/json:
schema:
$ref: '#/components/schemas/Conversation'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: conversation_id
in: path
required: true
schema:
type: string
description: 'Path parameter: conversation_id'
delete:
tags:
- Conversations
summary: Openai Delete Conversation
description: |-
Delete a conversation.
Delete a conversation with the given ID.
operationId: openai_delete_conversation_v1_conversations__conversation_id__delete
responses:
'200':
description: The deleted conversation resource.
content:
application/json:
schema:
$ref: '#/components/schemas/ConversationDeletedResource'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: conversation_id
in: path
required: true
schema:
type: string
description: 'Path parameter: conversation_id'
/v1/conversations/{conversation_id}/items/{item_id}:
get:
tags:
- Conversations
summary: Retrieve
description: |-
Retrieve an item.
Retrieve a conversation item.
operationId: retrieve_v1_conversations__conversation_id__items__item_id__get
responses:
'200':
description: The conversation item.
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAIResponseMessage'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: conversation_id
in: path
required: true
schema:
type: string
description: 'Path parameter: conversation_id'
- name: item_id
in: path
required: true
schema:
type: string
description: 'Path parameter: item_id'
delete:
tags:
- Conversations
summary: Openai Delete Conversation Item
description: |-
Delete an item.
Delete a conversation item.
operationId: openai_delete_conversation_item_v1_conversations__conversation_id__items__item_id__delete
responses:
'200':
description: The deleted item resource.
content:
application/json:
schema:
$ref: '#/components/schemas/ConversationItemDeletedResource'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
parameters:
- name: conversation_id
in: path
required: true
schema:
type: string
description: 'Path parameter: conversation_id'
- name: item_id
in: path
required: true
schema:
type: string
description: 'Path parameter: item_id'
components:
schemas:
AggregationFunctionType:
type: string
enum:
- average
- weighted_average
- median
- categorical_count
- accuracy
title: AggregationFunctionType
description: Types of aggregation functions for scoring results.
AllowedToolsFilter:
properties:
tool_names:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Tool Names
type: object
title: AllowedToolsFilter
description: Filter configuration for restricting which MCP tools can be used.
ApprovalFilter:
properties:
always:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Always
never:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Never
type: object
title: ApprovalFilter
description: Filter configuration for MCP tool approval requirements.
ArrayType:
properties:
type:
type: string
const: array
title: Type
default: array
type: object
title: ArrayType
description: Parameter type for array values.
BasicScoringFnParams:
properties:
type:
type: string
const: basic
title: Type
default: basic
aggregation_functions:
items:
$ref: '#/components/schemas/AggregationFunctionType'
type: array
title: Aggregation Functions
description: Aggregation functions to apply to the scores of each row
type: object
title: BasicScoringFnParams
description: Parameters for basic scoring function configuration.
Batch:
properties:
id:
type: string
title: Id
completion_window:
type: string
title: Completion Window
created_at:
type: integer
title: Created At
endpoint:
type: string
title: Endpoint
input_file_id:
type: string
title: Input File Id
object:
type: string
const: batch
title: Object
status:
type: string
enum:
- validating
- failed
- in_progress
- finalizing
- completed
- expired
- cancelling
- cancelled
title: Status
cancelled_at:
anyOf:
- type: integer
- type: 'null'
title: Cancelled At
cancelling_at:
anyOf:
- type: integer
- type: 'null'
title: Cancelling At
completed_at:
anyOf:
- type: integer
- type: 'null'
title: Completed At
error_file_id:
anyOf:
- type: string
- type: 'null'
title: Error File Id
errors:
anyOf:
- $ref: '#/components/schemas/Errors'
- type: 'null'
expired_at:
anyOf:
- type: integer
- type: 'null'
title: Expired At
expires_at:
anyOf:
- type: integer
- type: 'null'
title: Expires At
failed_at:
anyOf:
- type: integer
- type: 'null'
title: Failed At
finalizing_at:
anyOf:
- type: integer
- type: 'null'
title: Finalizing At
in_progress_at:
anyOf:
- type: integer
- type: 'null'
title: In Progress At
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Metadata
model:
anyOf:
- type: string
- type: 'null'
title: Model
output_file_id:
anyOf:
- type: string
- type: 'null'
title: Output File Id
request_counts:
anyOf:
- $ref: '#/components/schemas/BatchRequestCounts'
- type: 'null'
usage:
anyOf:
- $ref: '#/components/schemas/BatchUsage'
- type: 'null'
additionalProperties: true
type: object
required:
- id
- completion_window
- created_at
- endpoint
- input_file_id
- object
- status
title: Batch
BatchError:
properties:
code:
anyOf:
- type: string
- type: 'null'
title: Code
line:
anyOf:
- type: integer
- type: 'null'
title: Line
message:
anyOf:
- type: string
- type: 'null'
title: Message
param:
anyOf:
- type: string
- type: 'null'
title: Param
additionalProperties: true
type: object
title: BatchError
BatchRequestCounts:
properties:
completed:
type: integer
title: Completed
failed:
type: integer
title: Failed
total:
type: integer
title: Total
additionalProperties: true
type: object
required:
- completed
- failed
- total
title: BatchRequestCounts
BatchUsage:
properties:
input_tokens:
type: integer
title: Input Tokens
input_tokens_details:
$ref: '#/components/schemas/InputTokensDetails'
output_tokens:
type: integer
title: Output Tokens
output_tokens_details:
$ref: '#/components/schemas/OutputTokensDetails'
total_tokens:
type: integer
title: Total Tokens
additionalProperties: true
type: object
required:
- input_tokens
- input_tokens_details
- output_tokens
- output_tokens_details
- total_tokens
title: BatchUsage
Benchmark:
properties:
identifier:
type: string
title: Identifier
description: Unique identifier for this resource in llama stack
provider_resource_id:
anyOf:
- type: string
- type: 'null'
title: Provider Resource Id
description: Unique identifier for this resource in the provider
provider_id:
type: string
title: Provider Id
description: ID of the provider that owns this resource
type:
type: string
const: benchmark
title: Type
default: benchmark
dataset_id:
type: string
title: Dataset Id
scoring_functions:
items:
type: string
type: array
title: Scoring Functions
metadata:
additionalProperties: true
type: object
title: Metadata
description: Metadata for this evaluation task
type: object
required:
- identifier
- provider_id
- dataset_id
- scoring_functions
title: Benchmark
description: A benchmark resource for evaluating model performance.
BenchmarkConfig:
properties:
eval_candidate:
$ref: '#/components/schemas/ModelCandidate'
scoring_params:
additionalProperties:
oneOf:
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
- $ref: '#/components/schemas/RegexParserScoringFnParams'
- $ref: '#/components/schemas/BasicScoringFnParams'
discriminator:
propertyName: type
mapping:
basic: '#/components/schemas/BasicScoringFnParams'
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
type: object
title: Scoring Params
description: Map between scoring function id and parameters for each scoring function you want to run
num_examples:
anyOf:
- type: integer
- type: 'null'
title: Num Examples
description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated
type: object
required:
- eval_candidate
title: BenchmarkConfig
description: A benchmark configuration for evaluation.
Body_openai_upload_file_v1_files_post:
properties:
file:
type: string
format: binary
title: File
purpose:
$ref: '#/components/schemas/OpenAIFilePurpose'
expires_after:
anyOf:
- $ref: '#/components/schemas/ExpiresAfter'
- type: 'null'
type: object
required:
- file
- purpose
title: Body_openai_upload_file_v1_files_post
Body_register_benchmark_v1alpha_eval_benchmarks_post:
properties:
scoring_functions:
items:
type: string
type: array
title: Scoring Functions
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
type: object
required:
- scoring_functions
title: Body_register_benchmark_v1alpha_eval_benchmarks_post
Body_register_scoring_function_v1_scoring_functions_post:
properties:
return_type:
anyOf:
- $ref: '#/components/schemas/StringType'
- $ref: '#/components/schemas/NumberType'
- $ref: '#/components/schemas/BooleanType'
- $ref: '#/components/schemas/ArrayType'
- $ref: '#/components/schemas/ObjectType'
- $ref: '#/components/schemas/JsonType'
- $ref: '#/components/schemas/UnionType'
- $ref: '#/components/schemas/ChatCompletionInputType'
- $ref: '#/components/schemas/CompletionInputType'
title: Return Type
params:
anyOf:
- oneOf:
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
- $ref: '#/components/schemas/RegexParserScoringFnParams'
- $ref: '#/components/schemas/BasicScoringFnParams'
discriminator:
propertyName: type
mapping:
basic: '#/components/schemas/BasicScoringFnParams'
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
- type: 'null'
title: Params
type: object
required:
- return_type
title: Body_register_scoring_function_v1_scoring_functions_post
Body_register_tool_group_v1_toolgroups_post:
properties:
mcp_endpoint:
anyOf:
- $ref: '#/components/schemas/URL'
- type: 'null'
args:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Args
type: object
title: Body_register_tool_group_v1_toolgroups_post
BooleanType:
properties:
type:
type: string
const: boolean
title: Type
default: boolean
type: object
title: BooleanType
description: Parameter type for boolean values.
ChatCompletionInputType:
properties:
type:
type: string
const: chat_completion_input
title: Type
default: chat_completion_input
type: object
title: ChatCompletionInputType
description: Parameter type for chat completion input.
Chunk-Input:
properties:
content:
anyOf:
- type: string
- oneOf:
- $ref: '#/components/schemas/ImageContentItem-Input'
- $ref: '#/components/schemas/TextContentItem'
discriminator:
propertyName: type
mapping:
image: '#/components/schemas/ImageContentItem-Input'
text: '#/components/schemas/TextContentItem'
- items:
oneOf:
- $ref: '#/components/schemas/ImageContentItem-Input'
- $ref: '#/components/schemas/TextContentItem'
discriminator:
propertyName: type
mapping:
image: '#/components/schemas/ImageContentItem-Input'
text: '#/components/schemas/TextContentItem'
type: array
title: Content
chunk_id:
type: string
title: Chunk Id
metadata:
additionalProperties: true
type: object
title: Metadata
embedding:
anyOf:
- items:
type: number
type: array
- type: 'null'
title: Embedding
chunk_metadata:
anyOf:
- $ref: '#/components/schemas/ChunkMetadata'
- type: 'null'
type: object
required:
- content
- chunk_id
title: Chunk
description: A chunk of content that can be inserted into a vector database.
Chunk-Output:
properties:
content:
anyOf:
- type: string
- oneOf:
- $ref: '#/components/schemas/ImageContentItem-Output'
- $ref: '#/components/schemas/TextContentItem'
discriminator:
propertyName: type
mapping:
image: '#/components/schemas/ImageContentItem-Output'
text: '#/components/schemas/TextContentItem'
- items:
oneOf:
- $ref: '#/components/schemas/ImageContentItem-Output'
- $ref: '#/components/schemas/TextContentItem'
discriminator:
propertyName: type
mapping:
image: '#/components/schemas/ImageContentItem-Output'
text: '#/components/schemas/TextContentItem'
type: array
title: Content
chunk_id:
type: string
title: Chunk Id
metadata:
additionalProperties: true
type: object
title: Metadata
embedding:
anyOf:
- items:
type: number
type: array
- type: 'null'
title: Embedding
chunk_metadata:
anyOf:
- $ref: '#/components/schemas/ChunkMetadata'
- type: 'null'
type: object
required:
- content
- chunk_id
title: Chunk
description: A chunk of content that can be inserted into a vector database.
ChunkMetadata:
properties:
chunk_id:
anyOf:
- type: string
- type: 'null'
title: Chunk Id
document_id:
anyOf:
- type: string
- type: 'null'
title: Document Id
source:
anyOf:
- type: string
- type: 'null'
title: Source
created_timestamp:
anyOf:
- type: integer
- type: 'null'
title: Created Timestamp
updated_timestamp:
anyOf:
- type: integer
- type: 'null'
title: Updated Timestamp
chunk_window:
anyOf:
- type: string
- type: 'null'
title: Chunk Window
chunk_tokenizer:
anyOf:
- type: string
- type: 'null'
title: Chunk Tokenizer
chunk_embedding_model:
anyOf:
- type: string
- type: 'null'
title: Chunk Embedding Model
chunk_embedding_dimension:
anyOf:
- type: integer
- type: 'null'
title: Chunk Embedding Dimension
content_token_count:
anyOf:
- type: integer
- type: 'null'
title: Content Token Count
metadata_token_count:
anyOf:
- type: integer
- type: 'null'
title: Metadata Token Count
type: object
title: ChunkMetadata
description: |-
`ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that
will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata`
is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after.
Use `Chunk.metadata` for metadata that will be used in the context during inference.
CompletionInputType:
properties:
type:
type: string
const: completion_input
title: Type
default: completion_input
type: object
title: CompletionInputType
description: Parameter type for completion input.
Conversation:
properties:
id:
type: string
title: Id
description: The unique ID of the conversation.
object:
type: string
const: conversation
title: Object
description: The object type, which is always conversation.
default: conversation
created_at:
type: integer
title: Created At
description: The time at which the conversation was created, measured in seconds since the Unix epoch.
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Metadata
description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
items:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Items
description: Initial items to include in the conversation context. You may add up to 20 items at a time.
type: object
required:
- id
- created_at
title: Conversation
description: OpenAI-compatible conversation object.
ConversationDeletedResource:
properties:
id:
type: string
title: Id
description: The deleted conversation identifier
object:
type: string
title: Object
description: Object type
default: conversation.deleted
deleted:
type: boolean
title: Deleted
description: Whether the object was deleted
default: true
type: object
required:
- id
title: ConversationDeletedResource
description: Response for deleted conversation.
ConversationItemDeletedResource:
properties:
id:
type: string
title: Id
description: The deleted item identifier
object:
type: string
title: Object
description: Object type
default: conversation.item.deleted
deleted:
type: boolean
title: Deleted
description: Whether the object was deleted
default: true
type: object
required:
- id
title: ConversationItemDeletedResource
description: Response for deleted conversation item.
ConversationItemInclude:
type: string
enum:
- web_search_call.action.sources
- code_interpreter_call.outputs
- computer_call_output.output.image_url
- file_search_call.results
- message.input_image.image_url
- message.output_text.logprobs
- reasoning.encrypted_content
title: ConversationItemInclude
description: Specify additional output data to include in the model response.
ConversationItemList:
properties:
object:
type: string
title: Object
description: Object type
default: list
data:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
- $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/OpenAIResponseOutputMessageMCPCall'
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
discriminator:
propertyName: type
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Output'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
type: array
title: Data
description: List of conversation items
first_id:
anyOf:
- type: string
- type: 'null'
title: First Id
description: The ID of the first item in the list
last_id:
anyOf:
- type: string
- type: 'null'
title: Last Id
description: The ID of the last item in the list
has_more:
type: boolean
title: Has More
description: Whether there are more items available
default: false
type: object
required:
- data
title: ConversationItemList
description: List of conversation items with pagination.
DPOAlignmentConfig:
properties:
beta:
type: number
title: Beta
loss_type:
$ref: '#/components/schemas/DPOLossType'
default: sigmoid
type: object
required:
- beta
title: DPOAlignmentConfig
description: Configuration for Direct Preference Optimization (DPO) alignment.
DPOLossType:
type: string
enum:
- sigmoid
- hinge
- ipo
- kto_pair
title: DPOLossType
DataConfig:
properties:
dataset_id:
type: string
title: Dataset Id
batch_size:
type: integer
title: Batch Size
shuffle:
type: boolean
title: Shuffle
data_format:
$ref: '#/components/schemas/DatasetFormat'
validation_dataset_id:
anyOf:
- type: string
- type: 'null'
title: Validation Dataset Id
packed:
anyOf:
- type: boolean
- type: 'null'
title: Packed
default: false
train_on_input:
anyOf:
- type: boolean
- type: 'null'
title: Train On Input
default: false
type: object
required:
- dataset_id
- batch_size
- shuffle
- data_format
title: DataConfig
description: Configuration for training data and data loading.
Dataset:
properties:
identifier:
type: string
title: Identifier
description: Unique identifier for this resource in llama stack
provider_resource_id:
anyOf:
- type: string
- type: 'null'
title: Provider Resource Id
description: Unique identifier for this resource in the provider
provider_id:
type: string
title: Provider Id
description: ID of the provider that owns this resource
type:
type: string
const: dataset
title: Type
default: dataset
purpose:
$ref: '#/components/schemas/DatasetPurpose'
source:
oneOf:
- $ref: '#/components/schemas/URIDataSource'
- $ref: '#/components/schemas/RowsDataSource'
title: Source
discriminator:
propertyName: type
mapping:
rows: '#/components/schemas/RowsDataSource'
uri: '#/components/schemas/URIDataSource'
metadata:
additionalProperties: true
type: object
title: Metadata
description: Any additional metadata for this dataset
type: object
required:
- identifier
- provider_id
- purpose
- source
title: Dataset
description: Dataset resource for storing and accessing training or evaluation data.
DatasetFormat:
type: string
enum:
- instruct
- dialog
title: DatasetFormat
description: Format of the training dataset.
DatasetPurpose:
type: string
enum:
- post-training/messages
- eval/question-answer
- eval/messages-answer
title: DatasetPurpose
description: Purpose of the dataset. Each purpose has a required input data schema.
EfficiencyConfig:
properties:
enable_activation_checkpointing:
anyOf:
- type: boolean
- type: 'null'
title: Enable Activation Checkpointing
default: false
enable_activation_offloading:
anyOf:
- type: boolean
- type: 'null'
title: Enable Activation Offloading
default: false
memory_efficient_fsdp_wrap:
anyOf:
- type: boolean
- type: 'null'
title: Memory Efficient Fsdp Wrap
default: false
fsdp_cpu_offload:
anyOf:
- type: boolean
- type: 'null'
title: Fsdp Cpu Offload
default: false
type: object
title: EfficiencyConfig
description: Configuration for memory and compute efficiency optimizations.
Errors:
properties:
data:
anyOf:
- items:
$ref: '#/components/schemas/BatchError'
type: array
- type: 'null'
title: Data
object:
anyOf:
- type: string
- type: 'null'
title: Object
additionalProperties: true
type: object
title: Errors
EvaluateResponse:
properties:
generations:
items:
additionalProperties: true
type: object
type: array
title: Generations
scores:
additionalProperties:
$ref: '#/components/schemas/ScoringResult'
type: object
title: Scores
type: object
required:
- generations
- scores
title: EvaluateResponse
description: The response from an evaluation.
ExpiresAfter:
properties:
anchor:
type: string
const: created_at
title: Anchor
seconds:
type: integer
maximum: 2592000.0
minimum: 3600.0
title: Seconds
type: object
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)
GreedySamplingStrategy:
properties:
type:
type: string
const: greedy
title: Type
default: greedy
type: object
title: GreedySamplingStrategy
description: Greedy sampling strategy that selects the highest probability token at each step.
HealthInfo:
properties:
status:
$ref: '#/components/schemas/HealthStatus'
type: object
required:
- status
title: HealthInfo
description: Health status information for the service.
HealthStatus:
type: string
enum:
- OK
- Error
- Not Implemented
title: HealthStatus
ImageContentItem-Input:
properties:
type:
type: string
const: image
title: Type
default: image
image:
$ref: '#/components/schemas/_URLOrData'
type: object
required:
- image
title: ImageContentItem
description: A image content item
ImageContentItem-Output:
properties:
type:
type: string
const: image
title: Type
default: image
image:
$ref: '#/components/schemas/_URLOrData'
type: object
required:
- image
title: ImageContentItem
description: A image content item
InputTokensDetails:
properties:
cached_tokens:
type: integer
title: Cached Tokens
additionalProperties: true
type: object
required:
- cached_tokens
title: InputTokensDetails
Job:
properties:
job_id:
type: string
title: Job Id
status:
$ref: '#/components/schemas/JobStatus'
type: object
required:
- job_id
- status
title: Job
description: A job execution instance with status tracking.
JobStatus:
type: string
enum:
- completed
- in_progress
- failed
- scheduled
- cancelled
title: JobStatus
description: Status of a job execution.
JsonType:
properties:
type:
type: string
const: json
title: Type
default: json
type: object
title: JsonType
description: Parameter type for JSON values.
LLMAsJudgeScoringFnParams:
properties:
type:
type: string
const: llm_as_judge
title: Type
default: llm_as_judge
judge_model:
type: string
title: Judge Model
prompt_template:
anyOf:
- type: string
- type: 'null'
title: Prompt Template
judge_score_regexes:
items:
type: string
type: array
title: Judge Score Regexes
description: Regexes to extract the answer from generated response
aggregation_functions:
items:
$ref: '#/components/schemas/AggregationFunctionType'
type: array
title: Aggregation Functions
description: Aggregation functions to apply to the scores of each row
type: object
required:
- judge_model
title: LLMAsJudgeScoringFnParams
description: Parameters for LLM-as-judge scoring function configuration.
ListBenchmarksResponse:
properties:
data:
items:
$ref: '#/components/schemas/Benchmark'
type: array
title: Data
type: object
required:
- data
title: ListBenchmarksResponse
ListDatasetsResponse:
properties:
data:
items:
$ref: '#/components/schemas/Dataset'
type: array
title: Data
type: object
required:
- data
title: ListDatasetsResponse
description: Response from listing datasets.
ListPostTrainingJobsResponse:
properties:
data:
items:
$ref: '#/components/schemas/PostTrainingJob'
type: array
title: Data
type: object
required:
- data
title: ListPostTrainingJobsResponse
ListPromptsResponse:
properties:
data:
items:
$ref: '#/components/schemas/Prompt'
type: array
title: Data
type: object
required:
- data
title: ListPromptsResponse
description: Response model to list prompts.
ListProvidersResponse:
properties:
data:
items:
$ref: '#/components/schemas/ProviderInfo'
type: array
title: Data
type: object
required:
- data
title: ListProvidersResponse
description: Response containing a list of all available providers.
ListScoringFunctionsResponse:
properties:
data:
items:
$ref: '#/components/schemas/ScoringFn'
type: array
title: Data
type: object
required:
- data
title: ListScoringFunctionsResponse
ListShieldsResponse:
properties:
data:
items:
$ref: '#/components/schemas/Shield'
type: array
title: Data
type: object
required:
- data
title: ListShieldsResponse
ListToolGroupsResponse:
properties:
data:
items:
$ref: '#/components/schemas/ToolGroup'
type: array
title: Data
type: object
required:
- data
title: ListToolGroupsResponse
description: Response containing a list of tool groups.
LoraFinetuningConfig:
properties:
type:
type: string
const: LoRA
title: Type
default: LoRA
lora_attn_modules:
items:
type: string
type: array
title: Lora Attn Modules
apply_lora_to_mlp:
type: boolean
title: Apply Lora To Mlp
apply_lora_to_output:
type: boolean
title: Apply Lora To Output
rank:
type: integer
title: Rank
alpha:
type: integer
title: Alpha
use_dora:
anyOf:
- type: boolean
- type: 'null'
title: Use Dora
default: false
quantize_base:
anyOf:
- type: boolean
- type: 'null'
title: Quantize Base
default: false
type: object
required:
- lora_attn_modules
- apply_lora_to_mlp
- apply_lora_to_output
- rank
- alpha
title: LoraFinetuningConfig
description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning.
MCPListToolsTool:
properties:
input_schema:
additionalProperties: true
type: object
title: Input Schema
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
type: object
required:
- input_schema
- name
title: MCPListToolsTool
description: Tool definition returned by MCP list tools operation.
Model:
properties:
identifier:
type: string
title: Identifier
description: Unique identifier for this resource in llama stack
provider_resource_id:
anyOf:
- type: string
- type: 'null'
title: Provider Resource Id
description: Unique identifier for this resource in the provider
provider_id:
type: string
title: Provider Id
description: ID of the provider that owns this resource
type:
type: string
const: model
title: Type
default: model
metadata:
additionalProperties: true
type: object
title: Metadata
description: Any additional metadata for this model
model_type:
$ref: '#/components/schemas/ModelType'
default: llm
type: object
required:
- identifier
- provider_id
title: Model
description: A model resource representing an AI model registered in Llama Stack.
ModelCandidate:
properties:
type:
type: string
const: model
title: Type
default: model
model:
type: string
title: Model
sampling_params:
$ref: '#/components/schemas/SamplingParams'
system_message:
anyOf:
- $ref: '#/components/schemas/SystemMessage'
- type: 'null'
type: object
required:
- model
- sampling_params
title: ModelCandidate
description: A model candidate for evaluation.
ModelType:
type: string
enum:
- llm
- embedding
- rerank
title: ModelType
description: Enumeration of supported model types in Llama Stack.
ModerationObject:
properties:
id:
type: string
title: Id
model:
type: string
title: Model
results:
items:
$ref: '#/components/schemas/ModerationObjectResults'
type: array
title: Results
type: object
required:
- id
- model
- results
title: ModerationObject
description: A moderation object.
ModerationObjectResults:
properties:
flagged:
type: boolean
title: Flagged
categories:
anyOf:
- additionalProperties:
type: boolean
type: object
- type: 'null'
title: Categories
category_applied_input_types:
anyOf:
- additionalProperties:
items:
type: string
type: array
type: object
- type: 'null'
title: Category Applied Input Types
category_scores:
anyOf:
- additionalProperties:
type: number
type: object
- type: 'null'
title: Category Scores
user_message:
anyOf:
- type: string
- type: 'null'
title: User Message
metadata:
additionalProperties: true
type: object
title: Metadata
type: object
required:
- flagged
title: ModerationObjectResults
description: A moderation object.
NumberType:
properties:
type:
type: string
const: number
title: Type
default: number
type: object
title: NumberType
description: Parameter type for numeric values.
ObjectType:
properties:
type:
type: string
const: object
title: Type
default: object
type: object
title: ObjectType
description: Parameter type for object values.
OpenAIAssistantMessageParam-Input:
properties:
role:
type: string
const: assistant
title: Role
default: assistant
content:
anyOf:
- type: string
- items:
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
type: array
- type: 'null'
title: Content
name:
anyOf:
- type: string
- type: 'null'
title: Name
tool_calls:
anyOf:
- items:
$ref: '#/components/schemas/OpenAIChatCompletionToolCall'
type: array
- type: 'null'
title: Tool Calls
type: object
title: OpenAIAssistantMessageParam
description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request.
OpenAIAssistantMessageParam-Output:
properties:
role:
type: string
const: assistant
title: Role
default: assistant
content:
anyOf:
- type: string
- items:
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
type: array
- type: 'null'
title: Content
name:
anyOf:
- type: string
- type: 'null'
title: Name
tool_calls:
anyOf:
- items:
$ref: '#/components/schemas/OpenAIChatCompletionToolCall'
type: array
- type: 'null'
title: Tool Calls
type: object
title: OpenAIAssistantMessageParam
description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request.
OpenAIChatCompletion:
properties:
id:
type: string
title: Id
choices:
items:
$ref: '#/components/schemas/OpenAIChoice-Output'
type: array
title: Choices
object:
type: string
const: chat.completion
title: Object
default: chat.completion
created:
type: integer
title: Created
model:
type: string
title: Model
usage:
anyOf:
- $ref: '#/components/schemas/OpenAIChatCompletionUsage'
- type: 'null'
type: object
required:
- id
- choices
- created
- model
title: OpenAIChatCompletion
description: Response from an OpenAI-compatible chat completion request.
OpenAIChatCompletionContentPartImageParam:
properties:
type:
type: string
const: image_url
title: Type
default: image_url
image_url:
$ref: '#/components/schemas/OpenAIImageURL'
type: object
required:
- image_url
title: OpenAIChatCompletionContentPartImageParam
description: Image content part for OpenAI-compatible chat completion messages.
OpenAIChatCompletionContentPartTextParam:
properties:
type:
type: string
const: text
title: Type
default: text
text:
type: string
title: Text
type: object
required:
- text
title: OpenAIChatCompletionContentPartTextParam
description: Text content part for OpenAI-compatible chat completion messages.
OpenAIChatCompletionRequestWithExtraBody:
properties:
model:
type: string
title: Model
messages:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIUserMessageParam-Input'
- $ref: '#/components/schemas/OpenAISystemMessageParam'
- $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input'
- $ref: '#/components/schemas/OpenAIToolMessageParam'
- $ref: '#/components/schemas/OpenAIDeveloperMessageParam'
discriminator:
propertyName: role
mapping:
assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input'
developer: '#/components/schemas/OpenAIDeveloperMessageParam'
system: '#/components/schemas/OpenAISystemMessageParam'
tool: '#/components/schemas/OpenAIToolMessageParam'
user: '#/components/schemas/OpenAIUserMessageParam-Input'
type: array
minItems: 1
title: Messages
frequency_penalty:
anyOf:
- type: number
- type: 'null'
title: Frequency Penalty
function_call:
anyOf:
- type: string
- additionalProperties: true
type: object
- type: 'null'
title: Function Call
functions:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Functions
logit_bias:
anyOf:
- additionalProperties:
type: number
type: object
- type: 'null'
title: Logit Bias
logprobs:
anyOf:
- type: boolean
- type: 'null'
title: Logprobs
max_completion_tokens:
anyOf:
- type: integer
- type: 'null'
title: Max Completion Tokens
max_tokens:
anyOf:
- type: integer
- type: 'null'
title: Max Tokens
n:
anyOf:
- type: integer
- type: 'null'
title: N
parallel_tool_calls:
anyOf:
- type: boolean
- type: 'null'
title: Parallel Tool Calls
presence_penalty:
anyOf:
- type: number
- type: 'null'
title: Presence Penalty
response_format:
anyOf:
- oneOf:
- $ref: '#/components/schemas/OpenAIResponseFormatText'
- $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema'
- $ref: '#/components/schemas/OpenAIResponseFormatJSONObject'
discriminator:
propertyName: type
mapping:
json_object: '#/components/schemas/OpenAIResponseFormatJSONObject'
json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema'
text: '#/components/schemas/OpenAIResponseFormatText'
- type: 'null'
title: Response Format
seed:
anyOf:
- type: integer
- type: 'null'
title: Seed
stop:
anyOf:
- type: string
- items:
type: string
type: array
- type: 'null'
title: Stop
stream:
anyOf:
- type: boolean
- type: 'null'
title: Stream
stream_options:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Stream Options
temperature:
anyOf:
- type: number
- type: 'null'
title: Temperature
tool_choice:
anyOf:
- type: string
- additionalProperties: true
type: object
- type: 'null'
title: Tool Choice
tools:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Tools
top_logprobs:
anyOf:
- type: integer
- type: 'null'
title: Top Logprobs
top_p:
anyOf:
- type: number
- type: 'null'
title: Top P
user:
anyOf:
- type: string
- type: 'null'
title: User
additionalProperties: true
type: object
required:
- model
- messages
title: OpenAIChatCompletionRequestWithExtraBody
description: Request parameters for OpenAI-compatible chat completion endpoint.
OpenAIChatCompletionToolCall:
properties:
index:
anyOf:
- type: integer
- type: 'null'
title: Index
id:
anyOf:
- type: string
- type: 'null'
title: Id
type:
type: string
const: function
title: Type
default: function
function:
anyOf:
- $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction'
- type: 'null'
type: object
title: OpenAIChatCompletionToolCall
description: Tool call specification for OpenAI-compatible chat completion responses.
OpenAIChatCompletionToolCallFunction:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
arguments:
anyOf:
- type: string
- type: 'null'
title: Arguments
type: object
title: OpenAIChatCompletionToolCallFunction
description: Function call details for OpenAI-compatible tool calls.
OpenAIChatCompletionUsage:
properties:
prompt_tokens:
type: integer
title: Prompt Tokens
completion_tokens:
type: integer
title: Completion Tokens
total_tokens:
type: integer
title: Total Tokens
prompt_tokens_details:
anyOf:
- $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails'
- type: 'null'
completion_tokens_details:
anyOf:
- $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails'
- type: 'null'
type: object
required:
- prompt_tokens
- completion_tokens
- total_tokens
title: OpenAIChatCompletionUsage
description: Usage information for OpenAI chat completion.
OpenAIChatCompletionUsageCompletionTokensDetails:
properties:
reasoning_tokens:
anyOf:
- type: integer
- type: 'null'
title: Reasoning Tokens
type: object
title: OpenAIChatCompletionUsageCompletionTokensDetails
description: Token details for output tokens in OpenAI chat completion usage.
OpenAIChatCompletionUsagePromptTokensDetails:
properties:
cached_tokens:
anyOf:
- type: integer
- type: 'null'
title: Cached Tokens
type: object
title: OpenAIChatCompletionUsagePromptTokensDetails
description: Token details for prompt tokens in OpenAI chat completion usage.
OpenAIChoice-Output:
properties:
message:
oneOf:
- $ref: '#/components/schemas/OpenAIUserMessageParam-Output'
- $ref: '#/components/schemas/OpenAISystemMessageParam'
- $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output'
- $ref: '#/components/schemas/OpenAIToolMessageParam'
- $ref: '#/components/schemas/OpenAIDeveloperMessageParam'
title: Message
discriminator:
propertyName: role
mapping:
assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output'
developer: '#/components/schemas/OpenAIDeveloperMessageParam'
system: '#/components/schemas/OpenAISystemMessageParam'
tool: '#/components/schemas/OpenAIToolMessageParam'
user: '#/components/schemas/OpenAIUserMessageParam-Output'
finish_reason:
type: string
title: Finish Reason
index:
type: integer
title: Index
logprobs:
anyOf:
- $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output'
- type: 'null'
type: object
required:
- message
- finish_reason
- index
title: OpenAIChoice
description: A choice from an OpenAI-compatible chat completion response.
OpenAIChoiceLogprobs-Output:
properties:
content:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
title: Content
refusal:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
title: Refusal
type: object
title: OpenAIChoiceLogprobs
description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response.
OpenAICompletion:
properties:
id:
type: string
title: Id
choices:
items:
$ref: '#/components/schemas/OpenAICompletionChoice-Output'
type: array
title: Choices
created:
type: integer
title: Created
model:
type: string
title: Model
object:
type: string
const: text_completion
title: Object
default: text_completion
type: object
required:
- id
- choices
- created
- model
title: OpenAICompletion
description: |-
Response from an OpenAI-compatible completion request.
:id: The ID of the completion
:choices: List of choices
:created: The Unix timestamp in seconds when the completion was created
:model: The model that was used to generate the completion
:object: The object type, which will be "text_completion"
OpenAICompletionChoice-Output:
properties:
finish_reason:
type: string
title: Finish Reason
text:
type: string
title: Text
index:
type: integer
title: Index
logprobs:
anyOf:
- $ref: '#/components/schemas/OpenAIChoiceLogprobs-Output'
- type: 'null'
type: object
required:
- finish_reason
- text
- index
title: OpenAICompletionChoice
description: |-
A choice from an OpenAI-compatible completion response.
:finish_reason: The reason the model stopped generating
:text: The text of the choice
:index: The index of the choice
:logprobs: (Optional) The log probabilities for the tokens in the choice
OpenAICompletionRequestWithExtraBody:
properties:
model:
type: string
title: Model
prompt:
anyOf:
- type: string
- items:
type: string
type: array
- items:
type: integer
type: array
- items:
items:
type: integer
type: array
type: array
title: Prompt
best_of:
anyOf:
- type: integer
- type: 'null'
title: Best Of
echo:
anyOf:
- type: boolean
- type: 'null'
title: Echo
frequency_penalty:
anyOf:
- type: number
- type: 'null'
title: Frequency Penalty
logit_bias:
anyOf:
- additionalProperties:
type: number
type: object
- type: 'null'
title: Logit Bias
logprobs:
anyOf:
- type: boolean
- type: 'null'
title: Logprobs
max_tokens:
anyOf:
- type: integer
- type: 'null'
title: Max Tokens
n:
anyOf:
- type: integer
- type: 'null'
title: N
presence_penalty:
anyOf:
- type: number
- type: 'null'
title: Presence Penalty
seed:
anyOf:
- type: integer
- type: 'null'
title: Seed
stop:
anyOf:
- type: string
- items:
type: string
type: array
- type: 'null'
title: Stop
stream:
anyOf:
- type: boolean
- type: 'null'
title: Stream
stream_options:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Stream Options
temperature:
anyOf:
- type: number
- type: 'null'
title: Temperature
top_p:
anyOf:
- type: number
- type: 'null'
title: Top P
user:
anyOf:
- type: string
- type: 'null'
title: User
suffix:
anyOf:
- type: string
- type: 'null'
title: Suffix
additionalProperties: true
type: object
required:
- model
- prompt
title: OpenAICompletionRequestWithExtraBody
description: Request parameters for OpenAI-compatible completion endpoint.
OpenAICompletionWithInputMessages:
properties:
id:
type: string
title: Id
choices:
items:
$ref: '#/components/schemas/OpenAIChoice-Output'
type: array
title: Choices
object:
type: string
const: chat.completion
title: Object
default: chat.completion
created:
type: integer
title: Created
model:
type: string
title: Model
usage:
anyOf:
- $ref: '#/components/schemas/OpenAIChatCompletionUsage'
- type: 'null'
input_messages:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIUserMessageParam-Output'
- $ref: '#/components/schemas/OpenAISystemMessageParam'
- $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output'
- $ref: '#/components/schemas/OpenAIToolMessageParam'
- $ref: '#/components/schemas/OpenAIDeveloperMessageParam'
discriminator:
propertyName: role
mapping:
assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output'
developer: '#/components/schemas/OpenAIDeveloperMessageParam'
system: '#/components/schemas/OpenAISystemMessageParam'
tool: '#/components/schemas/OpenAIToolMessageParam'
user: '#/components/schemas/OpenAIUserMessageParam-Output'
type: array
title: Input Messages
type: object
required:
- id
- choices
- created
- model
- input_messages
title: OpenAICompletionWithInputMessages
OpenAICreateVectorStoreFileBatchRequestWithExtraBody:
properties:
file_ids:
items:
type: string
type: array
title: File Ids
attributes:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Attributes
chunking_strategy:
anyOf:
- oneOf:
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
discriminator:
propertyName: type
mapping:
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
static: '#/components/schemas/VectorStoreChunkingStrategyStatic'
- type: 'null'
title: Chunking Strategy
additionalProperties: true
type: object
required:
- file_ids
title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody
description: Request to create a vector store file batch with extra_body support.
OpenAICreateVectorStoreRequestWithExtraBody:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
file_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: File Ids
expires_after:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Expires After
chunking_strategy:
anyOf:
- oneOf:
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
discriminator:
propertyName: type
mapping:
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
static: '#/components/schemas/VectorStoreChunkingStrategyStatic'
- type: 'null'
title: Chunking Strategy
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
additionalProperties: true
type: object
title: OpenAICreateVectorStoreRequestWithExtraBody
description: Request to create a vector store with extra_body support.
OpenAIDeleteResponseObject:
properties:
id:
type: string
title: Id
object:
type: string
const: response
title: Object
default: response
deleted:
type: boolean
title: Deleted
default: true
type: object
required:
- id
title: OpenAIDeleteResponseObject
description: Response object confirming deletion of an OpenAI response.
OpenAIDeveloperMessageParam:
properties:
role:
type: string
const: developer
title: Role
default: developer
content:
anyOf:
- type: string
- items:
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
type: array
title: Content
name:
anyOf:
- type: string
- type: 'null'
title: Name
type: object
required:
- content
title: OpenAIDeveloperMessageParam
description: A message from the developer in an OpenAI-compatible chat completion request.
OpenAIEmbeddingData:
properties:
object:
type: string
const: embedding
title: Object
default: embedding
embedding:
anyOf:
- items:
type: number
type: array
- type: string
title: Embedding
index:
type: integer
title: Index
type: object
required:
- embedding
- index
title: OpenAIEmbeddingData
description: A single embedding data object from an OpenAI-compatible embeddings response.
OpenAIEmbeddingUsage:
properties:
prompt_tokens:
type: integer
title: Prompt Tokens
total_tokens:
type: integer
title: Total Tokens
type: object
required:
- prompt_tokens
- total_tokens
title: OpenAIEmbeddingUsage
description: Usage information for an OpenAI-compatible embeddings response.
OpenAIEmbeddingsRequestWithExtraBody:
properties:
model:
type: string
title: Model
input:
anyOf:
- type: string
- items:
type: string
type: array
title: Input
encoding_format:
anyOf:
- type: string
- type: 'null'
title: Encoding Format
default: float
dimensions:
anyOf:
- type: integer
- type: 'null'
title: Dimensions
user:
anyOf:
- type: string
- type: 'null'
title: User
additionalProperties: true
type: object
required:
- model
- input
title: OpenAIEmbeddingsRequestWithExtraBody
description: Request parameters for OpenAI-compatible embeddings endpoint.
OpenAIEmbeddingsResponse:
properties:
object:
type: string
const: list
title: Object
default: list
data:
items:
$ref: '#/components/schemas/OpenAIEmbeddingData'
type: array
title: Data
model:
type: string
title: Model
usage:
$ref: '#/components/schemas/OpenAIEmbeddingUsage'
type: object
required:
- data
- model
- usage
title: OpenAIEmbeddingsResponse
description: Response from an OpenAI-compatible embeddings request.
OpenAIFile:
properties:
type:
type: string
const: file
title: Type
default: file
file:
$ref: '#/components/schemas/OpenAIFileFile'
type: object
required:
- file
title: OpenAIFile
OpenAIFileDeleteResponse:
properties:
id:
type: string
title: Id
object:
type: string
const: file
title: Object
default: file
deleted:
type: boolean
title: Deleted
type: object
required:
- id
- deleted
title: OpenAIFileDeleteResponse
description: Response for deleting a file in OpenAI Files API.
OpenAIFileFile:
properties:
file_data:
anyOf:
- type: string
- type: 'null'
title: File Data
file_id:
anyOf:
- type: string
- type: 'null'
title: File Id
filename:
anyOf:
- type: string
- type: 'null'
title: Filename
type: object
title: OpenAIFileFile
OpenAIFileObject:
properties:
object:
type: string
const: file
title: Object
default: file
id:
type: string
title: Id
bytes:
type: integer
title: Bytes
created_at:
type: integer
title: Created At
expires_at:
type: integer
title: Expires At
filename:
type: string
title: Filename
purpose:
$ref: '#/components/schemas/OpenAIFilePurpose'
type: object
required:
- id
- bytes
- created_at
- expires_at
- filename
- purpose
title: OpenAIFileObject
description: OpenAI File object as defined in the OpenAI Files API.
OpenAIFilePurpose:
type: string
enum:
- assistants
- batch
title: OpenAIFilePurpose
description: Valid purpose values for OpenAI Files API.
OpenAIImageURL:
properties:
url:
type: string
title: Url
detail:
anyOf:
- type: string
- type: 'null'
title: Detail
type: object
required:
- url
title: OpenAIImageURL
description: Image URL specification for OpenAI-compatible chat completion messages.
OpenAIJSONSchema:
properties:
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
strict:
anyOf:
- type: boolean
- type: 'null'
title: Strict
schema:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Schema
type: object
title: OpenAIJSONSchema
description: JSON schema specification for OpenAI-compatible structured response format.
OpenAIListModelsResponse:
properties:
data:
items:
$ref: '#/components/schemas/OpenAIModel'
type: array
title: Data
type: object
required:
- data
title: OpenAIListModelsResponse
OpenAIModel:
properties:
id:
type: string
title: Id
object:
type: string
const: model
title: Object
default: model
created:
type: integer
title: Created
owned_by:
type: string
title: Owned By
custom_metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Custom Metadata
type: object
required:
- id
- created
- owned_by
title: OpenAIModel
description: |-
A model from OpenAI.
:id: The ID of the model
:object: The object type, which will be "model"
:created: The Unix timestamp in seconds when the model was created
:owned_by: The owner of the model
:custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata
OpenAIResponseAnnotationCitation:
properties:
type:
type: string
const: url_citation
title: Type
default: url_citation
end_index:
type: integer
title: End Index
start_index:
type: integer
title: Start Index
title:
type: string
title: Title
url:
type: string
title: Url
type: object
required:
- end_index
- start_index
- title
- url
title: OpenAIResponseAnnotationCitation
description: URL citation annotation for referencing external web resources.
OpenAIResponseAnnotationContainerFileCitation:
properties:
type:
type: string
const: container_file_citation
title: Type
default: container_file_citation
container_id:
type: string
title: Container Id
end_index:
type: integer
title: End Index
file_id:
type: string
title: File Id
filename:
type: string
title: Filename
start_index:
type: integer
title: Start Index
type: object
required:
- container_id
- end_index
- file_id
- filename
- start_index
title: OpenAIResponseAnnotationContainerFileCitation
OpenAIResponseAnnotationFileCitation:
properties:
type:
type: string
const: file_citation
title: Type
default: file_citation
file_id:
type: string
title: File Id
filename:
type: string
title: Filename
index:
type: integer
title: Index
type: object
required:
- file_id
- filename
- index
title: OpenAIResponseAnnotationFileCitation
description: File citation annotation for referencing specific files in response content.
OpenAIResponseAnnotationFilePath:
properties:
type:
type: string
const: file_path
title: Type
default: file_path
file_id:
type: string
title: File Id
index:
type: integer
title: Index
type: object
required:
- file_id
- index
title: OpenAIResponseAnnotationFilePath
OpenAIResponseContentPartRefusal:
properties:
type:
type: string
const: refusal
title: Type
default: refusal
refusal:
type: string
title: Refusal
type: object
required:
- refusal
title: OpenAIResponseContentPartRefusal
description: Refusal content within a streamed response part.
OpenAIResponseError:
properties:
code:
type: string
title: Code
message:
type: string
title: Message
type: object
required:
- code
- message
title: OpenAIResponseError
description: Error details for failed OpenAI response requests.
OpenAIResponseFormatJSONObject:
properties:
type:
type: string
const: json_object
title: Type
default: json_object
type: object
title: OpenAIResponseFormatJSONObject
description: JSON object response format for OpenAI-compatible chat completion requests.
OpenAIResponseFormatJSONSchema:
properties:
type:
type: string
const: json_schema
title: Type
default: json_schema
json_schema:
$ref: '#/components/schemas/OpenAIJSONSchema'
type: object
required:
- json_schema
title: OpenAIResponseFormatJSONSchema
description: JSON schema response format for OpenAI-compatible chat completion requests.
OpenAIResponseFormatText:
properties:
type:
type: string
const: text
title: Type
default: text
type: object
title: OpenAIResponseFormatText
description: Text response format for OpenAI-compatible chat completion requests.
OpenAIResponseInputFunctionToolCallOutput:
properties:
call_id:
type: string
title: Call Id
output:
type: string
title: Output
type:
type: string
const: function_call_output
title: Type
default: function_call_output
id:
anyOf:
- type: string
- type: 'null'
title: Id
status:
anyOf:
- type: string
- type: 'null'
title: Status
type: object
required:
- call_id
- output
title: OpenAIResponseInputFunctionToolCallOutput
description: This represents the output of a function call that gets passed back to the model.
OpenAIResponseInputMessageContentFile:
properties:
type:
type: string
const: input_file
title: Type
default: input_file
file_data:
anyOf:
- type: string
- type: 'null'
title: File Data
file_id:
anyOf:
- type: string
- type: 'null'
title: File Id
file_url:
anyOf:
- type: string
- type: 'null'
title: File Url
filename:
anyOf:
- type: string
- type: 'null'
title: Filename
type: object
title: OpenAIResponseInputMessageContentFile
description: File content for input messages in OpenAI response format.
OpenAIResponseInputMessageContentImage:
properties:
detail:
anyOf:
- type: string
const: low
- type: string
const: high
- type: string
const: auto
title: Detail
default: auto
type:
type: string
const: input_image
title: Type
default: input_image
file_id:
anyOf:
- type: string
- type: 'null'
title: File Id
image_url:
anyOf:
- type: string
- type: 'null'
title: Image Url
type: object
title: OpenAIResponseInputMessageContentImage
description: Image content for input messages in OpenAI response format.
OpenAIResponseInputMessageContentText:
properties:
text:
type: string
title: Text
type:
type: string
const: input_text
title: Type
default: input_text
type: object
required:
- text
title: OpenAIResponseInputMessageContentText
description: Text content for input messages in OpenAI response format.
OpenAIResponseInputToolFileSearch:
properties:
type:
type: string
const: file_search
title: Type
default: file_search
vector_store_ids:
items:
type: string
type: array
title: Vector Store Ids
filters:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Filters
max_num_results:
anyOf:
- type: integer
maximum: 50.0
minimum: 1.0
- type: 'null'
title: Max Num Results
default: 10
ranking_options:
anyOf:
- $ref: '#/components/schemas/SearchRankingOptions'
- type: 'null'
type: object
required:
- vector_store_ids
title: OpenAIResponseInputToolFileSearch
description: File search tool configuration for OpenAI response inputs.
OpenAIResponseInputToolFunction:
properties:
type:
type: string
const: function
title: Type
default: function
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
parameters:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Parameters
strict:
anyOf:
- type: boolean
- type: 'null'
title: Strict
type: object
required:
- name
- parameters
title: OpenAIResponseInputToolFunction
description: Function tool configuration for OpenAI response inputs.
OpenAIResponseInputToolMCP:
properties:
type:
type: string
const: mcp
title: Type
default: mcp
server_label:
type: string
title: Server Label
server_url:
type: string
title: Server Url
headers:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Headers
require_approval:
anyOf:
- type: string
const: always
- type: string
const: never
- $ref: '#/components/schemas/ApprovalFilter'
title: Require Approval
default: never
allowed_tools:
anyOf:
- items:
type: string
type: array
- $ref: '#/components/schemas/AllowedToolsFilter'
- type: 'null'
title: Allowed Tools
type: object
required:
- server_label
- server_url
title: OpenAIResponseInputToolMCP
description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs.
OpenAIResponseInputToolWebSearch:
properties:
type:
anyOf:
- type: string
const: web_search
- type: string
const: web_search_preview
- type: string
const: web_search_preview_2025_03_11
- type: string
const: web_search_2025_08_26
title: Type
default: web_search
search_context_size:
anyOf:
- type: string
pattern: ^low|medium|high$
- type: 'null'
title: Search Context Size
default: medium
type: object
title: OpenAIResponseInputToolWebSearch
description: Web search tool configuration for OpenAI response inputs.
OpenAIResponseMCPApprovalRequest:
properties:
arguments:
type: string
title: Arguments
id:
type: string
title: Id
name:
type: string
title: Name
server_label:
type: string
title: Server Label
type:
type: string
const: mcp_approval_request
title: Type
default: mcp_approval_request
type: object
required:
- arguments
- id
- name
- server_label
title: OpenAIResponseMCPApprovalRequest
description: A request for human approval of a tool invocation.
OpenAIResponseMCPApprovalResponse:
properties:
approval_request_id:
type: string
title: Approval Request Id
approve:
type: boolean
title: Approve
type:
type: string
const: mcp_approval_response
title: Type
default: mcp_approval_response
id:
anyOf:
- type: string
- type: 'null'
title: Id
reason:
anyOf:
- type: string
- type: 'null'
title: Reason
type: object
required:
- approval_request_id
- approve
title: OpenAIResponseMCPApprovalResponse
description: A response to an MCP approval request.
OpenAIResponseMessage-Input:
properties:
content:
anyOf:
- type: string
- items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
discriminator:
propertyName: type
mapping:
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
type: array
- items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
discriminator:
propertyName: type
mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
type: array
title: Content
role:
anyOf:
- type: string
const: system
- type: string
const: developer
- type: string
const: user
- type: string
const: assistant
title: Role
type:
type: string
const: message
title: Type
default: message
id:
anyOf:
- type: string
- type: 'null'
title: Id
status:
anyOf:
- type: string
- type: 'null'
title: Status
type: object
required:
- content
- role
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.
OpenAIResponseMessage-Output:
properties:
content:
anyOf:
- type: string
- items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
discriminator:
propertyName: type
mapping:
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
type: array
- items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
discriminator:
propertyName: type
mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
type: array
title: Content
role:
anyOf:
- type: string
const: system
- type: string
const: developer
- type: string
const: user
- type: string
const: assistant
title: Role
type:
type: string
const: message
title: Type
default: message
id:
anyOf:
- type: string
- type: 'null'
title: Id
status:
anyOf:
- type: string
- type: 'null'
title: Status
type: object
required:
- content
- role
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.
OpenAIResponseObject:
properties:
created_at:
type: integer
title: Created At
error:
anyOf:
- $ref: '#/components/schemas/OpenAIResponseError'
- type: 'null'
id:
type: string
title: Id
model:
type: string
title: Model
object:
type: string
const: response
title: Object
default: response
output:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
- $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:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Output'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
type: array
title: Output
parallel_tool_calls:
type: boolean
title: Parallel Tool Calls
default: false
previous_response_id:
anyOf:
- type: string
- type: 'null'
title: Previous Response Id
prompt:
anyOf:
- $ref: '#/components/schemas/OpenAIResponsePrompt'
- type: 'null'
status:
type: string
title: Status
temperature:
anyOf:
- type: number
- type: 'null'
title: Temperature
text:
$ref: '#/components/schemas/OpenAIResponseText'
default:
format:
type: text
top_p:
anyOf:
- type: number
- type: 'null'
title: Top P
tools:
anyOf:
- items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
- $ref: '#/components/schemas/OpenAIResponseToolMCP'
discriminator:
propertyName: type
mapping:
file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch'
function: '#/components/schemas/OpenAIResponseInputToolFunction'
mcp: '#/components/schemas/OpenAIResponseToolMCP'
web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
type: array
- type: 'null'
title: Tools
truncation:
anyOf:
- type: string
- type: 'null'
title: Truncation
usage:
anyOf:
- $ref: '#/components/schemas/OpenAIResponseUsage'
- type: 'null'
instructions:
anyOf:
- type: string
- type: 'null'
title: Instructions
type: object
required:
- created_at
- id
- model
- output
- status
title: OpenAIResponseObject
description: Complete OpenAI response object containing generation results and metadata.
OpenAIResponseOutputMessageContentOutputText:
properties:
text:
type: string
title: Text
type:
type: string
const: output_text
title: Type
default: output_text
annotations:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
discriminator:
propertyName: type
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
type: array
title: Annotations
type: object
required:
- text
title: OpenAIResponseOutputMessageContentOutputText
OpenAIResponseOutputMessageFileSearchToolCall:
properties:
id:
type: string
title: Id
queries:
items:
type: string
type: array
title: Queries
status:
type: string
title: Status
type:
type: string
const: file_search_call
title: Type
default: file_search_call
results:
anyOf:
- items:
$ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults'
type: array
- type: 'null'
title: Results
type: object
required:
- id
- queries
- status
title: OpenAIResponseOutputMessageFileSearchToolCall
description: File search tool call output message for OpenAI responses.
OpenAIResponseOutputMessageFileSearchToolCallResults:
properties:
attributes:
additionalProperties: true
type: object
title: Attributes
file_id:
type: string
title: File Id
filename:
type: string
title: Filename
score:
type: number
title: Score
text:
type: string
title: Text
type: object
required:
- attributes
- file_id
- filename
- score
- text
title: OpenAIResponseOutputMessageFileSearchToolCallResults
description: Search results returned by the file search operation.
OpenAIResponseOutputMessageFunctionToolCall:
properties:
call_id:
type: string
title: Call Id
name:
type: string
title: Name
arguments:
type: string
title: Arguments
type:
type: string
const: function_call
title: Type
default: function_call
id:
anyOf:
- type: string
- type: 'null'
title: Id
status:
anyOf:
- type: string
- type: 'null'
title: Status
type: object
required:
- call_id
- name
- arguments
title: OpenAIResponseOutputMessageFunctionToolCall
description: Function tool call output message for OpenAI responses.
OpenAIResponseOutputMessageMCPCall:
properties:
id:
type: string
title: Id
type:
type: string
const: mcp_call
title: Type
default: mcp_call
arguments:
type: string
title: Arguments
name:
type: string
title: Name
server_label:
type: string
title: Server Label
error:
anyOf:
- type: string
- type: 'null'
title: Error
output:
anyOf:
- type: string
- type: 'null'
title: Output
type: object
required:
- id
- arguments
- name
- server_label
title: OpenAIResponseOutputMessageMCPCall
description: Model Context Protocol (MCP) call output message for OpenAI responses.
OpenAIResponseOutputMessageMCPListTools:
properties:
id:
type: string
title: Id
type:
type: string
const: mcp_list_tools
title: Type
default: mcp_list_tools
server_label:
type: string
title: Server Label
tools:
items:
$ref: '#/components/schemas/MCPListToolsTool'
type: array
title: Tools
type: object
required:
- id
- server_label
- tools
title: OpenAIResponseOutputMessageMCPListTools
description: MCP list tools output message containing available tools from an MCP server.
OpenAIResponseOutputMessageWebSearchToolCall:
properties:
id:
type: string
title: Id
status:
type: string
title: Status
type:
type: string
const: web_search_call
title: Type
default: web_search_call
type: object
required:
- id
- status
title: OpenAIResponseOutputMessageWebSearchToolCall
description: Web search tool call output message for OpenAI responses.
OpenAIResponsePrompt:
properties:
id:
type: string
title: Id
variables:
anyOf:
- additionalProperties:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
discriminator:
propertyName: type
mapping:
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
type: object
- type: 'null'
title: Variables
version:
anyOf:
- type: string
- type: 'null'
title: Version
type: object
required:
- id
title: OpenAIResponsePrompt
description: OpenAI compatible Prompt object that is used in OpenAI responses.
OpenAIResponseText:
properties:
format:
anyOf:
- $ref: '#/components/schemas/OpenAIResponseTextFormat'
- type: 'null'
type: object
title: OpenAIResponseText
description: Text response configuration for OpenAI responses.
OpenAIResponseTextFormat:
properties:
type:
anyOf:
- type: string
const: text
- type: string
const: json_schema
- type: string
const: json_object
title: Type
name:
anyOf:
- type: string
- type: 'null'
title: Name
schema:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Schema
description:
anyOf:
- type: string
- type: 'null'
title: Description
strict:
anyOf:
- type: boolean
- type: 'null'
title: Strict
type: object
title: OpenAIResponseTextFormat
description: Configuration for Responses API text format.
OpenAIResponseToolMCP:
properties:
type:
type: string
const: mcp
title: Type
default: mcp
server_label:
type: string
title: Server Label
allowed_tools:
anyOf:
- items:
type: string
type: array
- $ref: '#/components/schemas/AllowedToolsFilter'
- type: 'null'
title: Allowed Tools
type: object
required:
- server_label
title: OpenAIResponseToolMCP
description: Model Context Protocol (MCP) tool configuration for OpenAI response object.
OpenAIResponseUsage:
properties:
input_tokens:
type: integer
title: Input Tokens
output_tokens:
type: integer
title: Output Tokens
total_tokens:
type: integer
title: Total Tokens
input_tokens_details:
anyOf:
- $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails'
- type: 'null'
output_tokens_details:
anyOf:
- $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails'
- type: 'null'
type: object
required:
- input_tokens
- output_tokens
- total_tokens
title: OpenAIResponseUsage
description: Usage information for OpenAI response.
OpenAIResponseUsageInputTokensDetails:
properties:
cached_tokens:
anyOf:
- type: integer
- type: 'null'
title: Cached Tokens
type: object
title: OpenAIResponseUsageInputTokensDetails
description: Token details for input tokens in OpenAI response usage.
OpenAIResponseUsageOutputTokensDetails:
properties:
reasoning_tokens:
anyOf:
- type: integer
- type: 'null'
title: Reasoning Tokens
type: object
title: OpenAIResponseUsageOutputTokensDetails
description: Token details for output tokens in OpenAI response usage.
OpenAISystemMessageParam:
properties:
role:
type: string
const: system
title: Role
default: system
content:
anyOf:
- type: string
- items:
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
type: array
title: Content
name:
anyOf:
- type: string
- type: 'null'
title: Name
type: object
required:
- content
title: OpenAISystemMessageParam
description: A system message providing instructions or context to the model.
OpenAITokenLogProb:
properties:
token:
type: string
title: Token
bytes:
anyOf:
- items:
type: integer
type: array
- type: 'null'
title: Bytes
logprob:
type: number
title: Logprob
top_logprobs:
items:
$ref: '#/components/schemas/OpenAITopLogProb'
type: array
title: Top Logprobs
type: object
required:
- token
- logprob
- top_logprobs
title: OpenAITokenLogProb
description: |-
The log probability for a token from an OpenAI-compatible chat completion response.
:token: The token
:bytes: (Optional) The bytes for the token
:logprob: The log probability of the token
:top_logprobs: The top log probabilities for the token
OpenAIToolMessageParam:
properties:
role:
type: string
const: tool
title: Role
default: tool
tool_call_id:
type: string
title: Tool Call Id
content:
anyOf:
- type: string
- items:
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
type: array
title: Content
type: object
required:
- tool_call_id
- content
title: OpenAIToolMessageParam
description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request.
OpenAITopLogProb:
properties:
token:
type: string
title: Token
bytes:
anyOf:
- items:
type: integer
type: array
- type: 'null'
title: Bytes
logprob:
type: number
title: Logprob
type: object
required:
- token
- logprob
title: OpenAITopLogProb
description: |-
The top log probability for a token from an OpenAI-compatible chat completion response.
:token: The token
:bytes: (Optional) The bytes for the token
:logprob: The log probability of the token
OpenAIUserMessageParam-Input:
properties:
role:
type: string
const: user
title: Role
default: user
content:
anyOf:
- type: string
- items:
oneOf:
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
- $ref: '#/components/schemas/OpenAIFile'
discriminator:
propertyName: type
mapping:
file: '#/components/schemas/OpenAIFile'
image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
type: array
title: Content
name:
anyOf:
- type: string
- type: 'null'
title: Name
type: object
required:
- content
title: OpenAIUserMessageParam
description: A message from the user in an OpenAI-compatible chat completion request.
OpenAIUserMessageParam-Output:
properties:
role:
type: string
const: user
title: Role
default: user
content:
anyOf:
- type: string
- items:
oneOf:
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
- $ref: '#/components/schemas/OpenAIFile'
discriminator:
propertyName: type
mapping:
file: '#/components/schemas/OpenAIFile'
image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
type: array
title: Content
name:
anyOf:
- type: string
- type: 'null'
title: Name
type: object
required:
- content
title: OpenAIUserMessageParam
description: A message from the user in an OpenAI-compatible chat completion request.
OptimizerConfig:
properties:
optimizer_type:
$ref: '#/components/schemas/OptimizerType'
lr:
type: number
title: Lr
weight_decay:
type: number
title: Weight Decay
num_warmup_steps:
type: integer
title: Num Warmup Steps
type: object
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.
Order:
type: string
enum:
- asc
- desc
title: Order
description: Sort order for paginated responses.
OutputTokensDetails:
properties:
reasoning_tokens:
type: integer
title: Reasoning Tokens
additionalProperties: true
type: object
required:
- reasoning_tokens
title: OutputTokensDetails
PostTrainingJob:
properties:
job_uuid:
type: string
title: Job Uuid
type: object
required:
- job_uuid
title: PostTrainingJob
Prompt:
properties:
prompt:
anyOf:
- type: string
- type: 'null'
title: Prompt
description: The system prompt with variable placeholders
version:
type: integer
minimum: 1.0
title: Version
description: Version (integer starting at 1, incremented on save)
prompt_id:
type: string
title: Prompt Id
description: Unique identifier in format 'pmpt_<48-digit-hash>'
variables:
items:
type: string
type: array
title: Variables
description: List of variable names that can be used in the prompt template
is_default:
type: boolean
title: Is Default
description: Boolean indicating whether this version is the default version
default: false
type: object
required:
- version
- prompt_id
title: Prompt
description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack.
ProviderInfo:
properties:
api:
type: string
title: Api
provider_id:
type: string
title: Provider Id
provider_type:
type: string
title: Provider Type
config:
additionalProperties: true
type: object
title: Config
health:
additionalProperties: true
type: object
title: Health
type: object
required:
- api
- provider_id
- provider_type
- config
- health
title: ProviderInfo
description: Information about a registered provider including its configuration and health status.
QATFinetuningConfig:
properties:
type:
type: string
const: QAT
title: Type
default: QAT
quantizer_name:
type: string
title: Quantizer Name
group_size:
type: integer
title: Group Size
type: object
required:
- quantizer_name
- group_size
title: QATFinetuningConfig
description: Configuration for Quantization-Aware Training (QAT) fine-tuning.
QueryChunksResponse:
properties:
chunks:
items:
$ref: '#/components/schemas/Chunk-Output'
type: array
title: Chunks
scores:
items:
type: number
type: array
title: Scores
type: object
required:
- chunks
- scores
title: QueryChunksResponse
description: Response from querying chunks in a vector database.
RegexParserScoringFnParams:
properties:
type:
type: string
const: regex_parser
title: Type
default: regex_parser
parsing_regexes:
items:
type: string
type: array
title: Parsing Regexes
description: Regex to extract the answer from generated response
aggregation_functions:
items:
$ref: '#/components/schemas/AggregationFunctionType'
type: array
title: Aggregation Functions
description: Aggregation functions to apply to the scores of each row
type: object
title: RegexParserScoringFnParams
description: Parameters for regex parser scoring function configuration.
RerankData:
properties:
index:
type: integer
title: Index
relevance_score:
type: number
title: Relevance Score
type: object
required:
- index
- relevance_score
title: RerankData
description: A single rerank result from a reranking response.
RerankResponse:
properties:
data:
items:
$ref: '#/components/schemas/RerankData'
type: array
title: Data
type: object
required:
- data
title: RerankResponse
description: Response from a reranking request.
RowsDataSource:
properties:
type:
type: string
const: rows
title: Type
default: rows
rows:
items:
additionalProperties: true
type: object
type: array
title: Rows
type: object
required:
- rows
title: RowsDataSource
description: A dataset stored in rows.
RunShieldResponse:
properties:
violation:
anyOf:
- $ref: '#/components/schemas/SafetyViolation'
- type: 'null'
type: object
title: RunShieldResponse
description: Response from running a safety shield.
SafetyViolation:
properties:
violation_level:
$ref: '#/components/schemas/ViolationLevel'
user_message:
anyOf:
- type: string
- type: 'null'
title: User Message
metadata:
additionalProperties: true
type: object
title: Metadata
type: object
required:
- violation_level
title: SafetyViolation
description: Details of a safety violation detected by content moderation.
SamplingParams:
properties:
strategy:
oneOf:
- $ref: '#/components/schemas/GreedySamplingStrategy'
- $ref: '#/components/schemas/TopPSamplingStrategy'
- $ref: '#/components/schemas/TopKSamplingStrategy'
title: Strategy
discriminator:
propertyName: type
mapping:
greedy: '#/components/schemas/GreedySamplingStrategy'
top_k: '#/components/schemas/TopKSamplingStrategy'
top_p: '#/components/schemas/TopPSamplingStrategy'
max_tokens:
anyOf:
- type: integer
- type: 'null'
title: Max Tokens
repetition_penalty:
anyOf:
- type: number
- type: 'null'
title: Repetition Penalty
default: 1.0
stop:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Stop
type: object
title: SamplingParams
description: Sampling parameters.
ScoreBatchResponse:
properties:
dataset_id:
anyOf:
- type: string
- type: 'null'
title: Dataset Id
results:
additionalProperties:
$ref: '#/components/schemas/ScoringResult'
type: object
title: Results
type: object
required:
- results
title: ScoreBatchResponse
description: Response from batch scoring operations on datasets.
ScoreResponse:
properties:
results:
additionalProperties:
$ref: '#/components/schemas/ScoringResult'
type: object
title: Results
type: object
required:
- results
title: ScoreResponse
description: The response from scoring.
ScoringFn:
properties:
identifier:
type: string
title: Identifier
description: Unique identifier for this resource in llama stack
provider_resource_id:
anyOf:
- type: string
- type: 'null'
title: Provider Resource Id
description: Unique identifier for this resource in the provider
provider_id:
type: string
title: Provider Id
description: ID of the provider that owns this resource
type:
type: string
const: scoring_function
title: Type
default: scoring_function
description:
anyOf:
- type: string
- type: 'null'
title: Description
metadata:
additionalProperties: true
type: object
title: Metadata
description: Any additional metadata for this definition
return_type:
oneOf:
- $ref: '#/components/schemas/StringType'
- $ref: '#/components/schemas/NumberType'
- $ref: '#/components/schemas/BooleanType'
- $ref: '#/components/schemas/ArrayType'
- $ref: '#/components/schemas/ObjectType'
- $ref: '#/components/schemas/JsonType'
- $ref: '#/components/schemas/UnionType'
- $ref: '#/components/schemas/ChatCompletionInputType'
- $ref: '#/components/schemas/CompletionInputType'
title: Return Type
description: The return type of the deterministic function
discriminator:
propertyName: type
mapping:
array: '#/components/schemas/ArrayType'
boolean: '#/components/schemas/BooleanType'
chat_completion_input: '#/components/schemas/ChatCompletionInputType'
completion_input: '#/components/schemas/CompletionInputType'
json: '#/components/schemas/JsonType'
number: '#/components/schemas/NumberType'
object: '#/components/schemas/ObjectType'
string: '#/components/schemas/StringType'
union: '#/components/schemas/UnionType'
params:
anyOf:
- oneOf:
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
- $ref: '#/components/schemas/RegexParserScoringFnParams'
- $ref: '#/components/schemas/BasicScoringFnParams'
discriminator:
propertyName: type
mapping:
basic: '#/components/schemas/BasicScoringFnParams'
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
- type: 'null'
title: Params
description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval
type: object
required:
- identifier
- provider_id
- return_type
title: ScoringFn
description: A scoring function resource for evaluating model outputs.
ScoringResult:
properties:
score_rows:
items:
additionalProperties: true
type: object
type: array
title: Score Rows
aggregated_results:
additionalProperties: true
type: object
title: Aggregated Results
type: object
required:
- score_rows
- aggregated_results
title: ScoringResult
description: A scoring result for a single row.
SearchRankingOptions:
properties:
ranker:
anyOf:
- type: string
- type: 'null'
title: Ranker
score_threshold:
anyOf:
- type: number
- type: 'null'
title: Score Threshold
default: 0.0
type: object
title: SearchRankingOptions
description: Options for ranking and filtering search results.
Shield:
properties:
identifier:
type: string
title: Identifier
description: Unique identifier for this resource in llama stack
provider_resource_id:
anyOf:
- type: string
- type: 'null'
title: Provider Resource Id
description: Unique identifier for this resource in the provider
provider_id:
type: string
title: Provider Id
description: ID of the provider that owns this resource
type:
type: string
const: shield
title: Type
default: shield
params:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Params
type: object
required:
- identifier
- provider_id
title: Shield
description: A safety shield resource that can be used to check content.
StringType:
properties:
type:
type: string
const: string
title: Type
default: string
type: object
title: StringType
description: Parameter type for string values.
SystemMessage:
properties:
role:
type: string
const: system
title: Role
default: system
content:
anyOf:
- type: string
- oneOf:
- $ref: '#/components/schemas/ImageContentItem-Input'
- $ref: '#/components/schemas/TextContentItem'
discriminator:
propertyName: type
mapping:
image: '#/components/schemas/ImageContentItem-Input'
text: '#/components/schemas/TextContentItem'
- items:
oneOf:
- $ref: '#/components/schemas/ImageContentItem-Input'
- $ref: '#/components/schemas/TextContentItem'
discriminator:
propertyName: type
mapping:
image: '#/components/schemas/ImageContentItem-Input'
text: '#/components/schemas/TextContentItem'
type: array
title: Content
type: object
required:
- content
title: SystemMessage
description: A system message providing instructions or context to the model.
TextContentItem:
properties:
type:
type: string
const: text
title: Type
default: text
text:
type: string
title: Text
type: object
required:
- text
title: TextContentItem
description: A text content item
ToolDef:
properties:
toolgroup_id:
anyOf:
- type: string
- type: 'null'
title: Toolgroup Id
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
input_schema:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Input Schema
output_schema:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Output Schema
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
type: object
required:
- name
title: ToolDef
description: Tool definition used in runtime contexts.
ToolGroup:
properties:
identifier:
type: string
title: Identifier
description: Unique identifier for this resource in llama stack
provider_resource_id:
anyOf:
- type: string
- type: 'null'
title: Provider Resource Id
description: Unique identifier for this resource in the provider
provider_id:
type: string
title: Provider Id
description: ID of the provider that owns this resource
type:
type: string
const: tool_group
title: Type
default: tool_group
mcp_endpoint:
anyOf:
- $ref: '#/components/schemas/URL'
- type: 'null'
args:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Args
type: object
required:
- identifier
- provider_id
title: ToolGroup
description: A group of related tools managed together.
ToolInvocationResult:
properties:
content:
anyOf:
- type: string
- oneOf:
- $ref: '#/components/schemas/ImageContentItem-Output'
- $ref: '#/components/schemas/TextContentItem'
discriminator:
propertyName: type
mapping:
image: '#/components/schemas/ImageContentItem-Output'
text: '#/components/schemas/TextContentItem'
- items:
oneOf:
- $ref: '#/components/schemas/ImageContentItem-Output'
- $ref: '#/components/schemas/TextContentItem'
discriminator:
propertyName: type
mapping:
image: '#/components/schemas/ImageContentItem-Output'
text: '#/components/schemas/TextContentItem'
type: array
- type: 'null'
title: Content
error_message:
anyOf:
- type: string
- type: 'null'
title: Error Message
error_code:
anyOf:
- type: integer
- type: 'null'
title: Error Code
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
type: object
title: ToolInvocationResult
description: Result of a tool invocation.
TopKSamplingStrategy:
properties:
type:
type: string
const: top_k
title: Type
default: top_k
top_k:
type: integer
minimum: 1.0
title: Top K
type: object
required:
- top_k
title: TopKSamplingStrategy
description: Top-k sampling strategy that restricts sampling to the k most likely tokens.
TopPSamplingStrategy:
properties:
type:
type: string
const: top_p
title: Type
default: top_p
temperature:
anyOf:
- type: number
minimum: 0.0
- type: 'null'
title: Temperature
top_p:
anyOf:
- type: number
- type: 'null'
title: Top P
default: 0.95
type: object
required:
- temperature
title: TopPSamplingStrategy
description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p.
TrainingConfig:
properties:
n_epochs:
type: integer
title: N Epochs
max_steps_per_epoch:
type: integer
title: Max Steps Per Epoch
default: 1
gradient_accumulation_steps:
type: integer
title: Gradient Accumulation Steps
default: 1
max_validation_steps:
anyOf:
- type: integer
- type: 'null'
title: Max Validation Steps
default: 1
data_config:
anyOf:
- $ref: '#/components/schemas/DataConfig'
- type: 'null'
optimizer_config:
anyOf:
- $ref: '#/components/schemas/OptimizerConfig'
- type: 'null'
efficiency_config:
anyOf:
- $ref: '#/components/schemas/EfficiencyConfig'
- type: 'null'
dtype:
anyOf:
- type: string
- type: 'null'
title: Dtype
default: bf16
type: object
required:
- n_epochs
title: TrainingConfig
description: Comprehensive configuration for the training process.
URIDataSource:
properties:
type:
type: string
const: uri
title: Type
default: uri
uri:
type: string
title: Uri
type: object
required:
- uri
title: URIDataSource
description: A dataset that can be obtained from a URI.
URL:
properties:
uri:
type: string
title: Uri
type: object
required:
- uri
title: URL
description: A URL reference to external content.
UnionType:
properties:
type:
type: string
const: union
title: Type
default: union
type: object
title: UnionType
description: Parameter type for union values.
VectorStoreChunkingStrategyAuto:
properties:
type:
type: string
const: auto
title: Type
default: auto
type: object
title: VectorStoreChunkingStrategyAuto
description: Automatic chunking strategy for vector store files.
VectorStoreChunkingStrategyStatic:
properties:
type:
type: string
const: static
title: Type
default: static
static:
$ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig'
type: object
required:
- static
title: VectorStoreChunkingStrategyStatic
description: Static chunking strategy with configurable parameters.
VectorStoreChunkingStrategyStaticConfig:
properties:
chunk_overlap_tokens:
type: integer
title: Chunk Overlap Tokens
default: 400
max_chunk_size_tokens:
type: integer
maximum: 4096.0
minimum: 100.0
title: Max Chunk Size Tokens
default: 800
type: object
title: VectorStoreChunkingStrategyStaticConfig
description: Configuration for static chunking strategy.
VectorStoreContent:
properties:
type:
type: string
const: text
title: Type
text:
type: string
title: Text
type: object
required:
- type
- text
title: VectorStoreContent
description: Content item from a vector store file or search result.
VectorStoreDeleteResponse:
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: vector_store.deleted
deleted:
type: boolean
title: Deleted
default: true
type: object
required:
- id
title: VectorStoreDeleteResponse
description: Response from deleting a vector store.
VectorStoreFileBatchObject:
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: vector_store.file_batch
created_at:
type: integer
title: Created At
vector_store_id:
type: string
title: Vector Store Id
status:
anyOf:
- type: string
const: completed
- type: string
const: in_progress
- type: string
const: cancelled
- type: string
const: failed
title: Status
file_counts:
$ref: '#/components/schemas/VectorStoreFileCounts'
type: object
required:
- id
- created_at
- vector_store_id
- status
- file_counts
title: VectorStoreFileBatchObject
description: OpenAI Vector Store File Batch object.
VectorStoreFileContentsResponse:
properties:
file_id:
type: string
title: File Id
filename:
type: string
title: Filename
attributes:
additionalProperties: true
type: object
title: Attributes
content:
items:
$ref: '#/components/schemas/VectorStoreContent'
type: array
title: Content
type: object
required:
- file_id
- filename
- attributes
- content
title: VectorStoreFileContentsResponse
description: Response from retrieving the contents of a vector store file.
VectorStoreFileCounts:
properties:
completed:
type: integer
title: Completed
cancelled:
type: integer
title: Cancelled
failed:
type: integer
title: Failed
in_progress:
type: integer
title: In Progress
total:
type: integer
title: Total
type: object
required:
- completed
- cancelled
- failed
- in_progress
- total
title: VectorStoreFileCounts
description: File processing status counts for a vector store.
VectorStoreFileDeleteResponse:
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: vector_store.file.deleted
deleted:
type: boolean
title: Deleted
default: true
type: object
required:
- id
title: VectorStoreFileDeleteResponse
description: Response from deleting a vector store file.
VectorStoreFileLastError:
properties:
code:
anyOf:
- type: string
const: server_error
- type: string
const: rate_limit_exceeded
title: Code
message:
type: string
title: Message
type: object
required:
- code
- message
title: VectorStoreFileLastError
description: Error information for failed vector store file processing.
VectorStoreFileObject:
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: vector_store.file
attributes:
additionalProperties: true
type: object
title: Attributes
chunking_strategy:
oneOf:
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
title: Chunking Strategy
discriminator:
propertyName: type
mapping:
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
static: '#/components/schemas/VectorStoreChunkingStrategyStatic'
created_at:
type: integer
title: Created At
last_error:
anyOf:
- $ref: '#/components/schemas/VectorStoreFileLastError'
- type: 'null'
status:
anyOf:
- type: string
const: completed
- type: string
const: in_progress
- type: string
const: cancelled
- type: string
const: failed
title: Status
usage_bytes:
type: integer
title: Usage Bytes
default: 0
vector_store_id:
type: string
title: Vector Store Id
type: object
required:
- id
- chunking_strategy
- created_at
- status
- vector_store_id
title: VectorStoreFileObject
description: OpenAI Vector Store File object.
VectorStoreObject:
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: vector_store
created_at:
type: integer
title: Created At
name:
anyOf:
- type: string
- type: 'null'
title: Name
usage_bytes:
type: integer
title: Usage Bytes
default: 0
file_counts:
$ref: '#/components/schemas/VectorStoreFileCounts'
status:
type: string
title: Status
default: completed
expires_after:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Expires After
expires_at:
anyOf:
- type: integer
- type: 'null'
title: Expires At
last_active_at:
anyOf:
- type: integer
- type: 'null'
title: Last Active At
metadata:
additionalProperties: true
type: object
title: Metadata
type: object
required:
- id
- created_at
- file_counts
title: VectorStoreObject
description: OpenAI Vector Store object.
VectorStoreSearchResponse:
properties:
file_id:
type: string
title: File Id
filename:
type: string
title: Filename
score:
type: number
title: Score
attributes:
anyOf:
- additionalProperties:
anyOf:
- type: string
- type: number
- type: boolean
type: object
- type: 'null'
title: Attributes
content:
items:
$ref: '#/components/schemas/VectorStoreContent'
type: array
title: Content
type: object
required:
- file_id
- filename
- score
- content
title: VectorStoreSearchResponse
description: Response from searching a vector store.
VectorStoreSearchResponsePage:
properties:
object:
type: string
title: Object
default: vector_store.search_results.page
search_query:
items:
type: string
type: array
title: Search Query
data:
items:
$ref: '#/components/schemas/VectorStoreSearchResponse'
type: array
title: Data
has_more:
type: boolean
title: Has More
default: false
next_page:
anyOf:
- type: string
- type: 'null'
title: Next Page
type: object
required:
- search_query
- data
title: VectorStoreSearchResponsePage
description: Paginated response from searching a vector store.
VersionInfo:
properties:
version:
type: string
title: Version
type: object
required:
- version
title: VersionInfo
description: Version information for the service.
ViolationLevel:
type: string
enum:
- info
- warn
- error
title: ViolationLevel
description: Severity level of a safety violation.
_URLOrData:
properties:
url:
anyOf:
- $ref: '#/components/schemas/URL'
- type: 'null'
data:
anyOf:
- type: string
- type: 'null'
contentEncoding: base64
title: Data
type: object
title: _URLOrData
description: A URL or a base64 encoded string
_batches_Request:
properties:
input_file_id:
type: string
title: Input File Id
endpoint:
type: string
title: Endpoint
completion_window:
type: string
const: 24h
title: Completion Window
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Metadata
idempotency_key:
anyOf:
- type: string
- type: 'null'
title: Idempotency Key
type: object
required:
- input_file_id
- endpoint
- completion_window
title: _batches_Request
_conversations_Request:
properties:
items:
anyOf:
- items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
- $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/OpenAIResponseOutputMessageMCPCall'
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
discriminator:
propertyName: type
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Input'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
type: array
- type: 'null'
title: Items
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Metadata
type: object
title: _conversations_Request
_conversations_conversation_id_Request:
properties:
metadata:
additionalProperties:
type: string
type: object
title: Metadata
type: object
required:
- metadata
title: _conversations_conversation_id_Request
_conversations_conversation_id_items_Request:
properties:
items:
items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
- $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/OpenAIResponseOutputMessageMCPCall'
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
discriminator:
propertyName: type
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Input'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
type: array
title: Items
type: object
required:
- items
title: _conversations_conversation_id_items_Request
_datasets_Request:
properties:
purpose:
title: Purpose
source:
title: Source
metadata:
title: Metadata
dataset_id:
title: Dataset Id
type: object
required:
- purpose
- source
title: _datasets_Request
_eval_benchmarks_benchmark_id_evaluations_Request:
properties:
input_rows:
items:
additionalProperties: true
type: object
type: array
title: Input Rows
scoring_functions:
items:
type: string
type: array
title: Scoring Functions
benchmark_config:
$ref: '#/components/schemas/BenchmarkConfig'
type: object
required:
- input_rows
- scoring_functions
- benchmark_config
title: _eval_benchmarks_benchmark_id_evaluations_Request
_inference_rerank_Request:
properties:
model:
type: string
title: Model
query:
anyOf:
- type: string
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
title: Query
items:
items:
anyOf:
- type: string
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
type: array
title: Items
max_num_results:
anyOf:
- type: integer
- type: 'null'
title: Max Num Results
type: object
required:
- model
- query
- items
title: _inference_rerank_Request
_models_Request:
properties:
model_id:
type: string
title: Model Id
provider_model_id:
anyOf:
- type: string
- type: 'null'
title: Provider Model Id
provider_id:
anyOf:
- type: string
- type: 'null'
title: Provider Id
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
model_type:
anyOf:
- $ref: '#/components/schemas/ModelType'
- type: 'null'
type: object
required:
- model_id
title: _models_Request
_moderations_Request:
properties:
input:
anyOf:
- type: string
- items:
type: string
type: array
title: Input
model:
anyOf:
- type: string
- type: 'null'
title: Model
type: object
required:
- input
title: _moderations_Request
_post_training_preference_optimize_Request:
properties:
job_uuid:
type: string
title: Job Uuid
finetuned_model:
type: string
title: Finetuned Model
algorithm_config:
$ref: '#/components/schemas/DPOAlignmentConfig'
training_config:
$ref: '#/components/schemas/TrainingConfig'
hyperparam_search_config:
additionalProperties: true
type: object
title: Hyperparam Search Config
logger_config:
additionalProperties: true
type: object
title: Logger Config
type: object
required:
- job_uuid
- finetuned_model
- algorithm_config
- training_config
- hyperparam_search_config
- logger_config
title: _post_training_preference_optimize_Request
_post_training_supervised_fine_tune_Request:
properties:
job_uuid:
type: string
title: Job Uuid
training_config:
$ref: '#/components/schemas/TrainingConfig'
hyperparam_search_config:
additionalProperties: true
type: object
title: Hyperparam Search Config
logger_config:
additionalProperties: true
type: object
title: Logger Config
model:
anyOf:
- type: string
- type: 'null'
title: Model
description: Model descriptor for training if not in provider config`
checkpoint_dir:
anyOf:
- type: string
- type: 'null'
title: Checkpoint Dir
algorithm_config:
anyOf:
- oneOf:
- $ref: '#/components/schemas/LoraFinetuningConfig'
- $ref: '#/components/schemas/QATFinetuningConfig'
discriminator:
propertyName: type
mapping:
LoRA: '#/components/schemas/LoraFinetuningConfig'
QAT: '#/components/schemas/QATFinetuningConfig'
- type: 'null'
title: Algorithm Config
type: object
required:
- job_uuid
- training_config
- hyperparam_search_config
- logger_config
title: _post_training_supervised_fine_tune_Request
_prompts_Request:
properties:
prompt:
type: string
title: Prompt
variables:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Variables
type: object
required:
- prompt
title: _prompts_Request
_prompts_prompt_id_Request:
properties:
prompt:
type: string
title: Prompt
version:
type: integer
title: Version
variables:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Variables
set_as_default:
type: boolean
title: Set As Default
default: true
type: object
required:
- prompt
- version
title: _prompts_prompt_id_Request
_prompts_prompt_id_set_default_version_Request:
properties:
version:
type: integer
title: Version
type: object
required:
- version
title: _prompts_prompt_id_set_default_version_Request
_responses_Request:
properties:
input:
anyOf:
- type: string
- items:
anyOf:
- oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
- $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:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Input'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
type: array
title: Input
model:
type: string
title: Model
prompt:
anyOf:
- $ref: '#/components/schemas/OpenAIResponsePrompt'
- type: 'null'
instructions:
anyOf:
- type: string
- type: 'null'
title: Instructions
previous_response_id:
anyOf:
- type: string
- type: 'null'
title: Previous Response Id
conversation:
anyOf:
- type: string
- type: 'null'
title: Conversation
store:
anyOf:
- type: boolean
- type: 'null'
title: Store
default: true
stream:
anyOf:
- type: boolean
- type: 'null'
title: Stream
default: false
temperature:
anyOf:
- type: number
- type: 'null'
title: Temperature
text:
anyOf:
- $ref: '#/components/schemas/OpenAIResponseText'
- type: 'null'
tools:
anyOf:
- items:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
- $ref: '#/components/schemas/OpenAIResponseInputToolMCP'
discriminator:
propertyName: type
mapping:
file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch'
function: '#/components/schemas/OpenAIResponseInputToolFunction'
mcp: '#/components/schemas/OpenAIResponseInputToolMCP'
web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
type: array
- type: 'null'
title: Tools
include:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Include
max_infer_iters:
anyOf:
- type: integer
- type: 'null'
title: Max Infer Iters
default: 10
guardrails:
title: Guardrails
type: object
required:
- input
- model
title: _responses_Request
_scoring_score_Request:
properties:
input_rows:
items:
additionalProperties: true
type: object
type: array
title: Input Rows
scoring_functions:
additionalProperties:
anyOf:
- oneOf:
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
- $ref: '#/components/schemas/RegexParserScoringFnParams'
- $ref: '#/components/schemas/BasicScoringFnParams'
discriminator:
propertyName: type
mapping:
basic: '#/components/schemas/BasicScoringFnParams'
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
- type: 'null'
type: object
title: Scoring Functions
type: object
required:
- input_rows
- scoring_functions
title: _scoring_score_Request
_scoring_score_batch_Request:
properties:
dataset_id:
type: string
title: Dataset Id
scoring_functions:
additionalProperties:
anyOf:
- oneOf:
- $ref: '#/components/schemas/LLMAsJudgeScoringFnParams'
- $ref: '#/components/schemas/RegexParserScoringFnParams'
- $ref: '#/components/schemas/BasicScoringFnParams'
discriminator:
propertyName: type
mapping:
basic: '#/components/schemas/BasicScoringFnParams'
llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams'
regex_parser: '#/components/schemas/RegexParserScoringFnParams'
- type: 'null'
type: object
title: Scoring Functions
save_results_dataset:
type: boolean
title: Save Results Dataset
default: false
type: object
required:
- dataset_id
- scoring_functions
title: _scoring_score_batch_Request
_shields_Request:
properties:
shield_id:
type: string
title: Shield Id
provider_shield_id:
anyOf:
- type: string
- type: 'null'
title: Provider Shield Id
provider_id:
anyOf:
- type: string
- type: 'null'
title: Provider Id
params:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Params
type: object
required:
- shield_id
title: _shields_Request
_tool_runtime_invoke_Request:
properties:
tool_name:
type: string
title: Tool Name
kwargs:
additionalProperties: true
type: object
title: Kwargs
type: object
required:
- tool_name
- kwargs
title: _tool_runtime_invoke_Request
_vector_io_query_Request:
properties:
vector_store_id:
type: string
title: Vector Store Id
query:
anyOf:
- type: string
- oneOf:
- $ref: '#/components/schemas/ImageContentItem-Input'
- $ref: '#/components/schemas/TextContentItem'
discriminator:
propertyName: type
mapping:
image: '#/components/schemas/ImageContentItem-Input'
text: '#/components/schemas/TextContentItem'
- items:
oneOf:
- $ref: '#/components/schemas/ImageContentItem-Input'
- $ref: '#/components/schemas/TextContentItem'
discriminator:
propertyName: type
mapping:
image: '#/components/schemas/ImageContentItem-Input'
text: '#/components/schemas/TextContentItem'
type: array
title: Query
params:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Params
type: object
required:
- vector_store_id
- query
title: _vector_io_query_Request
_vector_stores_vector_store_id_Request:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
expires_after:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Expires After
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
type: object
title: _vector_stores_vector_store_id_Request
_vector_stores_vector_store_id_files_Request:
properties:
file_id:
type: string
title: File Id
attributes:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Attributes
chunking_strategy:
anyOf:
- oneOf:
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
discriminator:
propertyName: type
mapping:
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
static: '#/components/schemas/VectorStoreChunkingStrategyStatic'
- type: 'null'
title: Chunking Strategy
type: object
required:
- file_id
title: _vector_stores_vector_store_id_files_Request
_vector_stores_vector_store_id_files_file_id_Request:
properties:
attributes:
additionalProperties: true
type: object
title: Attributes
type: object
required:
- attributes
title: _vector_stores_vector_store_id_files_file_id_Request
_vector_stores_vector_store_id_search_Request:
properties:
query:
anyOf:
- type: string
- items:
type: string
type: array
title: Query
filters:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Filters
max_num_results:
anyOf:
- type: integer
- type: 'null'
title: Max Num Results
default: 10
ranking_options:
anyOf:
- $ref: '#/components/schemas/SearchRankingOptions'
- type: 'null'
rewrite_query:
anyOf:
- type: boolean
- type: 'null'
title: Rewrite Query
default: false
search_mode:
anyOf:
- type: string
- type: 'null'
title: Search Mode
default: vector
type: object
required:
- query
title: _vector_stores_vector_store_id_search_Request
Error:
description: Error response from the API. Roughly follows RFC 7807.
properties:
status:
title: Status
type: integer
title:
title: Title
type: string
detail:
title: Detail
type: string
instance:
anyOf:
- type: string
- type: 'null'
title: Instance
nullable: true
required:
- status
- title
- detail
title: Error
type: object
ImageContentItem:
description: A image content item
properties:
type:
const: image
default: image
title: Type
type: string
image:
$ref: '#/components/schemas/_URLOrData'
required:
- image
title: ImageContentItem
type: object
InterleavedContentItem:
discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
InterleavedContent:
anyOf:
- type: string
- discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
- items:
discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
type: array
BuiltinTool:
enum:
- brave_search
- wolfram_alpha
- photogen
- code_interpreter
title: BuiltinTool
type: string
ImageDelta:
description: An image content delta for streaming responses.
properties:
type:
const: image
default: image
title: Type
type: string
image:
format: binary
title: Image
type: string
required:
- image
title: ImageDelta
type: object
TextDelta:
description: A text content delta for streaming responses.
properties:
type:
const: text
default: text
title: Type
type: string
text:
title: Text
type: string
required:
- text
title: TextDelta
type: object
ToolCall:
properties:
call_id:
title: Call Id
type: string
tool_name:
anyOf:
- $ref: '#/components/schemas/BuiltinTool'
- type: string
title: Tool Name
arguments:
title: Arguments
type: string
required:
- call_id
- tool_name
- arguments
title: ToolCall
type: object
ToolCallDelta:
description: A tool call content delta for streaming responses.
properties:
type:
const: tool_call
default: tool_call
title: Type
type: string
tool_call:
anyOf:
- type: string
- $ref: '#/components/schemas/ToolCall'
title: Tool Call
parse_status:
$ref: '#/components/schemas/ToolCallParseStatus'
required:
- tool_call
- parse_status
title: ToolCallDelta
type: object
ToolCallParseStatus:
description: Status of tool call parsing during streaming.
enum:
- started
- in_progress
- failed
- succeeded
title: ToolCallParseStatus
type: string
ContentDelta:
discriminator:
mapping:
image: '#/components/schemas/ImageDelta'
text: '#/components/schemas/TextDelta'
tool_call: '#/components/schemas/ToolCallDelta'
propertyName: type
oneOf:
- $ref: '#/components/schemas/TextDelta'
- $ref: '#/components/schemas/ImageDelta'
- $ref: '#/components/schemas/ToolCallDelta'
ToolDefinition:
properties:
tool_name:
anyOf:
- $ref: '#/components/schemas/BuiltinTool'
- type: string
title: Tool Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
nullable: true
input_schema:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Input Schema
nullable: true
output_schema:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Output Schema
nullable: true
required:
- tool_name
title: ToolDefinition
type: object
SamplingStrategy:
discriminator:
mapping:
greedy: '#/components/schemas/GreedySamplingStrategy'
top_k: '#/components/schemas/TopKSamplingStrategy'
top_p: '#/components/schemas/TopPSamplingStrategy'
propertyName: type
oneOf:
- $ref: '#/components/schemas/GreedySamplingStrategy'
- $ref: '#/components/schemas/TopPSamplingStrategy'
- $ref: '#/components/schemas/TopKSamplingStrategy'
CompletionMessage:
description: A message containing the model's (assistant) response in a chat conversation.
properties:
role:
const: assistant
default: assistant
title: Role
type: string
content:
anyOf:
- type: string
- discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
- items:
discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
type: array
title: Content
stop_reason:
$ref: '#/components/schemas/StopReason'
tool_calls:
anyOf:
- items:
$ref: '#/components/schemas/ToolCall'
type: array
- type: 'null'
title: Tool Calls
required:
- content
- stop_reason
title: CompletionMessage
type: object
StopReason:
enum:
- end_of_turn
- end_of_message
- out_of_tokens
title: StopReason
type: string
ToolResponseMessage:
description: A message representing the result of a tool invocation.
properties:
role:
const: tool
default: tool
title: Role
type: string
call_id:
title: Call Id
type: string
content:
anyOf:
- type: string
- discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
- items:
discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
type: array
title: Content
required:
- call_id
- content
title: ToolResponseMessage
type: object
UserMessage:
description: A message from the user in a chat conversation.
properties:
role:
const: user
default: user
title: Role
type: string
content:
anyOf:
- type: string
- discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
- items:
discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
type: array
title: Content
context:
anyOf:
- type: string
- discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
- items:
discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
type: array
- type: 'null'
title: Context
nullable: true
required:
- content
title: UserMessage
type: object
Message:
discriminator:
mapping:
assistant: '#/components/schemas/CompletionMessage'
system: '#/components/schemas/SystemMessage'
tool: '#/components/schemas/ToolResponseMessage'
user: '#/components/schemas/UserMessage'
propertyName: role
oneOf:
- $ref: '#/components/schemas/UserMessage'
- $ref: '#/components/schemas/SystemMessage'
- $ref: '#/components/schemas/ToolResponseMessage'
- $ref: '#/components/schemas/CompletionMessage'
GrammarResponseFormat:
description: Configuration for grammar-guided response generation.
properties:
type:
const: grammar
default: grammar
title: Type
type: string
bnf:
additionalProperties: true
title: Bnf
type: object
required:
- bnf
title: GrammarResponseFormat
type: object
JsonSchemaResponseFormat:
description: Configuration for JSON schema-guided response generation.
properties:
type:
const: json_schema
default: json_schema
title: Type
type: string
json_schema:
additionalProperties: true
title: Json Schema
type: object
required:
- json_schema
title: JsonSchemaResponseFormat
type: object
ResponseFormat:
discriminator:
mapping:
grammar: '#/components/schemas/GrammarResponseFormat'
json_schema: '#/components/schemas/JsonSchemaResponseFormat'
propertyName: type
oneOf:
- $ref: '#/components/schemas/JsonSchemaResponseFormat'
- $ref: '#/components/schemas/GrammarResponseFormat'
OpenAIChatCompletionContentPartParam:
discriminator:
mapping:
file: '#/components/schemas/OpenAIFile'
image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
- $ref: '#/components/schemas/OpenAIFile'
OpenAIAssistantMessageParam:
description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request.
properties:
role:
const: assistant
default: assistant
title: Role
type: string
content:
anyOf:
- type: string
- items:
$ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
type: array
- type: 'null'
title: Content
nullable: true
name:
anyOf:
- type: string
- type: 'null'
title: Name
nullable: true
tool_calls:
anyOf:
- items:
$ref: '#/components/schemas/OpenAIChatCompletionToolCall'
type: array
- type: 'null'
title: Tool Calls
nullable: true
title: OpenAIAssistantMessageParam
type: object
OpenAIUserMessageParam:
description: A message from the user in an OpenAI-compatible chat completion request.
properties:
role:
const: user
default: user
title: Role
type: string
content:
anyOf:
- type: string
- items:
discriminator:
mapping:
file: '#/components/schemas/OpenAIFile'
image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
- $ref: '#/components/schemas/OpenAIFile'
type: array
title: Content
name:
anyOf:
- type: string
- type: 'null'
title: Name
nullable: true
required:
- content
title: OpenAIUserMessageParam
type: object
OpenAIMessageParam:
discriminator:
mapping:
assistant: '#/components/schemas/OpenAIAssistantMessageParam'
developer: '#/components/schemas/OpenAIDeveloperMessageParam'
system: '#/components/schemas/OpenAISystemMessageParam'
tool: '#/components/schemas/OpenAIToolMessageParam'
user: '#/components/schemas/OpenAIUserMessageParam'
propertyName: role
oneOf:
- $ref: '#/components/schemas/OpenAIUserMessageParam'
- $ref: '#/components/schemas/OpenAISystemMessageParam'
- $ref: '#/components/schemas/OpenAIAssistantMessageParam'
- $ref: '#/components/schemas/OpenAIToolMessageParam'
- $ref: '#/components/schemas/OpenAIDeveloperMessageParam'
OpenAIResponseFormatParam:
discriminator:
mapping:
json_object: '#/components/schemas/OpenAIResponseFormatJSONObject'
json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema'
text: '#/components/schemas/OpenAIResponseFormatText'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseFormatText'
- $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema'
- $ref: '#/components/schemas/OpenAIResponseFormatJSONObject'
VectorStoreChunkingStrategy:
discriminator:
mapping:
auto: '#/components/schemas/VectorStoreChunkingStrategyAuto'
static: '#/components/schemas/VectorStoreChunkingStrategyStatic'
propertyName: type
oneOf:
- $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto'
- $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic'
VectorStoreFileStatus:
anyOf:
- const: completed
type: string
- const: in_progress
type: string
- const: cancelled
type: string
- const: failed
type: string
OpenAIResponseInputMessageContent:
discriminator:
mapping:
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
OpenAIResponseAnnotations:
discriminator:
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
OpenAIResponseOutputMessageContent:
discriminator:
mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
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.
properties:
content:
anyOf:
- type: string
- items:
discriminator:
mapping:
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentText'
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage'
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
type: array
- items:
discriminator:
mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
type: array
title: Content
role:
anyOf:
- const: system
type: string
- const: developer
type: string
- const: user
type: string
- const: assistant
type: string
title: Role
type:
const: message
default: message
title: Type
type: string
id:
anyOf:
- type: string
- type: 'null'
title: Id
nullable: true
status:
anyOf:
- type: string
- type: 'null'
title: Status
nullable: true
required:
- content
- role
title: OpenAIResponseMessage
type: object
OpenAIResponseOutput:
discriminator:
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
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'
OpenAIResponseInputTool:
discriminator:
mapping:
file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch'
function: '#/components/schemas/OpenAIResponseInputToolFunction'
mcp: '#/components/schemas/OpenAIResponseInputToolMCP'
web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
- $ref: '#/components/schemas/OpenAIResponseInputToolMCP'
OpenAIResponseTool:
discriminator:
mapping:
file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch'
function: '#/components/schemas/OpenAIResponseInputToolFunction'
mcp: '#/components/schemas/OpenAIResponseToolMCP'
web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
- $ref: '#/components/schemas/OpenAIResponseToolMCP'
OpenAIResponseContentPartOutputText:
description: Text content within a streamed response part.
properties:
type:
const: output_text
default: output_text
title: Type
type: string
text:
title: Text
type: string
annotations:
items:
discriminator:
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: Annotations
type: array
logprobs:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Logprobs
nullable: true
required:
- text
title: OpenAIResponseContentPartOutputText
type: object
OpenAIResponseContentPartReasoningText:
description: Reasoning text emitted as part of a streamed response.
properties:
type:
const: reasoning_text
default: reasoning_text
title: Type
type: string
text:
title: Text
type: string
required:
- text
title: OpenAIResponseContentPartReasoningText
type: object
OpenAIResponseContentPart:
discriminator:
mapping:
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
OpenAIResponseContentPartReasoningSummary:
description: Reasoning summary part in a streamed response.
properties:
type:
const: summary_text
default: summary_text
title: Type
type: string
text:
title: Text
type: string
required:
- text
title: OpenAIResponseContentPartReasoningSummary
type: object
OpenAIResponseObjectStreamResponseCompleted:
description: Streaming event indicating a response has been completed.
properties:
response:
$ref: '#/components/schemas/OpenAIResponseObject'
type:
const: response.completed
default: response.completed
title: Type
type: string
required:
- response
title: OpenAIResponseObjectStreamResponseCompleted
type: object
OpenAIResponseObjectStreamResponseContentPartAdded:
description: Streaming event for when a new content part is added to a response item.
properties:
content_index:
title: Content Index
type: integer
response_id:
title: Response Id
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
part:
discriminator:
mapping:
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
title: Part
sequence_number:
title: Sequence Number
type: integer
type:
const: response.content_part.added
default: response.content_part.added
title: Type
type: string
required:
- content_index
- response_id
- item_id
- output_index
- part
- sequence_number
title: OpenAIResponseObjectStreamResponseContentPartAdded
type: object
OpenAIResponseObjectStreamResponseContentPartDone:
description: Streaming event for when a content part is completed.
properties:
content_index:
title: Content Index
type: integer
response_id:
title: Response Id
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
part:
discriminator:
mapping:
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
title: Part
sequence_number:
title: Sequence Number
type: integer
type:
const: response.content_part.done
default: response.content_part.done
title: Type
type: string
required:
- content_index
- response_id
- item_id
- output_index
- part
- sequence_number
title: OpenAIResponseObjectStreamResponseContentPartDone
type: object
OpenAIResponseObjectStreamResponseCreated:
description: Streaming event indicating a new response has been created.
properties:
response:
$ref: '#/components/schemas/OpenAIResponseObject'
type:
const: response.created
default: response.created
title: Type
type: string
required:
- response
title: OpenAIResponseObjectStreamResponseCreated
type: object
OpenAIResponseObjectStreamResponseFailed:
description: Streaming event emitted when a response fails.
properties:
response:
$ref: '#/components/schemas/OpenAIResponseObject'
sequence_number:
title: Sequence Number
type: integer
type:
const: response.failed
default: response.failed
title: Type
type: string
required:
- response
- sequence_number
title: OpenAIResponseObjectStreamResponseFailed
type: object
OpenAIResponseObjectStreamResponseFileSearchCallCompleted:
description: Streaming event for completed file search calls.
properties:
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.file_search_call.completed
default: response.file_search_call.completed
title: Type
type: string
required:
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseFileSearchCallCompleted
type: object
OpenAIResponseObjectStreamResponseFileSearchCallInProgress:
description: Streaming event for file search calls in progress.
properties:
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.file_search_call.in_progress
default: response.file_search_call.in_progress
title: Type
type: string
required:
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseFileSearchCallInProgress
type: object
OpenAIResponseObjectStreamResponseFileSearchCallSearching:
description: Streaming event for file search currently searching.
properties:
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.file_search_call.searching
default: response.file_search_call.searching
title: Type
type: string
required:
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseFileSearchCallSearching
type: object
OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta:
description: Streaming event for incremental function call argument updates.
properties:
delta:
title: Delta
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.function_call_arguments.delta
default: response.function_call_arguments.delta
title: Type
type: string
required:
- delta
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta
type: object
OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone:
description: Streaming event for when function call arguments are completed.
properties:
arguments:
title: Arguments
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.function_call_arguments.done
default: response.function_call_arguments.done
title: Type
type: string
required:
- arguments
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone
type: object
OpenAIResponseObjectStreamResponseInProgress:
description: Streaming event indicating the response remains in progress.
properties:
response:
$ref: '#/components/schemas/OpenAIResponseObject'
sequence_number:
title: Sequence Number
type: integer
type:
const: response.in_progress
default: response.in_progress
title: Type
type: string
required:
- response
- sequence_number
title: OpenAIResponseObjectStreamResponseInProgress
type: object
OpenAIResponseObjectStreamResponseIncomplete:
description: Streaming event emitted when a response ends in an incomplete state.
properties:
response:
$ref: '#/components/schemas/OpenAIResponseObject'
sequence_number:
title: Sequence Number
type: integer
type:
const: response.incomplete
default: response.incomplete
title: Type
type: string
required:
- response
- sequence_number
title: OpenAIResponseObjectStreamResponseIncomplete
type: object
OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta:
properties:
delta:
title: Delta
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.mcp_call.arguments.delta
default: response.mcp_call.arguments.delta
title: Type
type: string
required:
- delta
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta
type: object
OpenAIResponseObjectStreamResponseMcpCallArgumentsDone:
properties:
arguments:
title: Arguments
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.mcp_call.arguments.done
default: response.mcp_call.arguments.done
title: Type
type: string
required:
- arguments
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDone
type: object
OpenAIResponseObjectStreamResponseMcpCallCompleted:
description: Streaming event for completed MCP calls.
properties:
sequence_number:
title: Sequence Number
type: integer
type:
const: response.mcp_call.completed
default: response.mcp_call.completed
title: Type
type: string
required:
- sequence_number
title: OpenAIResponseObjectStreamResponseMcpCallCompleted
type: object
OpenAIResponseObjectStreamResponseMcpCallFailed:
description: Streaming event for failed MCP calls.
properties:
sequence_number:
title: Sequence Number
type: integer
type:
const: response.mcp_call.failed
default: response.mcp_call.failed
title: Type
type: string
required:
- sequence_number
title: OpenAIResponseObjectStreamResponseMcpCallFailed
type: object
OpenAIResponseObjectStreamResponseMcpCallInProgress:
description: Streaming event for MCP calls in progress.
properties:
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.mcp_call.in_progress
default: response.mcp_call.in_progress
title: Type
type: string
required:
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseMcpCallInProgress
type: object
OpenAIResponseObjectStreamResponseMcpListToolsCompleted:
properties:
sequence_number:
title: Sequence Number
type: integer
type:
const: response.mcp_list_tools.completed
default: response.mcp_list_tools.completed
title: Type
type: string
required:
- sequence_number
title: OpenAIResponseObjectStreamResponseMcpListToolsCompleted
type: object
OpenAIResponseObjectStreamResponseMcpListToolsFailed:
properties:
sequence_number:
title: Sequence Number
type: integer
type:
const: response.mcp_list_tools.failed
default: response.mcp_list_tools.failed
title: Type
type: string
required:
- sequence_number
title: OpenAIResponseObjectStreamResponseMcpListToolsFailed
type: object
OpenAIResponseObjectStreamResponseMcpListToolsInProgress:
properties:
sequence_number:
title: Sequence Number
type: integer
type:
const: response.mcp_list_tools.in_progress
default: response.mcp_list_tools.in_progress
title: Type
type: string
required:
- sequence_number
title: OpenAIResponseObjectStreamResponseMcpListToolsInProgress
type: object
OpenAIResponseObjectStreamResponseOutputItemAdded:
description: Streaming event for when a new output item is added to the response.
properties:
response_id:
title: Response Id
type: string
item:
discriminator:
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
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'
title: Item
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.output_item.added
default: response.output_item.added
title: Type
type: string
required:
- response_id
- item
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseOutputItemAdded
type: object
OpenAIResponseObjectStreamResponseOutputItemDone:
description: Streaming event for when an output item is completed.
properties:
response_id:
title: Response Id
type: string
item:
discriminator:
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
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'
title: Item
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.output_item.done
default: response.output_item.done
title: Type
type: string
required:
- response_id
- item
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseOutputItemDone
type: object
OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded:
description: Streaming event for when an annotation is added to output text.
properties:
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
content_index:
title: Content Index
type: integer
annotation_index:
title: Annotation Index
type: integer
annotation:
discriminator:
mapping:
container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath'
url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation'
- $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath'
title: Annotation
sequence_number:
title: Sequence Number
type: integer
type:
const: response.output_text.annotation.added
default: response.output_text.annotation.added
title: Type
type: string
required:
- item_id
- output_index
- content_index
- annotation_index
- annotation
- sequence_number
title: OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded
type: object
OpenAIResponseObjectStreamResponseOutputTextDelta:
description: Streaming event for incremental text content updates.
properties:
content_index:
title: Content Index
type: integer
delta:
title: Delta
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.output_text.delta
default: response.output_text.delta
title: Type
type: string
required:
- content_index
- delta
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseOutputTextDelta
type: object
OpenAIResponseObjectStreamResponseOutputTextDone:
description: Streaming event for when text output is completed.
properties:
content_index:
title: Content Index
type: integer
text:
title: Text
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.output_text.done
default: response.output_text.done
title: Type
type: string
required:
- content_index
- text
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseOutputTextDone
type: object
OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded:
description: Streaming event for when a new reasoning summary part is added.
properties:
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
part:
$ref: '#/components/schemas/OpenAIResponseContentPartReasoningSummary'
sequence_number:
title: Sequence Number
type: integer
summary_index:
title: Summary Index
type: integer
type:
const: response.reasoning_summary_part.added
default: response.reasoning_summary_part.added
title: Type
type: string
required:
- item_id
- output_index
- part
- sequence_number
- summary_index
title: OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded
type: object
OpenAIResponseObjectStreamResponseReasoningSummaryPartDone:
description: Streaming event for when a reasoning summary part is completed.
properties:
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
part:
$ref: '#/components/schemas/OpenAIResponseContentPartReasoningSummary'
sequence_number:
title: Sequence Number
type: integer
summary_index:
title: Summary Index
type: integer
type:
const: response.reasoning_summary_part.done
default: response.reasoning_summary_part.done
title: Type
type: string
required:
- item_id
- output_index
- part
- sequence_number
- summary_index
title: OpenAIResponseObjectStreamResponseReasoningSummaryPartDone
type: object
OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta:
description: Streaming event for incremental reasoning summary text updates.
properties:
delta:
title: Delta
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
summary_index:
title: Summary Index
type: integer
type:
const: response.reasoning_summary_text.delta
default: response.reasoning_summary_text.delta
title: Type
type: string
required:
- delta
- item_id
- output_index
- sequence_number
- summary_index
title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta
type: object
OpenAIResponseObjectStreamResponseReasoningSummaryTextDone:
description: Streaming event for when reasoning summary text is completed.
properties:
text:
title: Text
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
summary_index:
title: Summary Index
type: integer
type:
const: response.reasoning_summary_text.done
default: response.reasoning_summary_text.done
title: Type
type: string
required:
- text
- item_id
- output_index
- sequence_number
- summary_index
title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDone
type: object
OpenAIResponseObjectStreamResponseReasoningTextDelta:
description: Streaming event for incremental reasoning text updates.
properties:
content_index:
title: Content Index
type: integer
delta:
title: Delta
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.reasoning_text.delta
default: response.reasoning_text.delta
title: Type
type: string
required:
- content_index
- delta
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseReasoningTextDelta
type: object
OpenAIResponseObjectStreamResponseReasoningTextDone:
description: Streaming event for when reasoning text is completed.
properties:
content_index:
title: Content Index
type: integer
text:
title: Text
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.reasoning_text.done
default: response.reasoning_text.done
title: Type
type: string
required:
- content_index
- text
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseReasoningTextDone
type: object
OpenAIResponseObjectStreamResponseRefusalDelta:
description: Streaming event for incremental refusal text updates.
properties:
content_index:
title: Content Index
type: integer
delta:
title: Delta
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.refusal.delta
default: response.refusal.delta
title: Type
type: string
required:
- content_index
- delta
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseRefusalDelta
type: object
OpenAIResponseObjectStreamResponseRefusalDone:
description: Streaming event for when refusal text is completed.
properties:
content_index:
title: Content Index
type: integer
refusal:
title: Refusal
type: string
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.refusal.done
default: response.refusal.done
title: Type
type: string
required:
- content_index
- refusal
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseRefusalDone
type: object
OpenAIResponseObjectStreamResponseWebSearchCallCompleted:
description: Streaming event for completed web search calls.
properties:
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.web_search_call.completed
default: response.web_search_call.completed
title: Type
type: string
required:
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseWebSearchCallCompleted
type: object
OpenAIResponseObjectStreamResponseWebSearchCallInProgress:
description: Streaming event for web search calls in progress.
properties:
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.web_search_call.in_progress
default: response.web_search_call.in_progress
title: Type
type: string
required:
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseWebSearchCallInProgress
type: object
OpenAIResponseObjectStreamResponseWebSearchCallSearching:
properties:
item_id:
title: Item Id
type: string
output_index:
title: Output Index
type: integer
sequence_number:
title: Sequence Number
type: integer
type:
const: response.web_search_call.searching
default: response.web_search_call.searching
title: Type
type: string
required:
- item_id
- output_index
- sequence_number
title: OpenAIResponseObjectStreamResponseWebSearchCallSearching
type: object
OpenAIResponseObjectStream:
discriminator:
mapping:
response.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
response.content_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded'
response.content_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone'
response.created: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
response.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
response.file_search_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted'
response.file_search_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress'
response.file_search_call.searching: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching'
response.function_call_arguments.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta'
response.function_call_arguments.done: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone'
response.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
response.incomplete: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
response.mcp_call.arguments.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta'
response.mcp_call.arguments.done: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone'
response.mcp_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted'
response.mcp_call.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed'
response.mcp_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress'
response.mcp_list_tools.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted'
response.mcp_list_tools.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed'
response.mcp_list_tools.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress'
response.output_item.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded'
response.output_item.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone'
response.output_text.annotation.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded'
response.output_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta'
response.output_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone'
response.reasoning_summary_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded'
response.reasoning_summary_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone'
response.reasoning_summary_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta'
response.reasoning_summary_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone'
response.reasoning_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta'
response.reasoning_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone'
response.refusal.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta'
response.refusal.done: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone'
response.web_search_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted'
response.web_search_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress'
response.web_search_call.searching: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
- $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/OpenAIResponseObjectStreamResponseReasoningTextDelta'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
OpenAIResponseInput:
anyOf:
- discriminator:
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
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'
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
- $ref: '#/components/schemas/OpenAIResponseMessage'
ConversationItem:
discriminator:
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
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'
OpenAIResponseContentPartRefusal:
type: object
properties:
type:
type: string
const: refusal
default: refusal
description: >-
Content part type identifier, always "refusal"
refusal:
type: string
description: Refusal text supplied by the model
additionalProperties: false
required:
- type
- refusal
title: OpenAIResponseContentPartRefusal
description: >-
Refusal content within a streamed response part.
"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'
- $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile'
discriminator:
propertyName: type
mapping:
input_text: '#/components/schemas/OpenAIResponseInputMessageContentText'
input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage'
input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile'
OpenAIResponseInputMessageContentFile:
type: object
properties:
type:
type: string
const: input_file
default: input_file
description: >-
The type of the input item. Always `input_file`.
file_data:
type: string
description: >-
The data of the file to be sent to the model.
file_id:
type: string
description: >-
(Optional) The ID of the file to be sent to the model.
file_url:
type: string
description: >-
The URL of the file to be sent to the model.
filename:
type: string
description: >-
The name of the file to be sent to the model.
additionalProperties: false
required:
- type
title: OpenAIResponseInputMessageContentFile
description: >-
File content for input messages in OpenAI response format.
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"
file_id:
type: string
description: >-
(Optional) The ID of the file to be sent to the model.
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.
OpenAIResponseOutputMessageContent:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
discriminator:
propertyName: type
mapping:
output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
"OpenAIResponseOutputMessageContentOutputText":
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.
CreateConversationRequest:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ConversationItem'
description: >-
Initial items to include in the conversation context.
metadata:
type: object
additionalProperties:
type: string
description: >-
Set of key-value pairs that can be attached to an object.
additionalProperties: false
title: CreateConversationRequest
Conversation:
type: object
properties:
id:
type: string
object:
type: string
const: conversation
default: conversation
created_at:
type: integer
metadata:
type: object
additionalProperties:
type: string
items:
type: array
items:
type: object
title: dict
description: >-
dict() -> new empty dictionary dict(mapping) -> new dictionary initialized
from a mapping object's (key, value) pairs dict(iterable) -> new
dictionary initialized as if via: d = {} for k, v in iterable: d[k]
= v dict(**kwargs) -> new dictionary initialized with the name=value
pairs in the keyword argument list. For example: dict(one=1, two=2)
additionalProperties: false
required:
- id
- object
- created_at
title: Conversation
description: OpenAI-compatible conversation object.
UpdateConversationRequest:
type: object
properties:
metadata:
type: object
additionalProperties:
type: string
description: >-
Set of key-value pairs that can be attached to an object.
additionalProperties: false
required:
- metadata
title: UpdateConversationRequest
ConversationDeletedResource:
type: object
properties:
id:
type: string
object:
type: string
default: conversation.deleted
deleted:
type: boolean
default: true
additionalProperties: false
required:
- id
- object
- deleted
title: ConversationDeletedResource
description: Response for deleted conversation.
ConversationItemList:
type: object
properties:
object:
type: string
default: list
data:
type: array
items:
$ref: '#/components/schemas/ConversationItem'
first_id:
type: string
last_id:
type: string
has_more:
type: boolean
default: false
additionalProperties: false
required:
- object
- data
- has_more
title: ConversationItemList
description: >-
List of conversation items with pagination.
AddItemsRequest:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ConversationItem'
description: >-
Items to include in the conversation context.
additionalProperties: false
required:
- items
title: AddItemsRequest
ConversationItemDeletedResource:
type: object
properties:
id:
type: string
object:
type: string
default: conversation.item.deleted
deleted:
type: boolean
default: true
additionalProperties: false
required:
- id
- object
- deleted
title: ConversationItemDeletedResource
description: Response for deleted conversation item.
OpenAIEmbeddingsRequestWithExtraBody:
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
default: float
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: OpenAIEmbeddingsRequestWithExtraBody
description: >-
Request parameters for OpenAI-compatible embeddings endpoint.
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
HealthInfo:
type: object
properties:
status:
type: string
enum:
- OK
- Error
- Not Implemented
description: Current health status of the service
additionalProperties: false
required:
- status
title: HealthInfo
description: >-
Health status information for the service.
RouteInfo:
type: object
properties:
route:
type: string
description: The API endpoint path
method:
type: string
description: HTTP method for the route
provider_types:
type: array
items:
type: string
description: >-
List of provider types that implement this route
additionalProperties: false
required:
- route
- method
- provider_types
title: RouteInfo
description: >-
Information about an API route including its path, method, and implementing
providers.
ListRoutesResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RouteInfo'
description: >-
List of available route information objects
additionalProperties: false
required:
- data
title: ListRoutesResponse
description: >-
Response containing a list of all available API routes.
OpenAIModel:
type: object
properties:
id:
type: string
object:
type: string
const: model
default: model
created:
type: integer
owned_by:
type: string
custom_metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
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
Model:
type: object
properties:
identifier:
type: string
description: >-
Unique identifier for this resource in llama stack
provider_resource_id:
type: string
description: >-
Unique identifier for this resource in the provider
provider_id:
type: string
description: >-
ID of the provider that owns this resource
type:
type: string
enum:
- model
- shield
- vector_store
- dataset
- scoring_function
- benchmark
- tool
- tool_group
- prompt
const: model
default: model
description: >-
The resource type, always 'model' for model resources
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: Any additional metadata for this model
model_type:
$ref: '#/components/schemas/ModelType'
default: llm
description: >-
The type of model (LLM or embedding model)
additionalProperties: false
required:
- identifier
- provider_id
- type
- metadata
- model_type
title: Model
description: >-
A model resource representing an AI model registered in Llama Stack.
ModelType:
type: string
enum:
- llm
- embedding
- rerank
title: ModelType
description: >-
Enumeration of supported model types in Llama Stack.
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: >-
(Optional) The content moderation model you would like to use.
additionalProperties: false
required:
- input
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.
Prompt:
type: object
properties:
prompt:
type: string
description: >-
The system prompt text with variable placeholders. Variables are only
supported when using the Responses API.
version:
type: integer
description: >-
Version (integer starting at 1, incremented on save)
prompt_id:
type: string
description: >-
Unique identifier formatted as 'pmpt_<48-digit-hash>'
variables:
type: array
items:
type: string
description: >-
List of prompt variable names that can be used in the prompt template
is_default:
type: boolean
default: false
description: >-
Boolean indicating whether this version is the default version for this
prompt
additionalProperties: false
required:
- version
- prompt_id
- variables
- is_default
title: Prompt
description: >-
A prompt resource representing a stored OpenAI Compatible prompt template
in Llama Stack.
ListPromptsResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Prompt'
additionalProperties: false
required:
- data
title: ListPromptsResponse
description: Response model to list prompts.
CreatePromptRequest:
type: object
properties:
prompt:
type: string
description: >-
The prompt text content with variable placeholders.
variables:
type: array
items:
type: string
description: >-
List of variable names that can be used in the prompt template.
additionalProperties: false
required:
- prompt
title: CreatePromptRequest
UpdatePromptRequest:
type: object
properties:
prompt:
type: string
description: The updated prompt text content.
version:
type: integer
description: >-
The current version of the prompt being updated.
variables:
type: array
items:
type: string
description: >-
Updated list of variable names that can be used in the prompt template.
set_as_default:
type: boolean
description: >-
Set the new version as the default (default=True).
additionalProperties: false
required:
- prompt
- version
- set_as_default
title: UpdatePromptRequest
SetDefaultVersionRequest:
type: object
properties:
version:
type: integer
description: The version to set as default.
additionalProperties: false
required:
- version
title: SetDefaultVersionRequest
ProviderInfo:
type: object
properties:
api:
type: string
description: The API name this provider implements
provider_id:
type: string
description: Unique identifier for the provider
provider_type:
type: string
description: The type of provider implementation
config:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
Configuration parameters for the provider
health:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: Current health status of the provider
additionalProperties: false
required:
- api
- provider_id
- provider_type
- config
- health
title: ProviderInfo
description: >-
Information about a registered provider including its configuration and health
status.
ListProvidersResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ProviderInfo'
description: List of provider information objects
additionalProperties: false
required:
- data
title: ListProvidersResponse
description: >-
Response containing a list of all available providers.
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.
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/OpenAIResponseOutput'
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
- $ref: '#/components/schemas/OpenAIResponseMessage'
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.
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
- type: string
const: web_search_2025_08_26
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.
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
prompt:
$ref: '#/components/schemas/OpenAIResponsePrompt'
description: >-
(Optional) Reference to a prompt template and its variables.
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
tools:
type: array
items:
$ref: '#/components/schemas/OpenAIResponseTool'
description: >-
(Optional) An array of tools the model may call while generating a response.
truncation:
type: string
description: >-
(Optional) Truncation strategy applied to the response
usage:
$ref: '#/components/schemas/OpenAIResponseUsage'
description: >-
(Optional) Token usage information for the response
instructions:
type: string
description: >-
(Optional) System message inserted into the model's context
max_tool_calls:
type: integer
description: >-
(Optional) Max number of total calls to built-in tools that can be processed
in a 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'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage'
- $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/OpenAIResponseOutputMessageMCPCall'
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
DataSource:
discriminator:
mapping:
web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch'
file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch'
function: '#/components/schemas/OpenAIResponseInputToolFunction'
mcp: '#/components/schemas/OpenAIResponseInputToolMCP'
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.
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.
prompt:
$ref: '#/components/schemas/OpenAIResponsePrompt'
description: >-
(Optional) Prompt object with ID, version, and variables.
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.
conversation:
type: string
description: >-
(Optional) The ID of a conversation to add the response to. Must begin
with 'conv_'. Input and output messages will be automatically added to
the conversation.
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
max_tool_calls:
type: integer
description: >-
(Optional) Max number of total calls to built-in tools that can be processed
in a response.
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
prompt:
$ref: '#/components/schemas/OpenAIResponsePrompt'
description: >-
(Optional) Reference to a prompt template and its variables.
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
tools:
type: array
items:
$ref: '#/components/schemas/OpenAIResponseTool'
description: >-
(Optional) An array of tools the model may call while generating a response.
truncation:
type: string
description: >-
(Optional) Truncation strategy applied to the response
usage:
$ref: '#/components/schemas/OpenAIResponseUsage'
description: >-
(Optional) Token usage information for the response
instructions:
type: string
description: >-
(Optional) System message inserted into the model's context
max_tool_calls:
type: integer
description: >-
(Optional) Max number of total calls to built-in tools that can be processed
in a 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
description: >-
Content part type identifier, always "output_text"
text:
type: string
description: Text emitted for this content part
annotations:
type: array
items:
$ref: '#/components/schemas/OpenAIResponseAnnotations'
description: >-
Structured annotations associated with the text
logprobs:
type: array
items:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: (Optional) Token log probability details
additionalProperties: false
required:
- type
- text
- annotations
title: OpenAIResponseContentPartOutputText
description: >-
Text content within a streamed response part.
"OpenAIResponseContentPartReasoningSummary":
type: object
properties:
type:
type: string
const: summary_text
default: summary_text
description: >-
Content part type identifier, always "summary_text"
text:
type: string
description: Summary text
additionalProperties: false
required:
- type
- text
title: >-
OpenAIResponseContentPartReasoningSummary
description: >-
Reasoning summary part in a streamed response.
OpenAIResponseContentPartReasoningText:
type: object
properties:
type:
type: string
const: reasoning_text
default: reasoning_text
description: >-
Content part type identifier, always "reasoning_text"
text:
type: string
description: Reasoning text supplied by the model
additionalProperties: false
required:
- type
- text
title: OpenAIResponseContentPartReasoningText
description: >-
Reasoning text emitted as part of a streamed response.
OpenAIResponseObjectStream:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
- $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/OpenAIResponseObjectStreamResponseReasoningTextDelta'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
- $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
discriminator:
propertyName: type
mapping:
response.created: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated'
response.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress'
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.reasoning_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta'
response.reasoning_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone'
response.reasoning_summary_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded'
response.reasoning_summary_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone'
response.reasoning_summary_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta'
response.reasoning_summary_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone'
response.refusal.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta'
response.refusal.done: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone'
response.output_text.annotation.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded'
response.file_search_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress'
response.file_search_call.searching: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching'
response.file_search_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted'
response.incomplete: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete'
response.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed'
response.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted'
"OpenAIResponseObjectStreamResponseCompleted":
type: object
properties:
response:
$ref: '#/components/schemas/OpenAIResponseObject'
description: 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:
content_index:
type: integer
description: >-
Index position of the part within the content array
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
output_index:
type: integer
description: >-
Index position of the output item in the response
part:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
discriminator:
propertyName: type
mapping:
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
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:
- content_index
- response_id
- item_id
- output_index
- 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:
content_index:
type: integer
description: >-
Index position of the part within the content array
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
output_index:
type: integer
description: >-
Index position of the output item in the response
part:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseContentPartOutputText'
- $ref: '#/components/schemas/OpenAIResponseContentPartRefusal'
- $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText'
discriminator:
propertyName: type
mapping:
output_text: '#/components/schemas/OpenAIResponseContentPartOutputText'
refusal: '#/components/schemas/OpenAIResponseContentPartRefusal'
reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText'
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:
- content_index
- response_id
- item_id
- output_index
- 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 response object that was created
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.
OpenAIResponseObjectStreamResponseFailed:
type: object
properties:
response:
$ref: '#/components/schemas/OpenAIResponseObject'
description: Response object describing the failure
sequence_number:
type: integer
description: >-
Sequential number for ordering streaming events
type:
type: string
const: response.failed
default: response.failed
description: >-
Event type identifier, always "response.failed"
additionalProperties: false
required:
- response
- sequence_number
- type
title: OpenAIResponseObjectStreamResponseFailed
description: >-
Streaming event emitted when a response fails.
"OpenAIResponseObjectStreamResponseFileSearchCallCompleted":
type: object
properties:
item_id:
type: string
description: >-
Unique identifier of the completed file 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.file_search_call.completed
default: response.file_search_call.completed
description: >-
Event type identifier, always "response.file_search_call.completed"
additionalProperties: false
required:
- item_id
- output_index
- sequence_number
- type
title: >-
OpenAIResponseObjectStreamResponseFileSearchCallCompleted
description: >-
Streaming event for completed file search calls.
"OpenAIResponseObjectStreamResponseFileSearchCallInProgress":
type: object
properties:
item_id:
type: string
description: >-
Unique identifier of the file 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.file_search_call.in_progress
default: response.file_search_call.in_progress
description: >-
Event type identifier, always "response.file_search_call.in_progress"
additionalProperties: false
required:
- item_id
- output_index
- sequence_number
- type
title: >-
OpenAIResponseObjectStreamResponseFileSearchCallInProgress
description: >-
Streaming event for file search calls in progress.
"OpenAIResponseObjectStreamResponseFileSearchCallSearching":
type: object
properties:
item_id:
type: string
description: >-
Unique identifier of the file 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.file_search_call.searching
default: response.file_search_call.searching
description: >-
Event type identifier, always "response.file_search_call.searching"
additionalProperties: false
required:
- item_id
- output_index
- sequence_number
- type
title: >-
OpenAIResponseObjectStreamResponseFileSearchCallSearching
description: >-
Streaming event for file search currently searching.
"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.
"OpenAIResponseObjectStreamResponseInProgress":
type: object
properties:
response:
$ref: '#/components/schemas/OpenAIResponseObject'
description: Current response state while in progress
sequence_number:
type: integer
description: >-
Sequential number for ordering streaming events
type:
type: string
const: response.in_progress
default: response.in_progress
description: >-
Event type identifier, always "response.in_progress"
additionalProperties: false
required:
- response
- sequence_number
- type
title: >-
OpenAIResponseObjectStreamResponseInProgress
description: >-
Streaming event indicating the response remains in progress.
"OpenAIResponseObjectStreamResponseIncomplete":
type: object
properties:
response:
$ref: '#/components/schemas/OpenAIResponseObject'
description: >-
Response object describing the incomplete state
sequence_number:
type: integer
description: >-
Sequential number for ordering streaming events
type:
type: string
const: response.incomplete
default: response.incomplete
description: >-
Event type identifier, always "response.incomplete"
additionalProperties: false
required:
- response
- sequence_number
- type
title: >-
OpenAIResponseObjectStreamResponseIncomplete
description: >-
Streaming event emitted when a response ends in an incomplete state.
"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.
"OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded":
type: object
properties:
item_id:
type: string
description: >-
Unique identifier of the item to which the annotation is being added
output_index:
type: integer
description: >-
Index position of the output item in the response's output array
content_index:
type: integer
description: >-
Index position of the content part within the output item
annotation_index:
type: integer
description: >-
Index of the annotation within the content part
annotation:
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'
description: The annotation object being added
sequence_number:
type: integer
description: >-
Sequential number for ordering streaming events
type:
type: string
const: response.output_text.annotation.added
default: response.output_text.annotation.added
description: >-
Event type identifier, always "response.output_text.annotation.added"
additionalProperties: false
required:
- item_id
- output_index
- content_index
- annotation_index
- annotation
- sequence_number
- type
title: >-
OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded
description: >-
Streaming event for when an annotation is added to output text.
"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.
"OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded":
type: object
properties:
item_id:
type: string
description: Unique identifier of the output item
output_index:
type: integer
description: Index position of the output item
part:
$ref: '#/components/schemas/OpenAIResponseContentPartReasoningSummary'
description: The summary part that was added
sequence_number:
type: integer
description: >-
Sequential number for ordering streaming events
summary_index:
type: integer
description: >-
Index of the summary part within the reasoning summary
type:
type: string
const: response.reasoning_summary_part.added
default: response.reasoning_summary_part.added
description: >-
Event type identifier, always "response.reasoning_summary_part.added"
additionalProperties: false
required:
- item_id
- output_index
- part
- sequence_number
- summary_index
- type
title: >-
OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded
description: >-
Streaming event for when a new reasoning summary part is added.
"OpenAIResponseObjectStreamResponseReasoningSummaryPartDone":
type: object
properties:
item_id:
type: string
description: Unique identifier of the output item
output_index:
type: integer
description: Index position of the output item
part:
$ref: '#/components/schemas/OpenAIResponseContentPartReasoningSummary'
description: The completed summary part
sequence_number:
type: integer
description: >-
Sequential number for ordering streaming events
summary_index:
type: integer
description: >-
Index of the summary part within the reasoning summary
type:
type: string
const: response.reasoning_summary_part.done
default: response.reasoning_summary_part.done
description: >-
Event type identifier, always "response.reasoning_summary_part.done"
additionalProperties: false
required:
- item_id
- output_index
- part
- sequence_number
- summary_index
- type
title: >-
OpenAIResponseObjectStreamResponseReasoningSummaryPartDone
description: >-
Streaming event for when a reasoning summary part is completed.
"OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta":
type: object
properties:
delta:
type: string
description: Incremental summary text being added
item_id:
type: string
description: Unique identifier of the output item
output_index:
type: integer
description: Index position of the output item
sequence_number:
type: integer
description: >-
Sequential number for ordering streaming events
summary_index:
type: integer
description: >-
Index of the summary part within the reasoning summary
type:
type: string
const: response.reasoning_summary_text.delta
default: response.reasoning_summary_text.delta
description: >-
Event type identifier, always "response.reasoning_summary_text.delta"
additionalProperties: false
required:
- delta
- item_id
- output_index
- sequence_number
- summary_index
- type
title: >-
OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta
description: >-
Streaming event for incremental reasoning summary text updates.
"OpenAIResponseObjectStreamResponseReasoningSummaryTextDone":
type: object
properties:
text:
type: string
description: Final complete summary text
item_id:
type: string
description: Unique identifier of the output item
output_index:
type: integer
description: Index position of the output item
sequence_number:
type: integer
description: >-
Sequential number for ordering streaming events
summary_index:
type: integer
description: >-
Index of the summary part within the reasoning summary
type:
type: string
const: response.reasoning_summary_text.done
default: response.reasoning_summary_text.done
description: >-
Event type identifier, always "response.reasoning_summary_text.done"
additionalProperties: false
required:
- text
- item_id
- output_index
- sequence_number
- summary_index
- type
title: >-
OpenAIResponseObjectStreamResponseReasoningSummaryTextDone
description: >-
Streaming event for when reasoning summary text is completed.
"OpenAIResponseObjectStreamResponseReasoningTextDelta":
type: object
properties:
content_index:
type: integer
description: >-
Index position of the reasoning content part
delta:
type: string
description: Incremental reasoning text 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.reasoning_text.delta
default: response.reasoning_text.delta
description: >-
Event type identifier, always "response.reasoning_text.delta"
additionalProperties: false
required:
- content_index
- delta
- item_id
- output_index
- sequence_number
- type
title: >-
OpenAIResponseObjectStreamResponseReasoningTextDelta
description: >-
Streaming event for incremental reasoning text updates.
"OpenAIResponseObjectStreamResponseReasoningTextDone":
type: object
properties:
content_index:
type: integer
description: >-
Index position of the reasoning content part
text:
type: string
description: Final complete reasoning text
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.reasoning_text.done
default: response.reasoning_text.done
description: >-
Event type identifier, always "response.reasoning_text.done"
additionalProperties: false
required:
- content_index
- text
- item_id
- output_index
- sequence_number
- type
title: >-
OpenAIResponseObjectStreamResponseReasoningTextDone
description: >-
Streaming event for when reasoning text is completed.
"OpenAIResponseObjectStreamResponseRefusalDelta":
type: object
properties:
content_index:
type: integer
description: Index position of the content part
delta:
type: string
description: Incremental refusal text being added
item_id:
type: string
description: Unique identifier of the 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.refusal.delta
default: response.refusal.delta
description: >-
Event type identifier, always "response.refusal.delta"
additionalProperties: false
required:
- content_index
- delta
- item_id
- output_index
- sequence_number
- type
title: >-
OpenAIResponseObjectStreamResponseRefusalDelta
description: >-
Streaming event for incremental refusal text updates.
"OpenAIResponseObjectStreamResponseRefusalDone":
type: object
properties:
content_index:
type: integer
description: Index position of the content part
refusal:
type: string
description: Final complete refusal text
item_id:
type: string
description: Unique identifier of the 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.refusal.done
default: response.refusal.done
description: >-
Event type identifier, always "response.refusal.done"
additionalProperties: false
required:
- content_index
- refusal
- item_id
- output_index
- sequence_number
- type
title: >-
OpenAIResponseObjectStreamResponseRefusalDone
description: >-
Streaming event for when refusal text 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
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.
RunShieldRequest:
type: object
properties:
shield_id:
type: string
description: The identifier of the shield to run.
messages:
type: array
items:
$ref: '#/components/schemas/OpenAIMessageParam'
description: The messages to run the shield on.
params:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: The parameters of the shield.
additionalProperties: false
required:
- shield_id
- messages
- params
title: RunShieldRequest
RunShieldResponse:
type: object
properties:
violation:
$ref: '#/components/schemas/SafetyViolation'
description: >-
(Optional) Safety violation detected by the shield, if any
additionalProperties: false
title: RunShieldResponse
description: Response from running a safety shield.
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.
ViolationLevel:
type: string
enum:
- info
- warn
- error
title: ViolationLevel
description: Severity level of a safety violation.
AggregationFunctionType:
type: string
enum:
- average
- weighted_average
- median
- categorical_count
- accuracy
title: AggregationFunctionType
description: >-
Types of aggregation functions for scoring results.
ArrayType:
type: object
properties:
type:
type: string
const: array
default: array
description: Discriminator type. Always "array"
additionalProperties: false
required:
- type
title: ArrayType
description: Parameter type for array values.
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.
BooleanType:
type: object
properties:
type:
type: string
const: boolean
default: boolean
description: Discriminator type. Always "boolean"
additionalProperties: false
required:
- type
title: BooleanType
description: Parameter type for boolean values.
ChatCompletionInputType:
type: object
properties:
type:
type: string
const: chat_completion_input
default: chat_completion_input
description: >-
Discriminator type. Always "chat_completion_input"
additionalProperties: false
required:
- type
title: ChatCompletionInputType
description: >-
Parameter type for chat completion input.
CompletionInputType:
type: object
properties:
type:
type: string
const: completion_input
default: completion_input
description: >-
Discriminator type. Always "completion_input"
additionalProperties: false
required:
- type
title: CompletionInputType
description: Parameter type for completion input.
JsonType:
type: object
properties:
type:
type: string
const: json
default: json
description: Discriminator type. Always "json"
additionalProperties: false
required:
- type
title: JsonType
description: Parameter type for JSON values.
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.
NumberType:
type: object
properties:
type:
type: string
const: number
default: number
description: Discriminator type. Always "number"
additionalProperties: false
required:
- type
title: NumberType
description: Parameter type for numeric values.
ObjectType:
type: object
properties:
type:
type: string
const: object
default: object
description: Discriminator type. Always "object"
additionalProperties: false
required:
- type
title: ObjectType
description: Parameter type for object values.
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.
ScoringFn:
type: object
properties:
identifier:
type: string
provider_resource_id:
type: string
provider_id:
type: string
type:
type: string
enum:
- model
- shield
- vector_store
- dataset
- scoring_function
- benchmark
- tool
- tool_group
- prompt
const: scoring_function
default: scoring_function
description: >-
The resource type, always scoring_function
description:
type: string
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
return_type:
oneOf:
- $ref: '#/components/schemas/StringType'
- $ref: '#/components/schemas/NumberType'
- $ref: '#/components/schemas/BooleanType'
- $ref: '#/components/schemas/ArrayType'
- $ref: '#/components/schemas/ObjectType'
- $ref: '#/components/schemas/JsonType'
- $ref: '#/components/schemas/UnionType'
- $ref: '#/components/schemas/ChatCompletionInputType'
- $ref: '#/components/schemas/CompletionInputType'
discriminator:
propertyName: type
mapping:
string: '#/components/schemas/StringType'
number: '#/components/schemas/NumberType'
boolean: '#/components/schemas/BooleanType'
array: '#/components/schemas/ArrayType'
object: '#/components/schemas/ObjectType'
json: '#/components/schemas/JsonType'
union: '#/components/schemas/UnionType'
chat_completion_input: '#/components/schemas/ChatCompletionInputType'
completion_input: '#/components/schemas/CompletionInputType'
params:
$ref: '#/components/schemas/ScoringFnParams'
additionalProperties: false
required:
- identifier
- provider_id
- type
- metadata
- return_type
title: ScoringFn
description: >-
A scoring function resource for evaluating model outputs.
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.
StringType:
type: object
properties:
type:
type: string
const: string
default: string
description: Discriminator type. Always "string"
additionalProperties: false
required:
- type
title: StringType
description: Parameter type for string values.
UnionType:
type: object
properties:
type:
type: string
const: union
default: union
description: Discriminator type. Always "union"
additionalProperties: false
required:
- type
title: UnionType
description: Parameter type for union values.
ListScoringFunctionsResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ScoringFn'
additionalProperties: false
required:
- data
title: ListScoringFunctionsResponse
ScoreRequest:
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 score.
scoring_functions:
type: object
additionalProperties:
oneOf:
- $ref: '#/components/schemas/ScoringFnParams'
- type: 'null'
description: >-
The scoring functions to use for the scoring.
additionalProperties: false
required:
- input_rows
- scoring_functions
title: ScoreRequest
ScoreResponse:
type: object
properties:
results:
type: object
additionalProperties:
$ref: '#/components/schemas/ScoringResult'
description: >-
A map of scoring function name to ScoringResult.
additionalProperties: false
required:
- results
title: ScoreResponse
description: The response from scoring.
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.
ScoreBatchRequest:
type: object
properties:
dataset_id:
type: string
description: The ID of the dataset to score.
scoring_functions:
type: object
additionalProperties:
oneOf:
- $ref: '#/components/schemas/ScoringFnParams'
- type: 'null'
description: >-
The scoring functions to use for the scoring.
save_results_dataset:
type: boolean
description: >-
Whether to save the results to a dataset.
additionalProperties: false
required:
- dataset_id
- scoring_functions
- save_results_dataset
title: ScoreBatchRequest
ScoreBatchResponse:
type: object
properties:
dataset_id:
type: string
description: >-
(Optional) The identifier of the dataset that was scored
results:
type: object
additionalProperties:
$ref: '#/components/schemas/ScoringResult'
description: >-
A map of scoring function name to ScoringResult
additionalProperties: false
required:
- results
title: ScoreBatchResponse
description: >-
Response from batch scoring operations on datasets.
Shield:
type: object
properties:
identifier:
type: string
provider_resource_id:
type: string
provider_id:
type: string
type:
type: string
enum:
- model
- shield
- vector_store
- dataset
- scoring_function
- benchmark
- tool
- tool_group
- prompt
const: shield
default: shield
description: The resource type, always shield
params:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Configuration parameters for the shield
additionalProperties: false
required:
- identifier
- provider_id
- type
title: Shield
description: >-
A safety shield resource that can be used to check content.
ListShieldsResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Shield'
additionalProperties: false
required:
- data
title: ListShieldsResponse
InvokeToolRequest:
type: object
properties:
tool_name:
type: string
description: The name of the tool to invoke.
kwargs:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
A dictionary of arguments to pass to the tool.
additionalProperties: false
required:
- tool_name
- kwargs
title: InvokeToolRequest
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
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'
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
ToolInvocationResult:
type: object
properties:
content:
$ref: '#/components/schemas/InterleavedContent'
description: >-
(Optional) The output content from the tool execution
error_message:
type: string
description: >-
(Optional) Error message if the tool execution failed
error_code:
type: integer
description: >-
(Optional) Numeric error code if the tool execution failed
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Additional metadata about the tool execution
additionalProperties: false
title: ToolInvocationResult
description: Result of a tool invocation.
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.
ToolDef:
type: object
properties:
toolgroup_id:
type: string
description: >-
(Optional) ID of the tool group this tool belongs to
name:
type: string
description: Name of the tool
description:
type: string
description: >-
(Optional) Human-readable description of what the tool does
input_schema:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) JSON Schema for tool inputs (MCP inputSchema)
output_schema:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) JSON Schema for tool outputs (MCP outputSchema)
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.
ListToolDefsResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ToolDef'
description: List of tool definitions
additionalProperties: false
required:
- data
title: ListToolDefsResponse
description: >-
Response containing a list of tool definitions.
ToolGroup:
type: object
properties:
identifier:
type: string
provider_resource_id:
type: string
provider_id:
type: string
type:
type: string
enum:
- model
- shield
- vector_store
- dataset
- scoring_function
- benchmark
- tool
- tool_group
- prompt
const: tool_group
default: tool_group
description: Type of resource, always 'tool_group'
mcp_endpoint:
$ref: '#/components/schemas/URL'
description: >-
(Optional) Model Context Protocol endpoint for remote tools
args:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
(Optional) Additional arguments for the tool group
additionalProperties: false
required:
- identifier
- provider_id
- type
title: ToolGroup
description: >-
A group of related tools managed together.
ListToolGroupsResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ToolGroup'
description: List of tool groups
additionalProperties: false
required:
- data
title: ListToolGroupsResponse
description: >-
Response containing a list of tool groups.
Chunk:
type: object
properties:
content:
$ref: '#/components/schemas/InterleavedContent'
description: >-
The content of the chunk, which can be interleaved text, images, or other
types.
chunk_id:
type: string
description: >-
Unique identifier for the chunk. Must be provided explicitly.
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
Metadata associated with the chunk that will be used in the model context
during inference.
embedding:
type: array
items:
type: number
description: >-
Optional embedding for the chunk. If not provided, it will be computed
later.
chunk_metadata:
$ref: '#/components/schemas/ChunkMetadata'
description: >-
Metadata for the chunk that will NOT be used in the context during inference.
The `chunk_metadata` is required backend functionality.
additionalProperties: false
required:
- content
- chunk_id
- metadata
title: Chunk
description: >-
A chunk of content that can be inserted into a vector database.
ChunkMetadata:
type: object
properties:
chunk_id:
type: string
description: >-
The ID of the chunk. If not set, it will be generated based on the document
ID and content.
document_id:
type: string
description: >-
The ID of the document this chunk belongs to.
source:
type: string
description: >-
The source of the content, such as a URL, file path, or other identifier.
created_timestamp:
type: integer
description: >-
An optional timestamp indicating when the chunk was created.
updated_timestamp:
type: integer
description: >-
An optional timestamp indicating when the chunk was last updated.
chunk_window:
type: string
description: >-
The window of the chunk, which can be used to group related chunks together.
chunk_tokenizer:
type: string
description: >-
The tokenizer used to create the chunk. Default is Tiktoken.
chunk_embedding_model:
type: string
description: >-
The embedding model used to create the chunk's embedding.
chunk_embedding_dimension:
type: integer
description: >-
The dimension of the embedding vector for the chunk.
content_token_count:
type: integer
description: >-
The number of tokens in the content of the chunk.
metadata_token_count:
type: integer
description: >-
The number of tokens in the metadata of the chunk.
additionalProperties: false
title: ChunkMetadata
description: >-
`ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional
information about the chunk that will not be used in the context during
inference, but is required for backend functionality. The `ChunkMetadata` is
set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not
expected to change after. Use `Chunk.metadata` for metadata that will
be used in the context during inference.
InsertChunksRequest:
type: object
properties:
vector_store_id:
type: string
description: >-
The identifier of the vector database to insert the chunks into.
chunks:
type: array
items:
$ref: '#/components/schemas/Chunk'
description: >-
The chunks to insert. Each `Chunk` should contain content which can be
interleaved text, images, or other types. `metadata`: `dict[str, Any]`
and `embedding`: `List[float]` are optional. If `metadata` is provided,
you configure how Llama Stack formats the chunk during generation. If
`embedding` is not provided, it will be computed later.
ttl_seconds:
type: integer
description: The time to live of the chunks.
additionalProperties: false
required:
- vector_store_id
- chunks
title: InsertChunksRequest
QueryChunksRequest:
type: object
properties:
vector_store_id:
type: string
description: >-
The identifier of the vector database to query.
query:
$ref: '#/components/schemas/InterleavedContent'
description: The query to search for.
params:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: The parameters of the query.
additionalProperties: false
required:
- vector_store_id
- query
title: QueryChunksRequest
QueryChunksResponse:
type: object
properties:
chunks:
type: array
items:
$ref: '#/components/schemas/Chunk'
description: >-
List of content chunks returned from the query
scores:
type: array
items:
type: number
description: >-
Relevance scores corresponding to each returned chunk
additionalProperties: false
required:
- chunks
- scores
title: QueryChunksResponse
description: >-
Response from querying chunks in a vector database.
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.
VectorStoreChunkingStrategy:
oneOf:
- $ref: '#/components/schemas/StringType'
- $ref: '#/components/schemas/NumberType'
- $ref: '#/components/schemas/BooleanType'
- $ref: '#/components/schemas/ArrayType'
- $ref: '#/components/schemas/ObjectType'
- $ref: '#/components/schemas/JsonType'
- $ref: '#/components/schemas/UnionType'
- $ref: '#/components/schemas/ChatCompletionInputType'
- $ref: '#/components/schemas/CompletionInputType'
ScoringFnParams:
discriminator:
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.
"OpenAICreateVectorStoreRequestWithExtraBody":
type: object
properties:
name:
type: string
description: (Optional) A name for the vector store
file_ids:
type: array
items:
type: string
description: >-
List of file IDs to include in 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
chunking_strategy:
$ref: '#/components/schemas/VectorStoreChunkingStrategy'
description: >-
(Optional) Strategy for splitting files into chunks
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
title: >-
OpenAICreateVectorStoreRequestWithExtraBody
description: >-
Request to create a vector store with extra_body support.
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.
"OpenAICreateVectorStoreFileBatchRequestWithExtraBody":
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: >-
OpenAICreateVectorStoreFileBatchRequestWithExtraBody
description: >-
Request to create a vector store file batch with extra_body support.
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.
bool:
type: boolean
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
embedding:
type: array
items:
type: number
description: >-
Optional embedding vector for this content chunk
chunk_metadata:
$ref: '#/components/schemas/ChunkMetadata'
description: Optional chunk metadata
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: Optional user-defined metadata
additionalProperties: false
required:
- type
- text
title: VectorStoreContent
description: >-
Content item from a vector store file or search result.
VectorStoreFileContentResponse:
type: object
properties:
object:
type: string
const: vector_store.file_content.page
default: vector_store.file_content.page
description: >-
The object type, which is always `vector_store.file_content.page`
data:
type: array
items:
$ref: '#/components/schemas/VectorStoreContent'
description: Parsed content of the file
has_more:
type: boolean
default: false
description: >-
Indicates if there are more content pages to fetch
next_page:
type: string
description: The token for the next page, if any
additionalProperties: false
required:
- object
- data
- has_more
title: VectorStoreFileContentResponse
description: >-
Represents the parsed content 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: array
items:
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.
VersionInfo:
type: object
properties:
version:
type: string
description: Version number of the service
additionalProperties: false
required:
- version
title: VersionInfo
description: Version information for the service.
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
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.
Dataset:
type: object
properties:
identifier:
type: string
provider_resource_id:
type: string
provider_id:
type: string
type:
type: string
enum:
- model
- shield
- vector_store
- 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.
Benchmark:
type: object
properties:
identifier:
type: string
provider_resource_id:
type: string
provider_id:
type: string
type:
type: string
enum:
- model
- shield
- vector_store
- 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
BenchmarkConfig:
type: object
properties:
eval_candidate:
$ref: '#/components/schemas/ModelCandidate'
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.
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.
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.
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
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.
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.
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.
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.
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.
RerankRequest:
type: object
properties:
model:
type: string
description: >-
The identifier of the reranking model to use.
query:
oneOf:
- type: string
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
description: >-
The search query to rank items against. Can be a string, text content
part, or image content part. The input must not exceed the model's max
input token length.
items:
type: array
items:
oneOf:
- type: string
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam'
- $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam'
description: >-
List of items to rerank. Each item can be a string, text content part,
or image content part. Each input must not exceed the model's max input
token length.
max_num_results:
type: integer
description: >-
(Optional) Maximum number of results to return. Default: returns all.
additionalProperties: false
required:
- model
- query
- items
title: RerankRequest
RerankData:
type: object
properties:
index:
type: integer
description: >-
The original index of the document in the input list
relevance_score:
type: number
description: >-
The relevance score from the model output. Values are inverted when applicable
so that higher scores indicate greater relevance.
additionalProperties: false
required:
- index
- relevance_score
title: RerankData
description: >-
A single rerank result from a reranking response.
RerankResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RerankData'
description: >-
List of rerank result objects, sorted by relevance score (descending)
additionalProperties: false
required:
- data
title: RerankResponse
description: Response from a reranking request.
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:
discriminator:
mapping:
LoRA: '#/components/schemas/LoraFinetuningConfig'
QAT: '#/components/schemas/QATFinetuningConfig'
propertyName: type
oneOf:
- $ref: '#/components/schemas/LoraFinetuningConfig'
- $ref: '#/components/schemas/QATFinetuningConfig'
SpanEndPayload:
description: Payload for a span end event.
properties:
type:
const: span_end
default: span_end
title: Type
type: string
status:
$ref: '#/components/schemas/SpanStatus'
required:
- status
title: SpanEndPayload
type: object
SpanStartPayload:
description: Payload for a span start event.
properties:
type:
const: span_start
default: span_start
title: Type
type: string
name:
title: Name
type: string
parent_span_id:
anyOf:
- type: string
- type: 'null'
title: Parent Span Id
nullable: true
required:
- name
title: SpanStartPayload
type: object
SpanStatus:
description: The status of a span indicating whether it completed successfully or with an error.
enum:
- ok
- error
title: SpanStatus
type: string
StructuredLogPayload:
discriminator:
mapping:
span_end: '#/components/schemas/SpanEndPayload'
span_start: '#/components/schemas/SpanStartPayload'
propertyName: type
oneOf:
- $ref: '#/components/schemas/SpanStartPayload'
- $ref: '#/components/schemas/SpanEndPayload'
LogSeverity:
description: The severity level of a log message.
enum:
- verbose
- debug
- info
- warn
- error
- critical
title: LogSeverity
type: string
MetricEvent:
description: A metric event containing a measured value.
properties:
trace_id:
title: Trace Id
type: string
span_id:
title: Span Id
type: string
timestamp:
format: date-time
title: Timestamp
type: string
attributes:
anyOf:
- additionalProperties:
anyOf:
- type: string
- type: integer
- type: number
- type: boolean
- type: 'null'
type: object
- type: 'null'
title: Attributes
type:
const: metric
default: metric
title: Type
type: string
metric:
title: Metric
type: string
value:
anyOf:
- type: integer
- type: number
title: Value
unit:
title: Unit
type: string
required:
- trace_id
- span_id
- timestamp
- metric
- value
- unit
title: MetricEvent
type: object
StructuredLogEvent:
description: A structured log event containing typed payload data.
properties:
trace_id:
title: Trace Id
type: string
span_id:
title: Span Id
type: string
timestamp:
format: date-time
title: Timestamp
type: string
attributes:
anyOf:
- additionalProperties:
anyOf:
- type: string
- type: integer
- type: number
- type: boolean
- type: 'null'
type: object
- type: 'null'
title: Attributes
type:
const: structured_log
default: structured_log
title: Type
type: string
payload:
discriminator:
mapping:
span_end: '#/components/schemas/SpanEndPayload'
span_start: '#/components/schemas/SpanStartPayload'
propertyName: type
oneOf:
- $ref: '#/components/schemas/SpanStartPayload'
- $ref: '#/components/schemas/SpanEndPayload'
title: Payload
required:
- trace_id
- span_id
- timestamp
- payload
title: StructuredLogEvent
type: object
UnstructuredLogEvent:
description: An unstructured log event containing a simple text message.
properties:
trace_id:
title: Trace Id
type: string
span_id:
title: Span Id
type: string
timestamp:
format: date-time
title: Timestamp
type: string
attributes:
anyOf:
- additionalProperties:
anyOf:
- type: string
- type: integer
- type: number
- type: boolean
- type: 'null'
type: object
- type: 'null'
title: Attributes
type:
const: unstructured_log
default: unstructured_log
title: Type
type: string
message:
title: Message
type: string
severity:
$ref: '#/components/schemas/LogSeverity'
required:
- trace_id
- span_id
- timestamp
- message
- severity
title: UnstructuredLogEvent
type: object
Event:
discriminator:
mapping:
metric: '#/components/schemas/MetricEvent'
structured_log: '#/components/schemas/StructuredLogEvent'
unstructured_log: '#/components/schemas/UnstructuredLogEvent'
propertyName: type
oneOf:
- $ref: '#/components/schemas/UnstructuredLogEvent'
- $ref: '#/components/schemas/MetricEvent'
- $ref: '#/components/schemas/StructuredLogEvent'
ListOpenAIResponseInputItem:
description: List container for OpenAI response input items.
properties:
data:
items:
anyOf:
- discriminator:
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
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'
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
- $ref: '#/components/schemas/OpenAIResponseMessage'
title: Data
type: array
object:
const: list
default: list
title: Object
type: string
required:
- data
title: ListOpenAIResponseInputItem
type: object
OpenAIResponseObjectWithInput:
description: OpenAI response object extended with input context information.
properties:
created_at:
title: Created At
type: integer
error:
anyOf:
- $ref: '#/components/schemas/OpenAIResponseError'
- type: 'null'
nullable: true
id:
title: Id
type: string
model:
title: Model
type: string
object:
const: response
default: response
title: Object
type: string
output:
items:
discriminator:
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
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'
title: Output
type: array
parallel_tool_calls:
default: false
title: Parallel Tool Calls
type: boolean
previous_response_id:
anyOf:
- type: string
- type: 'null'
title: Previous Response Id
nullable: true
prompt:
anyOf:
- $ref: '#/components/schemas/OpenAIResponsePrompt'
- type: 'null'
nullable: true
status:
title: Status
type: string
temperature:
anyOf:
- type: number
- type: 'null'
title: Temperature
nullable: true
text:
$ref: '#/components/schemas/OpenAIResponseText'
default:
format:
type: text
top_p:
anyOf:
- type: number
- type: 'null'
title: Top P
nullable: true
tools:
anyOf:
- items:
discriminator:
mapping:
file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch'
function: '#/components/schemas/OpenAIResponseInputToolFunction'
mcp: '#/components/schemas/OpenAIResponseToolMCP'
web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch'
web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch'
- $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch'
- $ref: '#/components/schemas/OpenAIResponseInputToolFunction'
- $ref: '#/components/schemas/OpenAIResponseToolMCP'
type: array
- type: 'null'
title: Tools
nullable: true
truncation:
anyOf:
- type: string
- type: 'null'
title: Truncation
nullable: true
usage:
anyOf:
- $ref: '#/components/schemas/OpenAIResponseUsage'
- type: 'null'
nullable: true
instructions:
anyOf:
- type: string
- type: 'null'
title: Instructions
nullable: true
input:
items:
anyOf:
- discriminator:
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
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'
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
- $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
- $ref: '#/components/schemas/OpenAIResponseMessage'
title: Input
type: array
required:
- created_at
- id
- model
- output
- status
- input
title: OpenAIResponseObjectWithInput
type: object
ListOpenAIResponseObject:
description: Paginated list of OpenAI response objects with navigation metadata.
properties:
data:
items:
$ref: '#/components/schemas/OpenAIResponseObjectWithInput'
title: Data
type: array
has_more:
title: Has More
type: boolean
first_id:
title: First Id
type: string
last_id:
title: Last Id
type: string
object:
const: list
default: list
title: Object
type: string
required:
- data
- has_more
- first_id
- last_id
title: ListOpenAIResponseObject
type: object
ResponseGuardrailSpec:
description: Specification for a guardrail to apply during response generation.
properties:
type:
title: Type
type: string
required:
- type
title: ResponseGuardrailSpec
type: object
ListBatchesResponse:
description: Response containing a list of batch objects.
properties:
object:
const: list
default: list
title: Object
type: string
data:
description: List of batch objects
items:
$ref: '#/components/schemas/Batch'
title: Data
type: array
first_id:
anyOf:
- type: string
- type: 'null'
description: ID of the first batch in the list
title: First Id
nullable: true
last_id:
anyOf:
- type: string
- type: 'null'
description: ID of the last batch in the list
title: Last Id
nullable: true
has_more:
default: false
description: Whether there are more batches available
title: Has More
type: boolean
required:
- data
title: ListBatchesResponse
type: object
MetricInResponse:
description: A metric value included in API responses.
properties:
metric:
title: Metric
type: string
value:
anyOf:
- type: integer
- type: number
title: Value
unit:
anyOf:
- type: string
- type: 'null'
title: Unit
nullable: true
required:
- metric
- value
title: MetricInResponse
type: object
PaginatedResponse:
description: A generic paginated response that follows a simple format.
properties:
data:
items:
additionalProperties: true
type: object
title: Data
type: array
has_more:
title: Has More
type: boolean
url:
anyOf:
- type: string
- type: 'null'
title: Url
nullable: true
required:
- data
- has_more
title: PaginatedResponse
type: object
PostTrainingMetric:
description: Training metrics captured during post-training jobs.
properties:
epoch:
title: Epoch
type: integer
train_loss:
title: Train Loss
type: number
validation_loss:
title: Validation Loss
type: number
perplexity:
title: Perplexity
type: number
required:
- epoch
- train_loss
- validation_loss
- perplexity
title: PostTrainingMetric
type: object
Checkpoint:
description: Checkpoint created during training runs.
properties:
identifier:
title: Identifier
type: string
created_at:
format: date-time
title: Created At
type: string
epoch:
title: Epoch
type: integer
post_training_job_id:
title: Post Training Job Id
type: string
path:
title: Path
type: string
training_metrics:
anyOf:
- $ref: '#/components/schemas/PostTrainingMetric'
- type: 'null'
nullable: true
required:
- identifier
- created_at
- epoch
- post_training_job_id
- path
title: Checkpoint
type: object
DialogType:
description: Parameter type for dialog data with semantic output labels.
properties:
type:
const: dialog
default: dialog
title: Type
type: string
title: DialogType
type: object
ConversationItemCreateRequest:
description: Request body for creating conversation items.
properties:
items:
description: Items to include in the conversation context. You may add up to 20 items at a time.
items:
discriminator:
mapping:
file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest'
mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse'
mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall'
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
propertyName: type
oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage'
- $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/OpenAIResponseOutputMessageMCPCall'
- $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
maxItems: 20
title: Items
type: array
required:
- items
title: ConversationItemCreateRequest
type: object
ConversationMessage:
description: OpenAI-compatible message item for conversations.
properties:
id:
description: unique identifier for this message
title: Id
type: string
content:
description: message content
items:
additionalProperties: true
type: object
title: Content
type: array
role:
description: message role
title: Role
type: string
status:
description: message status
title: Status
type: string
type:
const: message
default: message
title: Type
type: string
object:
const: message
default: message
title: Object
type: string
required:
- id
- content
- role
- status
title: ConversationMessage
type: object
ListOpenAIFileResponse:
description: Response for listing files in OpenAI Files API.
properties:
data:
items:
$ref: '#/components/schemas/OpenAIFileObject'
title: Data
type: array
has_more:
title: Has More
type: boolean
first_id:
title: First Id
type: string
last_id:
title: Last Id
type: string
object:
const: list
default: list
title: Object
type: string
required:
- data
- has_more
- first_id
- last_id
title: ListOpenAIFileResponse
type: object
Bf16QuantizationConfig:
description: Configuration for BFloat16 precision (typically no quantization).
properties:
type:
const: bf16
default: bf16
title: Type
type: string
title: Bf16QuantizationConfig
type: object
LogProbConfig:
description: ''
properties:
top_k:
anyOf:
- type: integer
- type: 'null'
default: 0
title: Top K
title: LogProbConfig
type: object
SystemMessageBehavior:
description: Config for how to override the default system prompt.
enum:
- append
- replace
title: SystemMessageBehavior
type: string
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.
enum:
- auto
- required
- none
title: ToolChoice
type: string
ToolConfig:
description: Configuration for tool use.
properties:
tool_choice:
anyOf:
- $ref: '#/components/schemas/ToolChoice'
- type: string
- type: 'null'
default: auto
title: Tool Choice
tool_prompt_format:
anyOf:
- $ref: '#/components/schemas/ToolPromptFormat'
- type: 'null'
nullable: true
system_message_behavior:
anyOf:
- $ref: '#/components/schemas/SystemMessageBehavior'
- type: 'null'
default: append
title: ToolConfig
type: object
ToolPromptFormat:
description: Prompt format for calling custom / zero shot tools.
enum:
- json
- function_tag
- python_list
title: ToolPromptFormat
type: string
ChatCompletionRequest:
properties:
model:
title: Model
type: string
messages:
items:
discriminator:
mapping:
assistant: '#/components/schemas/CompletionMessage'
system: '#/components/schemas/SystemMessage'
tool: '#/components/schemas/ToolResponseMessage'
user: '#/components/schemas/UserMessage'
propertyName: role
oneOf:
- $ref: '#/components/schemas/UserMessage'
- $ref: '#/components/schemas/SystemMessage'
- $ref: '#/components/schemas/ToolResponseMessage'
- $ref: '#/components/schemas/CompletionMessage'
title: Messages
type: array
sampling_params:
anyOf:
- $ref: '#/components/schemas/SamplingParams'
- type: 'null'
tools:
anyOf:
- items:
$ref: '#/components/schemas/ToolDefinition'
type: array
- type: 'null'
title: Tools
tool_config:
anyOf:
- $ref: '#/components/schemas/ToolConfig'
- type: 'null'
response_format:
anyOf:
- discriminator:
mapping:
grammar: '#/components/schemas/GrammarResponseFormat'
json_schema: '#/components/schemas/JsonSchemaResponseFormat'
propertyName: type
oneOf:
- $ref: '#/components/schemas/JsonSchemaResponseFormat'
- $ref: '#/components/schemas/GrammarResponseFormat'
- type: 'null'
title: Response Format
nullable: true
stream:
anyOf:
- type: boolean
- type: 'null'
default: false
title: Stream
logprobs:
anyOf:
- $ref: '#/components/schemas/LogProbConfig'
- type: 'null'
nullable: true
required:
- model
- messages
title: ChatCompletionRequest
type: object
TokenLogProbs:
description: Log probabilities for generated tokens.
properties:
logprobs_by_token:
additionalProperties:
type: number
title: Logprobs By Token
type: object
required:
- logprobs_by_token
title: TokenLogProbs
type: object
ChatCompletionResponse:
description: Response from a chat completion request.
properties:
metrics:
anyOf:
- items:
$ref: '#/components/schemas/MetricInResponse'
type: array
- type: 'null'
title: Metrics
nullable: true
completion_message:
$ref: '#/components/schemas/CompletionMessage'
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/TokenLogProbs'
type: array
- type: 'null'
title: Logprobs
nullable: true
required:
- completion_message
title: ChatCompletionResponse
type: object
ChatCompletionResponseEventType:
description: Types of events that can occur during chat completion.
enum:
- start
- complete
- progress
title: ChatCompletionResponseEventType
type: string
ChatCompletionResponseEvent:
description: An event during chat completion generation.
properties:
event_type:
$ref: '#/components/schemas/ChatCompletionResponseEventType'
delta:
discriminator:
mapping:
image: '#/components/schemas/ImageDelta'
text: '#/components/schemas/TextDelta'
tool_call: '#/components/schemas/ToolCallDelta'
propertyName: type
oneOf:
- $ref: '#/components/schemas/TextDelta'
- $ref: '#/components/schemas/ImageDelta'
- $ref: '#/components/schemas/ToolCallDelta'
title: Delta
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/TokenLogProbs'
type: array
- type: 'null'
title: Logprobs
nullable: true
stop_reason:
anyOf:
- $ref: '#/components/schemas/StopReason'
- type: 'null'
nullable: true
required:
- event_type
- delta
title: ChatCompletionResponseEvent
type: object
ChatCompletionResponseStreamChunk:
description: A chunk of a streamed chat completion response.
properties:
metrics:
anyOf:
- items:
$ref: '#/components/schemas/MetricInResponse'
type: array
- type: 'null'
title: Metrics
nullable: true
event:
$ref: '#/components/schemas/ChatCompletionResponseEvent'
required:
- event
title: ChatCompletionResponseStreamChunk
type: object
CompletionResponse:
description: Response from a completion request.
properties:
metrics:
anyOf:
- items:
$ref: '#/components/schemas/MetricInResponse'
type: array
- type: 'null'
title: Metrics
nullable: true
content:
title: Content
type: string
stop_reason:
$ref: '#/components/schemas/StopReason'
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/TokenLogProbs'
type: array
- type: 'null'
title: Logprobs
nullable: true
required:
- content
- stop_reason
title: CompletionResponse
type: object
CompletionResponseStreamChunk:
description: A chunk of a streamed completion response.
properties:
metrics:
anyOf:
- items:
$ref: '#/components/schemas/MetricInResponse'
type: array
- type: 'null'
title: Metrics
nullable: true
delta:
title: Delta
type: string
stop_reason:
anyOf:
- $ref: '#/components/schemas/StopReason'
- type: 'null'
nullable: true
logprobs:
anyOf:
- items:
$ref: '#/components/schemas/TokenLogProbs'
type: array
- type: 'null'
title: Logprobs
nullable: true
required:
- delta
title: CompletionResponseStreamChunk
type: object
EmbeddingsResponse:
description: Response containing generated embeddings.
properties:
embeddings:
items:
items:
type: number
type: array
title: Embeddings
type: array
required:
- embeddings
title: EmbeddingsResponse
type: object
Fp8QuantizationConfig:
description: Configuration for 8-bit floating point quantization.
properties:
type:
const: fp8_mixed
default: fp8_mixed
title: Type
type: string
title: Fp8QuantizationConfig
type: object
Int4QuantizationConfig:
description: Configuration for 4-bit integer quantization.
properties:
type:
const: int4_mixed
default: int4_mixed
title: Type
type: string
scheme:
anyOf:
- type: string
- type: 'null'
default: int4_weight_int8_dynamic_activation
title: Scheme
title: Int4QuantizationConfig
type: object
OpenAIChoice:
description: A choice from an OpenAI-compatible chat completion response.
properties:
message:
discriminator:
mapping:
assistant: '#/components/schemas/OpenAIAssistantMessageParam'
developer: '#/components/schemas/OpenAIDeveloperMessageParam'
system: '#/components/schemas/OpenAISystemMessageParam'
tool: '#/components/schemas/OpenAIToolMessageParam'
user: '#/components/schemas/OpenAIUserMessageParam'
propertyName: role
oneOf:
- $ref: '#/components/schemas/OpenAIUserMessageParam'
- $ref: '#/components/schemas/OpenAISystemMessageParam'
- $ref: '#/components/schemas/OpenAIAssistantMessageParam'
- $ref: '#/components/schemas/OpenAIToolMessageParam'
- $ref: '#/components/schemas/OpenAIDeveloperMessageParam'
title: Message
finish_reason:
title: Finish Reason
type: string
index:
title: Index
type: integer
logprobs:
anyOf:
- $ref: '#/components/schemas/OpenAIChoiceLogprobs'
- type: 'null'
nullable: true
required:
- message
- finish_reason
- index
title: OpenAIChoice
type: object
OpenAIChoiceLogprobs:
description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response.
properties:
content:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
title: Content
nullable: true
refusal:
anyOf:
- items:
$ref: '#/components/schemas/OpenAITokenLogProb'
type: array
- type: 'null'
title: Refusal
nullable: true
title: OpenAIChoiceLogprobs
type: object
ListOpenAIChatCompletionResponse:
description: Response from listing OpenAI-compatible chat completions.
properties:
data:
items:
$ref: '#/components/schemas/OpenAICompletionWithInputMessages'
title: Data
type: array
has_more:
title: Has More
type: boolean
first_id:
title: First Id
type: string
last_id:
title: Last Id
type: string
object:
const: list
default: list
title: Object
type: string
required:
- data
- has_more
- first_id
- last_id
title: ListOpenAIChatCompletionResponse
type: object
OpenAIChoiceDelta:
description: A delta from an OpenAI-compatible chat completion streaming response.
properties:
content:
anyOf:
- type: string
- type: 'null'
title: Content
nullable: true
refusal:
anyOf:
- type: string
- type: 'null'
title: Refusal
nullable: true
role:
anyOf:
- type: string
- type: 'null'
title: Role
nullable: true
tool_calls:
anyOf:
- items:
$ref: '#/components/schemas/OpenAIChatCompletionToolCall'
type: array
- type: 'null'
title: Tool Calls
nullable: true
reasoning_content:
anyOf:
- type: string
- type: 'null'
title: Reasoning Content
nullable: true
title: OpenAIChoiceDelta
type: object
OpenAIChunkChoice:
description: A chunk choice from an OpenAI-compatible chat completion streaming response.
properties:
delta:
$ref: '#/components/schemas/OpenAIChoiceDelta'
finish_reason:
title: Finish Reason
type: string
index:
title: Index
type: integer
logprobs:
anyOf:
- $ref: '#/components/schemas/OpenAIChoiceLogprobs'
- type: 'null'
nullable: true
required:
- delta
- finish_reason
- index
title: OpenAIChunkChoice
type: object
OpenAIChatCompletionChunk:
description: Chunk from a streaming response to an OpenAI-compatible chat completion request.
properties:
id:
title: Id
type: string
choices:
items:
$ref: '#/components/schemas/OpenAIChunkChoice'
title: Choices
type: array
object:
const: chat.completion.chunk
default: chat.completion.chunk
title: Object
type: string
created:
title: Created
type: integer
model:
title: Model
type: string
usage:
anyOf:
- $ref: '#/components/schemas/OpenAIChatCompletionUsage'
- type: 'null'
nullable: true
required:
- id
- choices
- created
- model
title: OpenAIChatCompletionChunk
type: object
OpenAICompletionChoice:
description: |-
A choice from an OpenAI-compatible completion response.
:finish_reason: The reason the model stopped generating
:text: The text of the choice
:index: The index of the choice
:logprobs: (Optional) The log probabilities for the tokens in the choice
properties:
finish_reason:
title: Finish Reason
type: string
text:
title: Text
type: string
index:
title: Index
type: integer
logprobs:
anyOf:
- $ref: '#/components/schemas/OpenAIChoiceLogprobs'
- type: 'null'
nullable: true
required:
- finish_reason
- text
- index
title: OpenAICompletionChoice
type: object
OpenAICompletionLogprobs:
description: |-
The log probabilities for the tokens in the message from an OpenAI-compatible completion response.
:text_offset: (Optional) The offset of the token in the text
:token_logprobs: (Optional) The log probabilities for the tokens
:tokens: (Optional) The tokens
:top_logprobs: (Optional) The top log probabilities for the tokens
properties:
text_offset:
anyOf:
- items:
type: integer
type: array
- type: 'null'
title: Text Offset
nullable: true
token_logprobs:
anyOf:
- items:
type: number
type: array
- type: 'null'
title: Token Logprobs
nullable: true
tokens:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Tokens
nullable: true
top_logprobs:
anyOf:
- items:
additionalProperties:
type: number
type: object
type: array
- type: 'null'
title: Top Logprobs
nullable: true
title: OpenAICompletionLogprobs
type: object
ToolResponse:
description: Response from a tool invocation.
properties:
call_id:
title: Call Id
type: string
tool_name:
anyOf:
- $ref: '#/components/schemas/BuiltinTool'
- type: string
title: Tool Name
content:
anyOf:
- type: string
- discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
- items:
discriminator:
mapping:
image: '#/components/schemas/ImageContentItem'
text: '#/components/schemas/TextContentItem'
propertyName: type
oneOf:
- $ref: '#/components/schemas/ImageContentItem'
- $ref: '#/components/schemas/TextContentItem'
type: array
title: Content
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
nullable: true
required:
- call_id
- tool_name
- content
title: ToolResponse
type: object
RouteInfo:
description: Information about an API route including its path, method, and implementing providers.
properties:
route:
title: Route
type: string
method:
title: Method
type: string
provider_types:
items:
type: string
title: Provider Types
type: array
required:
- route
- method
- provider_types
title: RouteInfo
type: object
ListRoutesResponse:
description: Response containing a list of all available API routes.
properties:
data:
items:
$ref: '#/components/schemas/RouteInfo'
title: Data
type: array
required:
- data
title: ListRoutesResponse
type: object
PostTrainingJobArtifactsResponse:
description: Artifacts of a finetuning job.
properties:
job_uuid:
title: Job Uuid
type: string
checkpoints:
items:
$ref: '#/components/schemas/Checkpoint'
title: Checkpoints
type: array
required:
- job_uuid
title: PostTrainingJobArtifactsResponse
type: object
PostTrainingJobLogStream:
description: Stream of logs from a finetuning job.
properties:
job_uuid:
title: Job Uuid
type: string
log_lines:
items:
type: string
title: Log Lines
type: array
required:
- job_uuid
- log_lines
title: PostTrainingJobLogStream
type: object
PostTrainingJobStatusResponse:
description: Status of a finetuning job.
properties:
job_uuid:
title: Job Uuid
type: string
status:
$ref: '#/components/schemas/JobStatus'
scheduled_at:
anyOf:
- format: date-time
type: string
- type: 'null'
title: Scheduled At
nullable: true
started_at:
anyOf:
- format: date-time
type: string
- type: 'null'
title: Started At
nullable: true
completed_at:
anyOf:
- format: date-time
type: string
- type: 'null'
title: Completed At
nullable: true
resources_allocated:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Resources Allocated
nullable: true
checkpoints:
items:
$ref: '#/components/schemas/Checkpoint'
title: Checkpoints
type: array
required:
- job_uuid
- status
title: PostTrainingJobStatusResponse
type: object
RLHFAlgorithm:
description: Available reinforcement learning from human feedback algorithms.
enum:
- dpo
title: RLHFAlgorithm
type: string
PostTrainingRLHFRequest:
description: Request to finetune a model using reinforcement learning from human feedback.
properties:
job_uuid:
title: Job Uuid
type: string
finetuned_model:
$ref: '#/components/schemas/URL'
dataset_id:
title: Dataset Id
type: string
validation_dataset_id:
title: Validation Dataset Id
type: string
algorithm:
$ref: '#/components/schemas/RLHFAlgorithm'
algorithm_config:
$ref: '#/components/schemas/DPOAlignmentConfig'
optimizer_config:
$ref: '#/components/schemas/OptimizerConfig'
training_config:
$ref: '#/components/schemas/TrainingConfig'
hyperparam_search_config:
additionalProperties: true
title: Hyperparam Search Config
type: object
logger_config:
additionalProperties: true
title: Logger Config
type: object
required:
- job_uuid
- training_config
- hyperparam_search_config
- logger_config
title: SupervisedFineTuneRequest
RegisterModelRequest:
type: object
properties:
model_id:
type: string
description: The identifier of the model to register.
provider_model_id:
type: string
description: >-
The identifier of the model in the provider.
provider_id:
type: string
description: The identifier of the provider.
metadata:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: Any additional metadata for this model.
model_type:
$ref: '#/components/schemas/ModelType'
description: The type of model to register.
additionalProperties: false
required:
- model_id
title: RegisterModelRequest
ParamType:
oneOf:
- $ref: '#/components/schemas/StringType'
- $ref: '#/components/schemas/NumberType'
- $ref: '#/components/schemas/BooleanType'
- $ref: '#/components/schemas/ArrayType'
- $ref: '#/components/schemas/ObjectType'
- $ref: '#/components/schemas/JsonType'
- $ref: '#/components/schemas/UnionType'
- $ref: '#/components/schemas/ChatCompletionInputType'
- $ref: '#/components/schemas/CompletionInputType'
discriminator:
propertyName: type
mapping:
string: '#/components/schemas/StringType'
number: '#/components/schemas/NumberType'
boolean: '#/components/schemas/BooleanType'
array: '#/components/schemas/ArrayType'
object: '#/components/schemas/ObjectType'
json: '#/components/schemas/JsonType'
union: '#/components/schemas/UnionType'
chat_completion_input: '#/components/schemas/ChatCompletionInputType'
completion_input: '#/components/schemas/CompletionInputType'
RegisterScoringFunctionRequest:
type: object
properties:
scoring_fn_id:
type: string
description: >-
The ID of the scoring function to register.
description:
type: string
description: The description of the scoring function.
return_type:
$ref: '#/components/schemas/ParamType'
description: The return type of the scoring function.
provider_scoring_fn_id:
type: string
description: >-
The ID of the provider scoring function to use for the scoring function.
provider_id:
type: string
description: >-
The ID of the provider to use for the scoring function.
params:
$ref: '#/components/schemas/ScoringFnParams'
description: >-
The parameters for the scoring function for benchmark eval, these can
be overridden for app eval.
additionalProperties: false
required:
- scoring_fn_id
- description
- return_type
title: RegisterScoringFunctionRequest
RegisterShieldRequest:
type: object
properties:
shield_id:
type: string
description: >-
The identifier of the shield to register.
provider_shield_id:
type: string
description: >-
The identifier of the shield in the provider.
provider_id:
type: string
description: The identifier of the provider.
params:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: The parameters of the shield.
additionalProperties: false
required:
- shield_id
title: RegisterShieldRequest
RegisterToolGroupRequest:
type: object
properties:
toolgroup_id:
type: string
description: The ID of the tool group to register.
provider_id:
type: string
description: >-
The ID of the provider to use for the tool group.
mcp_endpoint:
$ref: '#/components/schemas/URL'
description: >-
The MCP endpoint to use for the tool group.
args:
type: object
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
description: >-
A dictionary of arguments to pass to the tool group.
additionalProperties: false
required:
- toolgroup_id
- provider_id
title: RegisterToolGroupRequest
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
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
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
DefaultError:
description: An error occurred
content:
application/json:
schema:
$ref: '#/components/schemas/Error'