openapi: 3.1.0 info: title: Mistral AI API version: 1.0.0 description: Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it. paths: /v2/prompts: get: tags: - beta.prompts summary: ListPrompts operationId: prompts_list parameters: - name: pageSize in: query schema: type: integer title: page_size format: int32 - name: pageToken in: query schema: type: string title: page_token - name: alias in: query schema: type: string title: alias - name: fields in: query schema: type: array items: type: string title: fields - name: sort.field in: query description: Defaults to created_at when omitted. schema: title: field description: Defaults to created_at when omitted. $ref: '#/components/schemas/ListSortField' - name: sort.direction in: query description: Defaults to descending for timestamp fields and ascending for text fields. schema: title: direction description: Defaults to descending for timestamp fields and ascending for text fields. $ref: '#/components/schemas/ListSortDirection' - name: sort_by in: query description: 'REST-friendly alias for sort.field. Supported values: created_at, last_modified_at, name, title.' schema: type: string title: sort_by description: 'REST-friendly alias for sort.field. Supported values: created_at, last_modified_at, name, title.' - name: sort_direction in: query description: 'REST-friendly alias for sort.direction. Supported values: asc, desc.' schema: type: string title: sort_direction description: 'REST-friendly alias for sort.direction. Supported values: asc, desc.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListPromptsResponse' x-speakeasy-pagination: type: cursor inputs: - name: pageToken in: parameters type: cursor - name: pageSize in: parameters type: limit outputs: results: $.data nextCursor: $.nextPageToken description: ListPrompts post: tags: - beta.prompts summary: CreatePrompt operationId: prompts_create requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePromptRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Prompt' description: CreatePrompt /v2/prompts/{prompt_id}: get: tags: - beta.prompts summary: GetPrompt operationId: prompts_get parameters: - name: prompt_id in: path required: true schema: type: string title: prompt_id - name: version in: query schema: type: integer title: version format: int32 example: 1 example: 1 - name: alias in: query schema: type: string title: alias - name: fields in: query schema: type: array items: type: string title: fields responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Prompt' description: GetPrompt delete: tags: - beta.prompts summary: DeletePrompt operationId: prompts_delete parameters: - name: prompt_id in: path required: true schema: type: string title: prompt_id responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeletePromptResponse' description: DeletePrompt patch: tags: - beta.prompts summary: UpdatePrompt operationId: prompts_update parameters: - name: prompt_id in: path required: true schema: type: string title: prompt_id requestBody: content: application/json: schema: type: object properties: title: type: string title: title nullable: true description: Display title. description: type: string title: description nullable: true description: Display description. sharingScope: title: sharing_scope nullable: true $ref: '#/components/schemas/RegistrySharingScope' description: Registry sharing scope. title: UpdatePromptRequest additionalProperties: false required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Prompt' x-speakeasy-max-method-params: 2 description: UpdatePrompt /v2/prompts/{prompt_id}/versions: get: tags: - beta.prompts summary: ListPromptVersions operationId: prompts_list_versions parameters: - name: prompt_id in: path required: true schema: type: string title: prompt_id responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListPromptVersionsResponse' description: ListPromptVersions post: tags: - beta.prompts summary: CreatePromptVersion operationId: prompts_create_version parameters: - name: prompt_id in: path required: true schema: type: string title: prompt_id requestBody: content: application/json: schema: type: object properties: definition: title: definition $ref: '#/components/schemas/PromptDefinition' notes: type: string title: notes nullable: true description: Notes for this version. aliases: type: array items: type: string title: aliases description: Aliases pointing to this version. title: CreatePromptVersionRequest additionalProperties: false required: - definition required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreatePromptVersionResponse' x-speakeasy-max-method-params: 2 description: CreatePromptVersion /v2/prompts/{prompt_id}/versions/{version}: get: tags: - beta.prompts summary: GetPromptVersion operationId: prompts_get_version parameters: - name: prompt_id in: path required: true schema: type: string title: prompt_id - name: version in: path required: true schema: type: integer title: version format: int32 example: 1 example: 1 - name: fields in: query schema: type: array items: type: string title: fields responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Prompt' description: GetPromptVersion patch: tags: - beta.prompts summary: UpdatePromptVersionMetadata operationId: prompts_update_version_metadata parameters: - name: prompt_id in: path required: true schema: type: string title: prompt_id - name: version in: path required: true schema: type: integer title: version format: int32 example: 1 example: 1 requestBody: content: application/json: schema: type: object properties: notes: type: string title: notes nullable: true description: Notes for this version. aliases: title: aliases description: Aliases pointing to this version. $ref: '#/components/schemas/AliasList' title: UpdatePromptVersionRequest additionalProperties: false required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Prompt' x-speakeasy-max-method-params: 3 description: UpdatePromptVersionMetadata /v2/skills: get: tags: - beta.skills summary: ListSkills operationId: skills_list parameters: - name: pageSize in: query schema: type: integer title: page_size format: int32 - name: pageToken in: query schema: type: string title: page_token - name: alias in: query schema: type: string title: alias - name: fields in: query schema: type: array items: type: string title: fields - name: sort.field in: query description: Defaults to created_at when omitted. schema: title: field description: Defaults to created_at when omitted. $ref: '#/components/schemas/ListSortField' - name: sort.direction in: query description: Defaults to descending for timestamp fields and ascending for text fields. schema: title: direction description: Defaults to descending for timestamp fields and ascending for text fields. $ref: '#/components/schemas/ListSortDirection' - name: sort_by in: query description: 'REST-friendly alias for sort.field. Supported values: created_at, last_modified_at, name, title.' schema: type: string title: sort_by description: 'REST-friendly alias for sort.field. Supported values: created_at, last_modified_at, name, title.' - name: sort_direction in: query description: 'REST-friendly alias for sort.direction. Supported values: asc, desc.' schema: type: string title: sort_direction description: 'REST-friendly alias for sort.direction. Supported values: asc, desc.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListSkillsResponse' x-speakeasy-pagination: type: cursor inputs: - name: pageToken in: parameters type: cursor - name: pageSize in: parameters type: limit outputs: results: $.data nextCursor: $.nextPageToken description: ListSkills post: tags: - beta.skills summary: CreateSkill operationId: skills_create requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSkillRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Skill' description: CreateSkill /v2/skills/{skill_id}: get: tags: - beta.skills summary: GetSkill operationId: skills_get parameters: - name: skill_id in: path required: true schema: type: string title: skill_id - name: version in: query schema: type: integer title: version format: int32 example: 1 example: 1 - name: alias in: query schema: type: string title: alias - name: fields in: query schema: type: array items: type: string title: fields responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Skill' description: GetSkill delete: tags: - beta.skills summary: DeleteSkill operationId: skills_delete parameters: - name: skill_id in: path required: true schema: type: string title: skill_id responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteSkillResponse' description: DeleteSkill patch: tags: - beta.skills summary: UpdateSkill operationId: skills_update parameters: - name: skill_id in: path required: true schema: type: string title: skill_id requestBody: content: application/json: schema: type: object properties: sharingScope: title: sharing_scope nullable: true $ref: '#/components/schemas/RegistrySharingScope' description: Registry sharing scope. title: UpdateSkillRequest additionalProperties: false required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Skill' x-speakeasy-max-method-params: 2 description: UpdateSkill /v2/skills/{skill_id}/versions: get: tags: - beta.skills summary: ListSkillVersions operationId: skills_list_versions parameters: - name: skill_id in: path required: true schema: type: string title: skill_id responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListSkillVersionsResponse' description: ListSkillVersions post: tags: - beta.skills summary: CreateSkillVersion operationId: skills_create_version parameters: - name: skill_id in: path required: true schema: type: string title: skill_id requestBody: content: application/json: schema: type: object properties: definition: title: definition $ref: '#/components/schemas/SkillDefinition' notes: type: string title: notes nullable: true description: Notes for this version. aliases: type: array items: type: string title: aliases description: Aliases pointing to this version. title: CreateSkillVersionRequest additionalProperties: false required: - definition required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateSkillVersionResponse' x-speakeasy-max-method-params: 2 description: CreateSkillVersion /v2/skills/{skill_id}/versions/{version}: get: tags: - beta.skills summary: GetSkillVersion operationId: skills_get_version parameters: - name: skill_id in: path required: true schema: type: string title: skill_id - name: version in: path required: true schema: type: integer title: version format: int32 example: 1 example: 1 - name: fields in: query schema: type: array items: type: string title: fields responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Skill' description: GetSkillVersion patch: tags: - beta.skills summary: UpdateSkillVersionMetadata operationId: skills_update_version_metadata parameters: - name: skill_id in: path required: true schema: type: string title: skill_id - name: version in: path required: true schema: type: integer title: version format: int32 example: 1 example: 1 requestBody: content: application/json: schema: type: object properties: notes: type: string title: notes nullable: true description: Notes for this version. aliases: title: aliases description: Aliases pointing to this version. $ref: '#/components/schemas/AliasList' title: UpdateSkillVersionRequest additionalProperties: false required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Skill' x-speakeasy-max-method-params: 3 description: UpdateSkillVersionMetadata /v1/audio/speech: post: operationId: speech_v1_audio_speech_post summary: Speech tags: - audio.speech requestBody: content: application/json: schema: $ref: '#/components/schemas/SpeechRequest' required: true responses: '200': description: Speech audio data. content: application/json: schema: type: object properties: audio_data: type: string title: Audio Data description: Base64 encoded audio data title: SpeechResponse required: - audio_data additionalProperties: false text/event-stream: schema: type: object properties: event: $ref: '#/$defs/SpeechStreamEventTypes' data: oneOf: - $ref: '#/$defs/SpeechStreamAudioDelta' - $ref: '#/$defs/SpeechStreamDone' discriminator: propertyName: type mapping: speech.audio.delta: '#/$defs/SpeechStreamAudioDelta' speech.audio.done: '#/$defs/SpeechStreamDone' title: Data $defs: CompletionTokensDetails: type: object properties: reasoning_tokens: type: integer title: Reasoning Tokens default: 0 title: CompletionTokensDetails additionalProperties: false description: Token usage details for the completion. MessageTokens: type: object properties: role: $ref: '#/$defs/Roles' total_tokens: anyOf: - type: integer - type: 'null' title: Total Tokens truncated: type: boolean title: Truncated default: false usage_count: type: integer title: Usage Count default: 1 title: MessageTokens required: - role additionalProperties: false description: Information on a single message included in a tokenized prompt as part of an InstructRequest. PromptTokensDetails: type: object properties: messages: type: array items: $ref: '#/$defs/MessageTokens' title: Messages cached_tokens: type: integer title: Cached Tokens default: 0 audio_tokens: type: integer title: Audio Tokens default: 0 title: PromptTokensDetails additionalProperties: false description: Token usage details for the prompt. Roles: type: string title: Roles enum: - system - user - assistant - tool SpeechStreamAudioDelta: type: object properties: type: type: string title: Type default: speech.audio.delta const: speech.audio.delta audio_data: type: string title: Audio Data title: SpeechStreamAudioDelta required: - audio_data additionalProperties: false SpeechStreamDone: type: object properties: type: type: string title: Type default: speech.audio.done const: speech.audio.done usage: $ref: '#/$defs/UsageInfo' title: SpeechStreamDone required: - usage additionalProperties: false SpeechStreamEventTypes: type: string title: SpeechStreamEventTypes enum: - speech.audio.delta - speech.audio.done UsageInfo: type: object properties: prompt_audio_seconds: anyOf: - type: integer - type: 'null' title: Prompt Audio Seconds prompt_tokens: type: integer title: Prompt Tokens default: 0 total_tokens: type: integer title: Total Tokens default: 0 completion_tokens: anyOf: - type: integer - type: 'null' title: Completion Tokens default: 0 request_count: anyOf: - type: integer - type: 'null' title: Request Count prompt_tokens_details: anyOf: - $ref: '#/$defs/PromptTokensDetails' - type: 'null' completion_tokens_details: anyOf: - $ref: '#/$defs/CompletionTokensDetails' - type: 'null' prompt_token_details: anyOf: - $ref: '#/$defs/PromptTokensDetails' - type: 'null' num_cached_tokens: anyOf: - type: integer - type: 'null' title: Num Cached Tokens title: UsageInfo additionalProperties: false title: SpeechStreamEvents required: - event - data additionalProperties: false '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Speech /v1/models: get: operationId: list_models_v1_models_get summary: List Models description: List all models available to the user. tags: - models parameters: - name: provider in: query required: false schema: anyOf: - type: string - type: 'null' title: Provider - name: model in: query required: false schema: anyOf: - type: string - type: 'null' title: Model responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ModelList' examples: userExample: value: - id: capabilities: completion_chat: true completion_fim: false function_calling: false fine_tuning: false vision: false classification: false job: root: open-mistral-7b object: model created: 1756746619 owned_by: max_context_length: 32768 aliases: [] TYPE: fine-tuned archived: false '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/models/{model_id}: get: operationId: retrieve_model_v1_models__model_id__get summary: Retrieve Model description: Retrieve information about a model. tags: - models parameters: - name: model_id in: path description: The ID of the model to retrieve. required: true schema: type: string examples: - ft:open-mistral-7b:587a6b29:20240514:7e773925 title: Model Id description: The ID of the model to retrieve. responses: '200': description: Successful Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/BaseModelCard' - $ref: '#/components/schemas/FTModelCard' discriminator: propertyName: type mapping: base: '#/components/schemas/BaseModelCard' fine-tuned: '#/components/schemas/FTModelCard' title: Response Retrieve Model V1 Models Model Id Get examples: userExample: value: id: capabilities: completion_chat: true completion_fim: false function_calling: false fine_tuning: false vision: false classification: false job: root: open-mistral-7b object: model created: 1756746619 owned_by: max_context_length: 32768 aliases: [] TYPE: fine-tuned archived: false '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: operationId: delete_model_v1_models__model_id__delete summary: Delete Model description: Delete a fine-tuned model. tags: - models parameters: - name: model_id in: path description: The ID of the model to delete. required: true schema: type: string examples: - ft:open-mistral-7b:587a6b29:20240514:7e773925 title: Model Id description: The ID of the model to delete. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DeleteModelResponse' examples: userExample: value: id: ft:open-mistral-7b:587a6b29:20240514:7e773925 object: model deleted: true '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/conversations: post: operationId: agents_api_v1_conversations_start summary: Create a conversation and append entries to it. description: Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. tags: - beta.conversations requestBody: content: application/json: schema: $ref: '#/components/schemas/ConversationRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConversationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: operationId: agents_api_v1_conversations_list summary: List all created conversations. description: Retrieve a list of conversation entities sorted by creation time. tags: - beta.conversations parameters: - name: page in: query required: false schema: type: integer title: Page default: 0 - name: page_size in: query required: false schema: type: integer title: Page Size default: 100 - name: metadata in: query required: false content: application/json: schema: anyOf: - type: object additionalProperties: true - type: 'null' title: Metadata responses: '200': description: Successful Response content: application/json: schema: type: array items: anyOf: - $ref: '#/components/schemas/ModelConversation' - $ref: '#/components/schemas/AgentConversation' title: Response V1 Conversations List '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/conversations/{conversation_id}: get: operationId: agents_api_v1_conversations_get summary: Retrieve a conversation information. description: Given a conversation_id retrieve a conversation entity with its attributes. tags: - beta.conversations parameters: - name: conversation_id in: path description: ID of the conversation from which we are fetching metadata. required: true schema: type: string title: Conversation Id description: ID of the conversation from which we are fetching metadata. responses: '200': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/ModelConversation' - $ref: '#/components/schemas/AgentConversation' title: Response V1 Conversations Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: operationId: agents_api_v1_conversations_delete summary: Delete a conversation. description: Delete a conversation given a conversation_id. tags: - beta.conversations parameters: - name: conversation_id in: path description: ID of the conversation from which we are fetching metadata. required: true schema: type: string title: Conversation Id description: ID of the conversation from which we are fetching metadata. responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: operationId: agents_api_v1_conversations_append summary: Append new entries to an existing conversation. description: Run completion on the history of the conversation and the user entries. Return the new created entries. tags: - beta.conversations parameters: - name: conversation_id in: path description: ID of the conversation to which we append entries. required: true schema: type: string title: Conversation Id description: ID of the conversation to which we append entries. requestBody: content: application/json: schema: $ref: '#/components/schemas/ConversationAppendRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConversationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/conversations/{conversation_id}/history: get: operationId: agents_api_v1_conversations_history summary: Retrieve all entries in a conversation. description: Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call. tags: - beta.conversations parameters: - name: conversation_id in: path description: ID of the conversation from which we are fetching entries. required: true schema: type: string title: Conversation Id description: ID of the conversation from which we are fetching entries. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConversationHistory' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/conversations/{conversation_id}/messages: get: operationId: agents_api_v1_conversations_messages summary: Retrieve all messages in a conversation. description: Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only. tags: - beta.conversations parameters: - name: conversation_id in: path description: ID of the conversation from which we are fetching messages. required: true schema: type: string title: Conversation Id description: ID of the conversation from which we are fetching messages. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConversationMessages' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/conversations/{conversation_id}/restart: post: operationId: agents_api_v1_conversations_restart summary: Restart a conversation starting from a given entry. description: Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. tags: - beta.conversations parameters: - name: conversation_id in: path description: ID of the original conversation which is being restarted. required: true schema: type: string title: Conversation Id description: ID of the original conversation which is being restarted. requestBody: content: application/json: schema: $ref: '#/components/schemas/ConversationRestartRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConversationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/agents: post: operationId: agents_api_v1_agents_create summary: Create a agent that can be used within a conversation. description: Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used. tags: - beta.agents requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAgentRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Agent' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: operationId: agents_api_v1_agents_list summary: List agent entities. description: 'Retrieve a list of agent entities sorted by creation time. Deprecated: some features such as agent sharing are not supported by this endpoint. Use the cursor-paginated `GET /v1/agents/pages` instead.' tags: - beta.agents parameters: - name: page in: query description: Page number (0-indexed) required: false schema: type: integer title: Page minimum: 0 description: Page number (0-indexed) default: 0 - name: page_size in: query description: Number of agents per page required: false schema: type: integer title: Page Size maximum: 1000 minimum: 1 description: Number of agents per page default: 20 - name: deployment_chat in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Deployment Chat - name: sources in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/RequestSource' - type: 'null' title: Sources - name: name in: query description: Filter by agent name required: false schema: anyOf: - type: string - type: 'null' title: Name description: Filter by agent name - name: search in: query description: Search agents by name or ID required: false schema: anyOf: - type: string - type: 'null' title: Search description: Search agents by name or ID - name: id in: query required: false schema: anyOf: - type: string - type: 'null' title: Id - name: metadata in: query required: false content: application/json: schema: anyOf: - type: object additionalProperties: true - type: 'null' title: Metadata responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/Agent' title: Response V1 Agents List '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true x-speakeasy-deprecation-message: Some features such as agent sharing are not supported by this endpoint. x-speakeasy-deprecation-replacement: agents_api_v1_agents_list_pages /v1/agents/pages: get: operationId: agents_api_v1_agents_list_pages summary: List agent entities, cursor-paginated. description: Retrieve a page of agent entities. Unlike the deprecated `GET /v1/agents`, this endpoint paginates by opaque cursor and honors per-agent sharing, returning only agents the caller is authorized to see. tags: - beta.agents parameters: - name: page_size in: query description: Number of agents per page required: false schema: type: integer title: Page Size maximum: 1000 minimum: 1 description: Number of agents per page default: 20 - name: deployment_chat in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Deployment Chat - name: sources in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/RequestSource' - type: 'null' title: Sources - name: name in: query description: Filter by agent name required: false schema: anyOf: - type: string - type: 'null' title: Name description: Filter by agent name - name: search in: query description: Search agents by name or ID required: false schema: anyOf: - type: string - type: 'null' title: Search description: Search agents by name or ID - name: id in: query required: false schema: anyOf: - type: string - type: 'null' title: Id - name: metadata in: query required: false content: application/json: schema: anyOf: - type: object additionalProperties: true - type: 'null' title: Metadata - name: page_token in: query description: Opaque cursor from a previous response's next_page_token. When set, results page forward from the cursor. required: false schema: anyOf: - type: string - type: 'null' title: Page Token description: Opaque cursor from a previous response's next_page_token. When set, results page forward from the cursor. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AgentListPage' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-speakeasy-pagination: type: cursor inputs: - name: page_token in: parameters type: cursor - name: page_size in: parameters type: limit outputs: results: $.data nextCursor: $.next_page_token /v1/agents/{agent_id}: get: operationId: agents_api_v1_agents_get summary: Retrieve an agent entity. description: Given an agent, retrieve an agent entity with its attributes. The agent_version parameter can be an integer version number or a string alias. tags: - beta.agents parameters: - name: agent_id in: path required: true schema: type: string title: Agent Id - name: agent_version in: query required: false schema: anyOf: - type: integer - type: string - type: 'null' title: Agent Version responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Agent' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: operationId: agents_api_v1_agents_update summary: Update an agent entity. description: Update an agent attributes and create a new version. tags: - beta.agents parameters: - name: agent_id in: path required: true schema: type: string title: Agent Id requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAgentRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Agent' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: operationId: agents_api_v1_agents_delete summary: Delete an agent entity. tags: - beta.agents parameters: - name: agent_id in: path required: true schema: type: string title: Agent Id responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Delete an agent entity. /v1/agents/{agent_id}/version: patch: operationId: agents_api_v1_agents_update_version summary: Update an agent version. description: Switch the version of an agent. tags: - beta.agents parameters: - name: agent_id in: path required: true schema: type: string title: Agent Id - name: version in: query required: true schema: type: integer title: Version responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Agent' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/agents/{agent_id}/versions: get: operationId: agents_api_v1_agents_list_versions summary: List all versions of an agent. description: Retrieve all versions for a specific agent with full agent context. Supports pagination. tags: - beta.agents parameters: - name: agent_id in: path required: true schema: type: string title: Agent Id - name: page in: query description: Page number (0-indexed) required: false schema: type: integer title: Page minimum: 0 description: Page number (0-indexed) default: 0 - name: page_size in: query description: Number of versions per page required: false schema: type: integer title: Page Size maximum: 100 minimum: 1 description: Number of versions per page default: 20 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/Agent' title: Response V1 Agents List Versions '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/agents/{agent_id}/versions/{version}: get: operationId: agents_api_v1_agents_get_version summary: Retrieve a specific version of an agent. description: Get a specific agent version by version number. tags: - beta.agents parameters: - name: agent_id in: path required: true schema: type: string title: Agent Id - name: version in: path required: true schema: type: string title: Version responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Agent' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/agents/{agent_id}/aliases: put: operationId: agents_api_v1_agents_create_or_update_alias summary: Create or update an agent version alias. description: Create a new alias or update an existing alias to point to a specific version. Aliases are unique per agent and can be reassigned to different versions. tags: - beta.agents parameters: - name: agent_id in: path required: true schema: type: string title: Agent Id - name: alias in: query required: true schema: type: string title: Alias maxLength: 64 minLength: 1 pattern: ^[a-z]([a-z0-9_-]*[a-z0-9])?$ - name: version in: query required: true schema: type: integer title: Version responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AgentAliasResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: operationId: agents_api_v1_agents_list_version_aliases summary: List all aliases for an agent. description: Retrieve all version aliases for a specific agent. tags: - beta.agents parameters: - name: agent_id in: path required: true schema: type: string title: Agent Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AgentAliasResponse' title: Response V1 Agents List Version Aliases '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: operationId: agents_api_v1_agents_delete_alias summary: Delete an agent version alias. description: Delete an existing alias for an agent. tags: - beta.agents parameters: - name: agent_id in: path required: true schema: type: string title: Agent Id - name: alias in: query required: true schema: type: string title: Alias maxLength: 64 minLength: 1 pattern: ^[a-z]([a-z0-9_-]*[a-z0-9])?$ responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/conversations#stream: post: operationId: agents_api_v1_conversations_start_stream summary: Create a conversation and append entries to it. description: Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation. tags: - beta.conversations requestBody: content: application/json: schema: $ref: '#/components/schemas/ConversationStreamRequest' required: true responses: '200': description: Successful Response content: text/event-stream: schema: $ref: '#/components/schemas/ConversationEvents' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/conversations/{conversation_id}#stream: post: operationId: agents_api_v1_conversations_append_stream summary: Append new entries to an existing conversation. description: Run completion on the history of the conversation and the user entries. Return the new created entries. tags: - beta.conversations parameters: - name: conversation_id in: path description: ID of the conversation to which we append entries. required: true schema: type: string title: Conversation Id description: ID of the conversation to which we append entries. requestBody: content: application/json: schema: $ref: '#/components/schemas/ConversationAppendStreamRequest' required: true responses: '200': description: Successful Response content: text/event-stream: schema: $ref: '#/components/schemas/ConversationEvents' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/conversations/{conversation_id}/restart#stream: post: operationId: agents_api_v1_conversations_restart_stream summary: Restart a conversation starting from a given entry. description: Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned. tags: - beta.conversations parameters: - name: conversation_id in: path description: ID of the original conversation which is being restarted. required: true schema: type: string title: Conversation Id description: ID of the original conversation which is being restarted. requestBody: content: application/json: schema: $ref: '#/components/schemas/ConversationRestartStreamRequest' required: true responses: '200': description: Successful Response content: text/event-stream: schema: $ref: '#/components/schemas/ConversationEvents' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/files: post: operationId: files_api_routes_upload_file summary: Upload File description: 'Upload a file that can be used across various endpoints. The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. Please contact us if you need to increase these storage limits.' tags: - files parameters: [] requestBody: content: multipart/form-data: schema: type: object properties: expiry: anyOf: - type: integer - type: 'null' title: Expiry visibility: allOf: - type: string title: FileVisibility enum: - workspace - user default: workspace purpose: $ref: '#/components/schemas/FilePurpose' file: $ref: '#/components/schemas/File' title: MultiPartBodyParams required: - file required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateFileResponse' examples: userExample: value: id: e85980c9-409e-4a46-9304-36588f6292b0 object: file bytes: null created_at: 1759500189 filename: example.file.jsonl purpose: fine-tune sample_type: instruct source: upload num_lines: 2 mimetype: application/jsonl signature: d4821d2de1917341 get: operationId: files_api_routes_list_files summary: List Files description: Returns a list of files that belong to the user's organization. tags: - files parameters: - name: page in: query required: false schema: type: integer title: Page default: 0 - name: page_size in: query required: false schema: type: integer title: Page Size default: 100 - name: include_total in: query required: false schema: type: boolean title: Include Total default: true - name: sample_type in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/SampleType' - type: 'null' title: Sample Type - name: source in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/Source' - type: 'null' title: Source - name: search in: query required: false schema: anyOf: - type: string - type: 'null' title: Search - name: purpose in: query required: false schema: anyOf: - $ref: '#/components/schemas/FilePurpose' - type: 'null' - name: mimetypes in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Mimetypes responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListFilesResponse' examples: userExample: value: data: - id: object: file bytes: null created_at: 1759491994 filename: purpose: batch sample_type: batch_result source: mistral num_lines: 2 mimetype: application/jsonl signature: null - id: object: file bytes: null created_at: 1759491994 filename: purpose: batch sample_type: batch_result source: mistral num_lines: 2 mimetype: application/jsonl signature: null object: list total: 2 /v1/files/{file_id}: get: operationId: files_api_routes_retrieve_file summary: Retrieve File description: Returns information about a specific file. tags: - files parameters: - name: file_id in: path required: true schema: type: string title: File Id format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetFileResponse' examples: userExample: value: id: e85980c9-409e-4a46-9304-36588f6292b0 object: file bytes: null created_at: 1759500189 filename: example.file.jsonl purpose: fine-tune sample_type: instruct source: upload deleted: false num_lines: 2 mimetype: application/jsonl signature: d4821d2de1917341 delete: operationId: files_api_routes_delete_file summary: Delete File description: Delete a file. tags: - files parameters: - name: file_id in: path required: true schema: type: string title: File Id format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteFileResponse' examples: userExample: value: id: e85980c9-409e-4a46-9304-36588f6292b0 object: file deleted: true /v1/files/{file_id}/content: get: operationId: files_api_routes_download_file summary: Download File description: Download a file tags: - files parameters: - name: file_id in: path required: true schema: type: string title: File Id format: uuid responses: '200': description: OK content: application/octet-stream: schema: type: string format: binary /v1/files/{file_id}/url: get: operationId: files_api_routes_get_signed_url summary: Get Signed Url tags: - files parameters: - name: file_id in: path required: true schema: type: string title: File Id format: uuid - name: expiry in: query description: Number of hours before the URL becomes invalid. Defaults to 24h. Must be between 1h and 168h. required: false schema: type: integer title: Expiry description: Number of hours before the URL becomes invalid. Defaults to 24h. Must be between 1h and 168h. default: 24 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetSignedUrlResponse' examples: userExample: value: url: https://mistralaifilesapiprodswe.blob.core.windows.net/fine-tune/.../.../e85980c9409e4a46930436588f6292b0.jsonl?se=2025-10-04T14%3A16%3A17Z&sp=r&sv=2025-01-05&sr=b&sig=... description: Get Signed Url /v1/fine_tuning/models/{model_id}: patch: operationId: jobs_api_routes_fine_tuning_update_fine_tuned_model summary: Update Fine Tuned Model description: Update a model name or description. tags: - models parameters: - name: model_id in: path description: The ID of the model to update. required: true schema: type: string title: Model Id description: The ID of the model to update. example: ft:open-mistral-7b:587a6b29:20240514:7e773925 example: ft:open-mistral-7b:587a6b29:20240514:7e773925 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateModelRequest' required: true responses: '200': description: OK content: application/json: schema: oneOf: - $ref: '#/components/schemas/CompletionFineTunedModel' - $ref: '#/components/schemas/ClassifierFineTunedModel' discriminator: propertyName: model_type mapping: classifier: '#/components/schemas/ClassifierFineTunedModel' completion: '#/components/schemas/CompletionFineTunedModel' title: Response /v1/fine_tuning/models/{model_id}/archive: post: operationId: jobs_api_routes_fine_tuning_archive_fine_tuned_model summary: Archive Fine Tuned Model description: Archive a fine-tuned model. tags: - models parameters: - name: model_id in: path description: The ID of the model to archive. required: true schema: type: string title: Model Id description: The ID of the model to archive. example: ft:open-mistral-7b:587a6b29:20240514:7e773925 example: ft:open-mistral-7b:587a6b29:20240514:7e773925 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArchiveModelResponse' delete: operationId: jobs_api_routes_fine_tuning_unarchive_fine_tuned_model summary: Unarchive Fine Tuned Model description: Un-archive a fine-tuned model. tags: - models parameters: - name: model_id in: path description: The ID of the model to unarchive. required: true schema: type: string title: Model Id description: The ID of the model to unarchive. example: ft:open-mistral-7b:587a6b29:20240514:7e773925 example: ft:open-mistral-7b:587a6b29:20240514:7e773925 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UnarchiveModelResponse' /v1/batch/jobs: get: operationId: jobs_api_routes_batch_get_batch_jobs summary: Get Batch Jobs description: Get a list of batch jobs for your organization and user. tags: - batch parameters: - name: page in: query required: false schema: type: integer title: Page default: 0 - name: page_size in: query required: false schema: type: integer title: Page Size default: 100 - name: model in: query required: false schema: anyOf: - type: string - type: 'null' title: Model - name: agent_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Agent Id - name: metadata in: query required: false schema: anyOf: - type: object additionalProperties: true - type: 'null' title: Metadata - name: created_after in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created After - name: created_by_me in: query required: false schema: type: boolean title: Created By Me default: false - name: status in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/BatchJobStatus' - type: 'null' title: Status - name: order_by in: query required: false schema: type: string title: Order By enum: - created - -created default: -created responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListBatchJobsResponse' post: operationId: jobs_api_routes_batch_create_batch_job summary: Create Batch Job description: Create a new batch job, it will be queued for processing. tags: - batch parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBatchJobRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BatchJob' /v1/batch/jobs/{job_id}: get: operationId: jobs_api_routes_batch_get_batch_job summary: Get Batch Job description: "Get a batch job details by its UUID.\n\nArgs:\n inline: If True, return results inline in the response." tags: - batch parameters: - name: job_id in: path required: true schema: type: string title: Job Id format: uuid - name: inline in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Inline responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BatchJob' delete: operationId: jobs_api_routes_batch_delete_batch_job summary: Delete Batch Job description: Request the deletion of a batch job. tags: - batch parameters: - name: job_id in: path required: true schema: type: string title: Job Id format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteBatchJobResponse' /v1/batch/jobs/{job_id}/cancel: post: operationId: jobs_api_routes_batch_cancel_batch_job summary: Cancel Batch Job description: Request the cancellation of a batch job. tags: - batch parameters: - name: job_id in: path required: true schema: type: string title: Job Id format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BatchJob' /v1/chat/completions: post: operationId: chat_completion_v1_chat_completions_post summary: Chat Completion tags: - chat requestBody: content: application/json: schema: $ref: '#/components/schemas/ChatCompletionRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ChatCompletionResponse' text/event-stream: schema: $ref: '#/components/schemas/CompletionEvent' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Chat Completion /v1/fim/completions: post: operationId: fim_completion_v1_fim_completions_post summary: Fim Completion description: FIM completion. tags: - fim requestBody: content: application/json: schema: $ref: '#/components/schemas/FIMCompletionRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FIMCompletionResponse' examples: userExample: value: id: 447e3e0d457e42e98248b5d2ef52a2a3 object: chat.completion model: codestral-2508 usage: prompt_tokens: 8 completion_tokens: 91 total_tokens: 99 created: 1759496862 choices: - index: 0 message: content: "add_numbers(a: int, b: int) -> int:\n \"\"\"\n You are given two integers `a` and `b`. Your task is to write a function that\n returns the sum of these two integers. The function should be implemented in a\n way that it can handle very large integers (up to 10^18). As a reminder, your\n code has to be in python\n \"\"\"\n" tool_calls: null prefix: false role: assistant finish_reason: stop text/event-stream: schema: $ref: '#/components/schemas/CompletionEvent' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/agents/completions: post: operationId: agents_completion_v1_agents_completions_post summary: Agents Completion tags: - agents requestBody: content: application/json: schema: $ref: '#/components/schemas/AgentsCompletionRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ChatCompletionResponse' examples: userExample: value: id: cf79f7daaee244b1a0ae5c7b1444424a object: chat.completion model: mistral-medium-latest usage: prompt_tokens: 24 completion_tokens: 27 total_tokens: 51 prompt_audio_seconds: {} created: 1759500534 choices: - index: 0 message: content: Arrr, the scallywag Claude Monet be the finest French painter to ever splash colors on a canvas, savvy? tool_calls: null prefix: false role: assistant finish_reason: stop '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Agents Completion /v1/embeddings: post: operationId: embeddings_v1_embeddings_post summary: Embeddings description: Embeddings tags: - embeddings requestBody: content: application/json: schema: $ref: '#/components/schemas/EmbeddingRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EmbeddingResponse' examples: userExample: value: data: - embedding: - -0.016632080078125 - 0.0701904296875 - 0.03143310546875 - 0.01309967041015625 - 0.0202789306640625 index: 0 object: embedding - embedding: - -0.0230560302734375 - 0.039337158203125 - 0.0521240234375 - -0.0184783935546875 - 0.034271240234375 index: 1 object: embedding model: mistral-embed object: list usage: prompt_tokens: 15 completion_tokens: 0 total_tokens: 15 prompt_audio_seconds: null '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/moderations: post: operationId: moderations_v1_moderations_post summary: Moderations tags: - classifiers requestBody: content: application/json: schema: $ref: '#/components/schemas/ClassificationRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ModerationResponse' examples: userExample: value: id: 4d71ae510af942108ef7344f903e2b88 model: mistral-moderation-latest results: - categories: sexual: false hate_and_discrimination: false violence_and_threats: false dangerous_and_criminal_content: false selfharm: false health: false financial: false law: false pii: false category_scores: sexual: 0.0011335690505802631 hate_and_discrimination: 0.0030753696337342262 violence_and_threats: 0.0003569706459529698 dangerous_and_criminal_content: 0.002251847181469202 selfharm: 0.00017952796770259738 health: 0.0002780309587251395 financial: 8.481103577651083e-05 law: 4.539786823443137e-05 pii: 0.0023967307060956955 - categories: sexual: false hate_and_discrimination: false violence_and_threats: false dangerous_and_criminal_content: false selfharm: false health: false financial: false law: false pii: false category_scores: sexual: 0.000626334105618298 hate_and_discrimination: 0.0013670255430042744 violence_and_threats: 0.0002611903182696551 dangerous_and_criminal_content: 0.0030753696337342262 selfharm: 0.00010889690747717395 health: 0.00015843621804378927 financial: 0.000191104321856983 law: 4.006369272246957e-05 pii: 0.0035936026833951473 '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Moderations /v1/chat/moderations: post: operationId: chat_moderations_v1_chat_moderations_post summary: Chat Moderations tags: - classifiers requestBody: content: application/json: schema: $ref: '#/components/schemas/ChatModerationRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ModerationResponse' examples: userExample: value: id: 352bce1a55814127a3b0bc4fb8f02a35 model: mistral-moderation-latest results: - categories: sexual: false hate_and_discrimination: false violence_and_threats: false dangerous_and_criminal_content: false selfharm: false health: false financial: false law: false pii: false category_scores: sexual: 0.0010322310263291001 hate_and_discrimination: 0.001597845577634871 violence_and_threats: 0.00020342698553577065 dangerous_and_criminal_content: 0.0029810327105224133 selfharm: 0.00017952796770259738 health: 0.0002959570847451687 financial: 7.9673009167891e-05 law: 4.539786823443137e-05 pii: 0.004198795650154352 '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Chat Moderations /v1/ocr: post: operationId: ocr_v1_ocr_post summary: OCR tags: - ocr requestBody: content: application/json: schema: $ref: '#/components/schemas/OCRRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OCRResponse' examples: userExample: value: pages: - index: 1 markdown: '# LEVERAGING UNLABELED DATA TO PREDICT OUT-OF-DISTRIBUTION PERFORMANCE Saurabh Garg*
Carnegie Mellon University
sgarg2@andrew.cmu.edu
Sivaraman Balakrishnan
Carnegie Mellon University
sbalakri@andrew.cmu.edu
Zachary C. Lipton
Carnegie Mellon University
zlipton@andrew.cmu.edu ## Behnam Neyshabur Google Research, Blueshift team
neyshabur@google.com Hanie Sedghi
Google Research, Brain team
hsedghi@google.com #### Abstract Real-world machine learning deployments are characterized by mismatches between the source (training) and target (test) distributions that may cause performance drops. In this work, we investigate methods for predicting the target domain accuracy using only labeled source data and unlabeled target data. We propose Average Thresholded Confidence (ATC), a practical method that learns a threshold on the model''s confidence, predicting accuracy as the fraction of unlabeled examples for which model confidence exceeds that threshold. ATC outperforms previous methods across several model architectures, types of distribution shifts (e.g., due to synthetic corruptions, dataset reproduction, or novel subpopulations), and datasets (WILDS, ImageNet, BREEDS, CIFAR, and MNIST). In our experiments, ATC estimates target performance $2-4 \times$ more accurately than prior methods. We also explore the theoretical foundations of the problem, proving that, in general, identifying the accuracy is just as hard as identifying the optimal predictor and thus, the efficacy of any method rests upon (perhaps unstated) assumptions on the nature of the shift. Finally, analyzing our method on some toy distributions, we provide insights concerning when it works ${ }^{1}$. ## 1 INTRODUCTION Machine learning models deployed in the real world typically encounter examples from previously unseen distributions. While the IID assumption enables us to evaluate models using held-out data from the source distribution (from which training data is sampled), this estimate is no longer valid in presence of a distribution shift. Moreover, under such shifts, model accuracy tends to degrade (Szegedy et al., 2014; Recht et al., 2019; Koh et al., 2021). Commonly, the only data available to the practitioner are a labeled training set (source) and unlabeled deployment-time data which makes the problem more difficult. In this setting, detecting shifts in the distribution of covariates is known to be possible (but difficult) in theory (Ramdas et al., 2015), and in practice (Rabanser et al., 2018). However, producing an optimal predictor using only labeled source and unlabeled target data is well-known to be impossible absent further assumptions (Ben-David et al., 2010; Lipton et al., 2018). Two vital questions that remain are: (i) the precise conditions under which we can estimate a classifier''s target-domain accuracy; and (ii) which methods are most practically useful. To begin, the straightforward way to assess the performance of a model under distribution shift would be to collect labeled (target domain) examples and then to evaluate the model on that data. However, collecting fresh labeled data from the target distribution is prohibitively expensive and time-consuming, especially if the target distribution is non-stationary. Hence, instead of using labeled data, we aim to use unlabeled data from the target distribution, that is comparatively abundant, to predict model performance. Note that in this work, our focus is not to improve performance on the target but, rather, to estimate the accuracy on the target for a given classifier. [^0]: Work done in part while Saurabh Garg was interning at Google ${ }^{1}$ Code is available at [https://github.com/saurabhgarg1996/ATC_code](https://github.com/saurabhgarg1996/ATC_code). ' images: [] dimensions: dpi: 200 height: 2200 width: 1700 - index: 2 markdown: '![img-0.jpeg](img-0.jpeg) Figure 1: Illustration of our proposed method ATC. Left: using source domain validation data, we identify a threshold on a score (e.g. negative entropy) computed on model confidence such that fraction of examples above the threshold matches the validation set accuracy. ATC estimates accuracy on unlabeled target data as the fraction of examples with the score above the threshold. Interestingly, this threshold yields accurate estimates on a wide set of target distributions resulting from natural and synthetic shifts. Right: Efficacy of ATC over previously proposed approaches on our testbed with a post-hoc calibrated model. To obtain errors on the same scale, we rescale all errors with Average Confidence (AC) error. Lower estimation error is better. See Table 1 for exact numbers and comparison on various types of distribution shift. See Sec. 5 for details on our testbed. Recently, numerous methods have been proposed for this purpose (Deng & Zheng, 2021; Chen et al., 2021b; Jiang et al., 2021; Deng et al., 2021; Guillory et al., 2021). These methods either require calibration on the target domain to yield consistent estimates (Jiang et al., 2021; Guillory et al., 2021) or additional labeled data from several target domains to learn a linear regression function on a distributional distance that then predicts model performance (Deng et al., 2021; Deng & Zheng, 2021; Guillory et al., 2021). However, methods that require calibration on the target domain typically yield poor estimates since deep models trained and calibrated on source data are not, in general, calibrated on a (previously unseen) target domain (Ovadia et al., 2019). Besides, methods that leverage labeled data from target domains rely on the fact that unseen target domains exhibit strong linear correlation with seen target domains on the underlying distance measure and, hence, can be rendered ineffective when such target domains with labeled data are unavailable (in Sec. 5.1 we demonstrate such a failure on a real-world distribution shift problem). Therefore, throughout the paper, we assume access to labeled source data and only unlabeled data from target domain(s). In this work, we first show that absent assumptions on the source classifier or the nature of the shift, no method of estimating accuracy will work generally (even in non-contrived settings). To estimate accuracy on target domain perfectly, we highlight that even given perfect knowledge of the labeled source distribution (i.e., $p_{s}(x, y)$ ) and unlabeled target distribution (i.e., $p_{t}(x)$ ), we need restrictions on the nature of the shift such that we can uniquely identify the target conditional $p_{t}(y \mid x)$. Thus, in general, identifying the accuracy of the classifier is as hard as identifying the optimal predictor. Second, motivated by the superiority of methods that use maximum softmax probability (or logit) of a model for Out-Of-Distribution (OOD) detection (Hendrycks & Gimpel, 2016; Hendrycks et al., 2019), we propose a simple method that leverages softmax probability to predict model performance. Our method, Average Thresholded Confidence (ATC), learns a threshold on a score (e.g., maximum confidence or negative entropy) of model confidence on validation source data and predicts target domain accuracy as the fraction of unlabeled target points that receive a score above that threshold. ATC selects a threshold on validation source data such that the fraction of source examples that receive the score above the threshold match the accuracy of those examples. Our primary contribution in ATC is the proposal of obtaining the threshold and observing its efficacy on (practical) accuracy estimation. Importantly, our work takes a step forward in positively answering the question raised in Deng & Zheng (2021); Deng et al. (2021) about a practical strategy to select a threshold that enables accuracy prediction with thresholded model confidence. ' images: - id: img-0.jpeg top_left_x: 292 top_left_y: 217 bottom_right_x: 1405 bottom_right_y: 649 image_base64: '...' dimensions: dpi: 200 height: 2200 width: 1700 - index: 3 markdown: '...' images: [] dimensions: {} - index: 27 markdown: '![img-8.jpeg](img-8.jpeg) Figure 9: Scatter plot of predicted accuracy versus (true) OOD accuracy for vision datasets except MNIST with a ResNet50 model. Results reported by aggregating MAE numbers over 4 different seeds. ' images: - id: img-8.jpeg top_left_x: 290 top_left_y: 226 bottom_right_x: 1405 bottom_right_y: 1834 image_base64: '...' dimensions: dpi: 200 height: 2200 width: 1700 - index: 28 markdown: '| Dataset | Shift | IM | | AC | | DOC | | GDE | ATC-MC (Ours) | | ATC-NE (Ours) | | | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | | | | Pre T | Post T | Pre T | Post T | Pre T | Post T | Post T | Pre T | Post T | Pre T | Post T | | CIFAR10 | Natural | 6.60 | 5.74 | 9.88 | 6.89 | 7.25 | 6.07 | 4.77 | 3.21 | 3.02 | 2.99 | 2.85 | | | | (0.35) | (0.30) | (0.16) | (0.13) | (0.15) | (0.16) | (0.13) | (0.49) | (0.40) | (0.37) | (0.29) | | | Synthetic | 12.33 | 10.20 | 16.50 | 11.91 | 13.87 | 11.08 | 6.55 | 4.65 | 4.25 | 4.21 | 3.87 | | | | (0.51) | (0.48) | (0.26) | (0.17) | (0.18) | (0.17) | (0.35) | (0.55) | (0.55) | (0.55) | (0.75) | | CIFAR100 | Synthetic | 13.69 | 11.51 | 23.61 | 13.10 | 14.60 | 10.14 | 9.85 | 5.50 | 4.75 | 4.72 | 4.94 | | | | (0.55) | (0.41) | (1.16) | (0.80) | (0.77) | (0.64) | (0.57) | (0.70) | (0.73) | (0.74) | (0.74) | | ImageNet200 | Natural | 12.37 | 8.19 | 22.07 | 8.61 | 15.17 | 7.81 | 5.13 | 4.37 | 2.04 | 3.79 | 1.45 | | | | (0.25) | (0.33) | (0.08) | (0.25) | (0.11) | (0.29) | (0.08) | (0.39) | (0.24) | (0.30) | (0.27) | | | Synthetic | 19.86 | 12.94 | 32.44 | 13.35 | 25.02 | 12.38 | 5.41 | 5.93 | 3.09 | 5.00 | 2.68 | | | | (1.38) | (1.81) | (1.00) | (1.30) | (1.10) | (1.38) | (0.89) | (1.38) | (0.87) | (1.28) | (0.45) | | ImageNet | Natural | 7.77 | 6.50 | 18.13 | 6.02 | 8.13 | 5.76 | 6.23 | 3.88 | 2.17 | 2.06 | 0.80 | | | | (0.27) | (0.33) | (0.23) | (0.34) | (0.27) | (0.37) | (0.41) | (0.53) | (0.62) | (0.54) | (0.44) | | | Synthetic | 13.39 | 10.12 | 24.62 | 8.51 | 13.55 | 7.90 | 6.32 | 3.34 | 2.53 | 2.61 | 4.89 | | | | (0.53) | (0.63) | (0.64) | (0.71) | (0.61) | (0.72) | (0.33) | (0.53) | (0.36) | (0.33) | (0.83) | | FMoW-WILDS | Natural | 5.53 | 4.31 | 33.53 | 12.84 | 5.94 | 4.45 | 5.74 | 3.06 | 2.70 | 3.02 | 2.72 | | | | (0.33) | (0.63) | (0.13) | (12.06) | (0.36) | (0.77) | (0.55) | (0.36) | (0.54) | (0.35) | (0.44) | | RxRx1-WILDS | Natural | 5.80 | 5.72 | 7.90 | 4.84 | 5.98 | 5.98 | 6.03 | 4.66 | 4.56 | 4.41 | 4.47 | | | | (0.17) | (0.15) | (0.24) | (0.09) | (0.15) | (0.13) | (0.08) | (0.38) | (0.38) | (0.31) | (0.26) | | Amazon-WILDS | Natural | 2.40 | 2.29 | 8.01 | 2.38 | 2.40 | 2.28 | 17.87 | 1.65 | 1.62 | 1.60 | 1.59 | | | | (0.08) | (0.09) | (0.53) | (0.17) | (0.09) | (0.09) | (0.18) | (0.06) | (0.05) | (0.14) | (0.15) | | CivilCom.-WILDS | Natural | 12.64 | 10.80 | 16.76 | 11.03 | 13.31 | 10.99 | 16.65 | | 7.14 | | | | | | (0.52) | (0.48) | (0.53) | (0.49) | (0.52) | (0.49) | (0.25) | | (0.41) | | | | MNIST | Natural | 18.48 | 15.99 | 21.17 | 14.81 | 20.19 | 14.56 | 24.42 | 5.02 | 2.40 | 3.14 | 3.50 | | | | (0.45) | (1.53) | (0.24) | (3.89) | (0.23) | (3.47) | (0.41) | (0.44) | (1.83) | (0.49) | (0.17) | | ENTITY-13 | Same | 16.23 | 11.14 | 24.97 | 10.88 | 19.08 | 10.47 | 10.71 | 5.39 | 3.88 | 4.58 | 4.19 | | | | (0.77) | (0.65) | (0.70) | (0.77) | (0.65) | (0.72) | (0.74) | (0.92) | (0.61) | (0.85) | (0.16) | | | Novel | 28.53 | 22.02 | 38.33 | 21.64 | 32.43 | 21.22 | 20.61 | 13.58 | 10.28 | 12.25 | 6.63 | | | | (0.82) | (0.68) | (0.75) | (0.86) | (0.69) | (0.80) | (0.60) | (1.15) | (1.34) | (1.21) | (0.93) | | ENTITY-30 | Same | 18.59 | 14.46 | 28.82 | 14.30 | 21.63 | 13.46 | 12.92 | 9.12 | 7.75 | 8.15 | 7.64 | | | | (0.51) | (0.52) | (0.43) | (0.71) | (0.37) | (0.59) | (0.14) | (0.62) | (0.72) | (0.68) | (0.88) | | | Novel | 32.34 | 26.85 | 44.02 | 26.27 | 36.82 | 25.42 | 23.16 | 17.75 | 14.30 | 15.60 | 10.57 | | | | (0.60) | (0.58) | (0.56) | (0.79) | (0.47) | (0.68) | (0.12) | (0.76) | (0.85) | (0.86) | (0.86) | | NONLIVING-26 | Same | 18.66 | 17.17 | 26.39 | 16.14 | 19.86 | 15.58 | 16.63 | 10.87 | 10.24 | 10.07 | 10.26 | | | | (0.76) | (0.74) | (0.82) | (0.81) | (0.67) | (0.76) | (0.45) | (0.98) | (0.83) | (0.92) | (1.18) | | | Novel | 33.43 | 31.53 | 41.66 | 29.87 | 35.13 | 29.31 | 29.56 | 21.70 | 20.12 | 19.08 | 18.26 | | | | (0.67) | (0.65) | (0.67) | (0.71) | (0.54) | (0.64) | (0.21) | (0.86) | (0.75) | (0.82) | (1.12) | | LIVING-17 | Same | 12.63 | 11.05 | 18.32 | 10.46 | 14.43 | 10.14 | 9.87 | 4.57 | 3.95 | 3.81 | 4.21 | | | | (1.25) | (1.20) | (1.01) | (1.12) | (1.11) | (1.16) | (0.61) | (0.71) | (0.48) | (0.22) | (0.53) | | | Novel | 29.03 | 26.96 | 35.67 | 26.11 | 31.73 | 25.73 | 23.53 | 16.15 | 14.49 | 12.97 | 11.39 | | | | (1.44) | (1.38) | (1.09) | (1.27) | (1.19) | (1.35) | (0.52) | (1.36) | (1.46) | (1.52) | (1.72) | Table 3: Mean Absolute estimation Error (MAE) results for different datasets in our setup grouped by the nature of shift. ''Same'' refers to same subpopulation shifts and ''Novel'' refers novel subpopulation shifts. We include details about the target sets considered in each shift in Table 2. Post T denotes use of TS calibration on source. For language datasets, we use DistilBERT-base-uncased, for vision dataset we report results with DenseNet model with the exception of MNIST where we use FCN. Across all datasets, we observe that ATC achieves superior performance (lower MAE is better). For GDE post T and pre T estimates match since TS doesn''t alter the argmax prediction. Results reported by aggregating MAE numbers over 4 different seeds. Values in parenthesis (i.e., $(\cdot)$ ) denote standard deviation values. ' images: [] dimensions: dpi: 200 height: 2200 width: 1700 - index: 29 markdown: '| Dataset | Shift | IM | | AC | | DOC | | GDE | ATC-MC (Ours) | | ATC-NE (Ours) | | | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | | | | Pre T | Post T | Pre T | Post T | Pre T | Post T | Post T | Pre T | Post T | Pre T | Post T | | CIFAR10 | Natural | 7.14 | 6.20 | 10.25 | 7.06 | 7.68 | 6.35 | 5.74 | 4.02 | 3.85 | 3.76 | 3.38 | | | | (0.14) | (0.11) | (0.31) | (0.33) | (0.28) | (0.27) | (0.25) | (0.38) | (0.30) | (0.33) | (0.32) | | | Synthetic | 12.62 | 10.75 | 16.50 | 11.91 | 13.93 | 11.20 | 7.97 | 5.66 | 5.03 | 4.87 | 3.63 | | | | (0.76) | (0.71) | (0.28) | (0.24) | (0.29) | (0.28) | (0.13) | (0.64) | (0.71) | (0.71) | (0.62) | | CIFAR100 | Synthetic | 12.77 | 12.34 | 16.89 | 12.73 | 11.18 | 9.63 | 12.00 | 5.61 | 5.55 | 5.65 | 5.76 | | | | (0.43) | (0.68) | (0.20) | (2.59) | (0.35) | (1.25) | (0.48) | (0.51) | (0.55) | (0.35) | (0.27) | | ImageNet200 | Natural | 12.63 | 7.99 | 23.08 | 7.22 | 15.40 | 6.33 | 5.00 | 4.60 | 1.80 | 4.06 | 1.38 | | | | (0.59) | (0.47) | (0.31) | (0.22) | (0.42) | (0.24) | (0.36) | (0.63) | (0.17) | (0.69) | (0.29) | | | Synthetic | 20.17 | 11.74 | 33.69 | 9.51 | 25.49 | 8.61 | 4.19 | 5.37 | 2.78 | 4.53 | 3.58 | | | | (0.74) | (0.80) | (0.73) | (0.51) | (0.66) | (0.50) | (0.14) | (0.88) | (0.23) | (0.79) | (0.33) | | ImageNet | Natural | 8.09 | 6.42 | 21.66 | 5.91 | 8.53 | 5.21 | 5.90 | 3.93 | 1.89 | 2.45 | 0.73 | | | | (0.25) | (0.28) | (0.38) | (0.22) | (0.26) | (0.25) | (0.44) | (0.26) | (0.21) | (0.16) | (0.10) | | | Synthetic | 13.93 | 9.90 | 28.05 | 7.56 | 13.82 | 6.19 | 6.70 | 3.33 | 2.55 | 2.12 | 5.06 | | | | (0.14) | (0.23) | (0.39) | (0.13) | (0.31) | (0.07) | (0.52) | (0.25) | (0.25) | (0.31) | (0.27) | | FMoW-WILDS | Natural | 5.15 | 3.55 | 34.64 | 5.03 | 5.58 | 3.46 | 5.08 | 2.59 | 2.33 | 2.52 | 2.22 | | | | (0.19) | (0.41) | (0.22) | (0.29) | (0.17) | (0.37) | (0.46) | (0.32) | (0.28) | (0.25) | (0.30) | | RxRx1-WILDS | Natural | 6.17 | 6.11 | 21.05 | 5.21 | 6.54 | 6.27 | 6.82 | 5.30 | 5.20 | 5.19 | 5.63 | | | | (0.20) | (0.24) | (0.31) | (0.18) | (0.21) | (0.20) | (0.31) | (0.30) | (0.44) | (0.43) | (0.55) | | Entity-13 | Same | 18.32 | 14.38 | 27.79 | 13.56 | 20.50 | 13.22 | 16.09 | 9.35 | 7.50 | 7.80 | 6.94 | | | | (0.29) | (0.53) | (1.18) | (0.58) | (0.47) | (0.58) | (0.84) | (0.79) | (0.65) | (0.62) | (0.71) | | | Novel | 28.82 | 24.03 | 38.97 | 22.96 | 31.66 | 22.61 | 25.26 | 17.11 | 13.96 | 14.75 | 9.94 | | | | (0.30) | (0.55) | (1.32) | (0.59) | (0.54) | (0.58) | (1.08) | (0.93) | (0.64) | (0.78) | | | Entity-30 | Same | 16.91 | 14.61 | 26.84 | 14.37 | 18.60 | 13.11 | 13.74 | 8.54 | 7.94 | 7.77 | 8.04 | | | | (1.33) | (1.11) | (2.15) | (1.34) | (1.69) | (1.30) | (1.07) | (1.47) | (1.38) | (1.44) | (1.51) | | | Novel | 28.66 | 25.83 | 39.21 | 25.03 | 30.95 | 23.73 | 23.15 | 15.57 | 13.24 | 12.44 | 11.05 | | | | (1.16) | (0.88) | (2.03) | (1.11) | (1.64) | (1.11) | (0.51) | (1.44) | (1.15) | (1.26) | (1.13) | | NonLIVING-26 | Same | 17.43 | 15.95 | 27.70 | 15.40 | 18.06 | 14.58 | 16.99 | 10.79 | 10.13 | 10.05 | 10.29 | | | | (0.90) | (0.86) | (0.90) | (0.69) | (1.00) | (0.78) | (1.25) | (0.62) | (0.32) | (0.46) | (0.79) | | | Novel | 29.51 | 27.75 | 40.02 | 26.77 | 30.36 | 25.93 | 27.70 | 19.64 | 17.75 | 16.90 | 15.69 | | | | (0.86) | (0.82) | (0.76) | (0.82) | (0.95) | (0.80) | (1.42) | (0.68) | (0.53) | (0.60) | (0.83) | | LIVING-17 | Same | 14.28 | 12.21 | 23.46 | 11.16 | 15.22 | 10.78 | 10.49 | 4.92 | 4.23 | 4.19 | 4.73 | | | | (0.96) | (0.93) | (1.16) | (0.90) | (0.96) | (0.99) | (0.97) | (0.57) | (0.42) | (0.35) | (0.24) | | | Novel | 28.91 | 26.35 | 38.62 | 24.91 | 30.32 | 24.52 | 22.49 | 15.42 | 13.02 | 12.29 | 10.34 | | | | (0.66) | (0.73) | (1.01) | (0.61) | (0.59) | (0.74) | (0.85) | (0.59) | (0.53) | (0.73) | (0.62) | Table 4: Mean Absolute estimation Error (MAE) results for different datasets in our setup grouped by the nature of shift for ResNet model. ''Same'' refers to same subpopulation shifts and ''Novel'' refers novel subpopulation shifts. We include details about the target sets considered in each shift in Table 2. Post T denotes use of TS calibration on source. Across all datasets, we observe that ATC achieves superior performance (lower MAE is better). For GDE post T and pre T estimates match since TS doesn''t alter the argmax prediction. Results reported by aggregating MAE numbers over 4 different seeds. Values in parenthesis (i.e., $(\cdot)$ ) denote standard deviation values. ' images: [] dimensions: dpi: 200 height: 2200 width: 1700 model: mistral-ocr-2503-completion usage_info: pages_processed: 29 doc_size_bytes: null '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: OCR /v1/classifications: post: operationId: classifications_v1_classifications_post summary: Classifications tags: - classifiers requestBody: content: application/json: schema: $ref: '#/components/schemas/ClassificationRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ClassificationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Classifications /v1/chat/classifications: post: operationId: chat_classifications_v1_chat_classifications_post summary: Chat Classifications tags: - classifiers requestBody: content: application/json: schema: $ref: '#/components/schemas/ChatClassificationRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ClassificationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Chat Classifications /v1/audio/transcriptions: post: operationId: audio_api_v1_transcriptions_post summary: Create Transcription tags: - audio.transcriptions requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/AudioTranscriptionRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TranscriptionResponse' examples: userExample: value: model: voxtral-mini-2507 text: 'This week, I traveled to Chicago to deliver my final farewell address to the nation, following in the tradition of presidents before me. It was an opportunity to say thank you. Whether we''ve seen eye to eye or rarely agreed at all, my conversations with you, the American people, in living rooms, in schools, at farms and on factory floors, at diners and on distant military outposts, All these conversations are what have kept me honest, kept me inspired, and kept me going. Every day, I learned from you. You made me a better President, and you made me a better man. Over the course of these eight years, I''ve seen the goodness, the resilience, and the hope of the American people. I''ve seen neighbors looking out for each other as we rescued our economy from the worst crisis of our lifetimes. I''ve hugged cancer survivors who finally know the security of affordable health care. I''ve seen communities like Joplin rebuild from disaster, and cities like Boston show the world that no terrorist will ever break the American spirit. I''ve seen the hopeful faces of young graduates and our newest military officers. I''ve mourned with grieving families searching for answers. And I found grace in a Charleston church. I''ve seen our scientists help a paralyzed man regain his sense of touch, and our wounded warriors walk again. I''ve seen our doctors and volunteers rebuild after earthquakes and stop pandemics in their tracks. I''ve learned from students who are building robots and curing diseases, and who will change the world in ways we can''t even imagine. I''ve seen the youngest of children remind us of our obligations to care for our refugees, to work in peace, and above all, to look out for each other. That''s what''s possible when we come together in the slow, hard, sometimes frustrating, but always vital work of self-government. But we can''t take our democracy for granted. All of us, regardless of party, should throw ourselves into the work of citizenship. Not just when there is an election. Not just when our own narrow interest is at stake. But over the full span of a lifetime. If you''re tired of arguing with strangers on the Internet, try to talk with one in real life. If something needs fixing, lace up your shoes and do some organizing. If you''re disappointed by your elected officials, then grab a clipboard, get some signatures, and run for office yourself. Our success depends on our participation, regardless of which way the pendulum of power swings. It falls on each of us to be guardians of our democracy, to embrace the joyous task we''ve been given to continually try to improve this great nation of ours. Because for all our outward differences, we all share the same proud title – citizen. It has been the honor of my life to serve you as President. Eight years later, I am even more optimistic about our country''s promise. And I look forward to working along your side as a citizen for all my days that remain. Thanks, everybody. God bless you. And God bless the United States of America. ' language: en segments: [] usage: prompt_audio_seconds: 203 prompt_tokens: 4 total_tokens: 3264 completion_tokens: 635 description: Create Transcription /v1/audio/transcriptions#stream: post: operationId: audio_api_v1_transcriptions_post_stream summary: Create Streaming Transcription (SSE) tags: - audio.transcriptions requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/AudioTranscriptionRequestStream' required: true responses: '200': description: Stream of transcription events content: text/event-stream: schema: $ref: '#/components/schemas/TranscriptionStreamEvents' description: Create Streaming Transcription (SSE) /v1/libraries: get: operationId: libraries_list_v1 summary: List all libraries you have access to. description: List all libraries that you have created or have been shared with you. tags: - beta.libraries parameters: - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 1 default: 100 - name: page_token in: query description: Continuation token from a previous response's next_page_token. Preferred over `page`. required: false schema: anyOf: - type: string - type: 'null' title: Page Token description: Continuation token from a previous response's next_page_token. Preferred over `page`. - name: page in: query description: 'Deprecated: use page_token. Offset paging re-scans earlier pages and is being phased out.' required: false deprecated: true schema: type: integer title: Page description: 'Deprecated: use page_token. Offset paging re-scans earlier pages and is being phased out.' default: 0 deprecated: true - name: search in: query description: Case-insensitive search on the library name. required: false schema: anyOf: - type: string - type: 'null' title: Search description: Case-insensitive search on the library name. - name: filter_owned_by_me in: query description: 'Deprecated: this parameter will be removed in a future version.' required: false deprecated: true schema: anyOf: - type: boolean - type: 'null' title: Filter Owned By Me description: 'Deprecated: this parameter will be removed in a future version.' deprecated: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListLibrariesResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: operationId: libraries_create_v1 summary: Create a new Library. description: Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you. tags: - beta.libraries requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLibraryRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Library' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/libraries/{library_id}: get: operationId: libraries_get_v1 summary: Detailed information about a specific Library. description: Given a library id, details information about that Library. tags: - beta.libraries parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Library' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: operationId: libraries_delete_v1 summary: Delete a library and all of it's document. description: 'Given a library id, deletes it together with all documents that have been uploaded to that library. Warning: the response will change from 200 (returning the deleted library) to 204 No Content in a future version.' tags: - beta.libraries parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid responses: '200': description: Library deleted (deprecated, will be removed in favor of 204). content: application/json: schema: $ref: '#/components/schemas/Library' '204': description: Library deleted. This will become the only response in a future version. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: operationId: libraries_patch_v1 summary: Update a library. description: Given a library id, you can update the name and description. tags: - beta.libraries parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLibraryRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Library' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' put: operationId: libraries_update_v1 summary: Update a library. description: Given a library id, you can update the name and description. tags: - beta.libraries parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLibraryRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Library' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true x-speakeasy-deprecation-message: Use the PATCH method instead. This PUT endpoint will be removed in a future version. /v1/libraries/{library_id}/documents: get: operationId: libraries_documents_list_v1 summary: List documents in a given library. description: Given a library, lists the document that have been uploaded to that library. tags: - beta.libraries.documents parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid - name: search in: query required: false schema: anyOf: - type: string - type: 'null' title: Search - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 1 default: 100 - name: page in: query required: false schema: type: integer title: Page minimum: 0 default: 0 - name: filters_attributes in: query description: 'Deprecated: this parameter will be removed in a future version.' required: false deprecated: true schema: anyOf: - type: string - type: 'null' title: Filters Attributes description: 'Deprecated: this parameter will be removed in a future version.' deprecated: true - name: sort_by in: query required: false schema: type: string title: Sort By default: created_at - name: sort_order in: query required: false schema: type: string title: Sort Order default: desc responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListDocumentsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: operationId: libraries_documents_upload_v1 summary: Upload a new document. description: Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search tags: - beta.libraries.documents parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid requestBody: content: multipart/form-data: schema: type: object properties: file: $ref: '#/components/schemas/File' title: DocumentUpload required: - file required: true responses: '201': description: Upload successful, returns the created document information's. content: application/json: schema: $ref: '#/components/schemas/Document' '200': description: A document with the same hash was found in this library. Returns the existing document. content: application/json: schema: $ref: '#/components/schemas/Document' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/libraries/{library_id}/documents/{document_id}: get: operationId: libraries_documents_get_v1 summary: Retrieve the metadata of a specific document. description: Given a library and a document in this library, you can retrieve the metadata of that document. tags: - beta.libraries.documents parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid - name: document_id in: path required: true schema: type: string title: Document Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Document' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: operationId: libraries_documents_patch_v1 summary: Update the metadata of a specific document. description: Given a library and a document in that library, update the name and/or attributes of that document. tags: - beta.libraries.documents parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid - name: document_id in: path required: true schema: type: string title: Document Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDocumentRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Document' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' put: operationId: libraries_documents_update_v1 summary: Update the metadata of a specific document. description: Given a library and a document in that library, update the name of that document. tags: - beta.libraries.documents parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid - name: document_id in: path required: true schema: type: string title: Document Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDocumentRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Document' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true x-speakeasy-deprecation-message: Use the PATCH method instead. This PUT endpoint will be removed in a future version. delete: operationId: libraries_documents_delete_v1 summary: Delete a document. description: Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index. tags: - beta.libraries.documents parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid - name: document_id in: path required: true schema: type: string title: Document Id format: uuid responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/libraries/{library_id}/documents/{document_id}/text_content: get: operationId: libraries_documents_get_text_content_v1 summary: Retrieve the text content of a specific document. description: Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR. tags: - beta.libraries.documents parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid - name: document_id in: path required: true schema: type: string title: Document Id format: uuid - name: page_start in: query required: false schema: anyOf: - type: integer - type: 'null' title: Page Start - name: page_end in: query required: false schema: anyOf: - type: integer - type: 'null' title: Page End responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DocumentTextContent' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/libraries/{library_id}/documents/{document_id}/status: get: operationId: libraries_documents_get_status_v1 summary: Retrieve the processing status of a specific document. description: Given a library and a document in that library, retrieve the processing status of that document. tags: - beta.libraries.documents parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid - name: document_id in: path required: true schema: type: string title: Document Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProcessingStatus' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/libraries/{library_id}/documents/{document_id}/signed-url: get: operationId: libraries_documents_get_signed_url_v1 summary: Retrieve the signed URL of a specific document. description: Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. tags: - beta.libraries.documents parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid - name: document_id in: path required: true schema: type: string title: Document Id format: uuid responses: '200': description: Successful Response content: application/json: schema: type: string title: Response Libraries Documents Get Signed Url V1 '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/libraries/{library_id}/documents/{document_id}/extracted-text-signed-url: get: operationId: libraries_documents_get_extracted_text_signed_url_v1 summary: Retrieve the signed URL of text extracted from a given document. description: Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries. tags: - beta.libraries.documents parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid - name: document_id in: path required: true schema: type: string title: Document Id format: uuid responses: '200': description: Successful Response content: application/json: schema: type: string title: Response Libraries Documents Get Extracted Text Signed Url V1 '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/libraries/{library_id}/documents/{document_id}/reprocess: post: operationId: libraries_documents_reprocess_v1 summary: Reprocess a document. description: Given a library and a document in that library, reprocess that document, it will be billed again. tags: - beta.libraries.documents parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid - name: document_id in: path required: true schema: type: string title: Document Id format: uuid responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/libraries/{library_id}/share: get: operationId: libraries_share_list_v1 summary: List all of the access to this library. description: Given a library, list all of the Entity that have access and to what level. tags: - beta.libraries.accesses parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListSharingResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' put: operationId: libraries_share_create_v1 summary: Create or update an access level. description: Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization. tags: - beta.libraries.accesses parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/SharingRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Sharing' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: operationId: libraries_share_delete_v1 summary: Delete an access level. description: 'Given a library id, you can delete the access level of an entity. An owner cannot delete their own access. You have to be the owner of the library to delete an access other than yours. Warning: the response will change from 200 (returning the deleted sharing) to 204 No Content in a future version.' tags: - beta.libraries.accesses parameters: - name: library_id in: path required: true schema: type: string title: Library Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/SharingDelete' required: true responses: '200': description: Access deleted (deprecated, will be removed in favor of 204). content: application/json: schema: $ref: '#/components/schemas/Sharing' '204': description: Access deleted. This will become the only response in a future version. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/observability/chat-completion-events/search: post: operationId: get_chat_completion_events_v1_observability_chat_completion_events_search_post summary: Get Chat Completion Events tags: - beta.observability.chat_completion_events parameters: - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' title: Cursor requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchChatCompletionEventsRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchChatCompletionEventsResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get Chat Completion Events /v1/observability/chat-completion-events/search-ids: post: operationId: get_chat_completion_event_ids_v1_observability_chat_completion_events_search_ids_post summary: Alternative to /search that returns only the IDs and that can return many IDs at once tags: - beta.observability.chat_completion_events parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchChatCompletionEventIdsRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchChatCompletionEventIdsResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Alternative to /search that returns only the IDs and that can return many IDs at once /v1/observability/chat-completion-events/{event_id}: get: operationId: get_chat_completion_event_v1_observability_chat_completion_events__event_id__get summary: Get Chat Completion Event tags: - beta.observability.chat_completion_events parameters: - name: event_id in: path required: true schema: type: string title: Event Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ChatCompletionEvent' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get Chat Completion Event /v1/observability/chat-completion-events/{event_id}/similar-events: get: operationId: get_similar_chat_completion_events_v1_observability_chat_completion_events__event_id__similar_events_get summary: Get Similar Chat Completion Events tags: - beta.observability.chat_completion_events parameters: - name: event_id in: path required: true schema: type: string title: Event Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchChatCompletionEventsResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get Similar Chat Completion Events /v1/observability/chat-completion-fields: get: operationId: get_chat_completion_fields_v1_observability_chat_completion_fields_get summary: Get Chat Completion Fields tags: - beta.observability.chat_completion_events.fields parameters: [] responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListChatCompletionFieldsResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get Chat Completion Fields /v1/observability/chat-completion-fields/{field_name}/options: get: operationId: get_chat_completion_field_options_v1_observability_chat_completion_fields__field_name__options_get summary: Get Chat Completion Field Options tags: - beta.observability.chat_completion_events.fields parameters: - name: field_name in: path required: true schema: type: string title: Field Name - name: operator in: query description: The operator to use for filtering options required: true schema: type: string title: Operator enum: - lt - lte - gt - gte - startswith - istartswith - endswith - iendswith - contains - icontains - matches - notcontains - inotcontains - eq - neq - isnull - includes - excludes - len_eq description: The operator to use for filtering options responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FetchChatCompletionFieldOptionsResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get Chat Completion Field Options /v1/observability/chat-completion-fields/{field_name}/options-counts: post: operationId: get_chat_completion_field_options_counts_v1_observability_chat_completion_fields__field_name__options_counts_post summary: Get Chat Completion Field Options Counts tags: - beta.observability.chat_completion_events.fields parameters: - name: field_name in: path required: true schema: type: string title: Field Name requestBody: content: application/json: schema: $ref: '#/components/schemas/FetchFieldOptionCountsRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FetchFieldOptionCountsResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get Chat Completion Field Options Counts /v1/observability/chat-completion-events/{event_id}/live-judging: post: operationId: judge_chat_completion_event_v1_observability_chat_completion_events__event_id__live_judging_post summary: Run Judge on an event based on the given options tags: - beta.observability.chat_completion_events parameters: - name: event_id in: path required: true schema: type: string title: Event Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/JudgeChatCompletionEventRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JudgeOutput' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Run Judge on an event based on the given options /v1/observability/judges: post: operationId: create_judge_v1_observability_judges_post summary: Create a new judge tags: - beta.observability.judges parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateJudgeRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Judge' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Create a new judge get: operationId: get_judges_v1_observability_judges_get summary: Get judges with optional filtering and search tags: - beta.observability.judges parameters: - name: type_filter in: query description: Filter by judge output types required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/JudgeOutputType' - type: 'null' title: Type Filter description: Filter by judge output types - name: model_filter in: query description: Filter by model names required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Model Filter description: Filter by model names - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: page in: query required: false schema: type: integer title: Page minimum: 1 default: 1 - name: q in: query required: false schema: anyOf: - type: string - type: 'null' title: Q responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListJudgesResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get judges with optional filtering and search /v1/observability/judges/{judge_id}: get: operationId: get_judge_by_id_v1_observability_judges__judge_id__get summary: Get judge by id tags: - beta.observability.judges parameters: - name: judge_id in: path required: true schema: type: string title: Judge Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Judge' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get judge by id delete: operationId: delete_judge_v1_observability_judges__judge_id__delete summary: Delete a judge tags: - beta.observability.judges parameters: - name: judge_id in: path required: true schema: type: string title: Judge Id format: uuid responses: '204': description: Successful Response '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Delete a judge put: operationId: update_judge_v1_observability_judges__judge_id__put summary: Update a judge tags: - beta.observability.judges parameters: - name: judge_id in: path required: true schema: type: string title: Judge Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateJudgeRequest' required: true responses: '204': description: Successful Response '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Update a judge /v1/observability/judges/{judge_id}/live-judging: post: operationId: judge_conversation_v1_observability_judges__judge_id__live_judging_post summary: Run a saved judge on a conversation tags: - beta.observability.judges parameters: - name: judge_id in: path required: true schema: type: string title: Judge Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/JudgeConversationRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JudgeOutput' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Run a saved judge on a conversation /v1/observability/campaigns: post: operationId: create_campaign_v1_observability_campaigns_post summary: Create and start a new campaign tags: - beta.observability.campaigns parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCampaignRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Campaign' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Create and start a new campaign get: operationId: get_campaigns_v1_observability_campaigns_get summary: Get all campaigns tags: - beta.observability.campaigns parameters: - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: page in: query required: false schema: type: integer title: Page minimum: 1 default: 1 - name: q in: query required: false schema: anyOf: - type: string - type: 'null' title: Q responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListCampaignsResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get all campaigns /v1/observability/campaigns/{campaign_id}: get: operationId: get_campaign_by_id_v1_observability_campaigns__campaign_id__get summary: Get campaign by id tags: - beta.observability.campaigns parameters: - name: campaign_id in: path required: true schema: type: string title: Campaign Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Campaign' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get campaign by id delete: operationId: delete_campaign_v1_observability_campaigns__campaign_id__delete summary: Delete a campaign tags: - beta.observability.campaigns parameters: - name: campaign_id in: path required: true schema: type: string title: Campaign Id format: uuid responses: '204': description: Successful Response '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Delete a campaign /v1/observability/campaigns/{campaign_id}/status: get: operationId: get_campaign_status_by_id_v1_observability_campaigns__campaign_id__status_get summary: Get campaign status by campaign id tags: - beta.observability.campaigns parameters: - name: campaign_id in: path required: true schema: type: string title: Campaign Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FetchCampaignStatusResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get campaign status by campaign id /v1/observability/campaigns/{campaign_id}/selected-events: get: operationId: get_campaign_selected_events_v1_observability_campaigns__campaign_id__selected_events_get summary: Get event ids that were selected by the given campaign tags: - beta.observability.campaigns parameters: - name: campaign_id in: path required: true schema: type: string title: Campaign Id format: uuid - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: page in: query required: false schema: type: integer title: Page minimum: 1 default: 1 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListCampaignSelectedEventsResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get event ids that were selected by the given campaign /v1/observability/datasets: post: operationId: create_dataset_v1_observability_datasets_post summary: Create a new empty dataset tags: - beta.observability.datasets parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDatasetRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Dataset' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Create a new empty dataset get: operationId: get_datasets_v1_observability_datasets_get summary: List existing datasets tags: - beta.observability.datasets parameters: - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: page in: query required: false schema: type: integer title: Page minimum: 1 default: 1 - name: q in: query required: false schema: anyOf: - type: string - type: 'null' title: Q responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListDatasetsResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: List existing datasets /v1/observability/datasets/{dataset_id}: get: operationId: get_dataset_by_id_v1_observability_datasets__dataset_id__get summary: Get dataset by id tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetPreview' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get dataset by id delete: operationId: delete_dataset_v1_observability_datasets__dataset_id__delete summary: Delete a dataset tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid responses: '204': description: Successful Response '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Delete a dataset patch: operationId: update_dataset_v1_observability_datasets__dataset_id__patch summary: Patch dataset tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetPreview' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Patch dataset /v1/observability/datasets/{dataset_id}/records: get: operationId: get_dataset_records_v1_observability_datasets__dataset_id__records_get summary: List existing records in the dataset tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: page in: query required: false schema: type: integer title: Page minimum: 1 default: 1 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListDatasetRecordsResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: List existing records in the dataset post: operationId: create_dataset_record_v1_observability_datasets__dataset_id__records_post summary: Add a record to the dataset tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDatasetRecordRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetRecord' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Add a record to the dataset /v1/observability/datasets/{dataset_id}/imports/from-campaign: post: operationId: post_dataset_records_from_campaign_v1_observability_datasets__dataset_id__imports_from_campaign_post summary: Populate the dataset with records from a campaign tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportDatasetFromCampaignRequest' required: true responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetImportTask' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Populate the dataset with records from a campaign /v1/observability/datasets/{dataset_id}/imports/from-explorer: post: operationId: post_dataset_records_from_explorer_v1_observability_datasets__dataset_id__imports_from_explorer_post summary: Populate the dataset with records from the explorer tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportDatasetFromExplorerRequest' required: true responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetImportTask' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Populate the dataset with records from the explorer /v1/observability/datasets/{dataset_id}/imports/from-file: post: operationId: post_dataset_records_from_file_v1_observability_datasets__dataset_id__imports_from_file_post summary: Populate the dataset with records from an uploaded file tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportDatasetFromFileRequest' required: true responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetImportTask' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Populate the dataset with records from an uploaded file /v1/observability/datasets/{dataset_id}/imports/from-playground: post: operationId: post_dataset_records_from_playground_v1_observability_datasets__dataset_id__imports_from_playground_post summary: Populate the dataset with records from playground conversations tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportDatasetFromPlaygroundRequest' required: true responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetImportTask' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Populate the dataset with records from playground conversations /v1/observability/datasets/{dataset_id}/imports/from-dataset: post: operationId: post_dataset_records_from_dataset_v1_observability_datasets__dataset_id__imports_from_dataset_post summary: Populate the dataset with records from another dataset tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportDatasetFromDatasetRequest' required: true responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetImportTask' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Populate the dataset with records from another dataset /v1/observability/datasets/{dataset_id}/exports/to-jsonl: get: operationId: export_dataset_to_jsonl_v1_observability_datasets__dataset_id__exports_to_jsonl_get summary: Export to the Files API and retrieve presigned URL to download the resulting JSONL file tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExportDatasetResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Export to the Files API and retrieve presigned URL to download the resulting JSONL file /v1/observability/datasets/{dataset_id}/tasks/{task_id}: get: operationId: get_dataset_import_task_v1_observability_datasets__dataset_id__tasks__task_id__get summary: Get status of a dataset import task tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid - name: task_id in: path required: true schema: type: string title: Task Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetImportTask' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get status of a dataset import task /v1/observability/datasets/{dataset_id}/tasks: get: operationId: get_dataset_import_tasks_v1_observability_datasets__dataset_id__tasks_get summary: List import tasks for the given dataset tags: - beta.observability.datasets parameters: - name: dataset_id in: path required: true schema: type: string title: Dataset Id format: uuid - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: page in: query required: false schema: type: integer title: Page minimum: 1 default: 1 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListDatasetImportTasksResponse' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: List import tasks for the given dataset /v1/observability/dataset-records/{dataset_record_id}: get: operationId: get_dataset_record_v1_observability_dataset_records__dataset_record_id__get summary: Get the content of a given dataset record tags: - beta.observability.datasets.records parameters: - name: dataset_record_id in: path required: true schema: type: string title: Dataset Record Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DatasetRecord' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get the content of a given dataset record delete: operationId: delete_dataset_record_v1_observability_dataset_records__dataset_record_id__delete summary: Delete a record from a dataset tags: - beta.observability.datasets.records parameters: - name: dataset_record_id in: path required: true schema: type: string title: Dataset Record Id format: uuid responses: '204': description: Successful Response '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Delete a record from a dataset /v1/observability/dataset-records/bulk-delete: post: operationId: delete_dataset_records_v1_observability_dataset_records_bulk_delete_post summary: Delete multiple records from datasets tags: - beta.observability.datasets.records parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteDatasetRecordsRequest' required: true responses: '204': description: Successful Response '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Delete multiple records from datasets /v1/observability/dataset-records/{dataset_record_id}/live-judging: post: operationId: judge_dataset_record_v1_observability_dataset_records__dataset_record_id__live_judging_post summary: Run Judge on a dataset record based on the given options tags: - beta.observability.datasets.records parameters: - name: dataset_record_id in: path required: true schema: type: string title: Dataset Record Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/JudgeDatasetRecordRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JudgeOutput' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Run Judge on a dataset record based on the given options /v1/observability/dataset-records/{dataset_record_id}/payload: put: operationId: update_dataset_record_payload_v1_observability_dataset_records__dataset_record_id__payload_put summary: Update a dataset record payload tags: - beta.observability.datasets.records parameters: - name: dataset_record_id in: path required: true schema: type: string title: Dataset Record Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetRecordPayloadRequest' required: true responses: '204': description: Successful Response '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Update a dataset record payload /v1/observability/dataset-records/{dataset_record_id}/properties: put: operationId: update_dataset_record_properties_v1_observability_dataset_records__dataset_record_id__properties_put summary: Update dataset record properties tags: - beta.observability.datasets.records parameters: - name: dataset_record_id in: path required: true schema: type: string title: Dataset Record Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetRecordPropertiesRequest' required: true responses: '204': description: Successful Response '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Update dataset record properties /v1/observability/logs/search: post: operationId: search_logs_v1_observability_logs_search_post summary: Search logs tags: - beta.observability.logs parameters: - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' title: Cursor requestBody: content: application/json: schema: $ref: '#/components/schemas/LogsRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetLogs' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Search logs /v1/observability/traces/search: post: operationId: search_traces_v1_observability_traces_search_post summary: Search traces tags: - beta.observability.traces parameters: - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' title: Cursor requestBody: content: application/json: schema: $ref: '#/components/schemas/TracesRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetTraces' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Search traces /v1/observability/traces/aggregate: post: operationId: aggregate_traces_v1_observability_traces_aggregate_post summary: Aggregate traces tags: - beta.observability.traces parameters: - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To requestBody: content: application/json: schema: $ref: '#/components/schemas/AggregationRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Aggregation' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Aggregate traces /v1/observability/spans/search: post: operationId: search_spans_v1_observability_spans_search_post summary: Search spans tags: - beta.observability.spans parameters: - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' title: Cursor requestBody: content: application/json: schema: $ref: '#/components/schemas/SpansRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetSpans' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Search spans /v1/observability/spans/aggregate: post: operationId: aggregate_spans_v1_observability_spans_aggregate_post summary: Aggregate spans tags: - beta.observability.spans parameters: - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To requestBody: content: application/json: schema: $ref: '#/components/schemas/AggregationRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Aggregation' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Aggregate spans /v1/observability/spans/evaluations/search: post: operationId: search_span_evaluations_v1_observability_spans_evaluations_search_post summary: Search span evaluations tags: - beta.observability.spans parameters: - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' title: Cursor requestBody: content: application/json: schema: $ref: '#/components/schemas/SpanEvaluationsRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetSpanEvaluations' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Search span evaluations /v1/observability/spans/evaluations/search/latest: post: operationId: search_latest_span_evaluations_v1_observability_spans_evaluations_search_latest_post summary: Search latest span evaluations tags: - beta.observability.spans parameters: - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' title: Cursor requestBody: content: application/json: schema: $ref: '#/components/schemas/SpanEvaluationsRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetSpanEvaluations' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Search latest span evaluations /v1/observability/traces/fields: get: operationId: get_trace_fields_v1_observability_traces_fields_get summary: Get trace field definitions tags: - beta.observability.traces parameters: [] responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetTraceFields' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get trace field definitions /v1/observability/traces/{trace_id}: get: operationId: get_trace_by_id_v1_observability_traces__trace_id__get summary: Get trace by id tags: - beta.observability.traces parameters: - name: trace_id in: path required: true schema: type: string title: Trace Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetTrace' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get trace by id /v1/observability/traces/{trace_id}/spans: get: operationId: get_trace_spans_v1_observability_traces__trace_id__spans_get summary: Get trace spans tags: - beta.observability.traces parameters: - name: trace_id in: path required: true schema: type: string title: Trace Id - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 100 minimum: 0 default: 50 - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' title: Cursor responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetSpans' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get trace spans /v1/observability/logs/fields: get: operationId: get_log_fields_v1_observability_logs_fields_get summary: Get log field definitions tags: - beta.observability.logs parameters: [] responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetLogFields' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get log field definitions /v1/observability/spans/fields: get: operationId: get_span_fields_v1_observability_spans_fields_get summary: Get span field definitions tags: - beta.observability.spans parameters: [] responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetSpanFields' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get span field definitions /v1/observability/spans/evaluations/fields: get: operationId: get_span_evaluation_fields_v1_observability_spans_evaluations_fields_get summary: Get span evaluation field definitions tags: - beta.observability.spans parameters: [] responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetSpanEvaluationFields' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get span evaluation field definitions /v1/observability/traces/fields/{field_name}/options: get: operationId: get_trace_field_options_v1_observability_traces_fields__field_name__options_get summary: Get options for a trace field tags: - beta.observability.traces parameters: - name: field_name in: path required: true schema: type: string title: Field Name - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetTraceFieldOptions' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get options for a trace field /v1/observability/logs/fields/{field_name}/options: get: operationId: get_log_field_options_v1_observability_logs_fields__field_name__options_get summary: Get options for a log field tags: - beta.observability.logs parameters: - name: field_name in: path required: true schema: type: string title: Field Name - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetLogFieldOptions' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get options for a log field /v1/observability/spans/fields/{field_name}/options: get: operationId: get_span_field_options_v1_observability_spans_fields__field_name__options_get summary: Get options for a span field tags: - beta.observability.spans parameters: - name: field_name in: path required: true schema: type: string title: Field Name - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetSpanFieldOptions' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get options for a span field /v1/observability/spans/evaluations/fields/{field_name}/options: get: operationId: get_span_evaluation_field_options_v1_observability_spans_evaluations_fields__field_name__options_get summary: Get options for a span evaluation field tags: - beta.observability.spans parameters: - name: field_name in: path required: true schema: type: string title: Field Name - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetSpanEvaluationFieldOptions' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get options for a span evaluation field /v1/observability/traces/{trace_id}/spans/{span_id}: get: operationId: get_span_by_id_v1_observability_traces__trace_id__spans__span_id__get summary: Get span by id tags: - beta.observability.traces parameters: - name: trace_id in: path required: true schema: type: string title: Trace Id - name: span_id in: path required: true schema: type: string title: Span Id - name: from in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: From - name: to in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: To responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetSpan' '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '404': description: Not Found - Resource does not exist content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '408': description: Request Timeout - Operation timed out content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '409': description: Conflict - Resource conflict content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' '422': description: Unprocessable Entity - Validation error content: application/json: schema: $ref: '#/components/schemas/ObservabilityError' description: Get span by id /v1/connectors: post: operationId: connector_create_v1 summary: Create a new connector. description: Create a new MCP connector. You can customize its visibility, url and auth type. tags: - beta.connectors requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConnectorRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Connector' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: operationId: connector_list_v1 summary: List all connectors. description: List all your custom connectors with keyset pagination and filters. tags: - beta.connectors parameters: - name: query_filters in: query required: false schema: $ref: '#/components/schemas/ConnectorsQueryFilters' default: fetch_user_data: false fetch_customer_data: false check_credentials_status: false - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' title: Cursor - name: page_size in: query required: false schema: type: integer title: Page Size maximum: 1000 minimum: 1 default: 100 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaginatedConnectors' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id_or_name}/auth_url: get: operationId: connector_get_auth_url_v1 summary: Get the auth URL for a connector. description: Get the OAuth2 authorization URL for a connector to initiate user authentication. tags: - beta.connectors parameters: - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name - name: app_return_url in: query required: false schema: anyOf: - type: string - type: 'null' title: App Return Url - name: method_type in: query description: Auth method type to use for the authorization URL. Required when the connector supports multiple interactive auth methods; otherwise the sole method is selected automatically. Use this to pick a specific method (e.g. 'oauth2' vs 'github_app'). required: false schema: $ref: '#/components/schemas/OutboundAuthenticationType' description: Auth method type to use for the authorization URL. Required when the connector supports multiple interactive auth methods; otherwise the sole method is selected automatically. Use this to pick a specific method (e.g. 'oauth2' vs 'github_app'). default: oauth2 - name: credentials_name in: query required: false schema: anyOf: - type: string pattern: ^[a-zA-Z0-9_-]{1,64}$ - type: 'null' title: Credentials Name - name: credentials_title in: query required: false schema: anyOf: - type: string maxLength: 255 - type: 'null' title: Credentials Title - name: github_installation_link in: query description: Only valid with method_type=oauth2. When true, returns a GitHub App installation URL (https://github.com/apps//installations/new) if the connector has the proper configuration The Github application needs to have 'Request user authorization (OAuth) during installation' enabled to perform the proper auth loop. required: false schema: type: boolean title: Github Installation Link description: Only valid with method_type=oauth2. When true, returns a GitHub App installation URL (https://github.com/apps//installations/new) if the connector has the proper configuration The Github application needs to have 'Request user authorization (OAuth) during installation' enabled to perform the proper auth loop. default: false responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AuthUrlResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id}/share: put: operationId: connector_share_v1 summary: Share a private connector to the current workspace. description: Transfers ownership of a private user-owned connector to the current workspace, making it available to all workspace members. The creator can later revert this via the unshare endpoint. Any authentication flows that rely on the original owner's identity (e.g. OAuth on-behalf-of) will be affected and must be reconfigured after sharing. Only the connector's creator can call this endpoint. Requires the ShareConnectorToWorkspace workspace permission. tags: - beta.connectors parameters: - name: connector_id in: path required: true schema: type: string title: Connector Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: operationId: connector_unshare_v1 summary: Unshare a connector from the current workspace. description: Reverts a workspace-shared connector back to a private, creator-owned connector. Workspace-scoped connections and other members' connections are removed; the creator's own connection is preserved. Only the connector's creator can call this endpoint. Requires the ShareConnectorToWorkspace workspace permission. tags: - beta.connectors parameters: - name: connector_id in: path required: true schema: type: string title: Connector Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id}/{consumer_scope}/activate: post: operationId: connector_activate_for_consumer_v1 summary: Activate a connector for the given consumer (organization, workspace, user). description: Enable a connector for the consumer. tags: - beta.connectors parameters: - name: connector_id in: path required: true schema: type: string title: Connector Id format: uuid - name: consumer_scope in: path required: true schema: type: string title: Consumer Scope enum: - user - workspace - organization responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id}/{consumer_scope}/deactivate: post: operationId: connector_deactivate_for_consumer_v1 summary: Deactivate a connector for the current consumer (at organization, workspace or user level). description: Disable a connector for the calling consumer only. tags: - beta.connectors parameters: - name: connector_id in: path required: true schema: type: string title: Connector Id format: uuid - name: consumer_scope in: path required: true schema: type: string title: Consumer Scope enum: - user - workspace - organization responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id_or_name}/tools/{tool_name}/call: post: operationId: connector_call_tool_v1 summary: Call Connector Tool description: Call a tool on an MCP connector. tags: - beta.connectors parameters: - name: tool_name in: path required: true schema: type: string title: Tool Name - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name - name: credentials_name in: query required: false schema: anyOf: - type: string pattern: ^[a-zA-Z0-9_-]{1,64}$ - type: 'null' title: Credentials Name requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectorCallToolRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConnectorToolCallResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id_or_name}/tools: get: operationId: connector_list_tools_v1 summary: List tools for a connector. description: List all tools available for an MCP connector. tags: - beta.connectors parameters: - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name - name: page in: query required: false schema: type: integer title: Page default: 1 - name: page_size in: query required: false schema: type: integer title: Page Size default: 100 - name: refresh in: query required: false schema: type: boolean title: Refresh default: false - name: pretty in: query description: Return a simplified payload with only name, description, annotations, and a compact inputSchema. required: false schema: type: boolean title: Pretty description: Return a simplified payload with only name, description, annotations, and a compact inputSchema. default: false - name: credentials_name in: query required: false schema: anyOf: - type: string pattern: ^[a-zA-Z0-9_-]{1,64}$ - type: 'null' title: Credentials Name responses: '200': description: Successful Response content: application/json: schema: anyOf: - type: array items: $ref: '#/components/schemas/MCPTool' - type: array items: type: object additionalProperties: true title: Response Connector List Tools V1 '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id_or_name}/authentication_methods: get: operationId: connector_get_authentication_methods_v1 summary: Get authentication methods for a connector. description: Get the authentication schema for a connector. Returns the list of supported authentication methods and their required headers. tags: - beta.connectors parameters: - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/PublicAuthenticationMethod' title: Response Connector Get Authentication Methods V1 '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id_or_name}/organization/credentials: get: operationId: connector_list_organization_credentials_v1 summary: List organization credentials for a connector. description: List all credentials configured at the organization level for a given connector. tags: - beta.connectors parameters: - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name - name: auth_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/OutboundAuthenticationType' - type: 'null' title: Auth Type - name: fetch_default in: query required: false schema: type: boolean title: Fetch Default default: false responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CredentialsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: operationId: connector_create_or_update_organization_credentials_v1 summary: Create or update organization credentials for a connector. description: Create or update credentials at the organization level for a given connector. tags: - beta.connectors parameters: - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name requestBody: content: application/json: schema: $ref: '#/components/schemas/CredentialsCreateOrUpdate' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id_or_name}/workspace/credentials: get: operationId: connector_list_workspace_credentials_v1 summary: List workspace credentials for a connector. description: List all credentials configured at the workspace level for a given connector. tags: - beta.connectors parameters: - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name - name: auth_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/OutboundAuthenticationType' - type: 'null' title: Auth Type - name: fetch_default in: query required: false schema: type: boolean title: Fetch Default default: false responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CredentialsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: operationId: connector_create_or_update_workspace_credentials_v1 summary: Create or update workspace credentials for a connector. description: Create or update credentials at the workspace level for a given connector. tags: - beta.connectors parameters: - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name requestBody: content: application/json: schema: $ref: '#/components/schemas/CredentialsCreateOrUpdate' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id_or_name}/user/credentials: get: operationId: connector_list_user_credentials_v1 summary: List user credentials for a connector. description: List all credentials configured at the user level for a given connector. tags: - beta.connectors parameters: - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name - name: auth_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/OutboundAuthenticationType' - type: 'null' title: Auth Type - name: fetch_default in: query required: false schema: type: boolean title: Fetch Default default: false responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CredentialsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: operationId: connector_create_or_update_user_credentials_v1 summary: Create or update user credentials for a connector. description: Create or update credentials at the user level for a given connector. tags: - beta.connectors parameters: - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name requestBody: content: application/json: schema: $ref: '#/components/schemas/CredentialsCreateOrUpdate' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: operationId: connector_delete_all_user_credentials_v1 summary: Delete all user credentials for a connector. description: Delete all credentials configured at the user level for a given connector. tags: - beta.connectors parameters: - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id_or_name}/organization/credentials/{credentials_name}: delete: operationId: connector_delete_organization_credentials_v1 summary: Delete organization credentials for a connector. description: Delete credentials at the organization level for a given connector. tags: - beta.connectors parameters: - name: credentials_name in: path required: true schema: type: string title: Credentials Name pattern: ^[a-zA-Z0-9_-]{1,64}$ - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id_or_name}/workspace/credentials/{credentials_name}: delete: operationId: connector_delete_workspace_credentials_v1 summary: Delete workspace credentials for a connector. description: Delete credentials at the workspace level for a given connector. tags: - beta.connectors parameters: - name: credentials_name in: path required: true schema: type: string title: Credentials Name pattern: ^[a-zA-Z0-9_-]{1,64}$ - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id_or_name}/user/credentials/{credentials_name}: delete: operationId: connector_delete_user_credentials_v1 summary: Delete user credentials for a connector. description: Delete credentials at the user level for a given connector. tags: - beta.connectors parameters: - name: credentials_name in: path required: true schema: type: string title: Credentials Name pattern: ^[a-zA-Z0-9_-]{1,64}$ - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id_or_name}#idOrName: get: operationId: connector_get_v1 summary: Get a connector. description: Get a connector by its ID or name. tags: - beta.connectors parameters: - name: connector_id_or_name in: path required: true schema: anyOf: - type: string format: uuid - type: string title: Connector Id Or Name - name: fetch_user_data in: query description: Fetch the user-level data associated with the connector (e.g. connection credentials). required: false schema: type: boolean title: Fetch User Data description: Fetch the user-level data associated with the connector (e.g. connection credentials). default: false - name: fetch_customer_data in: query description: Fetch the customer data associated with the connector (e.g. customer secrets / config). required: false schema: type: boolean title: Fetch Customer Data description: Fetch the customer data associated with the connector (e.g. customer secrets / config). default: false responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Connector' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/{connector_id}#id: patch: operationId: connector_update_v1 summary: Update a connector. description: Update a connector by its ID. tags: - beta.connectors parameters: - name: connector_id in: path required: true schema: type: string title: Connector Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateConnectorRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Connector' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: operationId: connector_delete_v1 summary: Delete a connector. description: Delete a connector by its ID. tags: - beta.connectors parameters: - name: connector_id in: path required: true schema: type: string title: Connector Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/audio/voices: get: operationId: list_voices_v1_audio_voices_get summary: List all voices description: List all voices (excluding sample data) tags: - audio.voices parameters: - name: limit in: query description: Maximum number of voices to return required: false schema: type: integer title: Limit maximum: 100 minimum: 1 description: Maximum number of voices to return default: 10 - name: offset in: query description: Offset for pagination required: false schema: type: integer title: Offset minimum: 0 description: Offset for pagination default: 0 - name: type in: query description: Filter the voices between customs and presets required: false schema: type: string title: Type enum: - all - custom - preset description: Filter the voices between customs and presets default: all responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VoiceListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: operationId: create_voice_v1_audio_voices_post summary: Create a new voice description: Create a new voice with a base64-encoded audio sample tags: - audio.voices requestBody: content: application/json: schema: $ref: '#/components/schemas/VoiceCreateRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VoiceResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/audio/voices/{voice_id}: delete: operationId: delete_voice_v1_audio_voices__voice_id__delete summary: Delete a custom voice description: Delete a custom voice tags: - audio.voices parameters: - name: voice_id in: path required: true schema: type: string title: Voice Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VoiceResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: operationId: update_voice_v1_audio_voices__voice_id__patch summary: Update voice metadata description: Update voice metadata (name, gender, languages, age, tags). tags: - audio.voices parameters: - name: voice_id in: path required: true schema: type: string title: Voice Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/VoiceUpdateRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VoiceResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: operationId: get_voice_v1_audio_voices__voice_id__get summary: Get voice details description: Get voice details (excluding sample) tags: - audio.voices parameters: - name: voice_id in: path required: true schema: type: string title: Voice Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VoiceResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/audio/voices/{voice_id}/sample: get: operationId: get_voice_sample_audio_v1_audio_voices__voice_id__sample_get summary: Get voice sample audio description: Get the audio sample for a voice tags: - audio.voices parameters: - name: voice_id in: path required: true schema: type: string title: Voice Id responses: '200': description: Successful Response content: audio/wav: schema: type: string format: binary '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/workflows/executions/{execution_id}: get: operationId: get_workflow_execution_v1_workflows_executions__execution_id__get summary: Get Workflow Execution tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowExecutionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Workflow Execution /v1/workflows/executions/{execution_id}/history: get: operationId: get_workflow_execution_history_v1_workflows_executions__execution_id__history_get summary: Get Workflow Execution History tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id - name: decode_payloads in: query required: false schema: type: boolean title: Decode Payloads default: false responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Workflow Execution History /v1/workflows/executions/{execution_id}/signals: post: operationId: signal_workflow_execution_v1_workflows_executions__execution_id__signals_post summary: Signal Workflow Execution tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id requestBody: content: application/json: schema: $ref: '#/components/schemas/SignalInvocationBody' required: true responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SignalWorkflowResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Signal Workflow Execution /v1/workflows/executions/{execution_id}/queries: post: operationId: query_workflow_execution_v1_workflows_executions__execution_id__queries_post summary: Query Workflow Execution tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryInvocationBody' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/QueryWorkflowResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Query Workflow Execution /v1/workflows/executions/{execution_id}/terminate: post: operationId: terminate_workflow_execution_v1_workflows_executions__execution_id__terminate_post summary: Terminate Workflow Execution tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Terminate Workflow Execution /v1/workflows/executions/terminate: post: operationId: batch_terminate_workflow_executions_v1_workflows_executions_terminate_post summary: Batch Terminate Workflow Executions tags: - workflows.executions requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchExecutionBody' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BatchExecutionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Batch Terminate Workflow Executions /v1/workflows/executions/{execution_id}/cancel: post: operationId: cancel_workflow_execution_v1_workflows_executions__execution_id__cancel_post summary: Cancel Workflow Execution tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Cancel Workflow Execution /v1/workflows/executions/cancel: post: operationId: batch_cancel_workflow_executions_v1_workflows_executions_cancel_post summary: Batch Cancel Workflow Executions tags: - workflows.executions requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchExecutionBody' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BatchExecutionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Batch Cancel Workflow Executions /v1/workflows/executions/{execution_id}/reset: post: operationId: reset_workflow_v1_workflows_executions__execution_id__reset_post summary: Reset Workflow tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id requestBody: content: application/json: schema: $ref: '#/components/schemas/ResetInvocationBody' required: true responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Reset Workflow /v1/workflows/executions/{execution_id}/updates: post: operationId: update_workflow_execution_v1_workflows_executions__execution_id__updates_post summary: Update Workflow Execution tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateInvocationBody' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Update Workflow Execution /v1/workflows/executions/{execution_id}/trace/info: get: operationId: get_workflow_execution_trace_info summary: Get Workflow Execution Trace Info tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExecutionTraceInfoResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Workflow Execution Trace Info /v1/workflows/executions/{execution_id}/trace/otel: get: operationId: get_workflow_execution_trace_otel summary: Get Workflow Execution Trace Otel tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowExecutionTraceOTelResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Workflow Execution Trace Otel /v1/workflows/executions/{execution_id}/trace/summary: get: operationId: get_workflow_execution_trace_summary summary: Get Workflow Execution Trace Summary tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowExecutionTraceSummaryResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Workflow Execution Trace Summary /v1/workflows/executions/{execution_id}/trace/events: get: operationId: get_workflow_execution_trace_events summary: Get Workflow Execution Trace Events tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id - name: merge_same_id_events in: query required: false schema: type: boolean title: Merge Same Id Events default: false - name: include_internal_events in: query required: false schema: type: boolean title: Include Internal Events default: false responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowExecutionTraceEventsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Workflow Execution Trace Events /v1/workflows/executions/{execution_id}/stream: get: operationId: stream_v1_workflows_executions__execution_id__stream_get summary: Stream tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id - name: event_source in: query required: false schema: anyOf: - $ref: '#/components/schemas/EventSource' - type: 'null' title: Event Source - name: last_event_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Last Event Id responses: '200': description: Stream of Server-Sent Events (SSE) content: text/event-stream: schema: type: object properties: event: type: string data: oneOf: - $ref: '#/components/schemas/StreamEventSsePayload' - $ref: '#/components/schemas/StreamEventSseErrorData' id: type: string retry: type: integer '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Stream /v1/workflows/executions/{execution_id}/logs: get: operationId: get_workflow_execution_logs summary: Get Workflow Execution Logs description: 'Retrieve logs for a workflow execution. Use `after`/`before`/`order` on the first request to set the time range and sort order; for the next pages pass the `cursor` from the previous response (it remembers the range and order).' tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id - name: run_id in: query description: Filter logs by workflow run ID required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Run Id description: Filter logs by workflow run ID - name: activity_id in: query description: Filter logs by activity ID required: false schema: anyOf: - type: string pattern: ^\d+$ - type: 'null' title: Activity Id description: Filter logs by activity ID - name: after in: query description: Only return logs at or after this timestamp required: false schema: anyOf: - type: string format: date-time - type: 'null' title: After description: Only return logs at or after this timestamp - name: before in: query description: Only return logs before this timestamp required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Before description: Only return logs before this timestamp - name: order in: query description: 'First-page sort order: ''asc'' (oldest first) or ''desc''. Ignored when `cursor` is set.' required: false schema: type: string title: Order enum: - asc - desc description: 'First-page sort order: ''asc'' (oldest first) or ''desc''. Ignored when `cursor` is set.' default: asc - name: cursor in: query description: Pagination cursor from a previous response's `next_cursor`; carries the window and order required: false schema: anyOf: - type: string - type: 'null' title: Cursor description: Pagination cursor from a previous response's `next_cursor`; carries the window and order - name: limit in: query description: Maximum number of logs to return required: false schema: type: integer title: Limit maximum: 100 minimum: 1 description: Maximum number of logs to return default: 50 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExecutionLogSearchResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/workflows/executions/{execution_id}/logs/stream: get: operationId: stream_workflow_execution_logs summary: Stream Workflow Execution Logs description: 'Stream logs for a workflow execution via SSE. Resume cursor comes from the `Last-Event-ID` header or `last_event_id` query param (header wins) and takes precedence over `after`; omit all to tail from the execution start.' tags: - workflows.executions parameters: - name: execution_id in: path required: true schema: type: string title: Execution Id - name: run_id in: query description: Filter logs by workflow run ID required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Run Id description: Filter logs by workflow run ID - name: activity_id in: query description: Filter logs by activity ID required: false schema: anyOf: - type: string pattern: ^\d+$ - type: 'null' title: Activity Id description: Filter logs by activity ID - name: after in: query description: Start a fresh stream at this timestamp (ignored when resuming via last_event_id) required: false schema: anyOf: - type: string format: date-time - type: 'null' title: After description: Start a fresh stream at this timestamp (ignored when resuming via last_event_id) - name: last_event_id in: query description: Resume from this cursor (a prior response's SSE id) required: false schema: anyOf: - type: string - type: 'null' title: Last Event Id description: Resume from this cursor (a prior response's SSE id) - name: Last-Event-ID in: header description: Resume from this cursor (a prior response's SSE id). Takes precedence over the query parameter. required: false schema: anyOf: - type: string - type: 'null' title: Last-Event-Id description: Resume from this cursor (a prior response's SSE id). Takes precedence over the query parameter. responses: '200': description: 'Stream of Server-Sent Events (SSE): `log` events carry an ExecutionLogRecord; `error` events carry a StreamError payload.' content: text/event-stream: schema: type: object properties: event: type: string enum: - log - error id: type: string data: oneOf: - $ref: '#/components/schemas/ExecutionLogRecord' - $ref: '#/components/schemas/StreamError' '404': description: Execution not found '503': description: Logs backend unavailable '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/workflows/{workflow_name}/metrics: get: operationId: get_workflow_metrics_v1_workflows__workflow_name__metrics_get summary: Get Workflow Metrics description: "Get comprehensive metrics for a specific workflow.\n\nArgs:\n workflow_name: The name of the workflow type to get metrics for\n start_time: Optional start time filter (ISO 8601 format)\n end_time: Optional end time filter (ISO 8601 format)\n\nReturns:\n WorkflowMetrics: Dictionary containing metrics:\n - execution_count: Total number of executions\n - success_count: Number of successful executions\n - error_count: Number of failed/terminated executions\n - average_latency_ms: Average execution duration in milliseconds\n - retry_rate: Proportion of workflows with retries\n - latency_over_time: Time-series data of execution durations\n\nExample:\n GET /v1/workflows/MyWorkflow/metrics\n GET /v1/workflows/MyWorkflow/metrics?start_time=2025-01-01T00:00:00Z\n GET /v1/workflows/MyWorkflow/metrics?start_time=2025-01-01T00:00:00Z&end_time=2025-12-31T23:59:59Z" tags: - workflows.metrics parameters: - name: workflow_name in: path required: true schema: type: string title: Workflow Name - name: start_time in: query description: Filter workflows started after this time (ISO 8601) required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Time description: Filter workflows started after this time (ISO 8601) - name: end_time in: query description: Filter workflows started before this time (ISO 8601) required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Time description: Filter workflows started before this time (ISO 8601) responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowMetrics' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/workflows/runs: get: operationId: list_runs_v1_workflows_runs_get summary: List Runs tags: - workflows.runs parameters: - name: workflow_identifier in: query description: Filter by workflow name or id required: false schema: anyOf: - type: string - type: 'null' title: Workflow Identifier description: Filter by workflow name or id - name: root_execution_id in: query description: Filter by root execution id; returns the whole execution tree (the root and all its descendant sub-workflows). required: false schema: anyOf: - type: string - type: 'null' title: Root Execution Id description: Filter by root execution id; returns the whole execution tree (the root and all its descendant sub-workflows). - name: search in: query description: Search by workflow name, display name, or ID required: false schema: anyOf: - type: string - type: 'null' title: Search description: Search by workflow name, display name, or ID - name: status in: query description: Filter by workflow status required: false schema: anyOf: - $ref: '#/components/schemas/WorkflowExecutionStatus' - type: array items: $ref: '#/components/schemas/WorkflowExecutionStatus' - type: 'null' title: Status description: Filter by workflow status - name: deployment_name in: query description: Filter by deployment name required: false schema: anyOf: - type: string - type: 'null' title: Deployment Name description: Filter by deployment name - name: sort_by in: query description: Field to sort by required: false schema: anyOf: - type: string enum: - start_time - end_time - type: 'null' title: Sort By description: Field to sort by - name: order in: query description: Sort direction required: false schema: type: string title: Order enum: - asc - desc description: Sort direction default: desc - name: start_time_after in: query description: Include runs with start_time >= value required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Time After description: Include runs with start_time >= value - name: start_time_before in: query description: Include runs with start_time <= value required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Start Time Before description: Include runs with start_time <= value - name: end_time_after in: query description: Include runs with end_time >= value. Running executions (no end_time) are excluded; use the status filter to include them. required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Time After description: Include runs with end_time >= value. Running executions (no end_time) are excluded; use the status filter to include them. - name: end_time_before in: query description: Include runs with end_time <= value. Running executions (no end_time) are excluded; use the status filter to include them. required: false schema: anyOf: - type: string format: date-time - type: 'null' title: End Time Before description: Include runs with end_time <= value. Running executions (no end_time) are excluded; use the status filter to include them. - name: user_id in: query description: Filter by user id. Use 'current' to filter by the authenticated user required: false schema: anyOf: - type: string - type: 'null' title: User Id description: Filter by user id. Use 'current' to filter by the authenticated user - name: workflow_tags in: query description: Filter to runs of workflows tagged with all listed tags (AND). required: false schema: anyOf: - type: array items: type: string maxItems: 20 - type: 'null' title: Workflow Tags description: Filter to runs of workflows tagged with all listed tags (AND). - name: include_internal in: query description: Include runs of internal/technical workflows (e.g. parallel-execution) required: false schema: type: boolean title: Include Internal description: Include runs of internal/technical workflows (e.g. parallel-execution) default: true - name: page_size in: query description: Number of items per page required: false schema: type: integer title: Page Size maximum: 1000 minimum: 1 description: Number of items per page default: 50 - name: next_page_token in: query description: Token for the next page of results required: false schema: anyOf: - type: string - type: 'null' title: Next Page Token description: Token for the next page of results - name: search_key in: query description: Filter executions by search key as repeated 'key:value' entries. Each entry matches an exact key and a similar value; multiple entries are AND'd together (max 3). required: false schema: anyOf: - type: array items: type: string pattern: ^[^:]+:.+$ maxItems: 3 - type: 'null' title: Search Key description: Filter executions by search key as repeated 'key:value' entries. Each entry matches an exact key and a similar value; multiple entries are AND'd together (max 3). responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowExecutionListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-speakeasy-pagination: type: cursor inputs: - name: next_page_token in: parameters type: cursor - name: page_size in: parameters type: limit outputs: results: $.executions nextCursor: $.next_page_token description: List Runs /v1/workflows/runs/{run_id}: get: operationId: get_run_v1_workflows_runs__run_id__get summary: Get Run tags: - workflows.runs parameters: - name: run_id in: path required: true schema: type: string title: Run Id format: uuid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowExecutionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Run /v1/workflows/runs/{run_id}/history: get: operationId: get_run_history_v1_workflows_runs__run_id__history_get summary: Get Run History tags: - workflows.runs parameters: - name: run_id in: path required: true schema: type: string title: Run Id format: uuid - name: decode_payloads in: query required: false schema: type: boolean title: Decode Payloads default: false responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Run History /v1/workflows/schedules: get: operationId: get_schedules_v1_workflows_schedules_get summary: Get Schedules tags: - workflows.schedules parameters: - name: workflow_name in: query description: Filter by exact workflow name required: false schema: anyOf: - type: string - type: 'null' title: Workflow Name description: Filter by exact workflow name - name: user_id in: query description: Filter by user ID. Pass 'current' to resolve to the authenticated user's ID. required: false schema: anyOf: - type: string - type: 'null' title: User Id description: Filter by user ID. Pass 'current' to resolve to the authenticated user's ID. - name: status in: query description: 'Filter by schedule status: ''active'' or ''paused''' required: false schema: anyOf: - type: string enum: - active - paused - type: 'null' title: Status description: 'Filter by schedule status: ''active'' or ''paused''' - name: search in: query description: Prefix search query for workflow name required: false schema: anyOf: - type: string - type: 'null' title: Search description: Prefix search query for workflow name - name: page_size in: query description: Number of items per page. Omitting this parameter fetches all results at once (deprecated — pass page_size to use pagination). required: false schema: anyOf: - type: integer maximum: 1000 minimum: 1 - type: 'null' title: Page Size description: Number of items per page. Omitting this parameter fetches all results at once (deprecated — pass page_size to use pagination). - name: next_page_token in: query description: Token for the next page of results required: false schema: anyOf: - type: string - type: 'null' title: Next Page Token description: Token for the next page of results responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowScheduleListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-speakeasy-pagination: type: cursor inputs: - name: next_page_token in: parameters type: cursor - name: page_size in: parameters type: limit outputs: results: $.schedules nextCursor: $.next_page_token description: Get Schedules post: operationId: schedule_workflow_v1_workflows_schedules_post summary: Schedule Workflow tags: - workflows.schedules requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowScheduleRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowScheduleResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Schedule Workflow /v1/workflows/schedules/{schedule_id}: get: operationId: get_schedule_v1_workflows_schedules__schedule_id__get summary: Get Schedule tags: - workflows.schedules parameters: - name: schedule_id in: path required: true schema: type: string title: Schedule Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ScheduleDefinitionOutput' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Schedule delete: operationId: unschedule_workflow_v1_workflows_schedules__schedule_id__delete summary: Unschedule Workflow tags: - workflows.schedules parameters: - name: schedule_id in: path required: true schema: type: string title: Schedule Id responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Unschedule Workflow patch: operationId: update_schedule_v1_workflows_schedules__schedule_id__patch summary: Update Schedule tags: - workflows.schedules parameters: - name: schedule_id in: path required: true schema: type: string title: Schedule Id requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowScheduleUpdateRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowScheduleResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Update Schedule /v1/workflows/schedules/{schedule_id}/pause: post: operationId: pause_schedule_v1_workflows_schedules__schedule_id__pause_post summary: Pause Schedule tags: - workflows.schedules parameters: - name: schedule_id in: path required: true schema: type: string title: Schedule Id requestBody: content: application/json: schema: anyOf: - $ref: '#/components/schemas/WorkflowSchedulePauseRequest' - type: 'null' title: Schedule State Request responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Pause Schedule /v1/workflows/schedules/{schedule_id}/resume: post: operationId: resume_schedule_v1_workflows_schedules__schedule_id__resume_post summary: Resume Schedule tags: - workflows.schedules parameters: - name: schedule_id in: path required: true schema: type: string title: Schedule Id requestBody: content: application/json: schema: anyOf: - $ref: '#/components/schemas/WorkflowSchedulePauseRequest' - type: 'null' title: Schedule State Request responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Resume Schedule /v1/workflows/schedules/{schedule_id}/trigger: post: operationId: trigger_schedule_v1_workflows_schedules__schedule_id__trigger_post summary: Trigger Schedule tags: - workflows.schedules parameters: - name: schedule_id in: path required: true schema: type: string title: Schedule Id requestBody: content: application/json: schema: anyOf: - $ref: '#/components/schemas/WorkflowScheduleTriggerRequest' - type: 'null' title: Trigger Request responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Trigger Schedule /v1/workflows/events/stream: get: operationId: get_stream_events_v1_workflows_events_stream_get summary: Get Stream Events tags: - events - workflows.events parameters: - name: scope in: query required: false schema: type: string title: Scope enum: - activity - workflow - '*' default: '*' - name: activity_name in: query required: false schema: type: string title: Activity Name default: '*' - name: activity_id in: query required: false schema: type: string title: Activity Id default: '*' - name: workflow_name in: query required: false schema: type: string title: Workflow Name default: '*' - name: workflow_exec_id in: query required: false schema: type: string title: Workflow Exec Id default: '*' - name: root_workflow_exec_id in: query required: false schema: type: string title: Root Workflow Exec Id default: '*' - name: parent_workflow_exec_id in: query required: false schema: type: string title: Parent Workflow Exec Id default: '*' - name: stream in: query required: false schema: type: string title: Stream default: '*' - name: start_seq in: query required: false schema: type: integer title: Start Seq default: 0 - name: metadata_filters in: query required: false schema: anyOf: - type: object additionalProperties: true - type: 'null' title: Metadata Filters - name: workflow_event_types in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/WorkflowEventType' - type: 'null' title: Workflow Event Types - name: last-event-id in: header required: false schema: anyOf: - type: string - type: 'null' title: Last-Event-Id responses: '200': description: Stream of Server-Sent Events (SSE) content: text/event-stream: schema: type: object properties: event: type: string data: oneOf: - $ref: '#/components/schemas/StreamEventSsePayload' - $ref: '#/components/schemas/StreamEventSseErrorData' id: type: string retry: type: integer '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Stream Events /v1/workflows/events/list: get: operationId: get_workflow_events_v1_workflows_events_list_get summary: Get Workflow Events tags: - events - workflows.events parameters: - name: root_workflow_exec_id in: query description: Execution ID of the root workflow that initiated this execution chain. required: false schema: anyOf: - type: string - type: 'null' title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. - name: workflow_exec_id in: query description: Execution ID of the workflow that emitted this event. required: false schema: anyOf: - type: string - type: 'null' title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. - name: workflow_run_id in: query description: Run ID of the workflow that emitted this event. required: false schema: anyOf: - type: string - type: 'null' title: Workflow Run Id description: Run ID of the workflow that emitted this event. - name: limit in: query description: Maximum number of events to return. required: false schema: type: integer title: Limit maximum: 1000 minimum: 1 description: Maximum number of events to return. default: 100 - name: cursor in: query description: Cursor for pagination. required: false schema: anyOf: - type: string - type: 'null' title: Cursor description: Cursor for pagination. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListWorkflowEventResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Workflow Events /v1/workflows/deployments: get: operationId: list_deployments_v1_workflows_deployments_get summary: List Deployments tags: - workflows.deployments parameters: - name: active_only in: query required: false schema: type: boolean title: Active Only default: true - name: is_hardened in: query description: Filter deployments by hardened status required: false schema: anyOf: - type: boolean - type: 'null' title: Is Hardened description: Filter deployments by hardened status - name: workflow_name in: query required: false schema: anyOf: - type: string - type: 'null' title: Workflow Name - name: search in: query description: Filter deployments by name or ID prefix required: false schema: anyOf: - type: string - type: 'null' title: Search description: Filter deployments by name or ID prefix - name: order_by in: query description: Field to sort by. When omitted, active and managed deployments are grouped first, then sorted by created_at. When set, results are sorted purely by the specified field with no grouping. required: false schema: anyOf: - type: string enum: - updated_at - created_at - type: 'null' title: Order By description: Field to sort by. When omitted, active and managed deployments are grouped first, then sorted by created_at. When set, results are sorted purely by the specified field with no grouping. - name: order in: query description: Sort direction. Applied to order_by when set, or within each activity group when omitted. required: false schema: type: string title: Order enum: - asc - desc description: Sort direction. Applied to order_by when set, or within each activity group when omitted. default: desc - name: limit in: query description: Maximum number of deployments to return required: false schema: anyOf: - type: integer maximum: 100 minimum: 1 - type: 'null' title: Limit description: Maximum number of deployments to return - name: cursor in: query description: Cursor from a previous response for pagination required: false schema: anyOf: - type: string - type: 'null' title: Cursor description: Cursor from a previous response for pagination - name: workspace_id in: query description: Workspace ID to scope the request to. Defaults to the caller's context. required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Workspace Id description: Workspace ID to scope the request to. Defaults to the caller's context. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DeploymentListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: List Deployments post: operationId: create_deployment_v1_workflows_deployments_post summary: Create Deployment tags: - workflows.deployments requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDeploymentRequest' required: true responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ManagedDeploymentResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Create Deployment /v1/workflows/deployments/{name}: patch: operationId: update_deployment_v1_workflows_deployments__name__patch summary: Update Deployment tags: - workflows.deployments parameters: - name: name in: path required: true schema: type: string title: Name requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeploymentRequest' required: true responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ManagedDeploymentResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Update Deployment delete: operationId: delete_deployment_v1_workflows_deployments__name__delete summary: Delete Deployment tags: - workflows.deployments parameters: - name: name in: path required: true schema: type: string title: Name responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ManagedDeploymentResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Delete Deployment get: operationId: get_deployment_v1_workflows_deployments__name__get summary: Get Deployment tags: - workflows.deployments parameters: - name: name in: path required: true schema: type: string title: Name - name: workflow_name in: query description: Scope serving status to this workflow required: false schema: anyOf: - type: string - type: 'null' title: Workflow Name description: Scope serving status to this workflow responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DeploymentDetailResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Deployment /v1/workflows/deployments/{name}/stop: post: operationId: stop_deployment_v1_workflows_deployments__name__stop_post summary: Stop Deployment tags: - workflows.deployments parameters: - name: name in: path required: true schema: type: string title: Name responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ManagedDeploymentResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Stop Deployment /v1/workflows/deployments/{name}/start: post: operationId: start_deployment_v1_workflows_deployments__name__start_post summary: Start Deployment tags: - workflows.deployments parameters: - name: name in: path required: true schema: type: string title: Name responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ManagedDeploymentResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Start Deployment /v1/workflows/deployments/{name}/restart: post: operationId: restart_deployment_v1_workflows_deployments__name__restart_post summary: Restart Deployment tags: - workflows.deployments parameters: - name: name in: path required: true schema: type: string title: Name responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ManagedDeploymentResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Restart Deployment /v1/workflows/deployments/{name}/workers: get: operationId: list_deployment_workers_v1_workflows_deployments__name__workers_get summary: List Deployment Workers tags: - workflows.deployments parameters: - name: name in: path required: true schema: type: string title: Name - name: worker_status in: query description: Filter by worker activity. active=only active, inactive=only inactive, None=no filter required: false schema: anyOf: - type: string enum: - active - inactive - type: 'null' title: Worker Status description: Filter by worker activity. active=only active, inactive=only inactive, None=no filter - name: limit in: query description: Maximum number of workers to return required: false schema: type: integer title: Limit maximum: 100 minimum: 1 description: Maximum number of workers to return default: 50 - name: cursor in: query description: Cursor from a previous response's `next_cursor`. Resend `worker_status` unchanged alongside it. required: false schema: anyOf: - type: string - type: 'null' title: Cursor description: Cursor from a previous response's `next_cursor`. Resend `worker_status` unchanged alongside it. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DeploymentWorkerListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: List Deployment Workers /v1/workflows/deployments/{name}/logs: get: operationId: get_deployment_logs summary: Get Deployment Logs description: 'Retrieve logs for a deployment (across all of its workers). Use `after`/`before`/`order` on the first request to set the time range and sort order; for the next pages pass the `cursor` from the previous response (it remembers the range and order).' tags: - workflows.deployments parameters: - name: name in: path required: true schema: type: string title: Name - name: worker_name in: query description: Filter logs by worker name required: false schema: anyOf: - type: string - type: 'null' title: Worker Name description: Filter logs by worker name - name: workflow_name in: query description: Filter logs by workflow name required: false schema: anyOf: - type: string - type: 'null' title: Workflow Name description: Filter logs by workflow name - name: after in: query description: Only return logs at or after this timestamp required: false schema: anyOf: - type: string format: date-time - type: 'null' title: After description: Only return logs at or after this timestamp - name: before in: query description: Only return logs before this timestamp required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Before description: Only return logs before this timestamp - name: order in: query description: 'First-page sort order: ''asc'' (oldest first) or ''desc''. Ignored when `cursor` is set.' required: false schema: type: string title: Order enum: - asc - desc description: 'First-page sort order: ''asc'' (oldest first) or ''desc''. Ignored when `cursor` is set.' default: asc - name: cursor in: query description: Pagination cursor from a previous response's `next_cursor`; carries the window and order required: false schema: anyOf: - type: string - type: 'null' title: Cursor description: Pagination cursor from a previous response's `next_cursor`; carries the window and order - name: limit in: query description: Maximum number of logs to return required: false schema: type: integer title: Limit maximum: 100 minimum: 1 description: Maximum number of logs to return default: 50 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DeploymentLogSearchResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/workflows/deployments/{name}/logs/stream: get: operationId: stream_deployment_logs summary: Stream Deployment Logs description: 'Stream logs for a deployment (all of its workers) via SSE. Resume cursor comes from the `Last-Event-ID` header or `last_event_id` query param (header wins) and takes precedence over `after`; omit all to tail from the deployment start.' tags: - workflows.deployments parameters: - name: name in: path required: true schema: type: string title: Name - name: worker_name in: query description: Filter logs by worker name required: false schema: anyOf: - type: string - type: 'null' title: Worker Name description: Filter logs by worker name - name: workflow_name in: query description: Filter logs by workflow name required: false schema: anyOf: - type: string - type: 'null' title: Workflow Name description: Filter logs by workflow name - name: after in: query description: Start a fresh stream at this timestamp (ignored when resuming via last_event_id) required: false schema: anyOf: - type: string format: date-time - type: 'null' title: After description: Start a fresh stream at this timestamp (ignored when resuming via last_event_id) - name: last_event_id in: query description: Resume from this cursor (a prior response's SSE id) required: false schema: anyOf: - type: string - type: 'null' title: Last Event Id description: Resume from this cursor (a prior response's SSE id) - name: Last-Event-ID in: header description: Resume from this cursor (a prior response's SSE id). Takes precedence over the query parameter. required: false schema: anyOf: - type: string - type: 'null' title: Last-Event-Id description: Resume from this cursor (a prior response's SSE id). Takes precedence over the query parameter. responses: '200': description: 'Stream of Server-Sent Events (SSE): `log` events carry a DeploymentLogRecord; `error` events carry a StreamError payload.' content: text/event-stream: schema: type: object properties: event: type: string enum: - log - error id: type: string data: oneOf: - $ref: '#/components/schemas/DeploymentLogRecord' - $ref: '#/components/schemas/StreamError' '404': description: Deployment not found '503': description: Logs backend unavailable '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/workflows: get: operationId: get_workflows_v1_workflows_get summary: Get Workflows tags: - workflows parameters: - name: status in: query description: Filter by workflow status required: false schema: anyOf: - $ref: '#/components/schemas/WorkflowExecutionStatus' - type: array items: $ref: '#/components/schemas/WorkflowExecutionStatus' - type: 'null' title: Status description: Filter by workflow status - name: include_shared in: query description: Whether to include shared workflows required: false schema: type: boolean title: Include Shared description: Whether to include shared workflows default: true - name: available_in_chat_assistant in: query description: Whether to only return workflows available in chat assistant required: false schema: anyOf: - type: boolean - type: 'null' title: Available In Chat Assistant description: Whether to only return workflows available in chat assistant - name: deployment_name in: query description: Filter by deployment name(s) required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Deployment Name description: Filter by deployment name(s) - name: deployment_status in: query description: Filter by deployment activity. active=only active, inactive=only inactive, None=no filter required: false schema: anyOf: - type: string enum: - active - inactive - type: 'null' title: Deployment Status description: Filter by deployment activity. active=only active, inactive=only inactive, None=no filter - name: archived in: query description: Filter by archived state. False=exclude archived, True=only archived, None=include all required: false schema: anyOf: - type: boolean - type: 'null' title: Archived description: Filter by archived state. False=exclude archived, True=only archived, None=include all - name: tags in: query description: Filter to workflows tagged with all listed tags (AND). required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Tags description: Filter to workflows tagged with all listed tags (AND). - name: sort_by in: query description: Field to sort by required: false schema: anyOf: - type: string const: display_name - type: 'null' title: Sort By description: Field to sort by - name: order in: query description: Sort direction required: false schema: type: string title: Order enum: - asc - desc description: Sort direction default: asc - name: cursor in: query description: The cursor for pagination required: false schema: anyOf: - type: string - type: 'null' title: Cursor description: The cursor for pagination - name: limit in: query description: The maximum number of workflows to return required: false schema: type: integer title: Limit maximum: 1000 minimum: 1 description: The maximum number of workflows to return default: 50 - name: active_only in: query description: 'Deprecated: use deployment_status instead' required: false deprecated: true schema: type: boolean title: Active Only description: 'Deprecated: use deployment_status instead' default: false deprecated: true - name: search in: query description: Fuzzy search query for workflow name, display name, description, or ID required: false schema: anyOf: - type: string - type: 'null' title: Search description: Fuzzy search query for workflow name, display name, description, or ID responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-speakeasy-pagination: type: cursor inputs: - name: cursor in: parameters type: cursor - name: limit in: parameters type: limit outputs: results: $.workflows nextCursor: $.next_cursor description: Get Workflows /v1/workflows/registrations: get: operationId: get_workflow_registrations_v1_workflows_registrations_get summary: Get Workflow Registrations tags: - workflows parameters: - name: workflow_id in: query description: The workflow ID to filter by required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Workflow Id description: The workflow ID to filter by - name: task_queue in: query description: The task queue to filter by required: false schema: anyOf: - type: string - type: 'null' title: Task Queue description: The task queue to filter by - name: active_only in: query description: Whether to only return active workflows versions required: false schema: type: boolean title: Active Only description: Whether to only return active workflows versions default: false - name: include_shared in: query description: Whether to include shared workflow versions required: false schema: type: boolean title: Include Shared description: Whether to include shared workflow versions default: true - name: workflow_search in: query description: The workflow name to filter by required: false schema: anyOf: - type: string - type: 'null' title: Workflow Search description: The workflow name to filter by - name: archived in: query description: Filter by archived state. False=exclude archived, True=only archived, None=include all required: false schema: anyOf: - type: boolean - type: 'null' title: Archived description: Filter by archived state. False=exclude archived, True=only archived, None=include all - name: with_workflow in: query description: Whether to include the workflow definition required: false schema: type: boolean title: With Workflow description: Whether to include the workflow definition default: false - name: available_in_chat_assistant in: query description: Whether to only return workflows available in chat assistant required: false schema: anyOf: - type: boolean - type: 'null' title: Available In Chat Assistant description: Whether to only return workflows available in chat assistant - name: limit in: query description: The maximum number of workflows versions to return required: false schema: type: integer title: Limit maximum: 1000 minimum: 1 description: The maximum number of workflows versions to return default: 50 - name: cursor in: query description: The cursor for pagination required: false schema: anyOf: - type: string - type: 'null' title: Cursor description: The cursor for pagination responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowRegistrationListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Workflow Registrations /v1/workflows/{workflow_identifier}/execute: post: operationId: execute_workflow_v1_workflows__workflow_identifier__execute_post summary: Execute Workflow tags: - workflows parameters: - name: workflow_identifier in: path required: true schema: type: string title: Workflow Identifier requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowExecutionRequest' required: true responses: '200': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/WorkflowExecutionResponse' - $ref: '#/components/schemas/WorkflowExecutionSyncResponse' title: Response Execute Workflow V1 Workflows Workflow Identifier Execute Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Execute Workflow /v1/workflows/registrations/{workflow_registration_id}/execute: post: operationId: execute_workflow_registration_v1_workflows_registrations__workflow_registration_id__execute_post summary: Execute Workflow Registration tags: - workflows parameters: - name: workflow_registration_id in: path required: true schema: type: string title: Workflow Registration Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowExecutionRequest' required: true responses: '200': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/WorkflowExecutionResponse' - $ref: '#/components/schemas/WorkflowExecutionSyncResponse' title: Response Execute Workflow Registration V1 Workflows Registrations Workflow Registration Id Execute Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true description: Execute Workflow Registration /v1/workflows/{workflow_identifier}: get: operationId: get_workflow_v1_workflows__workflow_identifier__get summary: Get Workflow tags: - workflows parameters: - name: workflow_identifier in: path required: true schema: type: string title: Workflow Identifier responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowGetResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Workflow put: operationId: update_workflow_v1_workflows__workflow_identifier__put summary: Update Workflow tags: - workflows parameters: - name: workflow_identifier in: path required: true schema: type: string title: Workflow Identifier requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowUpdateRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowUpdateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Update Workflow /v1/workflows/registrations/{workflow_registration_id}: get: operationId: get_workflow_registration_v1_workflows_registrations__workflow_registration_id__get summary: Get Workflow Registration tags: - workflows parameters: - name: workflow_registration_id in: path required: true schema: type: string title: Workflow Registration Id format: uuid - name: with_workflow in: query description: Whether to include the workflow definition required: false schema: type: boolean title: With Workflow description: Whether to include the workflow definition default: false - name: include_shared in: query description: Whether to include shared workflow versions required: false schema: type: boolean title: Include Shared description: Whether to include shared workflow versions default: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowRegistrationGetResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Get Workflow Registration /v1/workflows/archive: put: operationId: bulk_archive_workflows_v1_workflows_archive_put summary: Bulk Archive Workflows tags: - workflows requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowBulkArchiveRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowBulkArchiveResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Bulk Archive Workflows /v1/workflows/unarchive: put: operationId: bulk_unarchive_workflows_v1_workflows_unarchive_put summary: Bulk Unarchive Workflows tags: - workflows requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowBulkUnarchiveRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowBulkUnarchiveResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Bulk Unarchive Workflows /v1/workflows/{workflow_identifier}/archive: put: operationId: archive_workflow_v1_workflows__workflow_identifier__archive_put summary: Archive Workflow tags: - workflows parameters: - name: workflow_identifier in: path required: true schema: type: string title: Workflow Identifier responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowArchiveResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Archive Workflow /v1/workflows/{workflow_identifier}/unarchive: put: operationId: unarchive_workflow_v1_workflows__workflow_identifier__unarchive_put summary: Unarchive Workflow tags: - workflows parameters: - name: workflow_identifier in: path required: true schema: type: string title: Workflow Identifier responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkflowUnarchiveResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Unarchive Workflow /v1/rag/ingestion_pipeline_configurations: get: operationId: get_configs_v1_rag_ingestion_pipeline_configurations_get summary: List ingestion pipeline configurations description: For the current workspace, lists all of the registered ingestion pipeline configurations. tags: - beta.rag.ingestion_pipeline_configurations responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/IngestionPipelineConfiguration' title: Response Get Configs V1 Rag Ingestion Pipeline Configurations Get put: operationId: register_config_v1_rag_ingestion_pipeline_configurations_put summary: Register Config description: Register an ingestion configuration. tags: - beta.rag.ingestion_pipeline_configurations requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateIngestionPipelineConfigurationRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/IngestionPipelineConfiguration' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/rag/ingestion_pipeline_configurations/{id}/run_info: put: operationId: update_run_info_v1_rag_ingestion_pipeline_configurations__id__run_info_put summary: Update Run Info tags: - beta.rag.ingestion_pipeline_configurations parameters: - name: id in: path required: true schema: type: string title: Id format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRunInfo' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/IngestionPipelineConfiguration' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Update Run Info /v1/rag/deployments: get: operationId: get_deployment_summaries_v1_rag_deployments_get summary: Get Deployment Summaries description: Fetch all indexes available to a user tags: - beta.rag.search_indexes responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetDeploymentSummariesResponse' '403': description: Unauthorized '404': description: Index not found '400': description: Invalid request '500': description: Internal server error put: operationId: register_deployment_v1_rag_deployments_put summary: Register (or re-register) a search index tags: - beta.rag.search_indexes requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterDeploymentRequestDeployment' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RegisterSearchIndexResponseIndex' '403': description: Unauthorized '404': description: Index not found '400': description: Invalid request '500': description: Internal server error '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Register (or re-register) a search index /v1/rag/deployments/{deployment_id}: delete: operationId: unregister_deployment_v1_rag_deployments__deployment_id__delete summary: Unregister Deployment description: Delete all information about a deployment tags: - beta.rag.search_indexes parameters: - name: deployment_id in: path required: true schema: type: string title: Deployment Id format: uuid responses: '200': description: Successful Response content: application/json: schema: {} '403': description: Unauthorized '404': description: Index not found '400': description: Invalid request '500': description: Internal server error '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/rag/deployments/{deployment_id}/metrics: put: operationId: update_index_metrics_v1_rag_deployments__deployment_id__metrics_put summary: Update Index Metrics description: Update the metrics for a given index tags: - beta.rag.search_indexes parameters: - name: deployment_id in: path required: true schema: type: string title: Deployment Id format: uuid requestBody: content: application/json: schema: anyOf: - $ref: '#/components/schemas/UpdateMetricsRequestDeploymentMetricsOnline' - $ref: '#/components/schemas/UpdateMetricsRequestDeploymentMetricsOffline' title: Metrics Data required: true responses: '200': description: Successful Response content: application/json: schema: {} '403': description: Unauthorized '404': description: Index not found '400': description: Invalid request '422': description: Attempted to update unknown index '500': description: Internal server error /v1/users/me: get: operationId: users_api_get_identity summary: Get Identity tags: - beta.users security: - DashboardUserContextAuth: [] parameters: [] responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserIdentity' description: Get Identity /v1/users/me/organizations: get: operationId: users_api_list_organizations summary: List Organizations description: 'List every organization the authenticated user is a member of. Identity-only: the caller need not have selected an organization, so this reads only the user and never scopes by the active org.' tags: - beta.users security: - DashboardUserContextAuth: [] parameters: - name: offset in: query description: Number of organizations to skip before returning results. required: false schema: type: integer examples: - 0 title: Offset minimum: 0 description: Number of organizations to skip before returning results. default: 0 examples: {} - name: limit in: query description: Maximum number of organizations to return. required: false schema: type: integer examples: - 100 title: Limit maximum: 100 minimum: 1 description: Maximum number of organizations to return. default: 100 examples: {} responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListOrganizationsResponse' x-speakeasy-pagination: type: offsetLimit inputs: - name: offset in: parameters type: offset - name: limit in: parameters type: limit outputs: results: $.organizations /v1/users/me/workspaces: get: operationId: users_api_list_workspaces summary: List Workspaces description: 'List every workspace the authenticated user is a member of, across all their organizations, each tagged with the organization it belongs to.' tags: - beta.users security: - DashboardUserContextAuth: [] parameters: - name: organization_id in: query description: Return only workspaces belonging to this organization. required: false schema: anyOf: - type: string format: uuid - type: 'null' examples: - 1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d title: Organization Id description: Return only workspaces belonging to this organization. examples: {} - name: offset in: query description: Number of workspaces to skip before returning results. required: false schema: type: integer examples: - 0 title: Offset minimum: 0 description: Number of workspaces to skip before returning results. default: 0 examples: {} - name: limit in: query description: Maximum number of workspaces to return. required: false schema: type: integer examples: - 100 title: Limit maximum: 100 minimum: 1 description: Maximum number of workspaces to return. default: 100 examples: {} responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListWorkspacesResponse' x-speakeasy-pagination: type: offsetLimit inputs: - name: offset in: parameters type: offset - name: limit in: parameters type: limit outputs: results: $.workspaces /v1/admin/users: get: operationId: users_api_admin_users_get_users summary: Get Users description: List Organization members and pending invitations. tags: - beta.admin.users security: - AdminApiKey: [] parameters: - name: page in: query description: Page number to return. required: false schema: exclusiveMinimum: 0 type: integer title: Page description: Page number to return. default: 1 - name: page_size in: query description: Maximum number of results per page. required: false schema: exclusiveMinimum: 0 type: integer title: Page Size description: Maximum number of results per page. default: 25 - name: email in: query description: Email address to filter users and invitations. required: false schema: anyOf: - type: string - type: 'null' examples: - alice.martin@example.com title: Email description: Email address to filter users and invitations. examples: {} responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrganizationAdminUsersOUT' post: operationId: users_api_admin_users_create_users summary: Create Users description: Create Organization members. tags: - beta.admin.users security: - AdminApiKey: [] parameters: [] requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/OrganizationMemberCreate' title: Body required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrganizationUsersCreateOUT' /v1/admin/users-invite: post: operationId: users_api_admin_users_invite_users summary: Invite Users description: Invite users to the Organization. tags: - beta.admin.users security: - AdminApiKey: [] parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/OrganizationInviteIN' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrganizationInvitesCreateOUT' get: operationId: users_api_admin_users_get_invite summary: Get Invite description: List pending Organization invitations. tags: - beta.admin.users security: - AdminApiKey: [] parameters: [] responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/OrganizationUserInviteOUT' title: Response /v1/admin/users-invite/{invite_uuid}: delete: operationId: users_api_admin_users_delete_invite summary: Delete Invite tags: - beta.admin.users security: - AdminApiKey: [] parameters: - name: invite_uuid in: path description: Organization invitation ID. required: true schema: type: string title: Invite Uuid format: uuid description: Organization invitation ID. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteOUT' description: Delete Invite /v1/admin/users/{user_id}: patch: operationId: users_api_admin_users_update_user summary: Update User description: Update an Organization member's roles and product seats. tags: - beta.admin.users security: - AdminApiKey: [] parameters: - name: user_id in: path description: User ID. required: true schema: type: string title: User Id format: uuid description: User ID. requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminOrganizationMemberUpdate' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminOrganizationMemberOUT' delete: operationId: users_api_admin_users_delete_user summary: Delete User description: Remove a member from the Organization. tags: - beta.admin.users security: - AdminApiKey: [] parameters: - name: user_id in: path description: User ID. required: true schema: type: string title: User Id format: uuid description: User ID. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteOUT' get: operationId: users_api_admin_users_get_user summary: Get User description: Get details for an Organization member. tags: - beta.admin.users security: - AdminApiKey: [] parameters: - name: user_id in: path description: User ID. required: true schema: type: string title: User Id format: uuid description: User ID. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminUserOUT' /v1/admin/roles: get: operationId: users_api_admin_roles_get_roles summary: Get Roles description: List Organization and Workspace roles. tags: - beta.admin.users security: - AdminApiKey: [] parameters: [] responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RolesOut' /v1/admin/workspaces: get: operationId: users_api_admin_workspaces_get_workspaces summary: Get Workspaces description: List Workspaces in the Organization. tags: - beta.admin.workspaces security: - AdminApiKey: [] parameters: - name: is_archived in: query description: Whether to include archived Workspaces. required: false schema: type: boolean title: Is Archived description: Whether to include archived Workspaces. default: false - name: page in: query description: Page number to return. required: false schema: exclusiveMinimum: 0 type: integer title: Page description: Page number to return. default: 1 - name: page_size in: query description: Maximum number of results per page. required: false schema: exclusiveMinimum: 0 type: integer title: Page Size description: Maximum number of results per page. default: 25 - name: search in: query description: Search term to filter Workspaces by name. required: false schema: anyOf: - type: string - type: 'null' examples: - Product title: Search description: Search term to filter Workspaces by name. examples: {} responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WorkspacesOut' post: operationId: users_api_admin_workspaces_create_workspace summary: Create Workspace description: Create a Workspace. tags: - beta.admin.workspaces security: - AdminApiKey: [] parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminWorkspaceIn' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WorkspaceEnrichedOUT' /v1/admin/workspaces/{workspace_uuid}: patch: operationId: users_api_admin_workspaces_update_workspaces summary: Update Workspaces description: Update a Workspace. tags: - beta.admin.workspaces security: - AdminApiKey: [] parameters: - name: workspace_uuid in: path description: Workspace ID. required: true schema: type: string title: Workspace Uuid format: uuid description: Workspace ID. requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceIN' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WorkspaceOUT' delete: operationId: users_api_admin_workspaces_delete_workspaces summary: Delete Workspaces description: Archive a Workspace. tags: - beta.admin.workspaces security: - AdminApiKey: [] parameters: - name: workspace_uuid in: path description: Workspace ID. required: true schema: type: string title: Workspace Uuid format: uuid description: Workspace ID. responses: '204': description: No Content /v1/admin/workspaces/{workspace_uuid}/add-users: post: operationId: users_api_admin_workspaces_add_users_workspaces summary: Add Users Workspaces description: Add members to a Workspace. tags: - beta.admin.workspaces security: - AdminApiKey: [] parameters: - name: workspace_uuid in: path description: Workspace ID. required: true schema: type: string title: Workspace Uuid format: uuid description: Workspace ID. requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkspaceMemberIN' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddUsersToWorkspaceOUT' /v1/admin/workspaces/{workspace_uuid}/users: patch: operationId: users_api_admin_workspaces_add_or_update_users_workspaces summary: Add Or Update Users Workspaces description: Add or update Workspace members. tags: - beta.admin.workspaces security: - AdminApiKey: [] parameters: - name: workspace_uuid in: path description: Workspace ID. required: true schema: type: string title: Workspace Uuid format: uuid description: Workspace ID. requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkspaceMemberIN' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddOrUpdateUsersToWorkspaceOUT' /v1/admin/workspaces/{workspace_uuid}/remove-users: delete: operationId: users_api_admin_workspaces_remove_users_workspaces summary: Remove Users Workspaces description: Remove members from a Workspace. tags: - beta.admin.workspaces security: - AdminApiKey: [] parameters: - name: workspace_uuid in: path description: Workspace ID. required: true schema: type: string title: Workspace Uuid format: uuid description: Workspace ID. requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveWorkspaceMembersIN' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RemoveWorkspaceMembersOUT' /v1/admin/rate-limit: get: operationId: users_api_admin_rate_limits_get_rate_limits summary: Get Rate Limits tags: - beta.admin.billing security: - AdminApiKey: [] parameters: [] responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RateLimitsOUT' description: Get Rate Limits /v1/admin/spend-limit: get: operationId: users_api_admin_spend_limits_get_spend_limits summary: Get Spend Limits description: Get usage, rate, and job limits for the Organization. tags: - beta.admin.billing security: - AdminApiKey: [] parameters: [] responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LimitsOUT' post: operationId: users_api_admin_spend_limits_update_spend_limits summary: Update Spend Limits description: Update the Organization usage limit. tags: - beta.admin.billing security: - AdminApiKey: [] parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/NewUsageLimitIN' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LimitsOUT' /v1/admin/usage: get: operationId: users_api_admin_usage_get_usage summary: Get Usage description: Get usage and cost data for the Organization. tags: - beta.admin.billing security: - AdminApiKey: [] parameters: - name: month in: query description: Month to return usage for. required: false schema: anyOf: - type: string - type: 'null' title: Month description: Month to return usage for. - name: year in: query description: Year to return usage for. required: false schema: anyOf: - type: string - type: 'null' title: Year description: Year to return usage for. - name: workspace_id in: query description: Workspace ID to filter results. required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Workspace Id description: Workspace ID to filter results. - name: api_zone in: query description: Regional inference zone to filter results. required: false schema: anyOf: - $ref: '#/components/schemas/ApiZone' - type: 'null' description: Regional inference zone to filter results. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UsageOUTJSON' /v1/admin/audit-logs: get: operationId: users_api_admin_audit_logs_get_audit_logs summary: Get Audit Logs description: List audit log entries for the Organization. tags: - beta.admin.audit-logs security: - AdminApiKey: [] parameters: - name: actor_type in: query description: Actor types to include in the audit log results. required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/ActorType' - type: 'null' title: Actor Type description: Actor types to include in the audit log results. - name: event_type in: query description: Event types to include in the audit log results. required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/AuditLogEventType' - type: 'null' title: Event Type description: Event types to include in the audit log results. - name: target_type in: query description: Target resource types to include in the audit log results. required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/TargetType' - type: 'null' title: Target Type description: Target resource types to include in the audit log results. - name: actor_user_uuid in: query description: Filter logs by the UUID of the user who performed the action. required: false schema: anyOf: - type: string - type: 'null' title: Actor User Uuid description: Filter logs by the UUID of the user who performed the action. - name: sort in: query description: Sort order for audit log entries. required: false schema: allOf: - type: string title: AuditLogsSorting enum: - ascending - descending description: Sort order for audit log entries. default: descending - name: after in: query description: Return audit log entries after this time. required: false schema: anyOf: - type: string format: date-time - type: 'null' title: After description: Return audit log entries after this time. - name: before in: query description: Return audit log entries before this time. required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Before description: Return audit log entries before this time. - name: limit in: query description: Maximum number of results to return. required: false schema: type: integer title: Limit description: Maximum number of results to return. default: 20 responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/AuditLogOut' title: Response /v1/admin/user-groups: get: operationId: users_api_admin_user_groups_get_user_groups summary: Get User Groups description: Get all user groups across the organization. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: page in: query description: Page number to return. required: false schema: exclusiveMinimum: 0 type: integer title: Page description: Page number to return. default: 1 - name: page_size in: query description: Maximum number of results per page. required: false schema: exclusiveMinimum: 0 type: integer title: Page Size maximum: 100 description: Maximum number of results per page. default: 25 - name: search in: query description: Search term used to filter user groups by name. required: false schema: anyOf: - type: string - type: 'null' examples: - Engineering title: Search description: Search term used to filter user groups by name. examples: {} responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminUserGroupsOut' post: operationId: users_api_admin_user_groups_create_user_group summary: Create User Group description: Create a new user group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminUserGroupIn' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminUserGroupOut' /v1/admin/user-groups/provision-workspace: post: operationId: users_api_admin_user_groups_provision_group_to_workspace summary: Provision Group To Workspace description: Provision all users from a user group to a workspace with a specific role. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminProvisionGroupToWorkspaceIn' required: true responses: '204': description: No Content /v1/admin/user-groups/{group_uuid}: get: operationId: users_api_admin_user_groups_get_user_group summary: Get User Group description: Get a specific user group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path description: User group ID. required: true schema: type: string title: Group Uuid format: uuid description: User group ID. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminUserGroupOut' patch: operationId: users_api_admin_user_groups_update_user_group summary: Update User Group description: Update a user group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path required: true schema: type: string title: Group Uuid format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminUpdateUserGroupIn' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminUserGroupOut' delete: operationId: users_api_admin_user_groups_delete_user_group summary: Delete User Group description: Delete a user group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path description: User group ID. required: true schema: type: string title: Group Uuid format: uuid description: User group ID. responses: '204': description: No Content /v1/admin/user-groups/{group_uuid}/members: get: operationId: users_api_admin_user_groups_get_user_group_members summary: Get User Group Members description: Get members of a user group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path description: User group ID. required: true schema: type: string title: Group Uuid format: uuid description: User group ID. - name: page in: query description: Page number to return. required: false schema: type: integer title: Page description: Page number to return. default: 1 - name: page_size in: query description: Maximum number of results per page. required: false schema: type: integer title: Page Size description: Maximum number of results per page. default: 25 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminUserGroupMembersOut' post: operationId: users_api_admin_user_groups_assign_users_to_group summary: Assign Users To Group description: Assign users to a user group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path required: true schema: type: string title: Group Uuid format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminAssignUsersToGroupIn' required: true responses: '204': description: No Content delete: operationId: users_api_admin_user_groups_remove_users_from_group summary: Remove Users From Group description: Remove users from a user group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path required: true schema: type: string title: Group Uuid format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminAssignUsersToGroupIn' required: true responses: '204': description: No Content /v1/admin/user-groups/{group_uuid}/workspaces: get: operationId: users_admin_user_groups_get_group_workspace_assignments summary: Get Group Workspace Assignments description: List workspace assignments for a user group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path description: User group ID. required: true schema: type: string title: Group Uuid format: uuid description: User group ID. - name: page in: query description: Page number to return. required: false schema: exclusiveMinimum: 0 type: integer title: Page description: Page number to return. default: 1 - name: page_size in: query description: Maximum number of results per page. required: false schema: exclusiveMinimum: 0 type: integer title: Page Size maximum: 100 description: Maximum number of results per page. default: 25 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GroupWorkspaceAssignmentsOut' post: operationId: users_api_admin_user_groups_assign_group_to_workspace summary: Assign Group To Workspace description: Assign a user group to a workspace. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path description: User group ID. required: true schema: type: string title: Group Uuid format: uuid description: User group ID. requestBody: content: application/json: schema: $ref: '#/components/schemas/AssignGroupToWorkspaceIn' required: true responses: '201': description: Created /v1/admin/user-groups/{group_uuid}/workspaces/{workspace_uuid}: patch: operationId: users_admin_user_groups_update_group_workspace_assignment summary: Update Group Workspace Assignment description: Update the workspace role assignment for a user group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path description: User group ID. required: true schema: type: string title: Group Uuid format: uuid description: User group ID. - name: workspace_uuid in: path description: Workspace ID. required: true schema: type: string title: Workspace Uuid format: uuid description: Workspace ID. requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateGroupWorkspaceAssignmentIn' required: true responses: '204': description: No Content delete: operationId: users_admin_user_groups_remove_group_from_workspace summary: Remove Group From Workspace description: Remove a user group from a workspace. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path description: User group ID. required: true schema: type: string title: Group Uuid format: uuid description: User group ID. - name: workspace_uuid in: path description: Workspace ID. required: true schema: type: string title: Workspace Uuid format: uuid description: Workspace ID. responses: '204': description: No Content /v1/admin/user-groups/{group_uuid}/organization-role: patch: operationId: users_admin_user_groups_update_user_group_organization_role summary: Update User Group Organization Role description: Update the organization role for a user group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path description: User group ID. required: true schema: type: string title: Group Uuid format: uuid description: User group ID. requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserGroupOrganizationRoleIn' required: true responses: '204': description: No Content /v1/admin/user-groups/{group_uuid}/nested: get: operationId: users_api_admin_user_groups_get_nested_groups summary: Get Nested Groups Admin description: List the groups directly nested inside this group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path description: User group ID. required: true schema: type: string title: Group Uuid format: uuid description: User group ID. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NestedGroupsOut' patch: operationId: users_api_admin_user_groups_set_nested_groups summary: Set Nested Groups Admin description: Replace the set of groups directly nested inside this group. tags: - beta.admin.user-groups security: - AdminApiKey: [] parameters: - name: group_uuid in: path description: User group ID. required: true schema: type: string title: Group Uuid format: uuid description: User group ID. requestBody: content: application/json: schema: $ref: '#/components/schemas/SetNestedGroupsIn' required: true responses: '204': description: No Content /v1/admin/api-keys: get: operationId: users_api_admin_api_keys_get_api_keys summary: Get Api Keys description: List API keys for the Organization. tags: - beta.admin.api-keys security: - AdminApiKey: [] parameters: - name: limit in: query description: Maximum number of results to return. required: false schema: type: integer title: Limit description: Maximum number of results to return. default: 100 - name: offset in: query description: Number of results to skip before returning results. required: false schema: type: integer title: Offset description: Number of results to skip before returning results. default: 0 - name: name in: query description: Filter API keys by name substring or the last 4 characters of the key. Matching is case-insensitive and accent-insensitive. required: false schema: anyOf: - type: string - type: 'null' title: Name description: Filter API keys by name substring or the last 4 characters of the key. Matching is case-insensitive and accent-insensitive. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/APIKeysExtendedOUT' post: operationId: users_api_admin_api_keys_create_api_key summary: Create Api Key description: Create a Workspace API key. tags: - beta.admin.api-keys security: - AdminApiKey: [] parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminCreateAPIKeyIN' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/APIKeyOUT' /v1/admin/api-keys/{key_id}: delete: operationId: users_api_admin_api_keys_delete_api_key summary: Delete Api Key description: Delete an API key. tags: - beta.admin.api-keys security: - AdminApiKey: [] parameters: - name: key_id in: path description: API key ID. required: true schema: type: string title: Key Id format: uuid description: API key ID. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteAPIKeyOUT' /v1/admin/scim/sync: post: operationId: users_api_admin_scim_sync_trigger_scim_sync summary: Trigger Scim Sync description: 'Trigger an on-demand SCIM synchronization for the Organization. Requires SAML authentication to be enabled and the Organization to be in SCIM user provisioning mode. A dry run previews every change without applying it; a real run applies the categories selected in `sync_config`. Only one run may be active at a time — a conflicting request returns the already-active run.' tags: - beta.admin.scim security: - AdminApiKey: [] parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminScimSyncTriggerIN' required: true responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/AdminScimSyncTriggerOUT' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/AdminScimSyncActiveRunOUT' /v1/admin/scim/sync/{run_id}: get: operationId: users_api_admin_scim_sync_get_scim_sync_run summary: Get Scim Sync Run description: 'Retrieve an on-demand SCIM synchronization run for the Organization. Returns the run''s lifecycle status along with the preview or result summary once the synchronization plan has been built.' tags: - beta.admin.scim security: - AdminApiKey: [] parameters: - name: run_id in: path description: Identifier of the SCIM synchronization run. required: true schema: type: string examples: - 6f9619ff-8b86-d011-b42d-00cf4fc964ff title: Run Id format: uuid description: Identifier of the SCIM synchronization run. examples: {} responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdminScimSyncRunOUT' /v1/admin/analytics/vibe/work/usage/by_user_stats: get: operationId: get_by_user_stats_v1_admin_analytics_vibe_work_usage_by_user_stats summary: Usage by user description: Get Vibe Work usage by user for a time range. tags: - beta.admin.vibe-work-analytics security: - AdminApiKey: [] parameters: - name: start_time in: query description: Start of the queried window, as a Unix timestamp in seconds. required: true schema: type: integer examples: - 1764547200 title: Start Time description: Start of the queried window, as a Unix timestamp in seconds. - name: end_time in: query description: End of the queried window, as a Unix timestamp in seconds. required: true schema: type: integer examples: - 1767225600 title: End Time description: End of the queried window, as a Unix timestamp in seconds. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VibeWorkByUserStatsOUT' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/admin/analytics/vibe/work/usage/by_agent_stats: get: operationId: get_by_agent_stats_v1_admin_analytics_vibe_work_usage_by_agent_stats summary: Usage by agent description: Get Vibe Work usage by agent for a time range. tags: - beta.admin.vibe-work-analytics security: - AdminApiKey: [] parameters: - name: start_time in: query description: Start of the queried window, as a Unix timestamp in seconds. required: true schema: type: integer examples: - 1764547200 title: Start Time description: Start of the queried window, as a Unix timestamp in seconds. - name: end_time in: query description: End of the queried window, as a Unix timestamp in seconds. required: true schema: type: integer examples: - 1767225600 title: End Time description: End of the queried window, as a Unix timestamp in seconds. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VibeWorkByAgentStatsOUT' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/admin/analytics/vibe/work/usage/by_time_stats: get: operationId: get_by_time_stats_v1_admin_analytics_vibe_work_usage_by_time_stats summary: Usage over time description: Get Vibe Work usage over time. tags: - beta.admin.vibe-work-analytics security: - AdminApiKey: [] parameters: - name: start_time in: query description: Start of the queried window, as a Unix timestamp in seconds. required: true schema: type: integer examples: - 1764547200 title: Start Time description: Start of the queried window, as a Unix timestamp in seconds. - name: end_time in: query description: End of the queried window, as a Unix timestamp in seconds. required: true schema: type: integer examples: - 1767225600 title: End Time description: End of the queried window, as a Unix timestamp in seconds. - name: granularity in: query description: Time interval used to group usage results. required: false schema: anyOf: - type: string enum: - hour - day - week - month - type: 'null' examples: - day title: Granularity description: Time interval used to group usage results. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VibeWorkByTimeStatsOUT' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/admin/analytics/vibe/code/usage/by_workspace: get: operationId: get_workspace_stats_v1_admin_analytics_vibe_code_usage_by_workspace summary: Usage by workspace description: Get Vibe Code usage for a Workspace. tags: - beta.admin.vibe-code-analytics security: - AdminApiKey: [] parameters: - name: start_time in: query description: Start of the queried window, as a Unix timestamp in seconds. required: true schema: type: integer examples: - 1764547200 title: Start Time description: Start of the queried window, as a Unix timestamp in seconds. - name: end_time in: query description: End of the queried window, as a Unix timestamp in seconds. required: true schema: type: integer examples: - 1767225600 title: End Time description: End of the queried window, as a Unix timestamp in seconds. - name: workspace_id in: query description: Workspace ID to filter results. required: false schema: anyOf: - type: string - type: 'null' examples: - e2f0a7c4-1b6d-4a9e-8c3f-5d7b9a1c2e3f title: Workspace Id description: Workspace ID to filter results. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VibeWorkspaceStatsOUT' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/admin/analytics/vibe/code/usage/by_organization: get: operationId: get_organization_stats_v1_admin_analytics_vibe_code_usage_by_organization summary: Usage by organization description: Get Vibe Code usage for the Organization. tags: - beta.admin.vibe-code-analytics security: - AdminApiKey: [] parameters: - name: start_time in: query description: Start of the queried window, as a Unix timestamp in seconds. required: true schema: type: integer examples: - 1764547200 title: Start Time description: Start of the queried window, as a Unix timestamp in seconds. - name: end_time in: query description: End of the queried window, as a Unix timestamp in seconds. required: true schema: type: integer examples: - 1767225600 title: End Time description: End of the queried window, as a Unix timestamp in seconds. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VibeOrganizationStatsOUT' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: ListSortDirection: type: string title: ListSortDirection enum: - list_sort_direction_unspecified - list_sort_direction_asc - list_sort_direction_desc ListSortField: type: string title: ListSortField enum: - list_sort_field_unspecified - list_sort_field_created_at - list_sort_field_last_modified_at - list_sort_field_name - list_sort_field_title RegistrySharingScope: type: string title: RegistrySharingScope enum: - sharing_scope_unspecified - private - workspace AliasList: type: object properties: values: type: array items: type: string title: values title: AliasList additionalProperties: false description: Presence wrapper for a set of alias labels on update RPCs. As a message field it carries presence, so callers can distinguish "leave aliases unchanged" (field omitted) from "clear all aliases" (field set, empty ``values``). CreatePromptRequest: type: object properties: name: type: string title: name description: Stable object name. definition: title: definition $ref: '#/components/schemas/PromptDefinition' title: type: string title: title nullable: true description: Display title. description: type: string title: description nullable: true description: Display description. notes: type: string title: notes nullable: true description: Notes for this version. sharingScope: title: sharing_scope nullable: true $ref: '#/components/schemas/RegistrySharingScope' description: Registry sharing scope. aliases: type: array items: type: string title: aliases description: Aliases pointing to this version. title: CreatePromptRequest additionalProperties: false required: - name - definition CreatePromptVersionResponse: type: object properties: version: type: integer title: version format: int32 example: 1 deduplicated: type: boolean title: deduplicated example: false title: CreatePromptVersionResponse additionalProperties: false DeletePromptResponse: type: object title: DeletePromptResponse additionalProperties: false ListPromptVersionsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PromptVersion' title: data title: ListPromptVersionsResponse additionalProperties: false ListPromptsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Prompt' title: data nextPageToken: type: string title: next_page_token title: ListPromptsResponse additionalProperties: false Prompt: type: object properties: id: type: string title: id name: type: string title: name description: Stable object name. definition: title: definition $ref: '#/components/schemas/PromptDefinition' version: type: integer title: version format: int32 example: 1 notes: type: string title: notes description: Notes for this version. aliases: type: array items: type: string title: aliases description: Aliases pointing to this version. sharingScope: title: sharing_scope $ref: '#/components/schemas/RegistrySharingScope' description: Registry sharing scope. createdAt: title: created_at $ref: '#/components/schemas/Timestamp' description: Creation time. updatedAt: title: updated_at $ref: '#/components/schemas/Timestamp' description: Last update time. latestVersion: type: integer title: latest_version format: int32 description: Latest version number. example: 1 title: type: string title: title description: Display title. description: type: string title: description description: Display description. title: Prompt additionalProperties: false PromptDefinition: type: object properties: content: type: string title: content description: Prompt template content. variables: type: array items: $ref: '#/components/schemas/PromptVariable' title: variables description: Variables used by the prompt. title: PromptDefinition additionalProperties: false description: Versioned prompt content. required: - content PromptVariable: type: object properties: name: type: string title: name description: Stable object name. title: PromptVariable additionalProperties: false PromptVersion: type: object properties: version: type: integer title: version format: int32 example: 1 definition: title: definition $ref: '#/components/schemas/PromptDefinition' notes: type: string title: notes description: Notes for this version. aliases: type: array items: type: string title: aliases description: Aliases pointing to this version. createdAt: title: created_at $ref: '#/components/schemas/Timestamp' description: Creation time. title: PromptVersion additionalProperties: false Timestamp: type: string examples: - 1s - 1.000340012s format: date-time description: RFC 3339 timestamp. title: Timestamp SkillAssetContent: type: object oneOf: - properties: rawContent: type: string title: raw_content format: byte title: raw_content required: - rawContent - properties: textContent: type: string title: text_content title: text_content required: - textContent properties: isExecutable: type: boolean title: is_executable title: SkillAssetContent additionalProperties: false CreateSkillRequest: type: object properties: name: type: string title: name description: Stable object name. definition: title: definition $ref: '#/components/schemas/SkillDefinition' notes: type: string title: notes nullable: true description: Notes for this version. sharingScope: title: sharing_scope nullable: true $ref: '#/components/schemas/RegistrySharingScope' description: Registry sharing scope. aliases: type: array items: type: string title: aliases description: Aliases pointing to this version. title: CreateSkillRequest additionalProperties: false required: - name - definition CreateSkillVersionResponse: type: object properties: version: type: integer title: version format: int32 example: 1 deduplicated: type: boolean title: deduplicated example: false title: CreateSkillVersionResponse additionalProperties: false DeleteSkillResponse: type: object title: DeleteSkillResponse additionalProperties: false ListSkillVersionsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/SkillVersion' title: data title: ListSkillVersionsResponse additionalProperties: false ListSkillsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Skill' title: data nextPageToken: type: string title: next_page_token title: ListSkillsResponse additionalProperties: false Skill: type: object properties: id: type: string title: id name: type: string title: name description: Stable object name. definition: title: definition $ref: '#/components/schemas/SkillDefinition' version: type: integer title: version format: int32 example: 1 notes: type: string title: notes description: Notes for this version. aliases: type: array items: type: string title: aliases description: Aliases pointing to this version. sharingScope: title: sharing_scope $ref: '#/components/schemas/RegistrySharingScope' description: Registry sharing scope. createdAt: title: created_at $ref: '#/components/schemas/Timestamp' description: Creation time. updatedAt: title: updated_at $ref: '#/components/schemas/Timestamp' description: Last update time. latestVersion: type: integer title: latest_version format: int32 description: Latest version number. example: 1 title: Skill additionalProperties: false SkillDefinition: type: object properties: description: type: string title: description description: Model-facing trigger and usage description. body: type: string title: body description: Skill body content. assets: type: object title: assets additionalProperties: title: value $ref: '#/components/schemas/SkillAssetContent' description: Additional files available to the skill. title: SkillDefinition additionalProperties: false description: Versioned skill content. SkillVersion: type: object properties: version: type: integer title: version format: int32 example: 1 definition: title: definition $ref: '#/components/schemas/SkillDefinition' notes: type: string title: notes description: Notes for this version. aliases: type: array items: type: string title: aliases description: Aliases pointing to this version. createdAt: title: created_at $ref: '#/components/schemas/Timestamp' description: Creation time. title: SkillVersion additionalProperties: false BaseModelCard: type: object properties: id: type: string title: Id object: type: string title: Object default: model created: type: integer title: Created owned_by: type: string title: Owned By default: mistralai capabilities: $ref: '#/components/schemas/ModelCapabilities' name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description max_context_length: type: integer title: Max Context Length default: 32768 aliases: type: array items: type: string title: Aliases default: [] deprecation: anyOf: - type: string format: date-time - type: 'null' title: Deprecation deprecation_replacement_model: anyOf: - type: string - type: 'null' title: Deprecation Replacement Model default_model_temperature: anyOf: - type: number - type: 'null' title: Default Model Temperature internal: type: boolean title: Internal default: false type: type: string title: Type default: base const: base title: BaseModelCard required: - id - capabilities FTModelCard: type: object properties: id: type: string title: Id object: type: string title: Object default: model created: type: integer title: Created owned_by: type: string title: Owned By default: mistralai capabilities: $ref: '#/components/schemas/ModelCapabilities' name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description max_context_length: type: integer title: Max Context Length default: 32768 aliases: type: array items: type: string title: Aliases default: [] deprecation: anyOf: - type: string format: date-time - type: 'null' title: Deprecation deprecation_replacement_model: anyOf: - type: string - type: 'null' title: Deprecation Replacement Model default_model_temperature: anyOf: - type: number - type: 'null' title: Default Model Temperature internal: type: boolean title: Internal default: false type: type: string title: Type default: fine-tuned const: fine-tuned job: type: string title: Job root: type: string title: Root archived: type: boolean title: Archived default: false title: FTModelCard required: - id - capabilities - job - root description: Extra fields for fine-tuned models. HTTPValidationError: type: object properties: detail: type: array items: $ref: '#/components/schemas/ValidationError' title: Detail title: HTTPValidationError MetadataDict: type: object properties: {} title: MetadataDict additionalProperties: true description: Custom type for metadata with embedded validation. ModelCapabilities: type: object properties: completion_chat: type: boolean title: Completion Chat default: false function_calling: type: boolean title: Function Calling default: false reasoning: type: boolean title: Reasoning default: false completion_fim: type: boolean title: Completion Fim default: false fine_tuning: type: boolean title: Fine Tuning default: false vision: type: boolean title: Vision default: false ocr: type: boolean title: Ocr default: false classification: type: boolean title: Classification default: false moderation: type: boolean title: Moderation default: false audio: type: boolean title: Audio default: false audio_transcription: type: boolean title: Audio Transcription default: false audio_transcription_realtime: type: boolean title: Audio Transcription Realtime default: false audio_speech: type: boolean title: Audio Speech default: false unified_resources: type: boolean title: Unified Resources default: false title: ModelCapabilities description: 'This is populated by Harmattan, but some fields have a name that we don''t want to expose in the API.' ModelList: type: object properties: object: type: string title: Object default: list data: type: array items: oneOf: - $ref: '#/components/schemas/BaseModelCard' - $ref: '#/components/schemas/FTModelCard' discriminator: propertyName: type mapping: base: '#/components/schemas/BaseModelCard' fine-tuned: '#/components/schemas/FTModelCard' title: Data title: ModelList SpeechOutputFormat: type: string title: SpeechOutputFormat enum: - pcm - wav - mp3 - flac - opus SpeechRequest: type: object properties: model: anyOf: - type: string - type: 'null' title: Model metadata: anyOf: - $ref: '#/components/schemas/MetadataDict' - type: 'null' stream: type: boolean title: Stream default: false prompt_cache_key: anyOf: - type: string - type: 'null' title: Prompt Cache Key voice_id: anyOf: - type: string - type: 'null' title: Voice Id description: The preset or custom voice to use for generating the speech. ref_audio: anyOf: - type: string - type: string - type: 'null' title: Ref Audio description: The audio reference for generating the speech. input: type: string title: Input description: Text to generate a speech from response_format: $ref: '#/components/schemas/SpeechOutputFormat' description: Output audio format. Defaults to mp3. default: mp3 title: SpeechRequest required: - input additionalProperties: true ValidationError: type: object properties: loc: type: array items: anyOf: - type: string - type: integer title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context title: ValidationError required: - loc - msg - type APIKeyAuth: type: object properties: type: type: string title: Type enum: - api-key default: api-key value: type: string title: Value title: APIKeyAuth required: - value additionalProperties: false Agent: type: object properties: instructions: anyOf: - type: string - type: 'null' title: Instructions description: Instruction prompt the model will follow during the conversation. tools: type: array items: oneOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/WebSearchPremiumTool' - $ref: '#/components/schemas/CodeInterpreterTool' - $ref: '#/components/schemas/ImageGenerationTool' - $ref: '#/components/schemas/DocumentLibraryTool' - $ref: '#/components/schemas/CustomConnector' discriminator: propertyName: type mapping: code_interpreter: '#/components/schemas/CodeInterpreterTool' connector: '#/components/schemas/CustomConnector' document_library: '#/components/schemas/DocumentLibraryTool' function: '#/components/schemas/FunctionTool' image_generation: '#/components/schemas/ImageGenerationTool' web_search: '#/components/schemas/WebSearchTool' web_search_premium: '#/components/schemas/WebSearchPremiumTool' title: Tools description: List of tools which are available to the model during the conversation. completion_args: $ref: '#/components/schemas/CompletionArgs' description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. guardrails: anyOf: - type: array items: $ref: '#/components/schemas/GuardrailConfig' - type: 'null' title: Guardrails model: type: string title: Model name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description handoffs: anyOf: - type: array items: type: string minItems: 1 - type: 'null' title: Handoffs metadata: anyOf: - $ref: '#/components/schemas/MetadataDict' - type: 'null' object: type: string title: Object default: agent const: agent id: type: string title: Id version: type: integer title: Version versions: type: array items: type: integer title: Versions created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time deployment_chat: type: boolean title: Deployment Chat source: type: string title: Source version_message: anyOf: - type: string - type: 'null' title: Version Message title: Agent required: - model - name - id - version - versions - created_at - updated_at - deployment_chat - source additionalProperties: false AgentAliasResponse: type: object properties: alias: type: string title: Alias version: type: integer title: Version created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time title: AgentAliasResponse required: - alias - version - created_at - updated_at additionalProperties: false AgentConversation: type: object properties: name: anyOf: - type: string - type: 'null' title: Name description: Name given to the conversation. description: anyOf: - type: string - type: 'null' title: Description description: Description of the what the conversation is about. metadata: anyOf: - $ref: '#/components/schemas/MetadataDict' - type: 'null' description: Custom metadata for the conversation. object: type: string title: Object default: conversation const: conversation id: type: string title: Id created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time agent_id: type: string title: Agent Id agent_version: anyOf: - type: string - type: integer - type: 'null' title: Agent Version title: AgentConversation required: - id - created_at - updated_at - agent_id additionalProperties: false AgentHandoffEntry: type: object properties: object: type: string title: Object default: entry const: entry type: type: string title: Type default: agent.handoff const: agent.handoff created_at: type: string title: Created At format: date-time completed_at: anyOf: - type: string format: date-time - type: 'null' title: Completed At id: type: string title: Id previous_agent_id: type: string title: Previous Agent Id previous_agent_name: type: string title: Previous Agent Name next_agent_id: type: string title: Next Agent Id next_agent_name: type: string title: Next Agent Name title: AgentHandoffEntry required: - previous_agent_id - previous_agent_name - next_agent_id - next_agent_name additionalProperties: false AgentListPage: type: object properties: object: type: string title: Object default: list const: list data: type: array items: $ref: '#/components/schemas/Agent' title: Data next_page_token: anyOf: - type: string - type: 'null' title: Next Page Token title: AgentListPage required: - data additionalProperties: false BuiltInConnectors: type: string title: BuiltInConnectors enum: - web_search - web_search_premium - code_interpreter - image_generation - document_library CodeInterpreterTool: type: object properties: tool_configuration: anyOf: - $ref: '#/components/schemas/ToolConfiguration' - type: 'null' type: type: string title: Type enum: - code_interpreter default: code_interpreter title: CodeInterpreterTool additionalProperties: false CompletionArgs: type: object properties: stop: $ref: '#/components/schemas/CompletionArgsStop' presence_penalty: anyOf: - type: number maximum: 2 minimum: -2 - type: 'null' title: Presence Penalty frequency_penalty: anyOf: - type: number maximum: 2 minimum: -2 - type: 'null' title: Frequency Penalty temperature: anyOf: - type: number maximum: 1 minimum: 0 - type: 'null' title: Temperature top_p: anyOf: - type: number maximum: 1 minimum: 0 - type: 'null' title: Top P max_tokens: anyOf: - type: integer minimum: 0 - type: 'null' title: Max Tokens random_seed: anyOf: - type: integer minimum: 0 - type: 'null' title: Random Seed prediction: anyOf: - $ref: '#/components/schemas/Prediction' - type: 'null' response_format: anyOf: - $ref: '#/components/schemas/ResponseFormat' - type: 'null' tool_choice: $ref: '#/components/schemas/ToolChoiceEnum' default: auto reasoning_effort: anyOf: - $ref: '#/components/schemas/ReasoningEffort' - type: 'null' title: CompletionArgs additionalProperties: false description: White-listed arguments from the completion API ConversationAppendRequest: allOf: - $ref: '#/components/schemas/AppendConversationRequest' - type: object properties: stream: type: boolean enum: - false default: false ConversationHistory: type: object properties: object: type: string title: Object default: conversation.history const: conversation.history conversation_id: type: string title: Conversation Id entries: type: array items: anyOf: - $ref: '#/components/schemas/MessageInputEntry' - $ref: '#/components/schemas/MessageOutputEntry' - $ref: '#/components/schemas/FunctionResultEntry' - $ref: '#/components/schemas/FunctionCallEntry' - $ref: '#/components/schemas/ToolExecutionEntry' - $ref: '#/components/schemas/AgentHandoffEntry' title: Entries title: ConversationHistory required: - conversation_id - entries additionalProperties: false description: Retrieve all entries in a conversation. ConversationMessages: type: object properties: object: type: string title: Object default: conversation.messages const: conversation.messages conversation_id: type: string title: Conversation Id messages: $ref: '#/components/schemas/MessageEntries' title: ConversationMessages required: - conversation_id - messages additionalProperties: false description: Similar to the conversation history but only keep the messages ConversationRestartRequest: allOf: - $ref: '#/components/schemas/RestartConversationRequest' - type: object properties: stream: type: boolean enum: - false default: false CustomConnector: type: object properties: type: type: string title: Type enum: - connector default: connector connector_id: type: string title: Connector Id authorization: anyOf: - oneOf: - $ref: '#/components/schemas/OAuth2TokenAuth' - $ref: '#/components/schemas/APIKeyAuth' discriminator: propertyName: type mapping: api-key: '#/components/schemas/APIKeyAuth' oauth2-token: '#/components/schemas/OAuth2TokenAuth' - type: 'null' title: Authorization tool_configuration: anyOf: - $ref: '#/components/schemas/ToolConfiguration' - type: 'null' title: CustomConnector required: - connector_id additionalProperties: false DocumentLibraryTool: type: object properties: tool_configuration: anyOf: - $ref: '#/components/schemas/ToolConfiguration' - type: 'null' type: type: string title: Type enum: - document_library default: document_library library_ids: type: array items: type: string title: Library Ids minItems: 1 description: Ids of the library in which to search. title: DocumentLibraryTool required: - library_ids additionalProperties: false DocumentURLChunk: type: object properties: type: type: string title: Type default: document_url const: document_url document_url: type: string title: Document Url document_name: anyOf: - type: string - type: 'null' title: Document Name description: The filename of the document title: DocumentURLChunk required: - document_url additionalProperties: false Function: type: object properties: name: type: string title: Name description: type: string title: Description default: '' strict: type: boolean title: Strict default: false parameters: type: object title: Parameters additionalProperties: true title: Function required: - name - parameters additionalProperties: false FunctionCallEntry: type: object properties: object: type: string title: Object default: entry const: entry type: type: string title: Type default: function.call const: function.call created_at: type: string title: Created At format: date-time completed_at: anyOf: - type: string format: date-time - type: 'null' title: Completed At agent_id: anyOf: - type: string - type: 'null' title: Agent Id model: anyOf: - type: string - type: 'null' title: Model id: type: string title: Id tool_call_id: type: string title: Tool Call Id name: type: string title: Name arguments: $ref: '#/components/schemas/FunctionCallEntryArguments' confirmation_status: anyOf: - type: string enum: - pending - allowed - denied - type: 'null' title: Confirmation Status title: FunctionCallEntry required: - tool_call_id - name - arguments additionalProperties: false FunctionResultEntry: type: object properties: object: type: string title: Object default: entry const: entry type: type: string title: Type default: function.result const: function.result created_at: type: string title: Created At format: date-time completed_at: anyOf: - type: string format: date-time - type: 'null' title: Completed At id: type: string title: Id tool_call_id: type: string title: Tool Call Id result: type: string title: Result title: FunctionResultEntry required: - tool_call_id - result additionalProperties: false FunctionTool: type: object properties: type: type: string title: Type enum: - function default: function function: $ref: '#/components/schemas/Function' title: FunctionTool required: - function additionalProperties: false GuardrailConfig: type: object properties: block_on_error: type: boolean title: Block On Error description: If true, return HTTP 403 and block request in the event of a server-side error default: false moderation_llm_v1: anyOf: - $ref: '#/components/schemas/ModerationLLMV1Config' - type: 'null' moderation_llm_v2: anyOf: - $ref: '#/components/schemas/ModerationLLMV2Config' - type: 'null' title: GuardrailConfig ImageDetail: type: string title: ImageDetail enum: - low - auto - high ImageGenerationTool: type: object properties: tool_configuration: anyOf: - $ref: '#/components/schemas/ToolConfiguration' - type: 'null' type: type: string title: Type enum: - image_generation default: image_generation title: ImageGenerationTool additionalProperties: false ImageURL: type: object properties: url: type: string title: Url detail: anyOf: - $ref: '#/components/schemas/ImageDetail' - type: 'null' title: ImageURL required: - url additionalProperties: false ImageURLChunk: type: object properties: type: type: string title: Type default: image_url const: image_url image_url: anyOf: - $ref: '#/components/schemas/ImageURL' - type: string title: Image Url title: ImageURLChunk required: - image_url additionalProperties: false description: '{"type":"image_url","image_url":"data:image/png;base64,iVBORw0"}' JsonSchema: type: object properties: name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description schema: type: object title: Schema additionalProperties: true x-speakeasy-name-override: schema_definition strict: type: boolean title: Strict default: false title: JsonSchema required: - name - schema additionalProperties: false MessageInputEntry: type: object properties: object: type: string title: Object default: entry const: entry type: type: string title: Type default: message.input const: message.input created_at: type: string title: Created At format: date-time completed_at: anyOf: - type: string format: date-time - type: 'null' title: Completed At id: type: string title: Id role: type: string title: Role enum: - assistant - user content: anyOf: - type: string - $ref: '#/components/schemas/MessageInputContentChunks' title: Content prefix: type: boolean title: Prefix default: false title: MessageInputEntry required: - role - content additionalProperties: false description: Representation of an input message inside the conversation. MessageOutputEntry: type: object properties: object: type: string title: Object default: entry const: entry type: type: string title: Type default: message.output const: message.output created_at: type: string title: Created At format: date-time completed_at: anyOf: - type: string format: date-time - type: 'null' title: Completed At agent_id: anyOf: - type: string - type: 'null' title: Agent Id model: anyOf: - type: string - type: 'null' title: Model id: type: string title: Id role: type: string title: Role default: assistant const: assistant content: anyOf: - type: string - $ref: '#/components/schemas/MessageOutputContentChunks' title: Content title: MessageOutputEntry required: - content additionalProperties: false ModelConversation: type: object properties: instructions: anyOf: - type: string - type: 'null' title: Instructions description: Instruction prompt the model will follow during the conversation. tools: type: array items: oneOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/WebSearchPremiumTool' - $ref: '#/components/schemas/CodeInterpreterTool' - $ref: '#/components/schemas/ImageGenerationTool' - $ref: '#/components/schemas/DocumentLibraryTool' - $ref: '#/components/schemas/CustomConnector' discriminator: propertyName: type mapping: code_interpreter: '#/components/schemas/CodeInterpreterTool' connector: '#/components/schemas/CustomConnector' document_library: '#/components/schemas/DocumentLibraryTool' function: '#/components/schemas/FunctionTool' image_generation: '#/components/schemas/ImageGenerationTool' web_search: '#/components/schemas/WebSearchTool' web_search_premium: '#/components/schemas/WebSearchPremiumTool' title: Tools description: List of tools which are available to the model during the conversation. completion_args: $ref: '#/components/schemas/CompletionArgs' description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. guardrails: anyOf: - type: array items: $ref: '#/components/schemas/GuardrailConfig' - type: 'null' title: Guardrails name: anyOf: - type: string - type: 'null' title: Name description: Name given to the conversation. description: anyOf: - type: string - type: 'null' title: Description description: Description of the what the conversation is about. metadata: anyOf: - $ref: '#/components/schemas/MetadataDict' - type: 'null' description: Custom metadata for the conversation. object: type: string title: Object default: conversation const: conversation id: type: string title: Id created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time model: type: string title: Model title: ModelConversation required: - id - created_at - updated_at - model additionalProperties: false ModerationLLMAction: type: string title: ModerationLLMAction enum: - none - block ModerationLLMV1CategoryThresholds: type: object properties: sexual: anyOf: - type: number - type: 'null' title: Sexual hate_and_discrimination: anyOf: - type: number - type: 'null' title: Hate And Discrimination violence_and_threats: anyOf: - type: number - type: 'null' title: Violence And Threats dangerous_and_criminal_content: anyOf: - type: number - type: 'null' title: Dangerous And Criminal Content selfharm: anyOf: - type: number - type: 'null' title: Selfharm health: anyOf: - type: number - type: 'null' title: Health financial: anyOf: - type: number - type: 'null' title: Financial law: anyOf: - type: number - type: 'null' title: Law pii: anyOf: - type: number - type: 'null' title: Pii title: ModerationLLMV1CategoryThresholds ModerationLLMV1Config: type: object properties: model_name: type: string title: Model Name description: Override model name. Should be omitted in general. default: mistral-moderation-2411 custom_category_thresholds: anyOf: - $ref: '#/components/schemas/ModerationLLMV1CategoryThresholds' - type: 'null' ignore_other_categories: type: boolean title: Ignore Other Categories description: If true, only evaluate categories in custom_category_thresholds; others are ignored. default: false action: $ref: '#/components/schemas/ModerationLLMAction' description: Action to take if any score is above the threshold for any category. default: none title: ModerationLLMV1Config ModerationLLMV2CategoryThresholds: type: object properties: sexual: anyOf: - type: number - type: 'null' title: Sexual hate_and_discrimination: anyOf: - type: number - type: 'null' title: Hate And Discrimination violence_and_threats: anyOf: - type: number - type: 'null' title: Violence And Threats dangerous: anyOf: - type: number - type: 'null' title: Dangerous criminal: anyOf: - type: number - type: 'null' title: Criminal selfharm: anyOf: - type: number - type: 'null' title: Selfharm health: anyOf: - type: number - type: 'null' title: Health financial: anyOf: - type: number - type: 'null' title: Financial law: anyOf: - type: number - type: 'null' title: Law pii: anyOf: - type: number - type: 'null' title: Pii jailbreaking: anyOf: - type: number - type: 'null' title: Jailbreaking title: ModerationLLMV2CategoryThresholds ModerationLLMV2Config: type: object properties: model_name: type: string title: Model Name description: Override model name. Should be omitted in general. default: mistral-moderation-2603 custom_category_thresholds: anyOf: - $ref: '#/components/schemas/ModerationLLMV2CategoryThresholds' - type: 'null' ignore_other_categories: type: boolean title: Ignore Other Categories description: If true, only evaluate categories in custom_category_thresholds; others are ignored. default: false action: $ref: '#/components/schemas/ModerationLLMAction' description: Action to take if any score is above the threshold for any category. default: none title: ModerationLLMV2Config OAuth2TokenAuth: type: object properties: type: type: string title: Type enum: - oauth2-token default: oauth2-token value: type: string title: Value title: OAuth2TokenAuth required: - value additionalProperties: false Prediction: type: object properties: type: type: string title: Type default: content const: content content: type: string title: Content default: '' title: Prediction additionalProperties: false description: Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content. ReasoningEffort: type: string title: ReasoningEffort enum: - none - minimal - low - medium - high - xhigh RequestSource: type: string title: RequestSource enum: - api - playground - agent_builder_v1 ResponseFormat: type: object examples: - type: text - type: json_object - type: json_schema json_schema: schema: properties: name: title: Name type: string authors: items: type: string title: Authors type: array required: - name - authors title: Book type: object additionalProperties: false name: book strict: true properties: type: $ref: '#/components/schemas/ResponseFormats' default: text json_schema: anyOf: - $ref: '#/components/schemas/JsonSchema' - type: 'null' title: ResponseFormat additionalProperties: false description: 'Specify the format that the model must output. By default it will use `{ "type": "text" }`. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. Setting to `{ "type": "json_schema" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide.' ResponseFormats: type: string title: ResponseFormats enum: - text - json_object - json_schema TextChunk: type: object properties: type: type: string title: Type default: text const: text text: type: string title: Text title: TextChunk required: - text additionalProperties: false ThinkChunk: type: object properties: type: type: string title: Type default: thinking const: thinking thinking: type: array items: anyOf: - $ref: '#/components/schemas/TextChunk' - $ref: '#/components/schemas/ToolReferenceChunk' - $ref: '#/components/schemas/ReferenceChunk' title: Thinking signature: anyOf: - type: string - type: 'null' title: Signature description: Signature to replay some reasoning blocks across turns. closed: type: boolean title: Closed description: Whether the thinking chunk is closed or not. Currently only used for prefixing. default: true title: ThinkChunk required: - thinking additionalProperties: false ToolCallConfirmation: type: object properties: tool_call_id: type: string title: Tool Call Id confirmation: type: string title: Confirmation enum: - allow - deny title: ToolCallConfirmation required: - tool_call_id - confirmation additionalProperties: false ToolChoiceEnum: type: string title: ToolChoiceEnum enum: - auto - none - any - required ToolConfiguration: type: object properties: exclude: anyOf: - type: array items: type: string - type: 'null' title: Exclude include: anyOf: - type: array items: type: string - type: 'null' title: Include requires_confirmation: anyOf: - type: array items: type: string - type: 'null' title: Requires Confirmation title: ToolConfiguration additionalProperties: false ToolExecutionEntry: type: object properties: object: type: string title: Object default: entry const: entry type: type: string title: Type default: tool.execution const: tool.execution created_at: type: string title: Created At format: date-time completed_at: anyOf: - type: string format: date-time - type: 'null' title: Completed At agent_id: anyOf: - type: string - type: 'null' title: Agent Id model: anyOf: - type: string - type: 'null' title: Model id: type: string title: Id name: anyOf: - $ref: '#/components/schemas/BuiltInConnectors' - type: string title: Name arguments: type: string title: Arguments info: $ref: '#/components/schemas/ToolExecutionInfo' title: ToolExecutionEntry required: - name - arguments additionalProperties: false ToolFileChunk: type: object properties: type: type: string title: Type default: tool_file const: tool_file tool: anyOf: - $ref: '#/components/schemas/BuiltInConnectors' - type: string title: Tool file_id: type: string title: File Id file_name: anyOf: - type: string - type: 'null' title: File Name file_type: anyOf: - type: string - type: 'null' title: File Type title: ToolFileChunk required: - tool - file_id additionalProperties: false ToolReferenceChunk: type: object properties: type: type: string title: Type default: tool_reference const: tool_reference tool: anyOf: - $ref: '#/components/schemas/BuiltInConnectors' - type: string title: Tool title: type: string title: Title url: anyOf: - type: string - type: 'null' title: Url favicon: anyOf: - type: string - type: 'null' title: Favicon description: anyOf: - type: string - type: 'null' title: Description title: ToolReferenceChunk required: - tool - title additionalProperties: false WebSearchPremiumTool: type: object properties: tool_configuration: anyOf: - $ref: '#/components/schemas/ToolConfiguration' - type: 'null' type: type: string title: Type enum: - web_search_premium default: web_search_premium title: WebSearchPremiumTool additionalProperties: false WebSearchTool: type: object properties: tool_configuration: anyOf: - $ref: '#/components/schemas/ToolConfiguration' - type: 'null' type: type: string title: Type enum: - web_search default: web_search title: WebSearchTool additionalProperties: false ConversationUsageInfo: type: object properties: prompt_tokens: type: integer title: Prompt Tokens default: 0 completion_tokens: type: integer title: Completion Tokens default: 0 total_tokens: type: integer title: Total Tokens default: 0 connector_tokens: anyOf: - type: integer - type: 'null' title: Connector Tokens default: null connectors: anyOf: - type: object additionalProperties: type: integer - type: 'null' title: Connectors default: null title: ConversationUsageInfo additionalProperties: false ConversationResponse: type: object properties: object: type: string title: Object default: conversation.response const: conversation.response conversation_id: type: string title: Conversation Id outputs: type: array items: anyOf: - $ref: '#/components/schemas/MessageOutputEntry' - $ref: '#/components/schemas/ToolExecutionEntry' - $ref: '#/components/schemas/FunctionCallEntry' - $ref: '#/components/schemas/AgentHandoffEntry' title: Outputs usage: $ref: '#/components/schemas/ConversationUsageInfo' guardrails: anyOf: - type: array items: type: object additionalProperties: true - type: 'null' title: Guardrails default: null title: ConversationResponse required: - conversation_id - outputs - usage additionalProperties: false description: The response after appending new entries to the conversation. ConversationRequest: allOf: - $ref: '#/components/schemas/ConversationRequestBase' - type: object properties: stream: type: boolean enum: - false default: false AgentHandoffDoneEvent: type: object properties: type: type: string title: Type default: agent.handoff.done const: agent.handoff.done created_at: type: string title: Created At format: date-time output_index: type: integer title: Output Index default: 0 id: type: string title: Id next_agent_id: type: string title: Next Agent Id next_agent_name: type: string title: Next Agent Name title: AgentHandoffDoneEvent required: - id - next_agent_id - next_agent_name additionalProperties: false AgentHandoffStartedEvent: type: object properties: type: type: string title: Type default: agent.handoff.started const: agent.handoff.started created_at: type: string title: Created At format: date-time output_index: type: integer title: Output Index default: 0 id: type: string title: Id previous_agent_id: type: string title: Previous Agent Id previous_agent_name: type: string title: Previous Agent Name title: AgentHandoffStartedEvent required: - id - previous_agent_id - previous_agent_name additionalProperties: false FunctionCallEvent: type: object properties: type: type: string title: Type default: function.call.delta const: function.call.delta created_at: type: string title: Created At format: date-time output_index: type: integer title: Output Index default: 0 id: type: string title: Id model: anyOf: - type: string - type: 'null' title: Model default: null agent_id: anyOf: - type: string - type: 'null' title: Agent Id default: null name: type: string title: Name tool_call_id: type: string title: Tool Call Id arguments: type: string title: Arguments confirmation_status: anyOf: - type: string enum: - pending - allowed - denied - type: 'null' title: Confirmation Status default: null title: FunctionCallEvent required: - id - name - tool_call_id - arguments additionalProperties: false MessageOutputEvent: type: object properties: type: type: string title: Type default: message.output.delta const: message.output.delta created_at: type: string title: Created At format: date-time output_index: type: integer title: Output Index default: 0 id: type: string title: Id content_index: type: integer title: Content Index default: 0 model: anyOf: - type: string - type: 'null' title: Model default: null agent_id: anyOf: - type: string - type: 'null' title: Agent Id default: null role: type: string title: Role default: assistant const: assistant content: anyOf: - type: string - $ref: '#/components/schemas/OutputContentChunks' title: Content title: MessageOutputEvent required: - id - content additionalProperties: false ResponseDoneEvent: type: object properties: type: type: string title: Type default: conversation.response.done const: conversation.response.done created_at: type: string title: Created At format: date-time usage: $ref: '#/components/schemas/ConversationUsageInfo' title: ResponseDoneEvent required: - usage additionalProperties: false ResponseErrorEvent: type: object properties: type: type: string title: Type default: conversation.response.error const: conversation.response.error created_at: type: string title: Created At format: date-time message: type: string title: Message code: type: integer title: Code title: ResponseErrorEvent required: - message - code additionalProperties: false ResponseStartedEvent: type: object properties: type: type: string title: Type default: conversation.response.started const: conversation.response.started created_at: type: string title: Created At format: date-time conversation_id: type: string title: Conversation Id title: ResponseStartedEvent required: - conversation_id additionalProperties: false SSETypes: type: string title: SSETypes enum: - conversation.response.started - conversation.response.done - conversation.response.error - message.output.delta - tool.execution.started - tool.execution.delta - tool.execution.done - agent.handoff.started - agent.handoff.done - function.call.delta description: Server side events sent when streaming a conversation response. ToolExecutionDeltaEvent: type: object properties: type: type: string title: Type default: tool.execution.delta const: tool.execution.delta created_at: type: string title: Created At format: date-time output_index: type: integer title: Output Index default: 0 id: type: string title: Id name: anyOf: - $ref: '#/components/schemas/BuiltInConnectors' - type: string title: Name arguments: type: string title: Arguments title: ToolExecutionDeltaEvent required: - id - name - arguments additionalProperties: false ToolExecutionDoneEvent: type: object properties: type: type: string title: Type default: tool.execution.done const: tool.execution.done created_at: type: string title: Created At format: date-time output_index: type: integer title: Output Index default: 0 id: type: string title: Id name: anyOf: - $ref: '#/components/schemas/BuiltInConnectors' - type: string title: Name info: $ref: '#/components/schemas/ToolExecutionInfo' title: ToolExecutionDoneEvent required: - id - name additionalProperties: false ToolExecutionStartedEvent: type: object properties: type: type: string title: Type default: tool.execution.started const: tool.execution.started created_at: type: string title: Created At format: date-time output_index: type: integer title: Output Index default: 0 id: type: string title: Id model: anyOf: - type: string - type: 'null' title: Model default: null agent_id: anyOf: - type: string - type: 'null' title: Agent Id default: null name: anyOf: - $ref: '#/components/schemas/BuiltInConnectors' - type: string title: Name arguments: type: string title: Arguments title: ToolExecutionStartedEvent required: - id - name - arguments additionalProperties: false ConversationEvents: type: object properties: event: $ref: '#/components/schemas/SSETypes' data: oneOf: - $ref: '#/components/schemas/ResponseStartedEvent' - $ref: '#/components/schemas/ResponseDoneEvent' - $ref: '#/components/schemas/ResponseErrorEvent' - $ref: '#/components/schemas/ToolExecutionStartedEvent' - $ref: '#/components/schemas/ToolExecutionDeltaEvent' - $ref: '#/components/schemas/ToolExecutionDoneEvent' - $ref: '#/components/schemas/MessageOutputEvent' - $ref: '#/components/schemas/FunctionCallEvent' - $ref: '#/components/schemas/AgentHandoffStartedEvent' - $ref: '#/components/schemas/AgentHandoffDoneEvent' discriminator: propertyName: type mapping: agent.handoff.done: '#/components/schemas/AgentHandoffDoneEvent' agent.handoff.started: '#/components/schemas/AgentHandoffStartedEvent' conversation.response.done: '#/components/schemas/ResponseDoneEvent' conversation.response.error: '#/components/schemas/ResponseErrorEvent' conversation.response.started: '#/components/schemas/ResponseStartedEvent' function.call.delta: '#/components/schemas/FunctionCallEvent' message.output.delta: '#/components/schemas/MessageOutputEvent' tool.execution.delta: '#/components/schemas/ToolExecutionDeltaEvent' tool.execution.done: '#/components/schemas/ToolExecutionDoneEvent' tool.execution.started: '#/components/schemas/ToolExecutionStartedEvent' title: Data title: ConversationEvents required: - event - data MessageInputContentChunks: type: array items: anyOf: - $ref: '#/components/schemas/TextChunk' - $ref: '#/components/schemas/ImageURLChunk' - $ref: '#/components/schemas/ToolFileChunk' - $ref: '#/components/schemas/DocumentURLChunk' - $ref: '#/components/schemas/ThinkChunk' title: MessageInputContentChunks MessageOutputContentChunks: type: array items: anyOf: - $ref: '#/components/schemas/TextChunk' - $ref: '#/components/schemas/ImageURLChunk' - $ref: '#/components/schemas/ToolFileChunk' - $ref: '#/components/schemas/DocumentURLChunk' - $ref: '#/components/schemas/ThinkChunk' - $ref: '#/components/schemas/ToolReferenceChunk' title: MessageOutputContentChunks OutputContentChunks: anyOf: - $ref: '#/components/schemas/TextChunk' - $ref: '#/components/schemas/ImageURLChunk' - $ref: '#/components/schemas/ToolFileChunk' - $ref: '#/components/schemas/DocumentURLChunk' - $ref: '#/components/schemas/ThinkChunk' - $ref: '#/components/schemas/ToolReferenceChunk' title: OutputContentChunks MessageEntries: type: array items: anyOf: - $ref: '#/components/schemas/MessageInputEntry' - $ref: '#/components/schemas/MessageOutputEntry' title: MessageEntries InputEntries: type: array items: anyOf: - $ref: '#/components/schemas/MessageInputEntry' - $ref: '#/components/schemas/MessageOutputEntry' - $ref: '#/components/schemas/FunctionResultEntry' - $ref: '#/components/schemas/FunctionCallEntry' - $ref: '#/components/schemas/ToolExecutionEntry' - $ref: '#/components/schemas/AgentHandoffEntry' title: InputEntries CompletionArgsStop: anyOf: - type: string - type: array items: type: string - type: 'null' title: CompletionArgsStop FunctionCallEntryArguments: anyOf: - type: object additionalProperties: true - type: string title: FunctionCallEntryArguments ConversationInputs: anyOf: - type: string - $ref: '#/components/schemas/InputEntries' title: ConversationInputs ToolExecutionInfo: type: object title: ToolExecutionInfo additionalProperties: true ConversationRequestBase: type: object properties: inputs: $ref: '#/components/schemas/ConversationInputs' stream: anyOf: - type: boolean - type: 'null' title: Stream default: null store: anyOf: - type: boolean - type: 'null' title: Store default: null handoff_execution: anyOf: - type: string enum: - client - server - type: 'null' title: Handoff Execution default: null instructions: anyOf: - type: string - type: 'null' title: Instructions default: null tools: anyOf: - type: array items: oneOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/WebSearchPremiumTool' - $ref: '#/components/schemas/CodeInterpreterTool' - $ref: '#/components/schemas/ImageGenerationTool' - $ref: '#/components/schemas/DocumentLibraryTool' - $ref: '#/components/schemas/CustomConnector' discriminator: propertyName: type mapping: code_interpreter: '#/components/schemas/CodeInterpreterTool' connector: '#/components/schemas/CustomConnector' document_library: '#/components/schemas/DocumentLibraryTool' function: '#/components/schemas/FunctionTool' image_generation: '#/components/schemas/ImageGenerationTool' web_search: '#/components/schemas/WebSearchTool' web_search_premium: '#/components/schemas/WebSearchPremiumTool' - type: 'null' title: Tools default: null completion_args: anyOf: - $ref: '#/components/schemas/CompletionArgs' - type: 'null' default: null guardrails: anyOf: - type: array items: $ref: '#/components/schemas/GuardrailConfig' - type: 'null' title: Guardrails default: null name: anyOf: - type: string - type: 'null' title: Name default: null description: anyOf: - type: string - type: 'null' title: Description default: null metadata: anyOf: - $ref: '#/components/schemas/MetadataDict' - type: 'null' default: null agent_id: anyOf: - type: string - type: 'null' title: Agent Id default: null agent_version: anyOf: - type: string - type: integer - type: 'null' title: Agent Version default: null model: anyOf: - type: string - type: 'null' title: Model default: null title: ConversationRequest required: - inputs ConversationStreamRequest: allOf: - $ref: '#/components/schemas/ConversationRequestBase' - type: object properties: stream: type: boolean enum: - true default: true ConversationAppendStreamRequest: allOf: - $ref: '#/components/schemas/AppendConversationRequest' - type: object properties: stream: type: boolean enum: - true default: true ConversationRestartStreamRequest: allOf: - $ref: '#/components/schemas/RestartConversationRequest' - type: object properties: stream: type: boolean enum: - true default: true ReferenceChunk: type: object properties: type: type: string title: Type default: reference const: reference reference_ids: type: array items: anyOf: - type: integer - type: string title: Reference Ids title: ReferenceChunk required: - reference_ids additionalProperties: false FilePurpose: type: string title: FilePurpose enum: - fine-tune - batch - ocr FileVisibility: type: string title: FileVisibility enum: - workspace - user SampleType: type: string title: SampleType enum: - pretrain - instruct - batch_request - batch_result - batch_error Source: type: string title: Source enum: - upload - repository - mistral FileSchema: type: object properties: id: type: string examples: - 497f6eca-6276-4993-bfeb-53cbbbba6f09 title: Id format: uuid description: The unique identifier of the file. object: type: string examples: - file title: Object description: The object type, which is always "file". bytes: type: integer examples: - 13000 title: Bytes description: The size of the file, in bytes. created_at: type: integer examples: - 1716963433 title: Created At description: The UNIX timestamp (in seconds) of the event. filename: type: string examples: - files_upload.jsonl title: Filename description: The name of the uploaded file. purpose: $ref: '#/components/schemas/FilePurpose' examples: - fine-tune - ocr - batch - audio description: The intended purpose of the uploaded file, currently supports fine-tuning (`fine-tune`), OCR (`ocr`), Audio/Transcription (`audio`) and batch inference (`batch`). sample_type: $ref: '#/components/schemas/SampleType' num_lines: anyOf: - type: integer - type: 'null' title: Num Lines mimetype: anyOf: - type: string - type: 'null' title: Mimetype source: $ref: '#/components/schemas/Source' signature: anyOf: - type: string - type: 'null' title: Signature expires_at: anyOf: - type: integer - type: 'null' title: Expires At visibility: anyOf: - $ref: '#/components/schemas/FileVisibility' - type: 'null' title: FileSchema required: - id - object - bytes - created_at - filename - purpose - sample_type - source FTClassifierLossFunction: type: string title: FTClassifierLossFunction enum: - single_class - multi_class BatchJobStatus: type: string title: BatchJobStatus enum: - QUEUED - RUNNING - SUCCESS - FAILED - TIMEOUT_EXCEEDED - CANCELLATION_REQUESTED - CANCELLED BatchError: type: object properties: message: type: string title: Message count: type: integer title: Count default: 1 title: BatchError required: - message ApiEndpoint: type: string title: ApiEndpoint enum: - /v1/chat/completions - /v1/embeddings - /v1/fim/completions - /v1/moderations - /v1/chat/moderations - /v1/ocr - /v1/classifications - /v1/chat/classifications - /v1/conversations - /v1/audio/transcriptions BatchRequest: type: object properties: custom_id: anyOf: - type: string - type: 'null' title: Custom Id body: type: object title: Body additionalProperties: true title: BatchRequest required: - body AssistantMessage: type: object properties: role: type: string title: Role default: assistant const: assistant content: anyOf: - type: string - type: 'null' - type: array items: $ref: '#/components/schemas/ContentChunk' title: Content tool_calls: anyOf: - type: array items: $ref: '#/components/schemas/ToolCall' - type: 'null' title: Tool Calls prefix: type: boolean title: Prefix description: Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message. default: false title: AssistantMessage additionalProperties: false AudioChunk: type: object properties: type: type: string title: Type default: input_audio const: input_audio input_audio: anyOf: - type: string - type: string format: binary title: Input Audio title: AudioChunk required: - input_audio additionalProperties: false ChatCompletionRequest: type: object properties: model: type: string examples: - mistral-large-latest title: Model description: ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions. temperature: anyOf: - type: number maximum: 1.5 minimum: 0 - type: 'null' title: Temperature description: What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. top_p: anyOf: - exclusiveMinimum: 0 type: number maximum: 1 - type: 'null' title: Top P description: Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. max_tokens: anyOf: - type: integer minimum: 0 - type: 'null' title: Max Tokens description: The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. stream: type: boolean title: Stream description: 'Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.' default: false stop: anyOf: - type: string - type: array items: type: string - type: 'null' title: Stop description: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array random_seed: anyOf: - type: integer minimum: 0 - type: 'null' title: Random Seed description: The seed to use for random sampling. If set, different calls will generate deterministic results. metadata: anyOf: - type: object additionalProperties: true - type: 'null' title: Metadata messages: type: array examples: - - role: user content: Who is the best French painter? Answer in one short sentence. items: oneOf: - $ref: '#/components/schemas/SystemMessage' - $ref: '#/components/schemas/UserMessage' - $ref: '#/components/schemas/AssistantMessage' - $ref: '#/components/schemas/ToolMessage' discriminator: propertyName: role mapping: assistant: '#/components/schemas/AssistantMessage' system: '#/components/schemas/SystemMessage' tool: '#/components/schemas/ToolMessage' user: '#/components/schemas/UserMessage' title: Messages description: The prompt(s) to generate completions for, encoded as a list of dict with role and content. response_format: $ref: '#/components/schemas/ResponseFormat' tools: anyOf: - type: array items: oneOf: - $ref: '#/components/schemas/Tool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/WebSearchPremiumTool' - $ref: '#/components/schemas/CodeInterpreterTool' - $ref: '#/components/schemas/ImageGenerationTool' - $ref: '#/components/schemas/DocumentLibraryTool' - $ref: '#/components/schemas/CustomConnector' discriminator: propertyName: type mapping: function: '#/components/schemas/Tool' web_search: '#/components/schemas/WebSearchTool' web_search_premium: '#/components/schemas/WebSearchPremiumTool' code_interpreter: '#/components/schemas/CodeInterpreterTool' image_generation: '#/components/schemas/ImageGenerationTool' document_library: '#/components/schemas/DocumentLibraryTool' connector: '#/components/schemas/CustomConnector' - type: 'null' title: Tools description: A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for. tool_choice: anyOf: - $ref: '#/components/schemas/ToolChoice' - $ref: '#/components/schemas/ToolChoiceEnum' title: Tool Choice description: 'Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `any` or `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.' default: auto presence_penalty: anyOf: - type: number maximum: 2 minimum: -2 - type: 'null' title: Presence Penalty description: The `presence_penalty` determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. frequency_penalty: anyOf: - type: number maximum: 2 minimum: -2 - type: 'null' title: Frequency Penalty description: The `frequency_penalty` penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. n: anyOf: - type: integer minimum: 1 - type: 'null' title: N description: Number of completions to return for each request, input tokens are only billed once. prediction: $ref: '#/components/schemas/Prediction' description: Enable users to specify expected results, optimizing response times by leveraging known or predictable content. This approach is especially effective for updating text documents or code files with minimal changes, reducing latency while maintaining high-quality results. default: type: content content: '' parallel_tool_calls: type: boolean title: Parallel Tool Calls description: Whether to enable parallel function calling during tool use, when enabled the model can call multiple tools in parallel. default: true reasoning_effort: anyOf: - $ref: '#/components/schemas/ReasoningEffort' - type: 'null' prompt_mode: anyOf: - $ref: '#/components/schemas/MistralPromptMode' - type: 'null' description: Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. guardrails: anyOf: - type: array items: $ref: '#/components/schemas/GuardrailConfig' - type: 'null' title: Guardrails prompt_cache_key: anyOf: - type: string - type: 'null' title: Prompt Cache Key service_tier: anyOf: - $ref: '#/components/schemas/RequestedServiceTier' - type: 'null' description: Determines whether to serve the request using priority or standard capacity. safe_prompt: type: boolean description: Whether to inject a safety prompt before all conversations. default: false title: ChatCompletionRequest required: - messages - model additionalProperties: false ChatModerationRequest: type: object properties: input: anyOf: - type: array items: oneOf: - $ref: '#/components/schemas/SystemMessage' - $ref: '#/components/schemas/UserMessage' - $ref: '#/components/schemas/AssistantMessage' - $ref: '#/components/schemas/ToolMessage' discriminator: propertyName: role mapping: assistant: '#/components/schemas/AssistantMessage' system: '#/components/schemas/SystemMessage' tool: '#/components/schemas/ToolMessage' user: '#/components/schemas/UserMessage' - type: array items: type: array items: oneOf: - $ref: '#/components/schemas/SystemMessage' - $ref: '#/components/schemas/UserMessage' - $ref: '#/components/schemas/AssistantMessage' - $ref: '#/components/schemas/ToolMessage' discriminator: propertyName: role mapping: assistant: '#/components/schemas/AssistantMessage' system: '#/components/schemas/SystemMessage' tool: '#/components/schemas/ToolMessage' user: '#/components/schemas/UserMessage' title: Input description: Chat to classify model: type: string title: Model title: ChatModerationRequest required: - input - model additionalProperties: false ClassificationRequest: type: object properties: model: type: string examples: - mistral-moderation-latest title: Model description: ID of the model to use. metadata: anyOf: - type: object additionalProperties: true - type: 'null' title: Metadata input: anyOf: - type: string - type: array items: type: string title: Input description: Text to classify. title: ClassificationRequest required: - input - model additionalProperties: false EmbeddingDtype: type: string title: EmbeddingDtype enum: - float - int8 - uint8 - binary - ubinary EmbeddingRequest: type: object properties: model: type: string title: Model description: ID of the model to use. example: mistral-embed metadata: anyOf: - type: object additionalProperties: true - type: 'null' title: Metadata input: anyOf: - type: string - type: array items: type: string title: Input description: Text to embed. example: - Embed this sentence. - As well as this one. output_dimension: anyOf: - exclusiveMinimum: 0 type: integer - type: 'null' title: Output Dimension description: The dimension of the output embeddings when feature available. If not provided, a default output dimension will be used. output_dtype: $ref: '#/components/schemas/EmbeddingDtype' description: The data type of the output embeddings when feature available. If not provided, a default output data type will be used. default: float encoding_format: $ref: '#/components/schemas/EncodingFormat' description: The format of embeddings in the response. default: float title: EmbeddingRequest required: - input - model additionalProperties: false EncodingFormat: type: string title: EncodingFormat enum: - float - base64 FIMCompletionRequest: type: object properties: model: type: string examples: - codestral-latest title: Model description: ID of the model with FIM to use. default: codestral-2404 temperature: anyOf: - type: number maximum: 1.5 minimum: 0 - type: 'null' title: Temperature description: What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value. top_p: anyOf: - exclusiveMinimum: 0 type: number maximum: 1 - type: 'null' title: Top P description: Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. max_tokens: anyOf: - type: integer minimum: 0 - type: 'null' title: Max Tokens description: The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. stream: type: boolean title: Stream description: 'Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.' default: false stop: anyOf: - type: string - type: array items: type: string - type: 'null' title: Stop description: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array random_seed: anyOf: - type: integer minimum: 0 - type: 'null' title: Random Seed description: The seed to use for random sampling. If set, different calls will generate deterministic results. metadata: anyOf: - type: object additionalProperties: true - type: 'null' title: Metadata prompt: type: string examples: - def title: Prompt description: The text/code to complete. suffix: anyOf: - type: string - type: 'null' examples: - return a+b title: Suffix description: Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`. default: '' min_tokens: anyOf: - type: integer minimum: 0 - type: 'null' title: Min Tokens description: The minimum number of tokens to generate in the completion. prompt_cache_key: anyOf: - type: string - type: 'null' title: Prompt Cache Key title: FIMCompletionRequest required: - prompt - model additionalProperties: false FileChunk: type: object properties: type: type: string title: Type default: file const: file file_id: type: string title: File Id format: uuid title: FileChunk required: - file_id additionalProperties: false FunctionCall: type: object properties: name: type: string title: Name arguments: title: Arguments anyOf: - type: object additionalProperties: true - type: string title: FunctionCall required: - name - arguments additionalProperties: false FunctionName: type: object properties: name: type: string title: Name title: FunctionName required: - name additionalProperties: false description: this restriction of `Function` is used to select a specific function to call MistralPromptMode: type: string title: MistralPromptMode enum: - reasoning description: 'Available options to the prompt_mode argument on the chat completion endpoint. Values represent high-level intent. Assignment to actual SPs is handled internally. System prompt may include knowledge cutoff date, model capabilities, tone to use, safety guidelines, etc.' OCRAsideTextBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: aside_text const: aside_text title: OCRAsideTextBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content OCRBlockConfidenceScores: type: object properties: average_content_confidence_score: anyOf: - type: number maximum: 1 minimum: 0 - type: 'null' title: Average Content Confidence Score description: Average confidence over the block's content (caption) tokens. None when the block has no textual content (e.g. image-only entry). minimum_content_confidence_score: anyOf: - type: number maximum: 1 minimum: 0 - type: 'null' title: Minimum Content Confidence Score description: Minimum per-word content confidence in the block. None when the block has no textual content. block_type_confidence_score: anyOf: - type: number maximum: 1 minimum: 0 - type: 'null' title: Block Type Confidence Score description: Confidence in the block type (e.g. 'text', 'title', 'table'). None when the entry had no block type or the block type span could not be located. title: OCRBlockConfidenceScores description: 'Per-block confidence scores, computed per-word from model logprobs. All fields ``None`` when the block couldn''t be scored. Individual fields ``None`` when that signal is absent — e.g. an image-only block has no caption, so content scores are ``None``.' OCRCaptionBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: caption const: caption title: OCRCaptionBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content OCRCodeBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: code const: code title: OCRCodeBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content OCRConfidenceScore: type: object properties: text: type: string title: Text description: The word or text segment confidence: type: number title: Confidence maximum: 1 minimum: 0 description: Confidence score (0-1) start_index: type: integer title: Start Index minimum: 0 description: Start index of the text in the page markdown string title: OCRConfidenceScore required: - text - confidence - start_index description: Confidence score for a token or word in OCR output. OCREquationBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: equation const: equation title: OCREquationBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content OCRFooterBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: footer const: footer title: OCRFooterBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content OCRHeaderBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: header const: header title: OCRHeaderBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content OCRImageBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: image const: image image_id: type: string title: Image Id description: References the corresponding entry in OCRPageObject.images title: OCRImageBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content - image_id OCRImageObject: type: object properties: id: type: string title: Id description: Image ID for extracted image in a page top_left_x: anyOf: - type: integer minimum: 0 - type: 'null' title: Top Left X description: X coordinate of top-left corner of the extracted image top_left_y: anyOf: - type: integer minimum: 0 - type: 'null' title: Top Left Y description: Y coordinate of top-left corner of the extracted image bottom_right_x: anyOf: - type: integer minimum: 0 - type: 'null' title: Bottom Right X description: X coordinate of bottom-right corner of the extracted image bottom_right_y: anyOf: - type: integer minimum: 0 - type: 'null' title: Bottom Right Y description: Y coordinate of bottom-right corner of the extracted image image_base64: anyOf: - type: string - type: 'null' title: Image Base64 description: Base64 string of the extracted image image_annotation: anyOf: - type: string - type: 'null' title: Image Annotation description: Annotation of the extracted image in json str title: OCRImageObject required: - id - top_left_x - top_left_y - bottom_right_x - bottom_right_y OCRListBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: list const: list title: OCRListBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content OCRPageConfidenceScores: type: object properties: word_confidence_scores: type: array items: $ref: '#/components/schemas/OCRConfidenceScore' title: Word Confidence Scores description: Word-level confidence scores (populated only for 'word' granularity) average_page_confidence_score: type: number title: Average Page Confidence Score maximum: 1 minimum: 0 description: Average confidence score for the page minimum_page_confidence_score: type: number title: Minimum Page Confidence Score maximum: 1 minimum: 0 description: Minimum confidence score for the page title: OCRPageConfidenceScores required: - average_page_confidence_score - minimum_page_confidence_score description: "Confidence scores for an OCR page at various granularities.\n\nNote on page-level stats:\n- For 'page' and 'block' granularity: average/minimum are computed from per-token\n exp(logprob). Neither ``word_confidence_scores`` nor ``token_scores`` is populated.\n Per-block scores are attached to response blocks separately for 'block' granularity.\n- For 'word' granularity: average/minimum are computed from per-word confidence, where\n each word's confidence is exp(mean(token_logprobs)) — a geometric mean over the\n word's subword tokens. ``word_confidence_scores`` is populated.\n- For 'token' granularity (internal): average/minimum are computed from\n ``token_scores``; ``token_scores`` is populated." OCRPageDimensions: type: object properties: dpi: type: integer title: Dpi minimum: 0 description: Dots per inch of the page-image height: type: integer title: Height minimum: 0 description: Height of the image in pixels width: type: integer title: Width minimum: 0 description: Width of the image in pixels title: OCRPageDimensions required: - dpi - height - width OCRPageObject: type: object properties: index: type: integer title: Index minimum: 0 description: The page index in a pdf document starting from 0 markdown: type: string title: Markdown description: The markdown string response of the page images: type: array items: $ref: '#/components/schemas/OCRImageObject' title: Images description: List of all extracted images in the page tables: type: array items: $ref: '#/components/schemas/OCRTableObject' title: Tables description: List of all extracted tables in the page hyperlinks: type: array items: type: string title: Hyperlinks description: List of all hyperlinks in the page header: anyOf: - type: string - type: 'null' title: Header description: Header of the page footer: anyOf: - type: string - type: 'null' title: Footer description: Footer of the page dimensions: anyOf: - $ref: '#/components/schemas/OCRPageDimensions' - type: 'null' description: The dimensions of the PDF Page's screenshot image confidence_scores: anyOf: - $ref: '#/components/schemas/OCRPageConfidenceScores' - type: 'null' description: Confidence scores for the OCR page (populated when confidence_scores_granularity is set) blocks: anyOf: - type: array items: oneOf: - $ref: '#/components/schemas/OCRTextBlock' - $ref: '#/components/schemas/OCRListBlock' - $ref: '#/components/schemas/OCRImageBlock' - $ref: '#/components/schemas/OCRTableBlock' - $ref: '#/components/schemas/OCRTitleBlock' - $ref: '#/components/schemas/OCREquationBlock' - $ref: '#/components/schemas/OCRCaptionBlock' - $ref: '#/components/schemas/OCRCodeBlock' - $ref: '#/components/schemas/OCRReferencesBlock' - $ref: '#/components/schemas/OCRAsideTextBlock' - $ref: '#/components/schemas/OCRHeaderBlock' - $ref: '#/components/schemas/OCRFooterBlock' - $ref: '#/components/schemas/OCRSignatureBlock' discriminator: propertyName: type mapping: aside_text: '#/components/schemas/OCRAsideTextBlock' caption: '#/components/schemas/OCRCaptionBlock' code: '#/components/schemas/OCRCodeBlock' equation: '#/components/schemas/OCREquationBlock' footer: '#/components/schemas/OCRFooterBlock' header: '#/components/schemas/OCRHeaderBlock' image: '#/components/schemas/OCRImageBlock' list: '#/components/schemas/OCRListBlock' references: '#/components/schemas/OCRReferencesBlock' signature: '#/components/schemas/OCRSignatureBlock' table: '#/components/schemas/OCRTableBlock' text: '#/components/schemas/OCRTextBlock' title: '#/components/schemas/OCRTitleBlock' - type: 'null' title: Blocks description: Paragraph-level bounding boxes for all content blocks in reading order (populated when include_blocks is True) title: OCRPageObject required: - index - markdown - images - dimensions OCRReferencesBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: references const: references title: OCRReferencesBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content OCRRequest: type: object properties: model: anyOf: - type: string - type: 'null' title: Model document: anyOf: - $ref: '#/components/schemas/FileChunk' - $ref: '#/components/schemas/DocumentURLChunk' - $ref: '#/components/schemas/ImageURLChunk' title: Document description: Document to run OCR on pages: anyOf: - type: string - type: array items: type: integer - type: 'null' title: Pages description: Specific pages to process. Accepts a list of integers or a string of comma-separated numbers and ranges (e.g. '0,1,2' or '0-5' or '0,2-4'). Page numbers start from 0. include_image_base64: anyOf: - type: boolean - type: 'null' title: Include Image Base64 description: Include image URLs in response image_limit: anyOf: - type: integer - type: 'null' title: Image Limit description: Max images to extract image_min_size: anyOf: - type: integer - type: 'null' title: Image Min Size description: Minimum height and width of image to extract bbox_annotation_format: anyOf: - $ref: '#/components/schemas/ResponseFormat' - type: 'null' description: Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field document_annotation_format: anyOf: - $ref: '#/components/schemas/ResponseFormat' - type: 'null' description: Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field document_annotation_prompt: anyOf: - type: string - type: 'null' title: Document Annotation Prompt description: Optional prompt to guide the model in extracting structured output from the entire document. A document_annotation_format must be provided. table_format: anyOf: - type: string enum: - markdown - html - type: 'null' title: Table Format extract_header: type: boolean title: Extract Header description: Extract the page header into the response's `header` field and remove it from the markdown content default: false extract_footer: type: boolean title: Extract Footer description: Extract the page footer into the response's `footer` field and remove it from the markdown content default: false include_blocks: type: boolean title: Include Blocks description: Return paragraph-level bounding boxes for all content blocks in the response default: true confidence_scores_granularity: anyOf: - type: string enum: - word - page - block - type: 'null' description: 'Granularity for confidence scores: ''page'' (aggregate only), ''word'' (per-word scores), or ''block'' (per-block scores). Defaults to None (no confidence scores) to keep response payload small.' title: OCRRequest required: - document - model additionalProperties: false OCRResponse: type: object properties: pages: type: array items: $ref: '#/components/schemas/OCRPageObject' title: Pages description: List of OCR info for pages. model: type: string title: Model description: The model used to generate the OCR. document_annotation: anyOf: - type: string - type: 'null' title: Document Annotation description: Formatted response in the request_format if provided in json str usage_info: $ref: '#/components/schemas/OCRUsageInfo' description: Usage info for the OCR request. title: OCRResponse required: - pages - model - usage_info OCRSignatureBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: signature const: signature title: OCRSignatureBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content description: Signature region. ``content`` is the transcribed name when legible, else ``""``. OCRTableBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: table const: table table_id: anyOf: - type: string - type: 'null' title: Table Id description: References the corresponding entry in OCRPageObject.tables, when tables are extracted title: OCRTableBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content OCRTableObject: type: object properties: id: type: string title: Id description: Table ID for extracted table in a page content: type: string title: Content description: Content of the table in the given format format: type: string title: Format enum: - markdown - html description: Format of the table word_confidence_scores: anyOf: - type: array items: $ref: '#/components/schemas/OCRConfidenceScore' - type: 'null' title: Word Confidence Scores description: Per-word confidence scores for the table content. Returned when confidence_scores_granularity is set to 'word'. title: OCRTableObject required: - id - content - format OCRTextBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: text const: text title: OCRTextBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content OCRTitleBlock: type: object properties: top_left_x: type: integer title: Top Left X minimum: 0 top_left_y: type: integer title: Top Left Y minimum: 0 bottom_right_x: type: integer title: Bottom Right X minimum: 0 bottom_right_y: type: integer title: Bottom Right Y minimum: 0 content: type: string title: Content description: Text/markdown/html content of this block confidence_scores: anyOf: - $ref: '#/components/schemas/OCRBlockConfidenceScores' - type: 'null' description: Confidence scores for this block. Populated when confidence_scores_granularity is set to 'block'. type: type: string title: Type default: title const: title title: OCRTitleBlock required: - top_left_x - top_left_y - bottom_right_x - bottom_right_y - content OCRUsageInfo: type: object properties: pages_processed: type: integer title: Pages Processed minimum: 0 description: Number of pages processed doc_size_bytes: anyOf: - type: integer - type: 'null' title: Doc Size Bytes description: Document size in bytes title: OCRUsageInfo required: - pages_processed SystemMessage: type: object properties: role: type: string title: Role default: system const: system content: anyOf: - type: string - type: array items: $ref: '#/components/schemas/SystemMessageContentChunks' title: Content title: SystemMessage required: - content additionalProperties: false Tool: type: object properties: type: $ref: '#/components/schemas/ToolTypes' default: function function: $ref: '#/components/schemas/Function' title: Tool required: - function additionalProperties: false ToolCall: type: object properties: id: type: string title: Id default: 'null' type: $ref: '#/components/schemas/ToolTypes' default: function function: $ref: '#/components/schemas/FunctionCall' index: type: integer title: Index default: 0 title: ToolCall required: - function additionalProperties: false ToolChoice: type: object properties: type: $ref: '#/components/schemas/ToolTypes' default: function function: $ref: '#/components/schemas/FunctionName' title: ToolChoice required: - function additionalProperties: false description: ToolChoice is either a ToolChoiceEnum or a ToolChoice ToolMessage: type: object properties: role: type: string title: Role default: tool const: tool content: anyOf: - type: string - type: 'null' - type: array items: $ref: '#/components/schemas/ContentChunk' title: Content tool_call_id: anyOf: - type: string - type: 'null' title: Tool Call Id name: anyOf: - type: string - type: 'null' title: Name title: ToolMessage required: - content additionalProperties: false ToolTypes: type: string title: ToolTypes enum: - function TranscriptionResponse: type: object properties: model: type: string title: Model text: type: string title: Text language: anyOf: - type: string pattern: ^\w{2}$ - type: 'null' title: Language segments: type: array items: $ref: '#/components/schemas/TranscriptionSegmentChunk' title: Segments usage: $ref: '#/components/schemas/UsageInfo' title: TranscriptionResponse required: - model - text - language - usage additionalProperties: false TranscriptionSegmentChunk: type: object properties: type: type: string title: Type default: transcription_segment const: transcription_segment text: type: string title: Text start: type: number title: Start end: type: number title: End score: anyOf: - type: number - type: 'null' title: Score speaker_id: anyOf: - type: string - type: 'null' title: Speaker Id title: TranscriptionSegmentChunk required: - text - start - end additionalProperties: false UsageInfo: type: object properties: prompt_tokens: type: integer title: Prompt Tokens default: 0 completion_tokens: title: Completion Tokens default: 0 type: integer total_tokens: type: integer title: Total Tokens default: 0 prompt_audio_seconds: anyOf: - type: integer - type: 'null' title: Prompt Audio Seconds service_tier: anyOf: - type: string - type: 'null' title: Service Tier description: 'The service tier at which the request was processed: standard or priority.' title: UsageInfo additionalProperties: false required: - prompt_tokens - completion_tokens - total_tokens UserMessage: type: object properties: role: type: string title: Role default: user const: user content: anyOf: - type: string - type: 'null' - type: array items: $ref: '#/components/schemas/ContentChunk' title: Content title: UserMessage required: - content additionalProperties: false File: type: string title: File format: binary description: "The File object (not file name) to be uploaded.\n To upload a file and specify a custom file name you should format your request as such:\n ```bash\n file=@path/to/your/file.jsonl;filename=custom_name.jsonl\n ```\n Otherwise, you can just keep the original file name:\n ```bash\n file=@path/to/your/file.jsonl\n ```" TimestampGranularity: type: string title: TimestampGranularity enum: - segment - word AudioTranscriptionRequest: type: object properties: model: type: string examples: - voxtral-mini-latest - voxtral-mini-2507 title: Model description: ID of the model to be used. file: anyOf: - $ref: '#/components/schemas/File' - type: 'null' title: File default: null file_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: File Url description: Url of a file to be transcribed default: null file_id: anyOf: - type: string - type: 'null' title: File Id description: ID of a file uploaded to /v1/files default: null language: anyOf: - type: string pattern: ^\w{2}$ - type: 'null' title: Language description: Language of the audio, e.g. 'en'. Providing the language can boost accuracy. default: null temperature: anyOf: - type: number - type: 'null' title: Temperature default: null stream: type: boolean title: Stream default: false const: false diarize: type: boolean title: Diarize default: false context_bias: type: array items: type: string pattern: ^[^,\s]+$ title: Context Bias default: [] timestamp_granularities: type: array items: $ref: '#/components/schemas/TimestampGranularity' title: Timestamp Granularities description: Granularities of timestamps to include in the response. $defs: TimestampGranularity: type: string title: TimestampGranularity enum: - segment - word title: AudioTranscriptionRequest required: - model AudioTranscriptionRequestStream: type: object properties: model: type: string title: Model file: anyOf: - $ref: '#/components/schemas/File' - type: 'null' title: File default: null file_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: File Url description: Url of a file to be transcribed default: null file_id: anyOf: - type: string - type: 'null' title: File Id description: ID of a file uploaded to /v1/files default: null language: anyOf: - type: string pattern: ^\w{2}$ - type: 'null' title: Language description: Language of the audio, e.g. 'en'. Providing the language can boost accuracy. default: null temperature: anyOf: - type: number - type: 'null' title: Temperature default: null stream: type: boolean title: Stream default: true const: true diarize: type: boolean title: Diarize default: false context_bias: type: array items: type: string pattern: ^[^,\s]+$ title: Context Bias default: [] timestamp_granularities: type: array items: $ref: '#/components/schemas/TimestampGranularity' title: Timestamp Granularities description: Granularities of timestamps to include in the response. $defs: TimestampGranularity: type: string title: TimestampGranularity enum: - segment - word title: AudioTranscriptionRequestStream required: - model TranscriptionStreamLanguage: type: object properties: type: type: string title: Type default: transcription.language const: transcription.language audio_language: type: string title: Audio Language pattern: ^\w{2}$ title: TranscriptionStreamLanguage required: - audio_language additionalProperties: false TranscriptionStreamSegmentDelta: type: object properties: type: type: string title: Type default: transcription.segment const: transcription.segment text: type: string title: Text start: type: number title: Start end: type: number title: End speaker_id: anyOf: - type: string - type: 'null' title: Speaker Id default: null title: TranscriptionStreamSegmentDelta required: - text - start - end additionalProperties: false TranscriptionStreamTextDelta: type: object properties: type: type: string title: Type default: transcription.text.delta const: transcription.text.delta text: type: string title: Text title: TranscriptionStreamTextDelta required: - text additionalProperties: false TranscriptionStreamDone: type: object properties: model: type: string title: Model text: type: string title: Text language: anyOf: - type: string pattern: ^\w{2}$ - type: 'null' title: Language segments: type: array items: $ref: '#/components/schemas/TranscriptionSegmentChunk' title: Segments usage: $ref: '#/components/schemas/UsageInfo' type: type: string title: Type default: transcription.done const: transcription.done title: TranscriptionStreamDone required: - model - text - language - usage additionalProperties: false TranscriptionStreamEvents: type: object properties: event: $ref: '#/components/schemas/TranscriptionStreamEventTypes' data: oneOf: - $ref: '#/components/schemas/TranscriptionStreamTextDelta' - $ref: '#/components/schemas/TranscriptionStreamLanguage' - $ref: '#/components/schemas/TranscriptionStreamSegmentDelta' - $ref: '#/components/schemas/TranscriptionStreamDone' discriminator: propertyName: type mapping: transcription.done: '#/components/schemas/TranscriptionStreamDone' transcription.language: '#/components/schemas/TranscriptionStreamLanguage' transcription.segment: '#/components/schemas/TranscriptionStreamSegmentDelta' transcription.text.delta: '#/components/schemas/TranscriptionStreamTextDelta' title: Data title: TranscriptionStreamEvents required: - event - data additionalProperties: false TranscriptionStreamEventTypes: type: string title: TranscriptionStreamEventTypes enum: - transcription.language - transcription.segment - transcription.text.delta - transcription.done InstructRequest: type: object properties: messages: type: array items: oneOf: - $ref: '#/components/schemas/SystemMessage' - $ref: '#/components/schemas/UserMessage' - $ref: '#/components/schemas/AssistantMessage' - $ref: '#/components/schemas/ToolMessage' discriminator: propertyName: role mapping: assistant: '#/components/schemas/AssistantMessage' system: '#/components/schemas/SystemMessage' tool: '#/components/schemas/ToolMessage' user: '#/components/schemas/UserMessage' title: Messages title: InstructRequest required: - messages additionalProperties: false RequestedServiceTier: type: string title: RequestedServiceTier enum: - auto - standard_only AgentsCompletionRequest: type: object properties: max_tokens: anyOf: - type: integer minimum: 0 - type: 'null' title: Max Tokens description: The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. stream: type: boolean title: Stream description: 'Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.' default: false stop: anyOf: - type: string - type: array items: type: string - type: 'null' title: Stop description: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array random_seed: anyOf: - type: integer minimum: 0 - type: 'null' title: Random Seed description: The seed to use for random sampling. If set, different calls will generate deterministic results. metadata: anyOf: - type: object additionalProperties: true - type: 'null' title: Metadata messages: type: array examples: - - role: user content: Who is the best French painter? Answer in one short sentence. items: oneOf: - $ref: '#/components/schemas/SystemMessage' - $ref: '#/components/schemas/UserMessage' - $ref: '#/components/schemas/AssistantMessage' - $ref: '#/components/schemas/ToolMessage' discriminator: propertyName: role mapping: assistant: '#/components/schemas/AssistantMessage' system: '#/components/schemas/SystemMessage' tool: '#/components/schemas/ToolMessage' user: '#/components/schemas/UserMessage' title: Messages description: The prompt(s) to generate completions for, encoded as a list of dict with role and content. response_format: $ref: '#/components/schemas/ResponseFormat' tools: anyOf: - type: array items: oneOf: - $ref: '#/components/schemas/Tool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/WebSearchPremiumTool' - $ref: '#/components/schemas/CodeInterpreterTool' - $ref: '#/components/schemas/ImageGenerationTool' - $ref: '#/components/schemas/DocumentLibraryTool' - $ref: '#/components/schemas/CustomConnector' discriminator: propertyName: type mapping: function: '#/components/schemas/Tool' web_search: '#/components/schemas/WebSearchTool' web_search_premium: '#/components/schemas/WebSearchPremiumTool' code_interpreter: '#/components/schemas/CodeInterpreterTool' image_generation: '#/components/schemas/ImageGenerationTool' document_library: '#/components/schemas/DocumentLibraryTool' connector: '#/components/schemas/CustomConnector' - type: 'null' title: Tools tool_choice: anyOf: - $ref: '#/components/schemas/ToolChoice' - $ref: '#/components/schemas/ToolChoiceEnum' title: Tool Choice default: auto presence_penalty: anyOf: - type: number maximum: 2 minimum: -2 - type: 'null' title: Presence Penalty description: The `presence_penalty` determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. frequency_penalty: anyOf: - type: number maximum: 2 minimum: -2 - type: 'null' title: Frequency Penalty description: The `frequency_penalty` penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. n: anyOf: - type: integer minimum: 1 - type: 'null' title: N description: Number of completions to return for each request, input tokens are only billed once. prediction: $ref: '#/components/schemas/Prediction' description: Enable users to specify expected results, optimizing response times by leveraging known or predictable content. This approach is especially effective for updating text documents or code files with minimal changes, reducing latency while maintaining high-quality results. default: type: content content: '' parallel_tool_calls: type: boolean title: Parallel Tool Calls default: true reasoning_effort: anyOf: - $ref: '#/components/schemas/ReasoningEffort' - type: 'null' prompt_mode: anyOf: - $ref: '#/components/schemas/MistralPromptMode' - type: 'null' description: Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. guardrails: anyOf: - type: array items: $ref: '#/components/schemas/GuardrailConfig' - type: 'null' title: Guardrails prompt_cache_key: anyOf: - type: string - type: 'null' title: Prompt Cache Key service_tier: anyOf: - $ref: '#/components/schemas/RequestedServiceTier' - type: 'null' description: Determines whether to serve the request using priority or standard capacity. agent_id: type: string description: The ID of the agent to use for this completion. title: AgentsCompletionRequest required: - messages - agent_id additionalProperties: false ChatClassificationRequest: type: object properties: model: type: string title: Model input: $ref: '#/components/schemas/ChatClassificationRequestInputs' title: ChatClassificationRequest required: - input - model additionalProperties: false ChatClassificationRequestInputs: anyOf: - $ref: '#/components/schemas/InstructRequest' - type: array items: $ref: '#/components/schemas/InstructRequest' title: ChatClassificationRequestInputs description: Chat to classify ClassificationResponse: type: object properties: id: type: string example: mod-e5cc70bb28c444948073e77776eb30ef model: type: string results: type: array items: type: object title: ClassificationTargetResult additionalProperties: $ref: '#/components/schemas/ClassificationTargetResult' title: ClassificationResponse required: - id - model - results ClassificationTargetResult: type: object properties: scores: type: object title: ClassifierTargetResultScores additionalProperties: type: number title: ClassificationTargetResult required: - scores ContentChunk: oneOf: - $ref: '#/components/schemas/TextChunk' - $ref: '#/components/schemas/ImageURLChunk' - $ref: '#/components/schemas/DocumentURLChunk' - $ref: '#/components/schemas/ReferenceChunk' - $ref: '#/components/schemas/FileChunk' - $ref: '#/components/schemas/ThinkChunk' - $ref: '#/components/schemas/AudioChunk' discriminator: propertyName: type mapping: image_url: '#/components/schemas/ImageURLChunk' document_url: '#/components/schemas/DocumentURLChunk' text: '#/components/schemas/TextChunk' reference: '#/components/schemas/ReferenceChunk' file: '#/components/schemas/FileChunk' thinking: '#/components/schemas/ThinkChunk' input_audio: '#/components/schemas/AudioChunk' title: ContentChunk ModerationResponse: type: object properties: id: type: string example: mod-e5cc70bb28c444948073e77776eb30ef model: type: string results: type: array items: $ref: '#/components/schemas/ModerationObject' title: ModerationResponse required: - id - model - results ModerationObject: type: object properties: categories: type: object additionalProperties: type: boolean description: Moderation result thresholds category_scores: type: object additionalProperties: type: number description: Moderation result title: ModerationObject SystemMessageContentChunks: oneOf: - $ref: '#/components/schemas/TextChunk' - $ref: '#/components/schemas/ThinkChunk' discriminator: propertyName: type mapping: text: '#/components/schemas/TextChunk' thinking: '#/components/schemas/ThinkChunk' title: SystemMessageContentChunks DocumentTextContent: type: object properties: text: type: string title: Text title: DocumentTextContent required: - text PaginationInfo: type: object properties: total_items: type: integer title: Total Items total_pages: type: integer title: Total Pages current_page: type: integer title: Current Page page_size: type: integer title: Page Size has_more: type: boolean title: Has More title: PaginationInfo required: - total_items - total_pages - current_page - page_size - has_more ProcessStatus: type: string title: ProcessStatus enum: - self_managed - missing_content - noop - done - todo - in_progress - error - waiting_for_capacity ShareEnum: type: string title: ShareEnum enum: - Viewer - Editor x-speakeasy-unknown-values: allow SharingDelete: type: object properties: org_id: anyOf: - type: string format: uuid - type: 'null' title: Org Id deprecated: true share_with_uuid: type: string format: uuid description: The id of the entity (user, workspace or organization) to share with share_with_type: $ref: '#/components/schemas/EntityType' title: SharingDelete required: - share_with_uuid - share_with_type - level EntityType: type: string title: EntityType enum: - User - Workspace - Org description: The type of entity, used to share a library. x-speakeasy-unknown-values: allow AggregationMeta: type: object properties: from_timestamp: type: string title: From Timestamp format: date-time to_timestamp: type: string title: To Timestamp format: date-time granularity_seconds: anyOf: - type: integer - type: 'null' title: Granularity Seconds title: AggregationMeta required: - from_timestamp - to_timestamp Aggregation: type: object properties: data: type: array items: $ref: '#/components/schemas/AggregationRow' title: Data meta: $ref: '#/components/schemas/AggregationMeta' title: Aggregation required: - data - meta AggregationRow: type: object properties: time_bucket: anyOf: - type: string format: date-time - type: 'null' title: Time Bucket dimensions: type: object title: Dimensions additionalProperties: true metric_name: type: string title: Metric Name metric_value: anyOf: - type: number - type: integer - type: 'null' title: Metric Value title: AggregationRow required: - metric_name BaseFieldDefinition: type: object properties: name: type: string title: Name label: type: string title: Label type: type: string title: Type enum: - ENUM - TEXT - INT - FLOAT - BOOL - TIMESTAMP - ARRAY - MAP group: anyOf: - type: string - type: 'null' title: Group supported_operators: type: array items: type: string enum: - lt - lte - gt - gte - startswith - istartswith - endswith - iendswith - contains - icontains - matches - notcontains - inotcontains - eq - neq - isnull - includes - excludes - len_eq title: Supported Operators readOnly: true title: BaseFieldDefinition required: - name - label - type - supported_operators BaseTaskStatus: type: string title: BaseTaskStatus enum: - RUNNING - COMPLETED - FAILED - CANCELED - TERMINATED - CONTINUED_AS_NEW - TIMED_OUT - UNKNOWN ChatCompletionEvent: type: object properties: event_id: type: string title: Event Id correlation_id: type: string title: Correlation Id created_at: type: string title: Created At format: date-time extra_fields: type: object title: Extra Fields additionalProperties: anyOf: - type: boolean - type: integer - type: number - type: string - type: string format: date-time - type: array items: type: string - type: object additionalProperties: type: string - type: 'null' nb_input_tokens: type: integer title: Nb Input Tokens nb_output_tokens: type: integer title: Nb Output Tokens enabled_tools: type: array items: type: object additionalProperties: true title: Enabled Tools request_messages: type: array items: type: object additionalProperties: true title: Request Messages response_messages: type: array items: type: object additionalProperties: true title: Response Messages nb_messages: type: integer title: Nb Messages chat_transcription_events: type: array items: $ref: '#/components/schemas/ChatTranscriptionEvent' title: Chat Transcription Events title: ChatCompletionEvent required: - event_id - correlation_id - created_at - extra_fields - nb_input_tokens - nb_output_tokens - enabled_tools - request_messages - response_messages - nb_messages - chat_transcription_events ChatCompletionEventPreview: type: object properties: event_id: type: string title: Event Id correlation_id: type: string title: Correlation Id created_at: type: string title: Created At format: date-time extra_fields: type: object title: Extra Fields additionalProperties: anyOf: - type: boolean - type: integer - type: number - type: string - type: string format: date-time - type: array items: type: string - type: object additionalProperties: type: string - type: 'null' nb_input_tokens: type: integer title: Nb Input Tokens nb_output_tokens: type: integer title: Nb Output Tokens title: ChatCompletionEventPreview required: - event_id - correlation_id - created_at - extra_fields - nb_input_tokens - nb_output_tokens ChatTranscriptionEvent: type: object properties: audio_url: type: string title: Audio Url model: type: string title: Model response_message: type: object title: Response Message additionalProperties: true title: ChatTranscriptionEvent required: - audio_url - model - response_message DatasetImportTask: type: object properties: id: type: string title: Id format: uuid created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At creator_id: type: string title: Creator Id format: uuid dataset_id: type: string title: Dataset Id format: uuid workspace_id: type: string title: Workspace Id format: uuid status: $ref: '#/components/schemas/BaseTaskStatus' progress: anyOf: - type: integer maximum: 100 minimum: 0 - type: 'null' title: Progress message: anyOf: - type: string - type: 'null' title: Message title: DatasetImportTask required: - id - created_at - updated_at - deleted_at - creator_id - dataset_id - workspace_id - status Dataset: type: object properties: id: type: string title: Id format: uuid created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At name: type: string title: Name description: type: string title: Description owner_id: type: string title: Owner Id format: uuid workspace_id: type: string title: Workspace Id format: uuid title: Dataset required: - id - created_at - updated_at - deleted_at - name - description - owner_id - workspace_id DatasetPreview: type: object properties: id: type: string title: Id format: uuid created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At name: type: string title: Name description: type: string title: Description owner_id: type: string title: Owner Id format: uuid workspace_id: type: string title: Workspace Id format: uuid title: DatasetPreview required: - id - created_at - updated_at - deleted_at - name - description - owner_id - workspace_id DatasetRecord: type: object properties: id: type: string title: Id format: uuid created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At dataset_id: type: string title: Dataset Id format: uuid payload: $ref: '#/components/schemas/DatasetRecordPayload' properties: type: object title: Properties additionalProperties: true source: $ref: '#/components/schemas/DatasetRecordSource' title: DatasetRecord required: - id - created_at - updated_at - deleted_at - dataset_id - payload - properties - source DatasetRecordPayload: type: object title: DatasetRecordPayload additionalProperties: true description: Caller-authored input object stored on a dataset record. DatasetRecordSource: type: string title: DatasetRecordSource enum: - EXPLORER - UPLOADED_FILE - DIRECT_INPUT - PLAYGROUND FieldGroup: type: object properties: name: type: string title: Name label: type: string title: Label title: FieldGroup required: - name - label FieldOptionCountItem: type: object properties: value: type: string title: Value count: type: integer title: Count title: FieldOptionCountItem required: - value - count FilterCondition: type: object properties: field: type: string title: Field op: type: string title: Op enum: - lt - lte - gt - gte - startswith - istartswith - endswith - iendswith - contains - icontains - matches - notcontains - inotcontains - eq - neq - isnull - includes - excludes - len_eq value: title: Value title: FilterCondition required: - field - op - value FilterGroup: type: object properties: AND: anyOf: - type: array items: anyOf: - $ref: '#/components/schemas/FilterGroup' - $ref: '#/components/schemas/FilterCondition' - type: 'null' title: And OR: anyOf: - type: array items: anyOf: - $ref: '#/components/schemas/FilterGroup' - $ref: '#/components/schemas/FilterCondition' - type: 'null' title: Or title: FilterGroup FilterPayload: type: object properties: filters: anyOf: - $ref: '#/components/schemas/FilterGroup' - $ref: '#/components/schemas/FilterCondition' - type: 'null' title: Filters title: FilterPayload required: - filters GetLogFieldOptions: type: object properties: options: anyOf: - type: array items: type: string - type: 'null' title: Options title: GetLogFieldOptions required: - options GetLogFields: type: object properties: field_definitions: type: array items: $ref: '#/components/schemas/OtelFieldDefinition' title: Field Definitions title: GetLogFields required: - field_definitions GetLog: type: object properties: customer_id: type: string title: Customer Id organization_id: type: string title: Organization Id workspace_id: type: string title: Workspace Id user_id: type: string title: User Id timestamp: type: string title: Timestamp format: date-time trace_id: type: string title: Trace Id span_id: type: string title: Span Id trace_flags: type: integer title: Trace Flags severity_text: type: string title: Severity Text severity_number: type: integer title: Severity Number service_name: type: string title: Service Name body: type: string title: Body event_name: type: string title: Event Name resource_schema_url: type: string title: Resource Schema Url resource_attributes: type: object title: Resource Attributes additionalProperties: type: string scope_schema_url: type: string title: Scope Schema Url scope_name: type: string title: Scope Name scope_version: type: string title: Scope Version scope_attributes: type: object title: Scope Attributes additionalProperties: type: string log_attributes: type: object title: Log Attributes additionalProperties: type: string title: GetLog required: - customer_id - organization_id - workspace_id - user_id - timestamp - trace_id - span_id - trace_flags - severity_text - severity_number - service_name - body - event_name - resource_schema_url - resource_attributes - scope_schema_url - scope_name - scope_version - scope_attributes - log_attributes GetLogs: type: object properties: logs: $ref: '#/components/schemas/FeedResultGetLog' title: GetLogs required: - logs GetSpanEvaluationFieldOptions: type: object properties: options: anyOf: - type: array items: type: string - type: 'null' title: Options title: GetSpanEvaluationFieldOptions required: - options GetSpanEvaluationFields: type: object properties: field_definitions: type: array items: $ref: '#/components/schemas/OtelFieldDefinition' title: Field Definitions title: GetSpanEvaluationFields required: - field_definitions GetSpanEvaluation: type: object properties: customer_id: type: string title: Customer Id organization_id: type: string title: Organization Id workspace_id: type: string title: Workspace Id user_id: type: string title: User Id trace_id: type: string title: Trace Id pattern: ^[0-9a-f]{32}$ span_id: type: string title: Span Id pattern: ^[0-9a-f]{16}$ response_id: type: string title: Response Id conversation_id: type: string title: Conversation Id timestamp: type: string title: Timestamp format: date-time evaluation_name: type: string title: Evaluation Name score_value: type: number title: Score Value score_label: type: string title: Score Label explanation: type: string title: Explanation metadata: type: object title: Metadata additionalProperties: type: string title: GetSpanEvaluation required: - customer_id - organization_id - workspace_id - user_id - trace_id - span_id - response_id - conversation_id - timestamp - evaluation_name - score_value - score_label - explanation - metadata GetSpanEvaluations: type: object properties: span_evaluations: $ref: '#/components/schemas/FeedResultGetSpanEvaluation' title: GetSpanEvaluations required: - span_evaluations GetSpanFieldOptions: type: object properties: options: anyOf: - type: array items: type: string - type: 'null' title: Options title: GetSpanFieldOptions required: - options GetSpanFields: type: object properties: field_definitions: type: array items: $ref: '#/components/schemas/OtelFieldDefinition' title: Field Definitions title: GetSpanFields required: - field_definitions GetSpan: type: object properties: customer_id: type: string title: Customer Id organization_id: type: string title: Organization Id workspace_id: type: string title: Workspace Id user_id: type: string title: User Id trace_id: type: string title: Trace Id pattern: ^[0-9a-f]{32}$ span_id: type: string title: Span Id pattern: ^[0-9a-f]{16}$ parent_span_id: type: string title: Parent Span Id trace_state: type: string title: Trace State start_time: type: string title: Start Time format: date-time end_time: type: string title: End Time format: date-time duration_ns: type: integer title: Duration Ns span_name: type: string title: Span Name span_kind: type: string title: Span Kind service_name: type: string title: Service Name status_code: type: string title: Status Code enum: - Error - Ok - Unset status_message: type: string title: Status Message error_type: type: string title: Error Type operation_name: type: string title: Operation Name provider_name: type: string title: Provider Name request_model: type: string title: Request Model response_model: type: string title: Response Model response_id: type: string title: Response Id output_type: type: string title: Output Type conversation_id: type: string title: Conversation Id data_source_id: type: string title: Data Source Id agent_id: type: string title: Agent Id agent_name: type: string title: Agent Name agent_version: type: string title: Agent Version agent_description: type: string title: Agent Description workflow_name: type: string title: Workflow Name prompt_name: type: string title: Prompt Name tool_name: type: string title: Tool Name tool_type: type: string title: Tool Type tool_call_id: type: string title: Tool Call Id input_messages: type: string title: Input Messages output_messages: type: string title: Output Messages system_instructions: type: string title: System Instructions tool_definitions: type: string title: Tool Definitions tool_call_arguments: type: string title: Tool Call Arguments tool_call_result: type: string title: Tool Call Result request_choice_count: type: integer title: Request Choice Count request_max_tokens: type: integer title: Request Max Tokens request_temperature: anyOf: - type: number - type: 'null' title: Request Temperature request_top_p: anyOf: - type: number - type: 'null' title: Request Top P request_top_k: anyOf: - type: number - type: 'null' title: Request Top K request_presence_penalty: anyOf: - type: number - type: 'null' title: Request Presence Penalty request_frequency_penalty: anyOf: - type: number - type: 'null' title: Request Frequency Penalty request_seed: type: integer title: Request Seed request_stop_sequences: type: array items: type: string title: Request Stop Sequences request_encoding_formats: type: array items: type: string title: Request Encoding Formats response_finish_reasons: type: array items: type: string title: Response Finish Reasons usage_input_tokens: type: integer title: Usage Input Tokens usage_output_tokens: type: integer title: Usage Output Tokens usage_cache_read_input_tokens: type: integer title: Usage Cache Read Input Tokens usage_cache_creation_input_tokens: type: integer title: Usage Cache Creation Input Tokens resource_attributes: type: object title: Resource Attributes additionalProperties: type: string span_attributes: type: object title: Span Attributes additionalProperties: type: string scope_name: type: string title: Scope Name scope_version: type: string title: Scope Version title: GetSpan required: - customer_id - organization_id - workspace_id - user_id - trace_id - span_id - parent_span_id - trace_state - start_time - end_time - duration_ns - span_name - span_kind - service_name - status_code - status_message - error_type - operation_name - provider_name - request_model - response_model - response_id - output_type - conversation_id - data_source_id - agent_id - agent_name - agent_version - agent_description - workflow_name - prompt_name - tool_name - tool_type - tool_call_id - input_messages - output_messages - system_instructions - tool_definitions - tool_call_arguments - tool_call_result - request_choice_count - request_max_tokens - request_temperature - request_top_p - request_top_k - request_presence_penalty - request_frequency_penalty - request_seed - request_stop_sequences - request_encoding_formats - response_finish_reasons - usage_input_tokens - usage_output_tokens - usage_cache_read_input_tokens - usage_cache_creation_input_tokens - resource_attributes - span_attributes - scope_name - scope_version GetSpans: type: object properties: spans: $ref: '#/components/schemas/FeedResultGetSpan' title: GetSpans required: - spans GetTraceFieldOptions: type: object properties: options: anyOf: - type: array items: type: string - type: 'null' title: Options title: GetTraceFieldOptions required: - options GetTraceFields: type: object properties: field_definitions: type: array items: $ref: '#/components/schemas/OtelFieldDefinition' title: Field Definitions title: GetTraceFields required: - field_definitions GetTrace: type: object properties: customer_id: type: string title: Customer Id organization_id: type: string title: Organization Id workspace_id: type: string title: Workspace Id user_id: type: string title: User Id trace_id: type: string title: Trace Id pattern: ^[0-9a-f]{32}$ root_span_id: type: string title: Root Span Id pattern: ^[0-9a-f]{16}$ root_span_name: type: string title: Root Span Name start_time: type: string title: Start Time format: date-time end_time: type: string title: End Time format: date-time duration_ns: type: integer title: Duration Ns service_name: type: string title: Service Name environment: type: string title: Environment conversation_id: type: string title: Conversation Id workflow_name: type: string title: Workflow Name agent_id: type: string title: Agent Id agent_name: type: string title: Agent Name status_code: type: string title: Status Code enum: - Error - Unset error_count: type: integer title: Error Count span_count: type: integer title: Span Count gen_ai_span_count: type: integer title: Gen Ai Span Count llm_call_count: type: integer title: Llm Call Count tool_call_count: type: integer title: Tool Call Count retrieval_count: type: integer title: Retrieval Count evaluation_count: type: integer title: Evaluation Count input_tokens: type: integer title: Input Tokens output_tokens: type: integer title: Output Tokens cache_read_input_tokens: type: integer title: Cache Read Input Tokens cache_creation_input_tokens: type: integer title: Cache Creation Input Tokens models_used: type: array items: type: string title: Models Used tools_used: type: array items: type: string title: Tools Used first_turn_last_input_message: type: string title: First Turn Last Input Message first_turn_last_output_message: type: string title: First Turn Last Output Message last_turn_last_input_message: type: string title: Last Turn Last Input Message last_turn_last_output_message: type: string title: Last Turn Last Output Message title: GetTrace required: - customer_id - organization_id - workspace_id - user_id - trace_id - root_span_id - root_span_name - start_time - end_time - duration_ns - service_name - environment - conversation_id - workflow_name - agent_id - agent_name - status_code - error_count - span_count - gen_ai_span_count - llm_call_count - tool_call_count - retrieval_count - evaluation_count - input_tokens - output_tokens - cache_read_input_tokens - cache_creation_input_tokens - models_used - tools_used - first_turn_last_input_message - first_turn_last_output_message - last_turn_last_input_message - last_turn_last_output_message GetTraces: type: object properties: traces: $ref: '#/components/schemas/FeedResultGetTrace' title: GetTraces required: - traces Granularity: type: string title: Granularity enum: - auto - second - minute - hour - day - week - month JudgeClassificationOutput: type: object properties: type: type: string title: Type default: CLASSIFICATION const: CLASSIFICATION options: type: array items: $ref: '#/components/schemas/JudgeClassificationOutputOption' title: Options title: JudgeClassificationOutput required: - options JudgeClassificationOutputOption: type: object properties: value: type: string title: Value description: type: string title: Description title: JudgeClassificationOutputOption required: - value - description JudgeOutput: type: object properties: analysis: type: string title: Analysis answer: anyOf: - type: string - type: number title: Answer title: JudgeOutput required: - analysis - answer JudgeOutputType: type: string title: JudgeOutputType enum: - REGRESSION - CLASSIFICATION JudgeRegressionOutput: type: object properties: type: type: string title: Type default: REGRESSION const: REGRESSION min: type: number title: Min minimum: 0 default: 0 min_description: type: string title: Min Description max: exclusiveMaximum: 1e+09 type: number title: Max default: 1 max_description: type: string title: Max Description title: JudgeRegressionOutput required: - min_description - max_description MetricAggregation: type: string title: MetricAggregation enum: - count - count_distinct - sum - avg - min - max - p50 - p90 - p95 - p99 MetricDefinition: type: object properties: measure: type: string title: Measure aggregation: $ref: '#/components/schemas/MetricAggregation' title: MetricDefinition required: - measure - aggregation ObservabilityErrorCode: type: string title: ObservabilityErrorCode enum: - UNKNOWN_ERROR - VALIDATION_ERROR - AUTH_FORBIDDEN - AUTH_FORBIDDEN_NOT_WORKSPACE_ADMIN - AUTH_FORBIDDEN_WORKSPACE_NOT_FOUND - AUTH_FORBIDDEN_ROLE_NOT_FOUND - AUTH_UNAUTHORIZED - FEATURE_NOT_SUPPORTED - FIELDS_BAD_REQUEST - FIELDS_NOT_FOUND - SEARCH_NOT_FOUND - SEARCH_BAD_REQUEST - SEARCH_SERVICE_UNAVAILABLE - DATABASE_ERROR - DATABASE_TIMEOUT - DATABASE_UNAVAILABLE - DATABASE_QUERY_ERROR - SEARCH_FILTER_TO_SQL_CONVERSION_ERROR - JUDGE_CONVERSATION_FORMAT_ERROR - JUDGE_MISTRAL_API_ERROR - JUDGE_MISTRAL_API_TIMEOUT - JUDGE_NAME_ALREADY_EXISTS - JUDGE_NOT_FOUND - JUDGE_ALREADY_HAS_NEW_VERSION - JUDGE_USED_IN_CAMPAIGN_CANNOT_BE_UPDATED - JUDGE_DID_NOT_CHANGE - CAMPAIGN_NOT_FOUND - CAMPAIGN_NO_MATCHING_EVENTS - DATASET_NOT_FOUND - DATASET_TASK_NOT_FOUND - DATASET_RECORD_NOT_FOUND - DATASET_RECORD_FORMAT_ERROR - AGENT_NOT_FOUND - AGENT_MISTRAL_API_ERROR - EVALUATION_NOT_FOUND - EVALUATION_CURRENTLY_RUNNING - EVALUATION_RECORD_NOT_FOUND - EVALUATION_RUN_NOT_FOUND - EVALUATION_RUN_TRANSITION_IS_INVALID - EVALUATION_RUN_TRANSITION_IS_RUNNING_ALREADY - EVALUATION_RUN_TRANSITION_ERROR - TEMPLATE_ERROR - TEMPLATE_SYNTAX_ERROR - PROJECT_NAME_ALREADY_EXISTS - EVALUATION_NAME_ALREADY_EXISTS - OPTIMIZATION_TRIAL_KEY_ALREADY_EXISTS - TRACES_FILTER_QUERY_PARSE_ERROR - TRACE_NOT_FOUND - SPAN_NOT_FOUND ObservabilityErrorDetail: type: object properties: message: type: string title: Message x-speakeasy-error-message: true error_code: anyOf: - $ref: '#/components/schemas/ObservabilityErrorCode' - type: 'null' title: ObservabilityErrorDetail required: - message - error_code ObservabilityError: type: object properties: detail: $ref: '#/components/schemas/ObservabilityErrorDetail' title: ObservabilityError required: - detail OrderByClause: type: object properties: field: type: string title: Field direction: type: string title: Direction enum: - asc - desc default: asc title: OrderByClause required: - field OtelFieldDefinition: type: object properties: name: type: string title: Name label: type: string title: Label type: type: string title: Type enum: - ENUM - TEXT - INT - FLOAT - BOOL - TIMESTAMP - ARRAY - MAP group: anyOf: - type: string - type: 'null' title: Group supported_operators: type: array items: type: string enum: - eq - neq - lt - lte - gt - gte - like - ilike - not_like - not_ilike - between - not_between - in - not_in - exists - not_exists - regexp - not_regexp - contains - not_contains - has - hasAny - hasAll - hasToken title: Supported Operators readOnly: true supported_aggregations: type: array items: $ref: '#/components/schemas/MetricAggregation' title: Supported Aggregations readOnly: true title: OtelFieldDefinition required: - name - label - type - supported_operators - supported_aggregations TimeDimension: type: object properties: granularity: $ref: '#/components/schemas/Granularity' default: auto title: TimeDimension Annotations: type: object properties: audience: anyOf: - type: array items: type: string enum: - user - assistant - type: 'null' title: Audience priority: anyOf: - type: number maximum: 1 minimum: 0 - type: 'null' title: Priority title: Annotations additionalProperties: true AudioContent: type: object properties: type: type: string title: Type const: audio data: type: string title: Data mimeType: type: string title: Mimetype annotations: anyOf: - $ref: '#/components/schemas/Annotations' - type: 'null' _meta: anyOf: - type: object additionalProperties: true - type: 'null' title: Meta title: AudioContent required: - type - data - mimeType additionalProperties: true description: Audio content for a message. AuthData: type: object properties: client_id: type: string title: Client Id client_secret: anyOf: - type: string format: password writeOnly: true - type: 'null' title: Client Secret title: AuthData required: - client_id AuthDirection: type: string title: AuthDirection enum: - inbound - outbound AuthStatus: type: string title: AuthStatus enum: - valid - invalid - error AuthUrlResponse: type: object properties: auth_url: type: string title: Auth Url ttl: type: integer title: Ttl title: AuthUrlResponse required: - auth_url - ttl AuthenticationConfiguration: type: object properties: name: type: string title: Name title: anyOf: - type: string - type: 'null' title: Title authentication_type: $ref: '#/components/schemas/OutboundAuthenticationType' scope: $ref: '#/components/schemas/ConsumerType' status: anyOf: - $ref: '#/components/schemas/CredentialsStatus' - type: 'null' is_default: type: boolean title: Is Default default: false title: AuthenticationConfiguration required: - name - authentication_type - scope AuthenticationMethodCreateOrUpdateRequest: type: object properties: method_type: anyOf: - $ref: '#/components/schemas/OutboundAuthenticationType' - $ref: '#/components/schemas/InboundAuthenticationType' title: Method Type description: The type of authentication method (e.g. oauth2, bearer, none). auth_direction: $ref: '#/components/schemas/AuthDirection' description: Whether the authentication method is for outbound or inbound requests. default: outbound headers: anyOf: - type: array items: $ref: '#/components/schemas/ConnectorAuthenticationHeader' - type: 'null' title: Headers description: Set of headers to connect to the connector global_headers: type: object title: Global Headers additionalProperties: $ref: '#/components/schemas/GlobalHeaderValue' description: Connector-wide headers keyed by header name, applied to every credential. Secret values are encrypted at rest and never returned in clear. default: {} oauth2_metadata_secrets: anyOf: - $ref: '#/components/schemas/Oauth2MetadataSecrets' - type: 'null' description: New OAuth2 client credentials (client_id and client_secret). oauth2_server_metadata: anyOf: - $ref: '#/components/schemas/ExtendedOAuthServerMetadata' - type: 'null' description: New OAuth2 authorization server metadata. title: AuthenticationMethodCreateOrUpdateRequest required: - method_type BlobResourceContents: type: object properties: uri: type: string title: Uri minLength: 1 format: uri mimeType: anyOf: - type: string - type: 'null' title: Mimetype _meta: anyOf: - type: object additionalProperties: true - type: 'null' title: Meta blob: type: string title: Blob title: BlobResourceContents required: - uri - blob additionalProperties: true description: Binary contents of a resource. ClientCapabilities: type: object properties: experimental: anyOf: - type: object additionalProperties: type: object additionalProperties: true - type: 'null' title: Experimental sampling: anyOf: - $ref: '#/components/schemas/SamplingCapability' - type: 'null' elicitation: anyOf: - $ref: '#/components/schemas/ElicitationCapability' - type: 'null' roots: anyOf: - $ref: '#/components/schemas/RootsCapability' - type: 'null' tasks: anyOf: - $ref: '#/components/schemas/ClientTasksCapability' - type: 'null' title: ClientCapabilities additionalProperties: true description: Capabilities a client may support. ClientTasksCapability: type: object properties: list: anyOf: - $ref: '#/components/schemas/TasksListCapability' - type: 'null' cancel: anyOf: - $ref: '#/components/schemas/TasksCancelCapability' - type: 'null' requests: anyOf: - $ref: '#/components/schemas/ClientTasksRequestsCapability' - type: 'null' title: ClientTasksCapability additionalProperties: true description: Capability for client tasks operations. ClientTasksRequestsCapability: type: object properties: sampling: anyOf: - $ref: '#/components/schemas/TasksSamplingCapability' - type: 'null' elicitation: anyOf: - $ref: '#/components/schemas/TasksElicitationCapability' - type: 'null' title: ClientTasksRequestsCapability additionalProperties: true description: Capability for tasks requests operations. CompletionsCapability: type: object properties: {} title: CompletionsCapability additionalProperties: true description: Capability for completions operations. ConnectionConfigType: type: string title: ConnectionConfigType enum: - mcp - turbine - eolienne ConnectionCredentials: type: object properties: oauth: anyOf: - $ref: '#/components/schemas/OAuth2Token' - type: 'null' headers: anyOf: - type: object additionalProperties: type: string - type: 'null' title: Headers bearer_token: anyOf: - type: string - type: 'null' title: Bearer Token github_installation_id: anyOf: - type: string - type: 'null' title: Github Installation Id title: ConnectionCredentials ConnectionPreference: type: object properties: name: type: string title: Name tool_configuration: $ref: '#/components/schemas/ToolExecutionConfiguration' is_default: anyOf: - type: boolean - type: 'null' title: Is Default consumer_type: anyOf: - $ref: '#/components/schemas/ConsumerType' - type: 'null' title: ConnectionPreference required: - name - tool_configuration ConnectorAuthenticationHeader: type: object properties: name: type: string title: Name is_required: type: boolean title: Is Required default: true is_secret: type: boolean title: Is Secret default: true title: ConnectorAuthenticationHeader required: - name ConnectorLocale: type: object properties: name: type: object propertyNames: $ref: '#/components/schemas/ConnectorSupportedLanguage' title: Name additionalProperties: type: string description: type: object propertyNames: $ref: '#/components/schemas/ConnectorSupportedLanguage' title: Description additionalProperties: type: string usage_sentence: type: object propertyNames: $ref: '#/components/schemas/ConnectorSupportedLanguage' title: Usage Sentence additionalProperties: type: string title: ConnectorLocale required: - name - description - usage_sentence ConnectorProtocol: type: string title: ConnectorProtocol enum: - mcp - http - turbine ConnectorSupportedLanguage: type: string title: ConnectorSupportedLanguage enum: - en - fr - ar - es - de - pl - pt-BR - it - nl ConnectorTool: type: object properties: id: type: string title: Id name: type: string title: Name description: type: string title: Description system_prompt: anyOf: - type: string - type: 'null' title: System Prompt locale: anyOf: - $ref: '#/components/schemas/ConnectorToolLocale' - type: 'null' jsonschema: anyOf: - type: object additionalProperties: true - type: 'null' title: Jsonschema execution_config: anyOf: - $ref: '#/components/schemas/ExecutionConfig' - type: 'null' visibility: $ref: '#/components/schemas/ResourceVisibility' created_at: type: string title: Created At format: date-time modified_at: type: string title: Modified At format: date-time active: anyOf: - type: boolean - type: 'null' title: Active title: ConnectorTool required: - id - name - description - execution_config - visibility - created_at - modified_at ConnectorsQueryFilters: type: object properties: active: anyOf: - type: boolean - type: 'null' title: Active description: Filter for active connectors for a given user, workspace and organization. title: ConnectorsQueryFilters ConsumerType: type: string title: ConsumerType enum: - user - org - workspace - system CredentialsCreateOrUpdate: type: object properties: name: type: string title: Name description: Name of the credentials. Use this name to access or modify your credentials. title: anyOf: - type: string maxLength: 255 - type: 'null' title: Title description: Human-readable title for the credentials. is_default: anyOf: - type: boolean - type: 'null' title: Is Default description: 'Controls whether this credential is the default for its auth method. On creation: if no credential exists yet for this auth method, the credential is automatically set as default when is_default is true or omitted; setting is_default to false is rejected because a default must exist. If other credentials already exist, setting is_default to true promotes this credential (demoting the previous default); false or omitted creates it as non-default. On update: true promotes this credential, false is rejected if it is currently the default (promote another credential first), omitted leaves the default status unchanged.' credentials: anyOf: - $ref: '#/components/schemas/ConnectionCredentials' - type: 'null' description: The credential data (headers, bearer_token). title: CredentialsCreateOrUpdate required: - name description: Request to create or update non-OAuth2 credentials for a connector. CredentialsResponse: type: object properties: credentials: type: array items: $ref: '#/components/schemas/AuthenticationConfiguration' title: Credentials connector_preset_credentials_for_auth: type: array items: $ref: '#/components/schemas/OutboundAuthenticationType' title: Connector Preset Credentials For Auth default: [] title: CredentialsResponse required: - credentials CredentialsStatus: type: object properties: status_type: $ref: '#/components/schemas/AuthStatus' last_checked_at: anyOf: - type: string format: date-time - type: 'null' title: Last Checked At error_http_code: anyOf: - $ref: '#/components/schemas/HTTPStatus' - type: 'null' error_message: anyOf: - $ref: '#/components/schemas/CredentialsStatusErrorReason' - type: 'null' title: CredentialsStatus required: - status_type CredentialsStatusErrorReason: type: string title: CredentialsStatusErrorReason enum: - oauth expired - oauth near expiry - empty credentials - unparsable credentials - you need to reconnect - oauth refresh error - MCP server unreachable - MCP server timed out - MCP server error - unknown error ElicitationCapability: type: object properties: form: anyOf: - $ref: '#/components/schemas/FormElicitationCapability' - type: 'null' url: anyOf: - $ref: '#/components/schemas/UrlElicitationCapability' - type: 'null' title: ElicitationCapability additionalProperties: true description: 'Capability for elicitation operations. Clients must support at least one mode (form or url).' EmbeddedResource: type: object properties: type: type: string title: Type const: resource resource: anyOf: - $ref: '#/components/schemas/TextResourceContents' - $ref: '#/components/schemas/BlobResourceContents' title: Resource annotations: anyOf: - $ref: '#/components/schemas/Annotations' - type: 'null' _meta: anyOf: - type: object additionalProperties: true - type: 'null' title: Meta title: EmbeddedResource required: - type - resource additionalProperties: true description: 'The contents of a resource, embedded into a prompt or tool call result. It is up to the client how best to render embedded resources for the benefit of the LLM and/or the user.' ExecutionConfig: type: object properties: type: type: string title: Type title: ExecutionConfig required: - type additionalProperties: true description: 'Not typed since mcp config can changed / not stable we allow all extra fields and this is a dict TODO: once mcp is stable, we need to type this' ExecutionTool: type: object properties: name: type: string title: Name integration_id: type: string title: Integration Id format: uuid execution_config: anyOf: - $ref: '#/components/schemas/ExecutionConfig' - type: 'null' title: ExecutionTool required: - name - integration_id - execution_config ExtendedOAuthServerMetadata: type: object properties: issuer: type: string title: Issuer minLength: 1 format: uri authorization_endpoint: type: string title: Authorization Endpoint minLength: 1 format: uri token_endpoint: type: string title: Token Endpoint minLength: 1 format: uri registration_endpoint: anyOf: - type: string minLength: 1 format: uri - type: 'null' title: Registration Endpoint scopes_supported: anyOf: - type: array items: type: string - type: 'null' title: Scopes Supported response_types_supported: type: array items: type: string title: Response Types Supported default: - code response_modes_supported: anyOf: - type: array items: type: string - type: 'null' title: Response Modes Supported grant_types_supported: anyOf: - type: array items: type: string - type: 'null' title: Grant Types Supported token_endpoint_auth_methods_supported: anyOf: - type: array items: type: string - type: 'null' title: Token Endpoint Auth Methods Supported token_endpoint_auth_signing_alg_values_supported: anyOf: - type: array items: type: string - type: 'null' title: Token Endpoint Auth Signing Alg Values Supported service_documentation: anyOf: - type: string minLength: 1 format: uri - type: 'null' title: Service Documentation ui_locales_supported: anyOf: - type: array items: type: string - type: 'null' title: Ui Locales Supported op_policy_uri: anyOf: - type: string minLength: 1 format: uri - type: 'null' title: Op Policy Uri op_tos_uri: anyOf: - type: string minLength: 1 format: uri - type: 'null' title: Op Tos Uri revocation_endpoint: anyOf: - type: string minLength: 1 format: uri - type: 'null' title: Revocation Endpoint revocation_endpoint_auth_methods_supported: anyOf: - type: array items: type: string - type: 'null' title: Revocation Endpoint Auth Methods Supported revocation_endpoint_auth_signing_alg_values_supported: anyOf: - type: array items: type: string - type: 'null' title: Revocation Endpoint Auth Signing Alg Values Supported introspection_endpoint: anyOf: - type: string minLength: 1 format: uri - type: 'null' title: Introspection Endpoint introspection_endpoint_auth_methods_supported: anyOf: - type: array items: type: string - type: 'null' title: Introspection Endpoint Auth Methods Supported introspection_endpoint_auth_signing_alg_values_supported: anyOf: - type: array items: type: string - type: 'null' title: Introspection Endpoint Auth Signing Alg Values Supported code_challenge_methods_supported: anyOf: - type: array items: type: string - type: 'null' title: Code Challenge Methods Supported client_id_metadata_document_supported: anyOf: - type: boolean - type: 'null' title: Client Id Metadata Document Supported x_source: anyOf: - $ref: '#/components/schemas/OAuthMetadataSource' - type: 'null' x_resource_url: anyOf: - type: string - type: 'null' title: X Resource Url x_scope: anyOf: - type: string - type: 'null' title: X Scope title: ExtendedOAuthServerMetadata required: - issuer - authorization_endpoint - token_endpoint description: 'Custom superset of RFC 8414 OAuth 2.0 Authorization Server Metadata. Stored at connector creation time (provided for HTTP connectors, discovered via .well-known for MCP). Mirrors the shape of .well-known/oauth-authorization-server responses.' FormElicitationCapability: type: object properties: {} title: FormElicitationCapability additionalProperties: true description: Capability for form mode elicitation. GlobalHeaderValue: type: object properties: is_secret: type: boolean title: Is Secret default: true value: type: string title: Value title: GlobalHeaderValue required: - value description: 'Value of a connector-wide header. ``value`` is plaintext in memory so create round-trips and encryption-at-rest keep the real value; secrets are redacted only on JSON serialization (API responses).' HTTPStatus: type: integer title: HTTPStatus enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 418 - 421 - 422 - 423 - 424 - 425 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 description: "HTTP status codes and reason phrases\n\nStatus codes from the following RFCs are all observed:\n\n * RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 2616\n * RFC 6585: Additional HTTP Status Codes\n * RFC 3229: Delta encoding in HTTP\n * RFC 4918: HTTP Extensions for WebDAV, obsoletes 2518\n * RFC 5842: Binding Extensions to WebDAV\n * RFC 7238: Permanent Redirect\n * RFC 2295: Transparent Content Negotiation in HTTP\n * RFC 2774: An HTTP Extension Framework\n * RFC 7725: An HTTP Status Code to Report Legal Obstacles\n * RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2)\n * RFC 2324: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0)\n * RFC 8297: An HTTP Status Code for Indicating Hints\n * RFC 8470: Using Early Data in HTTP" ImageContent: type: object properties: type: type: string title: Type const: image data: type: string title: Data mimeType: type: string title: Mimetype annotations: anyOf: - $ref: '#/components/schemas/Annotations' - type: 'null' _meta: anyOf: - type: object additionalProperties: true - type: 'null' title: Meta title: ImageContent required: - type - data - mimeType additionalProperties: true description: Image content for a message. InboundAuthenticationType: type: string title: InboundAuthenticationType enum: - webhook LoggingCapability: type: object properties: {} title: LoggingCapability additionalProperties: true description: Capability for logging operations. LogicalExpression: type: object properties: type: type: string title: Type enum: - and - or expressions: type: array items: anyOf: - type: array items: type: string uniqueItems: true - $ref: '#/components/schemas/LogicalExpression' - $ref: '#/components/schemas/ToolProperties' title: Expressions title: LogicalExpression required: - type - expressions MCPServerAuthenticationRequirement: type: object properties: required: type: boolean title: Required description: Whether authentication is mandatory schemes: type: array items: type: string title: Schemes description: Supported schemes (e.g. ['bearer', 'oauth2']) default: [] title: MCPServerAuthenticationRequirement required: - required description: Authentication requirements for a remote transport (SEP-2127). MCPServerCard: type: object properties: $schema: anyOf: - type: string - type: 'null' title: $Schema description: URL to the JSON schema definition default: https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json name: type: string title: Name description: Server identifier in reverse-DNS format with exactly one / version: type: string title: Version description: Server version (semantic versioning preferred) capabilities: $ref: '#/components/schemas/ServerCapabilities' title: anyOf: - type: string - type: 'null' title: Title description: anyOf: - type: string - type: 'null' title: Description websiteUrl: anyOf: - type: string - type: 'null' title: Websiteurl repository: anyOf: - $ref: '#/components/schemas/MCPServerRepository' - type: 'null' icons: anyOf: - type: array items: $ref: '#/components/schemas/MCPServerIcon' - type: 'null' title: Icons remotes: anyOf: - type: array items: $ref: '#/components/schemas/MCPServerRemote' - type: 'null' title: Remotes requires: anyOf: - $ref: '#/components/schemas/ClientCapabilities' - type: 'null' resources: anyOf: - type: string const: dynamic - type: array items: $ref: '#/components/schemas/MCPResource' - type: 'null' title: Resources tools: anyOf: - type: string const: dynamic - type: array items: $ref: '#/components/schemas/MCPServerCardTool' - type: 'null' title: Tools prompts: anyOf: - type: string const: dynamic - type: array items: $ref: '#/components/schemas/MCPPrompt' - type: 'null' title: Prompts _meta: anyOf: - $ref: '#/components/schemas/MCPServerCardMeta' - type: 'null' title: MCPServerCard required: - name - version additionalProperties: true MCPServerCardMeta: type: object properties: ai.mistral/turbine: anyOf: - $ref: '#/components/schemas/TurbineMeta' - type: 'null' title: MCPServerCardMeta additionalProperties: true description: 'Typed _meta for MCP server cards. Only the ''turbine'' field is typed. Other fields are allowed via extra="allow".' MCPServerRemote: type: object properties: type: type: string title: Type enum: - streamable-http - sse description: Transport type url: type: string title: Url description: Transport endpoint URL supportedProtocolVersions: anyOf: - type: array items: type: string - type: 'null' title: Supportedprotocolversions headers: anyOf: - type: array items: $ref: '#/components/schemas/MCPServerRemoteHeader' - type: 'null' title: Headers authentication: anyOf: - $ref: '#/components/schemas/MCPServerAuthenticationRequirement' - type: 'null' title: MCPServerRemote required: - type - url description: Remote transport endpoint (SEP-2127). MCPServerRemoteHeader: type: object properties: name: type: string title: Name description: Header name description: type: string title: Description description: Human-readable description of the header isRequired: anyOf: - type: boolean - type: 'null' title: Isrequired isSecret: anyOf: - type: boolean - type: 'null' title: Issecret default: anyOf: - type: string - type: 'null' title: Default choices: anyOf: - type: array items: type: string - type: 'null' title: Choices title: MCPServerRemoteHeader required: - name - description description: Header definition for a remote transport (SEP-2127). MCPServerRepository: type: object properties: url: type: string title: Url description: Repository URL source: type: string title: Source description: Source identifier (e.g. 'github') subfolder: anyOf: - type: string - type: 'null' title: Subfolder title: MCPServerRepository required: - url - source description: Source repository information (SEP-2127). MCPSupportedLanguage: type: string title: MCPSupportedLanguage enum: - en - fr - de - es - pl - it - ar - pt-BR - nl MCPTool: type: object properties: name: type: string title: Name title: anyOf: - type: string - type: 'null' title: Title description: anyOf: - type: string - type: 'null' title: Description inputSchema: type: object title: Inputschema additionalProperties: true outputSchema: anyOf: - type: object additionalProperties: true - type: 'null' title: Outputschema icons: anyOf: - type: array items: $ref: '#/components/schemas/MCPServerIcon' - type: 'null' title: Icons annotations: anyOf: - $ref: '#/components/schemas/ToolAnnotations' - type: 'null' _meta: anyOf: - $ref: '#/components/schemas/MCPToolMeta' - type: 'null' execution: anyOf: - $ref: '#/components/schemas/ToolExecution' - type: 'null' title: MCPTool required: - name - inputSchema additionalProperties: true MCPToolMeta: type: object properties: ui: anyOf: - $ref: '#/components/schemas/MCPUIToolMeta' - type: 'null' ai.mistral/turbine: anyOf: - $ref: '#/components/schemas/TurbineToolMeta' - type: 'null' title: MCPToolMeta additionalProperties: true description: 'Typed _meta for MCP tools. Only the ''ui'' field is typed. Other fields are allowed via extra="allow".' MCPUIToolMeta: type: object properties: resourceUri: anyOf: - type: string - type: 'null' title: Resourceuri visibility: anyOf: - type: array items: type: string enum: - model - app - type: 'null' title: Visibility title: MCPUIToolMeta additionalProperties: true description: UI metadata for tools that reference UI resources. MessageResponse: type: object properties: message: type: string title: Message title: MessageResponse required: - message OAuth2Token: type: object properties: access_token: type: string title: Access Token token_type: type: string title: Token Type default: Bearer const: Bearer expires_in: anyOf: - type: integer - type: 'null' title: Expires In scope: anyOf: - type: string - type: 'null' title: Scope refresh_token: anyOf: - type: string - type: 'null' title: Refresh Token expires_at: anyOf: - type: string format: date-time - type: 'null' title: Expires At title: OAuth2Token required: - access_token OAuthMetadataSource: type: string title: OAuthMetadataSource enum: - autodiscovery - provided description: How a connector's OAuth server metadata was obtained. Oauth2MetadataSecrets: type: object properties: client_id: anyOf: - type: string - type: 'null' title: Client Id client_secret: anyOf: - type: string format: password writeOnly: true - type: 'null' title: Client Secret client_id_issued_at: anyOf: - type: integer - type: 'null' title: Client Id Issued At client_secret_expires_at: anyOf: - type: integer - type: 'null' title: Client Secret Expires At title: Oauth2MetadataSecrets description: 'OAuth2 client credentials stored alongside a connector''s authentication method. Used by OAuth2 and Slack App auth types for token exchange and refresh flows. Contains the client credentials obtained during OAuth2 Dynamic Client Registration or provided at connector creation time.' OutboundAuthenticationType: type: string title: OutboundAuthenticationType enum: - oauth2 - bearer - none - github_app - slack_app PaginatedConnectors: type: object properties: items: type: array items: $ref: '#/components/schemas/Connector' title: Items pagination: $ref: '#/components/schemas/PaginationResponse' title: PaginatedConnectors required: - items - pagination PaginationResponse: type: object properties: next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor page_size: type: integer title: Page Size title: PaginationResponse required: - page_size PromptArgument: type: object properties: name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description required: anyOf: - type: boolean - type: 'null' title: Required title: PromptArgument required: - name additionalProperties: true description: An argument for a prompt template. PromptsCapability: type: object properties: listChanged: anyOf: - type: boolean - type: 'null' title: Listchanged title: PromptsCapability additionalProperties: true description: Capability for prompts operations. PublicAuthenticationMethod: type: object properties: method_type: $ref: '#/components/schemas/OutboundAuthenticationType' headers: anyOf: - type: array items: $ref: '#/components/schemas/ConnectorAuthenticationHeader' - type: 'null' title: Headers global_headers: type: object title: Global Headers additionalProperties: $ref: '#/components/schemas/GlobalHeaderValue' default: {} has_default_credentials: type: boolean title: Has Default Credentials oauth2_server_metadata: anyOf: - $ref: '#/components/schemas/ExtendedOAuthServerMetadata' - type: 'null' title: PublicAuthenticationMethod required: - method_type - has_default_credentials description: Public view of an authentication method, without secrets. PublicConnectionConfig: type: object properties: type: $ref: '#/components/schemas/ConnectionConfigType' default: mcp base_url: anyOf: - type: string - type: 'null' title: Base Url headers: anyOf: - type: object additionalProperties: type: string - type: 'null' title: Headers signed: anyOf: - type: boolean - type: 'null' title: Signed default: false title: PublicConnectionConfig PublicExecutionConnectionConfig: type: object properties: type: $ref: '#/components/schemas/ConnectionConfigType' server: anyOf: - type: string - type: 'null' title: Server name: anyOf: - type: string - type: 'null' title: Name id: anyOf: - type: string - type: 'null' title: Id tool_configuration: anyOf: - $ref: '#/components/schemas/ToolExecutionConfiguration' - type: 'null' hosted_internally: type: boolean title: Hosted Internally default: false title: PublicExecutionConnectionConfig required: - type additionalProperties: false description: 'Connection config exposed in the public, unauthenticated /connectors/mistral response. Unlike ConnectionConfig, this has no `headers` field and forbids extra fields, so connector credentials can never be serialized into this cacheable response.' PublicExecutionConnector: type: object properties: id: type: string title: Id format: uuid name: type: string title: Name connection_config: anyOf: - $ref: '#/components/schemas/PublicExecutionConnectionConfig' - type: 'null' title: PublicExecutionConnector required: - id - name - connection_config PublicExecutionEnv: type: object properties: tools: type: array items: $ref: '#/components/schemas/Tool' title: Tools tool_execution_data: $ref: '#/components/schemas/PublicConnectorExecutionData' errors: type: array items: type: string title: Errors title: PublicExecutionEnv required: - tools - tool_execution_data - errors description: Credentials-free projection of ExecutionEnv for the public /connectors/mistral response. PublicResourceVisibility: type: string title: PublicResourceVisibility enum: - shared_org - shared_workspace - private description: 'Visibility options available to public API callers. Excludes ``shared_global`` which is reserved for system-owned connectors.' ResourceLink: type: object properties: name: type: string title: Name title: anyOf: - type: string - type: 'null' title: Title uri: type: string title: Uri minLength: 1 format: uri description: anyOf: - type: string - type: 'null' title: Description mimeType: anyOf: - type: string - type: 'null' title: Mimetype size: anyOf: - type: integer - type: 'null' title: Size icons: anyOf: - type: array items: $ref: '#/components/schemas/MCPServerIcon' - type: 'null' title: Icons annotations: anyOf: - $ref: '#/components/schemas/Annotations' - type: 'null' _meta: anyOf: - type: object additionalProperties: true - type: 'null' title: Meta type: type: string title: Type const: resource_link title: ResourceLink required: - name - uri - type additionalProperties: true description: 'A resource that the server is capable of reading, included in a prompt or tool call result. Note: resource links returned by tools are not guaranteed to appear in the results of `resources/list` requests.' ResourceVisibility: type: string title: ResourceVisibility enum: - shared_global - shared_org - shared_workspace - private ResourcesCapability: type: object properties: subscribe: anyOf: - type: boolean - type: 'null' title: Subscribe listChanged: anyOf: - type: boolean - type: 'null' title: Listchanged title: ResourcesCapability additionalProperties: true description: Capability for resources operations. RootsCapability: type: object properties: listChanged: anyOf: - type: boolean - type: 'null' title: Listchanged title: RootsCapability additionalProperties: true description: Capability for root operations. SamplingCapability: type: object properties: context: anyOf: - $ref: '#/components/schemas/SamplingContextCapability' - type: 'null' tools: anyOf: - $ref: '#/components/schemas/SamplingToolsCapability' - type: 'null' title: SamplingCapability additionalProperties: true description: Sampling capability structure, allowing fine-grained capability advertisement. SamplingContextCapability: type: object properties: {} title: SamplingContextCapability additionalProperties: true description: 'Capability for context inclusion during sampling. Indicates support for non-''none'' values in the includeContext parameter. SOFT-DEPRECATED: New implementations should use tools parameter instead.' SamplingToolsCapability: type: object properties: {} title: SamplingToolsCapability additionalProperties: true description: 'Capability indicating support for tool calling during sampling. When present in ClientCapabilities.sampling, indicates that the client supports the tools and toolChoice parameters in sampling requests.' ServerCapabilities: type: object properties: experimental: anyOf: - type: object additionalProperties: type: object additionalProperties: true - type: 'null' title: Experimental logging: anyOf: - $ref: '#/components/schemas/LoggingCapability' - type: 'null' prompts: anyOf: - $ref: '#/components/schemas/PromptsCapability' - type: 'null' resources: anyOf: - $ref: '#/components/schemas/ResourcesCapability' - type: 'null' tools: anyOf: - $ref: '#/components/schemas/ToolsCapability' - type: 'null' completions: anyOf: - $ref: '#/components/schemas/CompletionsCapability' - type: 'null' tasks: anyOf: - $ref: '#/components/schemas/ServerTasksCapability' - type: 'null' title: ServerCapabilities additionalProperties: true description: Capabilities that a server may support. ServerLocale: type: object properties: name: anyOf: - type: object propertyNames: $ref: '#/components/schemas/MCPSupportedLanguage' additionalProperties: type: string - type: 'null' title: Name description: anyOf: - type: object propertyNames: $ref: '#/components/schemas/MCPSupportedLanguage' additionalProperties: type: string - type: 'null' title: Description usage_sentence: anyOf: - type: object propertyNames: $ref: '#/components/schemas/MCPSupportedLanguage' additionalProperties: type: string - type: 'null' title: Usage Sentence working_description: anyOf: - type: object propertyNames: $ref: '#/components/schemas/MCPSupportedLanguage' additionalProperties: type: string - type: 'null' title: Working Description done_description: anyOf: - type: object propertyNames: $ref: '#/components/schemas/MCPSupportedLanguage' additionalProperties: type: string - type: 'null' title: Done Description title: ServerLocale ServerTasksCapability: type: object properties: list: anyOf: - $ref: '#/components/schemas/TasksListCapability' - type: 'null' cancel: anyOf: - $ref: '#/components/schemas/TasksCancelCapability' - type: 'null' requests: anyOf: - $ref: '#/components/schemas/ServerTasksRequestsCapability' - type: 'null' title: ServerTasksCapability additionalProperties: true description: Capability for server tasks operations. ServerTasksRequestsCapability: type: object properties: tools: anyOf: - $ref: '#/components/schemas/TasksToolsCapability' - type: 'null' title: ServerTasksRequestsCapability additionalProperties: true description: Capability for tasks requests operations. TasksCallCapability: type: object properties: {} title: TasksCallCapability additionalProperties: true description: Capability for tasks call operations. TasksCancelCapability: type: object properties: {} title: TasksCancelCapability additionalProperties: true description: Capability for tasks cancel operations. TasksCreateElicitationCapability: type: object properties: {} title: TasksCreateElicitationCapability additionalProperties: true description: Capability for tasks create elicitation operations. TasksCreateMessageCapability: type: object properties: {} title: TasksCreateMessageCapability additionalProperties: true description: Capability for tasks create messages. TasksElicitationCapability: type: object properties: create: anyOf: - $ref: '#/components/schemas/TasksCreateElicitationCapability' - type: 'null' title: TasksElicitationCapability additionalProperties: true description: Capability for tasks elicitation operations. TasksListCapability: type: object properties: {} title: TasksListCapability additionalProperties: true description: Capability for tasks listing operations. TasksSamplingCapability: type: object properties: createMessage: anyOf: - $ref: '#/components/schemas/TasksCreateMessageCapability' - type: 'null' title: TasksSamplingCapability additionalProperties: true description: Capability for tasks sampling operations. TasksToolsCapability: type: object properties: call: anyOf: - $ref: '#/components/schemas/TasksCallCapability' - type: 'null' title: TasksToolsCapability additionalProperties: true description: Capability for tasks tools operations. TextContent: type: object properties: type: type: string title: Type const: text text: type: string title: Text annotations: anyOf: - $ref: '#/components/schemas/Annotations' - type: 'null' _meta: anyOf: - type: object additionalProperties: true - type: 'null' title: Meta title: TextContent required: - type - text additionalProperties: true description: Text content for a message. TextResourceContents: type: object properties: uri: type: string title: Uri minLength: 1 format: uri mimeType: anyOf: - type: string - type: 'null' title: Mimetype _meta: anyOf: - type: object additionalProperties: true - type: 'null' title: Meta text: type: string title: Text title: TextResourceContents required: - uri - text additionalProperties: true description: Text contents of a resource. ToolAnnotations: type: object properties: title: anyOf: - type: string - type: 'null' title: Title readOnlyHint: anyOf: - type: boolean - type: 'null' title: Readonlyhint destructiveHint: anyOf: - type: boolean - type: 'null' title: Destructivehint idempotentHint: anyOf: - type: boolean - type: 'null' title: Idempotenthint openWorldHint: anyOf: - type: boolean - type: 'null' title: Openworldhint title: ToolAnnotations additionalProperties: true description: 'Additional properties describing a Tool to clients. NOTE: all properties in ToolAnnotations are **hints**. They are not guaranteed to provide a faithful description of tool behavior (including descriptive properties like `title`). Clients should never make tool use decisions based on ToolAnnotations received from untrusted servers.' ToolExecution: type: object properties: taskSupport: anyOf: - type: string enum: - forbidden - optional - required - type: 'null' title: Tasksupport title: ToolExecution additionalProperties: true description: Execution-related properties for a tool. ToolExecutionConfiguration: type: object properties: requires_confirmation: anyOf: - type: array items: type: string uniqueItems: true - $ref: '#/components/schemas/LogicalExpression' - $ref: '#/components/schemas/ToolProperties' - type: 'null' title: Requires Confirmation skip_confirmation: anyOf: - type: array items: type: string uniqueItems: true - $ref: '#/components/schemas/LogicalExpression' - $ref: '#/components/schemas/ToolProperties' - type: 'null' title: Skip Confirmation include: anyOf: - type: array items: type: string - type: 'null' title: Include exclude: anyOf: - type: array items: type: string - type: 'null' title: Exclude title: ToolExecutionConfiguration ToolProperties: type: object properties: read_only: anyOf: - type: boolean - type: 'null' title: Read Only title: ToolProperties required: - read_only ToolType: type: string title: ToolType enum: - rag - image - code - event ToolsCapability: type: object properties: listChanged: anyOf: - type: boolean - type: 'null' title: Listchanged title: ToolsCapability additionalProperties: true description: Capability for tools operations. TurbineMeta: type: object properties: system_prompt_name: anyOf: - type: string - type: 'null' title: System Prompt Name locale: anyOf: - $ref: '#/components/schemas/ServerLocale' - type: 'null' title: TurbineMeta TurbineToolLocale: type: object properties: name: anyOf: - type: object propertyNames: $ref: '#/components/schemas/MCPSupportedLanguage' additionalProperties: type: string - type: 'null' title: Name description: anyOf: - type: object propertyNames: $ref: '#/components/schemas/MCPSupportedLanguage' additionalProperties: type: string - type: 'null' title: Description usage_sentence: anyOf: - type: object propertyNames: $ref: '#/components/schemas/MCPSupportedLanguage' additionalProperties: type: string - type: 'null' title: Usage Sentence working_description: anyOf: - type: object propertyNames: $ref: '#/components/schemas/MCPSupportedLanguage' additionalProperties: type: string - type: 'null' title: Working Description done_description: anyOf: - type: object propertyNames: $ref: '#/components/schemas/MCPSupportedLanguage' additionalProperties: type: string - type: 'null' title: Done Description title: TurbineToolLocale TurbineToolMeta: type: object properties: locale: anyOf: - $ref: '#/components/schemas/TurbineToolLocale' - type: 'null' tool_type: anyOf: - $ref: '#/components/schemas/ToolType' - type: 'null' timeout: anyOf: - type: number - type: 'null' title: Timeout private_execution: anyOf: - type: boolean - type: 'null' title: Private Execution title: TurbineToolMeta UrlElicitationCapability: type: object properties: {} title: UrlElicitationCapability additionalProperties: true description: Capability for URL mode elicitation. Connector: type: object properties: id: type: string title: Id format: uuid name: type: string title: Name title: anyOf: - type: string - type: 'null' title: Title description: type: string title: Description created_at: type: string title: Created At format: date-time modified_at: type: string title: Modified At format: date-time server: anyOf: - type: string - type: 'null' title: Server protocol: $ref: '#/components/schemas/ConnectorProtocol' default: mcp icon_url: anyOf: - type: string - type: 'null' title: Icon Url server_card: anyOf: - $ref: '#/components/schemas/MCPServerCard' - type: 'null' owner_id: anyOf: - type: string - type: 'null' title: Owner Id owner_type: $ref: '#/components/schemas/ConsumerType' visibility: $ref: '#/components/schemas/ResourceVisibility' creator_id: anyOf: - type: string - type: 'null' title: Creator Id locale: anyOf: - $ref: '#/components/schemas/ConnectorLocale' - type: 'null' system_prompt: anyOf: - type: string - type: 'null' title: System Prompt supported_auth_methods: anyOf: - type: array items: $ref: '#/components/schemas/PublicAuthenticationMethod' - type: 'null' title: Supported Auth Methods connection_preferences: anyOf: - type: array items: $ref: '#/components/schemas/ConnectionPreference' - type: 'null' title: Connection Preferences connection_credentials: anyOf: - type: array items: $ref: '#/components/schemas/AuthenticationConfiguration' - type: 'null' title: Connection Credentials active: anyOf: - type: boolean - type: 'null' title: Active private_tool_execution: type: boolean title: Private Tool Execution mistral: type: boolean title: Mistral default: false is_authenticated: anyOf: - type: boolean - type: 'null' title: Is Authenticated tools: anyOf: - type: array items: $ref: '#/components/schemas/ConnectorTool' - type: 'null' title: Tools system_prompt_route: anyOf: - type: string - type: 'null' title: System Prompt Route connection_config: anyOf: - $ref: '#/components/schemas/PublicConnectionConfig' - type: 'null' execution_env: anyOf: - $ref: '#/components/schemas/PublicExecutionEnv' - type: 'null' title: Connector required: - id - name - description - created_at - modified_at - owner_type - visibility - private_tool_execution MCPServerIcon: type: object properties: src: type: string title: Src mimeType: anyOf: - type: string - type: 'null' title: Mimetype sizes: anyOf: - type: array items: type: string - type: 'null' title: Sizes title: MCPServerIcon required: - src additionalProperties: true description: An icon for display in user interfaces. MCPServerCardTool: type: object properties: name: type: string title: Name title: anyOf: - type: string - type: 'null' title: Title description: anyOf: - type: string - type: 'null' title: Description inputSchema: type: object title: Inputschema additionalProperties: true outputSchema: anyOf: - type: object additionalProperties: true - type: 'null' title: Outputschema icons: anyOf: - type: array items: $ref: '#/components/schemas/MCPServerIcon' - type: 'null' title: Icons annotations: anyOf: - $ref: '#/components/schemas/ToolAnnotations' - type: 'null' _meta: anyOf: - $ref: '#/components/schemas/MCPToolMeta' - type: 'null' execution: anyOf: - $ref: '#/components/schemas/ToolExecution' - type: 'null' title: MCPServerCardTool required: - name - inputSchema additionalProperties: true MCPResource: type: object properties: name: type: string title: Name title: anyOf: - type: string - type: 'null' title: Title uri: type: string title: Uri minLength: 1 format: uri description: anyOf: - type: string - type: 'null' title: Description mimeType: anyOf: - type: string - type: 'null' title: Mimetype size: anyOf: - type: integer - type: 'null' title: Size icons: anyOf: - type: array items: $ref: '#/components/schemas/MCPServerIcon' - type: 'null' title: Icons annotations: anyOf: - $ref: '#/components/schemas/Annotations' - type: 'null' _meta: anyOf: - type: object additionalProperties: true - type: 'null' title: Meta title: MCPResource required: - name - uri additionalProperties: true MCPPrompt: type: object properties: name: type: string title: Name title: anyOf: - type: string - type: 'null' title: Title description: anyOf: - type: string - type: 'null' title: Description arguments: anyOf: - type: array items: $ref: '#/components/schemas/PromptArgument' - type: 'null' title: Arguments icons: anyOf: - type: array items: $ref: '#/components/schemas/MCPServerIcon' - type: 'null' title: Icons _meta: anyOf: - type: object additionalProperties: true - type: 'null' title: Meta title: MCPPrompt required: - name additionalProperties: true VoiceCreateRequest: type: object properties: name: type: string title: Name slug: anyOf: - type: string - type: 'null' title: Slug languages: type: array items: type: string title: Languages default: [] gender: anyOf: - type: string - type: 'null' title: Gender age: anyOf: - type: integer - type: 'null' title: Age tags: anyOf: - type: array items: type: string - type: 'null' title: Tags color: anyOf: - type: string - type: 'null' title: Color description: anyOf: - type: string maxLength: 500 - type: 'null' title: Description retention_notice: type: integer title: Retention Notice default: 30 sample_audio: type: string title: Sample Audio description: Base64-encoded audio file sample_filename: anyOf: - type: string - type: 'null' title: Sample Filename description: Original filename for extension detection title: VoiceCreateRequest required: - name - sample_audio description: Request model for creating a new voice with base64 audio. VoiceListResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/VoiceResponse' title: Items total: type: integer title: Total page: type: integer title: Page page_size: type: integer title: Page Size total_pages: type: integer title: Total Pages title: VoiceListResponse required: - items - total - page - page_size - total_pages description: Schema for voice list response VoiceResponse: type: object properties: name: type: string title: Name slug: anyOf: - type: string - type: 'null' title: Slug languages: type: array items: type: string title: Languages default: [] gender: anyOf: - type: string - type: 'null' title: Gender age: anyOf: - type: integer - type: 'null' title: Age tags: anyOf: - type: array items: type: string - type: 'null' title: Tags color: anyOf: - type: string - type: 'null' title: Color description: anyOf: - type: string maxLength: 500 - type: 'null' title: Description retention_notice: type: integer title: Retention Notice default: 30 id: type: string title: Id format: uuid created_at: type: string title: Created At format: date-time user_id: anyOf: - type: string - type: 'null' title: User Id trimmed_seconds: anyOf: - type: number - type: 'null' title: Trimmed Seconds title: VoiceResponse required: - name - id - created_at - user_id description: Schema for voice response VoiceUpdateRequest: type: object properties: name: anyOf: - type: string - type: 'null' title: Name languages: anyOf: - type: array items: type: string - type: 'null' title: Languages gender: anyOf: - type: string - type: 'null' title: Gender age: anyOf: - type: integer - type: 'null' title: Age tags: anyOf: - type: array items: type: string - type: 'null' title: Tags description: anyOf: - type: string maxLength: 500 - type: 'null' title: Description title: VoiceUpdateRequest description: Request model for partially updating voice metadata. ActivityTaskCompletedResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: ACTIVITY_TASK_COMPLETED const: ACTIVITY_TASK_COMPLETED attributes: $ref: '#/components/schemas/ActivityTaskCompletedAttributesResponse' description: Event-specific attributes. title: ActivityTaskCompleted required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when an activity task completes successfully. Contains timing information about the successful execution.' ActivityTaskCompletedAttributesResponse: type: object properties: task_id: type: string title: Task Id description: Unique identifier for the activity task within the workflow. activity_name: type: string title: Activity Name description: The registered name of the activity being executed. result: $ref: '#/components/schemas/JSONPayloadResponse' description: The result returned by the activity. title: ActivityTaskCompletedAttributes required: - task_id - activity_name - result description: Attributes for activity task completed events. ActivityTaskFailedResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: ACTIVITY_TASK_FAILED const: ACTIVITY_TASK_FAILED attributes: $ref: '#/components/schemas/ActivityTaskFailedAttributes' description: Event-specific attributes. title: ActivityTaskFailed required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when an activity task fails after exhausting all retry attempts. This is a terminal event indicating the activity could not complete successfully.' ActivityTaskFailedAttributes: type: object properties: task_id: type: string title: Task Id description: Unique identifier for the activity task within the workflow. activity_name: type: string title: Activity Name description: The registered name of the activity being executed. attempt: type: integer title: Attempt description: The final attempt number that failed (1-indexed). failure: $ref: '#/components/schemas/Failure' description: Details about the failure that caused the activity to fail. title: ActivityTaskFailedAttributes required: - task_id - activity_name - attempt - failure description: Attributes for activity task failed events (final failure after all retries). ActivityTaskRetryingResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: ACTIVITY_TASK_RETRYING const: ACTIVITY_TASK_RETRYING attributes: $ref: '#/components/schemas/ActivityTaskRetryingAttributes' description: Event-specific attributes. title: ActivityTaskRetrying required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when an activity task fails and will be retried. Contains information about the failed attempt and the error that occurred.' ActivityTaskRetryingAttributes: type: object properties: task_id: type: string title: Task Id description: Unique identifier for the activity task within the workflow. activity_name: type: string title: Activity Name description: The registered name of the activity being executed. attempt: type: integer title: Attempt description: The attempt number that failed (1-indexed). failure: $ref: '#/components/schemas/Failure' description: Details about the failure that caused the retry. title: ActivityTaskRetryingAttributes required: - task_id - activity_name - attempt - failure description: Attributes for activity task retrying events. ActivityTaskStartedResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: ACTIVITY_TASK_STARTED const: ACTIVITY_TASK_STARTED attributes: $ref: '#/components/schemas/ActivityTaskStartedAttributesResponse' description: Event-specific attributes. title: ActivityTaskStarted required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when an activity task begins execution. This is the first event for an activity, emitted on the first attempt only. Subsequent retry attempts emit ACTIVITY_TASK_RETRYING instead.' ActivityTaskStartedAttributesResponse: type: object properties: task_id: type: string title: Task Id description: Unique identifier for the activity task within the workflow. activity_name: type: string title: Activity Name description: The registered name of the activity being executed. input: $ref: '#/components/schemas/JSONPayloadResponse' description: The input arguments passed to the activity. title: ActivityTaskStartedAttributes required: - task_id - activity_name - input description: Attributes for activity task started events. BatchExecutionBody: type: object properties: execution_ids: type: array items: type: string title: Execution Ids maxItems: 100 minItems: 1 description: List of execution IDs to process title: BatchExecutionBody required: - execution_ids BatchExecutionResponse: type: object properties: results: type: object title: Results additionalProperties: $ref: '#/components/schemas/BatchExecutionResult' description: Mapping of execution_id to result with status and optional error message title: BatchExecutionResponse BatchExecutionResult: type: object properties: status: type: string title: Status description: Status of the operation (success/failure) error: anyOf: - type: string - type: 'null' title: Error description: Error message if operation failed title: BatchExecutionResult required: - status CreateDeploymentRequest: type: object properties: name: type: string title: Name spec: $ref: '#/components/schemas/DeploymentWorkerSpecInput' resources: anyOf: - $ref: '#/components/schemas/DeploymentResourceConfig' - type: 'null' hardened: type: boolean title: Hardened default: false title: CreateDeploymentRequest required: - name - spec CustomTaskCanceledResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: CUSTOM_TASK_CANCELED const: CUSTOM_TASK_CANCELED attributes: $ref: '#/components/schemas/CustomTaskCanceledAttributes' description: Event-specific attributes. title: CustomTaskCanceled required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a custom task is canceled. Indicates the task was explicitly stopped before completion.' CustomTaskCanceledAttributes: type: object properties: custom_task_id: type: string title: Custom Task Id description: Unique identifier for the custom task within the workflow. custom_task_type: type: string title: Custom Task Type description: The type/category of the custom task (e.g., 'llm_call', 'api_request'). reason: anyOf: - type: string - type: 'null' title: Reason description: Optional reason provided for the cancellation. title: CustomTaskCanceledAttributes required: - custom_task_id - custom_task_type description: Attributes for custom task canceled events. CustomTaskCompletedResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: CUSTOM_TASK_COMPLETED const: CUSTOM_TASK_COMPLETED attributes: $ref: '#/components/schemas/CustomTaskCompletedAttributesResponse' description: Event-specific attributes. title: CustomTaskCompleted required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a custom task completes successfully. Contains the final result of the task execution.' CustomTaskCompletedAttributesResponse: type: object properties: custom_task_id: type: string title: Custom Task Id description: Unique identifier for the custom task within the workflow. custom_task_type: type: string title: Custom Task Type description: The type/category of the custom task (e.g., 'llm_call', 'api_request'). payload: $ref: '#/components/schemas/JSONPayloadResponse' description: The final result of the custom task. title: CustomTaskCompletedAttributes required: - custom_task_id - custom_task_type - payload description: Attributes for custom task completed events. CustomTaskFailedResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: CUSTOM_TASK_FAILED const: CUSTOM_TASK_FAILED attributes: $ref: '#/components/schemas/CustomTaskFailedAttributes' description: Event-specific attributes. title: CustomTaskFailed required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a custom task fails. Contains details about the failure for debugging and error handling.' CustomTaskFailedAttributes: type: object properties: custom_task_id: type: string title: Custom Task Id description: Unique identifier for the custom task within the workflow. custom_task_type: type: string title: Custom Task Type description: The type/category of the custom task (e.g., 'llm_call', 'api_request'). failure: $ref: '#/components/schemas/Failure' description: Details about the failure that caused the task to fail. title: CustomTaskFailedAttributes required: - custom_task_id - custom_task_type - failure description: Attributes for custom task failed events. CustomTaskInProgressResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: CUSTOM_TASK_IN_PROGRESS const: CUSTOM_TASK_IN_PROGRESS attributes: $ref: '#/components/schemas/CustomTaskInProgressAttributesResponse' description: Event-specific attributes. title: CustomTaskInProgress required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted during custom task execution to report progress. This event supports streaming updates via JSON or JSON Patch payloads, enabling real-time progress tracking for long-running tasks.' CustomTaskInProgressAttributesResponse: type: object properties: custom_task_id: type: string title: Custom Task Id description: Unique identifier for the custom task within the workflow. custom_task_type: type: string title: Custom Task Type description: The type/category of the custom task (e.g., 'llm_call', 'api_request'). payload: oneOf: - $ref: '#/components/schemas/JSONPayloadResponse' - $ref: '#/components/schemas/JSONPatchPayloadResponse' discriminator: propertyName: type mapping: json: '#/components/schemas/JSONPayloadResponse' json_patch: '#/components/schemas/JSONPatchPayloadResponse' title: Payload description: The current state or incremental update for the task. title: CustomTaskInProgressAttributes required: - custom_task_id - custom_task_type - payload description: Attributes for custom task in-progress events with streaming updates. CustomTaskStartedResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: CUSTOM_TASK_STARTED const: CUSTOM_TASK_STARTED attributes: $ref: '#/components/schemas/CustomTaskStartedAttributesResponse' description: Event-specific attributes. title: CustomTaskStarted required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a custom task begins execution. Custom tasks represent user-defined units of work within a workflow, such as LLM calls, API requests, or data processing steps.' CustomTaskStartedAttributesResponse: type: object properties: custom_task_id: type: string title: Custom Task Id description: Unique identifier for the custom task within the workflow. custom_task_type: type: string title: Custom Task Type description: The type/category of the custom task (e.g., 'llm_call', 'api_request'). payload: $ref: '#/components/schemas/JSONPayloadResponse' description: The initial state or payload for the custom task. title: CustomTaskStartedAttributes required: - custom_task_id - custom_task_type description: Attributes for custom task started events. CustomTaskTimedOutResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: CUSTOM_TASK_TIMED_OUT const: CUSTOM_TASK_TIMED_OUT attributes: $ref: '#/components/schemas/CustomTaskTimedOutAttributes' description: Event-specific attributes. title: CustomTaskTimedOut required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a custom task exceeds its timeout. Indicates the task did not complete within its configured time limit.' CustomTaskTimedOutAttributes: type: object properties: custom_task_id: type: string title: Custom Task Id description: Unique identifier for the custom task within the workflow. custom_task_type: type: string title: Custom Task Type description: The type/category of the custom task (e.g., 'llm_call', 'api_request'). timeout_type: anyOf: - type: string - type: 'null' title: Timeout Type description: The type of timeout that occurred. title: CustomTaskTimedOutAttributes required: - custom_task_id - custom_task_type description: Attributes for custom task timed out events. DeploymentBuildState: type: object properties: phase: anyOf: - type: string - type: 'null' title: Phase commit_sha: anyOf: - type: string - type: 'null' title: Commit Sha image: anyOf: - type: string - type: 'null' title: Image message: anyOf: - type: string - type: 'null' title: Message started_at: anyOf: - type: string format: date-time - type: 'null' title: Started At finished_at: anyOf: - type: string format: date-time - type: 'null' title: Finished At title: DeploymentBuildState DeploymentDetailResponse: type: object properties: id: type: string title: Id format: uuid description: Unique identifier of the deployment name: type: string title: Name description: Deployment name is_active: type: boolean title: Is Active description: Whether at least one worker is currently live is_hardened: type: boolean title: Is Hardened description: Whether the deployment has at least one authorized credential default: false created_at: type: string title: Created At format: date-time description: When the deployment was first registered updated_at: type: string title: Updated At format: date-time description: When the deployment was last updated location: anyOf: - $ref: '#/components/schemas/DeploymentLocation' - type: 'null' description: Where the deployment is running deprecated: true worker_count: type: integer title: Worker Count description: Number of workers registered to the deployment default: 0 active_worker_count: type: integer title: Active Worker Count description: Number of workers currently live within the liveness cutoff default: 0 locations: type: array items: $ref: '#/components/schemas/LocationType' title: Locations description: Distinct location types reported by the deployment's workers managed: anyOf: - $ref: '#/components/schemas/ManagedDeploymentResponse' - type: 'null' description: Live managed service state for managed deployments; null for self-hosted deployments or when managed services are unavailable workers: type: array items: $ref: '#/components/schemas/DeploymentWorkerResponse' title: Workers description: Workers registered for the deployment title: DeploymentDetailResponse required: - id - name - is_active - created_at - updated_at - workers DeploymentListResponse: type: object properties: deployments: type: array items: $ref: '#/components/schemas/DeploymentResponse' title: Deployments description: List of deployments next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: Cursor for the next page of results workspace_id: type: string title: Workspace Id format: uuid description: Workspace ID the results are scoped to title: DeploymentListResponse required: - deployments - next_cursor - workspace_id DeploymentLocation: type: object properties: location_type: $ref: '#/components/schemas/LocationType' description: 'Where the deployment runs: ''local'', ''k8s'', or ''managed''' k8s_cluster: anyOf: - type: string - type: 'null' title: K8S Cluster description: K8s cluster name, if applicable k8s_namespace: anyOf: - type: string - type: 'null' title: K8S Namespace description: K8s namespace, if applicable title: DeploymentLocation required: - location_type DeploymentLogRecord: type: object properties: timestamp: type: string title: Timestamp format: date-time trace_id: type: string title: Trace Id span_id: type: string title: Span Id severity_text: type: string title: Severity Text body: type: string title: Body log_attributes: type: object title: Log Attributes additionalProperties: type: string title: DeploymentLogRecord required: - timestamp - trace_id - span_id - severity_text - body - log_attributes DeploymentLogSearchResponse: type: object properties: results: type: array items: $ref: '#/components/schemas/DeploymentLogRecord' title: Results next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor title: DeploymentLogSearchResponse required: - results DeploymentObservedState: type: object properties: phase: anyOf: - type: string - type: 'null' title: Phase available_replicas: type: integer title: Available Replicas default: 0 ready_replicas: type: integer title: Ready Replicas default: 0 endpoint: anyOf: - type: string - type: 'null' title: Endpoint message: anyOf: - type: string - type: 'null' title: Message last_seen: anyOf: - type: string format: date-time - type: 'null' title: Last Seen deployed_revision: anyOf: - type: string - type: 'null' title: Deployed Revision generation: anyOf: - type: integer - type: 'null' title: Generation build_state: anyOf: - $ref: '#/components/schemas/DeploymentBuildState' - type: 'null' title: DeploymentObservedState DeploymentResourceConfig: type: object properties: replicas: anyOf: - type: integer - type: 'null' title: Replicas cpu_request: anyOf: - type: string - type: 'null' title: Cpu Request cpu_limit: anyOf: - type: string - type: 'null' title: Cpu Limit memory_request: anyOf: - type: string - type: 'null' title: Memory Request memory_limit: anyOf: - type: string - type: 'null' title: Memory Limit title: DeploymentResourceConfig DeploymentResourceConfigUpdate: type: object properties: replicas: anyOf: - type: integer - type: 'null' title: Replicas cpu_request: anyOf: - type: string - type: 'null' title: Cpu Request cpu_limit: anyOf: - type: string - type: 'null' title: Cpu Limit memory_request: anyOf: - type: string - type: 'null' title: Memory Request memory_limit: anyOf: - type: string - type: 'null' title: Memory Limit title: DeploymentResourceConfigUpdate DeploymentResponse: type: object properties: id: type: string title: Id format: uuid description: Unique identifier of the deployment name: type: string title: Name description: Deployment name is_active: type: boolean title: Is Active description: Whether at least one worker is currently live is_hardened: type: boolean title: Is Hardened description: Whether the deployment has at least one authorized credential default: false created_at: type: string title: Created At format: date-time description: When the deployment was first registered updated_at: type: string title: Updated At format: date-time description: When the deployment was last updated location: anyOf: - $ref: '#/components/schemas/DeploymentLocation' - type: 'null' description: Where the deployment is running deprecated: true worker_count: type: integer title: Worker Count description: Number of workers registered to the deployment default: 0 active_worker_count: type: integer title: Active Worker Count description: Number of workers currently live within the liveness cutoff default: 0 locations: type: array items: $ref: '#/components/schemas/LocationType' title: Locations description: Distinct location types reported by the deployment's workers managed: anyOf: - $ref: '#/components/schemas/ManagedDeploymentResponse' - type: 'null' description: Live managed service state for managed deployments; null for self-hosted deployments or when managed services are unavailable title: DeploymentResponse required: - id - name - is_active - created_at - updated_at DeploymentWorkerListResponse: type: object properties: workers: type: array items: $ref: '#/components/schemas/DeploymentWorkerResponse' title: Workers description: Workers registered for the deployment next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: Cursor for the next page of results title: DeploymentWorkerListResponse required: - workers - next_cursor DeploymentWorkerResponse: type: object properties: name: type: string title: Name description: Worker name created_at: type: string title: Created At format: date-time description: When the worker first registered updated_at: type: string title: Updated At format: date-time description: When the worker last registered is_active: type: boolean title: Is Active description: Whether this worker's liveness key is currently alive location: anyOf: - $ref: '#/components/schemas/DeploymentLocation' - type: 'null' description: Where the worker is running; null if the worker did not report a location title: DeploymentWorkerResponse required: - name - created_at - updated_at - is_active DeploymentWorkerSpecInput: type: object properties: github_url: type: string title: Github Url revision: anyOf: - type: string - type: 'null' title: Revision default: main entrypoint: anyOf: - type: string - type: 'null' title: Entrypoint default: worker:main working_dir: anyOf: - type: string - type: 'null' title: Working Dir title: DeploymentWorkerSpecInput required: - github_url DeploymentWorkerSpecResponse: type: object properties: github_url: type: string title: Github Url type: type: string title: Type default: workflows_worker revision: anyOf: - type: string - type: 'null' title: Revision entrypoint: anyOf: - type: string - type: 'null' title: Entrypoint working_dir: anyOf: - type: string - type: 'null' title: Working Dir restarted_at: anyOf: - type: string - type: 'null' title: Restarted At commit_sha: anyOf: - type: string - type: 'null' title: Commit Sha deprecated: true commit: anyOf: - $ref: '#/components/schemas/GitCommitMetadata' - type: 'null' title: DeploymentWorkerSpecResponse required: - github_url EncodedPayloadOptions: type: string title: EncodedPayloadOptions enum: - offloaded - encrypted - encrypted-partial - compressed EncryptedPatchValue: type: object properties: type: type: string title: Type const: __encrypted__ value: type: string title: Value title: EncryptedPatchValue required: - type - value description: 'Wrapper for encrypted patch values in selective json_patch encryption. When partial encryption mode is enabled and a patch targets an EncryptedStrField, the patch value is encrypted and wrapped in this structure. The type field acts as a discriminator to distinguish this from user data.' EventProgressStatus: type: string title: EventProgressStatus enum: - RUNNING - COMPLETED - FAILED EventSource: type: string title: EventSource enum: - DATABASE - LIVE - HYBRID EventType: type: string title: EventType enum: - EVENT - EVENT_PROGRESS ExecutionLogRecord: type: object properties: timestamp: type: string title: Timestamp format: date-time trace_id: type: string title: Trace Id span_id: type: string title: Span Id severity_text: type: string title: Severity Text body: type: string title: Body log_attributes: type: object title: Log Attributes additionalProperties: type: string title: ExecutionLogRecord required: - timestamp - trace_id - span_id - severity_text - body - log_attributes ExecutionLogSearchResponse: type: object properties: results: type: array items: $ref: '#/components/schemas/ExecutionLogRecord' title: Results next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor title: ExecutionLogSearchResponse required: - results ExecutionTraceInfoResponse: type: object properties: otel_trace_id: anyOf: - type: string - type: 'null' title: Otel Trace Id description: The ID of the trace, if available has_trace_data: type: boolean title: Has Trace Data description: Whether trace data is available in the trace backend for this execution default: false title: ExecutionTraceInfoResponse Failure: type: object properties: message: type: string title: Message description: A human-readable description of the failure. title: Failure required: - message description: Represents an error or exception that occurred during execution. GitCommitAuthor: type: object properties: name: anyOf: - type: string - type: 'null' title: Name username: anyOf: - type: string - type: 'null' title: Username html_url: anyOf: - type: string - type: 'null' title: Html Url title: GitCommitAuthor GitCommitMetadata: type: object properties: sha: type: string title: Sha message: anyOf: - type: string - type: 'null' title: Message author: anyOf: - $ref: '#/components/schemas/GitCommitAuthor' - type: 'null' html_url: anyOf: - type: string - type: 'null' title: Html Url title: GitCommitMetadata required: - sha JSONPatchAdd: type: object properties: path: type: string title: Path description: A JSON Pointer (RFC 6901) identifying the target location within the document. Can be a string path (e.g., '/foo/bar'), '/', '', or an empty list [] for root-level operations. value: title: Value description: The value to use for the operation op: type: string title: Op description: 'Add operation ' const: add title: JSONPatchAdd required: - path - value - op JSONPatchAppend: type: object properties: path: type: string title: Path description: A JSON Pointer (RFC 6901) identifying the target location within the document. Can be a string path (e.g., '/foo/bar'), '/', '', or an empty list [] for root-level operations. value: anyOf: - type: string - $ref: '#/components/schemas/EncryptedPatchValue' title: Value description: The value to use for the operation. A string to append to the existing value, or an EncryptedPatchValue wrapper when encryption is applied. op: type: string title: Op description: '''append'' is an extension for efficient string concatenation in streaming scenarios.' const: append title: JSONPatchAppend required: - path - value - op JSONPatchPayloadResponse: type: object properties: type: type: string title: Type description: Discriminator indicating this is a JSON Patch payload. default: json_patch const: json_patch value: $ref: '#/components/schemas/JSONPatchPayloadValueResponse' description: The list of JSON Patch operations. When encrypted, contains base64-encoded data. encoding_options: anyOf: - type: array items: $ref: '#/components/schemas/EncodedPayloadOptions' - type: 'null' title: Encoding Options description: Encoding options applied to the payload. title: JSONPatchPayload required: - type - value description: 'A payload containing a list of JSON Patch operations. Used for streaming incremental updates to workflow state. When encrypted, the value field contains base64-encoded encrypted data and encoding_options indicates the type of encryption applied.' JSONPatchPayloadValueResponse: anyOf: - type: array items: $ref: '#/components/schemas/JSONPatch' - type: string JSONPatchRemove: type: object properties: path: type: string title: Path description: A JSON Pointer (RFC 6901) identifying the target location within the document. Can be a string path (e.g., '/foo/bar'), '/', '', or an empty list [] for root-level operations. value: title: Value description: The value to use for the operation op: type: string title: Op description: Remove operation const: remove title: JSONPatchRemove required: - path - value - op JSONPatchReplace: type: object properties: path: type: string title: Path description: A JSON Pointer (RFC 6901) identifying the target location within the document. Can be a string path (e.g., '/foo/bar'), '/', '', or an empty list [] for root-level operations. value: title: Value description: The value to use for the operation op: type: string title: Op description: Replace operation const: replace title: JSONPatchReplace required: - path - value - op JSONPayloadResponse: type: object properties: type: type: string title: Type description: Discriminator indicating this is a raw JSON payload. default: json const: json value: title: Value description: The JSON-serializable payload value. When encrypted, contains base64-encoded data. encoding_options: anyOf: - type: array items: $ref: '#/components/schemas/EncodedPayloadOptions' - type: 'null' title: Encoding Options description: Encoding options applied to the payload. title: JSONPayload required: - type - value description: 'A payload containing arbitrary JSON data. Used for complete state snapshots or final results. When encrypted, the value field contains base64-encoded encrypted data and encoding_options indicates the type of encryption applied.' ListWorkflowEventResponse: type: object properties: events: type: array items: oneOf: - $ref: '#/components/schemas/WorkflowExecutionStartedResponse' - $ref: '#/components/schemas/WorkflowExecutionCompletedResponse' - $ref: '#/components/schemas/WorkflowExecutionFailedResponse' - $ref: '#/components/schemas/WorkflowExecutionCanceledResponse' - $ref: '#/components/schemas/WorkflowExecutionContinuedAsNewResponse' - $ref: '#/components/schemas/WorkflowTaskTimedOutResponse' - $ref: '#/components/schemas/WorkflowTaskFailedResponse' - $ref: '#/components/schemas/CustomTaskStartedResponse' - $ref: '#/components/schemas/CustomTaskInProgressResponse' - $ref: '#/components/schemas/CustomTaskCompletedResponse' - $ref: '#/components/schemas/CustomTaskFailedResponse' - $ref: '#/components/schemas/CustomTaskTimedOutResponse' - $ref: '#/components/schemas/CustomTaskCanceledResponse' - $ref: '#/components/schemas/ActivityTaskStartedResponse' - $ref: '#/components/schemas/ActivityTaskCompletedResponse' - $ref: '#/components/schemas/ActivityTaskRetryingResponse' - $ref: '#/components/schemas/ActivityTaskFailedResponse' title: Events description: List of workflow events. next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: Cursor for pagination. title: ListWorkflowEventResponse required: - events LocationType: type: string title: LocationType enum: - local - k8s - managed ManagedDeploymentResponse: type: object properties: service_id: type: string title: Service Id name: type: string title: Name spec: $ref: '#/components/schemas/DeploymentWorkerSpecResponse' resources: $ref: '#/components/schemas/DeploymentResourceConfig' status: $ref: '#/components/schemas/DeploymentObservedState' created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time stopped: type: boolean title: Stopped default: false rollout_status: anyOf: - type: string - type: 'null' title: Rollout Status created_by: anyOf: - type: string - type: 'null' title: Created By updated_by: anyOf: - type: string - type: 'null' title: Updated By deployed_by: anyOf: - type: string - type: 'null' title: Deployed By deployed_at: anyOf: - type: string format: date-time - type: 'null' title: Deployed At is_hardened: type: boolean title: Is Hardened default: false title: ManagedDeploymentResponse required: - service_id - name - spec - resources - status - created_at - updated_at NetworkEncodedInput: type: object properties: b64payload: type: string title: B64Payload description: The encoded payload encoding_options: type: array items: $ref: '#/components/schemas/EncodedPayloadOptions' title: Encoding Options description: The encoding of the payload default: [] empty: type: boolean title: Empty description: Whether the payload is empty default: false title: NetworkEncodedInput required: - b64payload PartialScheduleDefinition: type: object properties: input: title: Input description: Input to provide to the workflow when starting it. calendars: type: array items: $ref: '#/components/schemas/ScheduleCalendar' title: Calendars description: Calendar-based specification of times. intervals: type: array items: $ref: '#/components/schemas/ScheduleInterval' title: Intervals description: Interval-based specification of times. cron_expressions: type: array items: type: string title: Cron Expressions description: Cron-based specification of times. skip: type: array items: $ref: '#/components/schemas/ScheduleCalendar' title: Skip description: Set of calendar times to skip. start_at: anyOf: - type: string format: date-time - type: 'null' title: Start At description: Time after which the first action may be run. end_at: anyOf: - type: string format: date-time - type: 'null' title: End At description: Time after which no more actions will be run. jitter: anyOf: - type: string format: duration - type: 'null' title: Jitter description: 'Jitter to apply each action. An action''s scheduled time will be incremented by a random value between 0 and this value if present (but not past the next schedule). ' time_zone_name: anyOf: - type: string - type: 'null' title: Time Zone Name description: IANA time zone name, for example ``US/Central``. policy: $ref: '#/components/schemas/SchedulePolicy' description: Policy for the schedule. max_executions: anyOf: - type: integer - type: 'null' title: Max Executions description: Maximum number of times this schedule will trigger a workflow execution. Once this limit is reached, no further executions are triggered automatically. null means unlimited. title: PartialScheduleDefinition description: 'Schedule definition for partial updates. All fields are optional (inherited from _ScheduleRequestBase). Only explicitly-set fields are applied during an update; unset fields preserve the existing schedule values.' QueryDefinition: type: object properties: name: type: string title: Name description: Name of the query description: anyOf: - type: string - type: 'null' title: Description description: Description of the query input_schema: type: object title: Input Schema additionalProperties: true description: Input JSON schema of the query's model output_schema: anyOf: - type: object additionalProperties: true - type: 'null' title: Output Schema additionalProperties: true description: Output JSON schema of the query's model title: QueryDefinition required: - name - input_schema QueryInvocationBody: type: object properties: name: type: string title: Name description: The name of the query to request input: anyOf: - $ref: '#/components/schemas/NetworkEncodedInput' - type: object additionalProperties: true - type: 'null' title: Input description: Input data for the query, matching its schema title: QueryInvocationBody required: - name QueryWorkflowResponse: type: object properties: query_name: type: string title: Query Name result: title: Result description: The result of the Query workflow call title: QueryWorkflowResponse required: - query_name - result ResetInvocationBody: type: object properties: event_id: type: integer title: Event Id description: The event ID to reset the workflow execution to reason: anyOf: - type: string - type: 'null' title: Reason description: Reason for resetting the workflow execution exclude_signals: type: boolean title: Exclude Signals description: Whether to exclude signals that happened after the reset point default: false exclude_updates: type: boolean title: Exclude Updates description: Whether to exclude updates that happened after the reset point default: false title: ResetInvocationBody required: - event_id ScalarMetric: type: object properties: value: anyOf: - type: integer - type: number title: Value title: ScalarMetric required: - value description: Scalar metric with a single value. ScheduleCalendar: type: object properties: second: type: array items: $ref: '#/components/schemas/ScheduleRange' title: Second default: - start: 0 end: 0 step: 0 minute: type: array items: $ref: '#/components/schemas/ScheduleRange' title: Minute default: - start: 0 end: 0 step: 0 hour: type: array items: $ref: '#/components/schemas/ScheduleRange' title: Hour default: - start: 0 end: 0 step: 0 day_of_month: type: array items: $ref: '#/components/schemas/ScheduleRange' title: Day Of Month default: - start: 1 end: 31 step: 0 month: type: array items: $ref: '#/components/schemas/ScheduleRange' title: Month default: - start: 1 end: 12 step: 0 year: type: array items: $ref: '#/components/schemas/ScheduleRange' title: Year default: [] day_of_week: type: array items: $ref: '#/components/schemas/ScheduleRange' title: Day Of Week default: - start: 0 end: 6 step: 0 comment: anyOf: - type: string - type: 'null' title: Comment title: ScheduleCalendar ScheduleDefinition: type: object properties: input: title: Input description: Input to provide to the workflow when starting it. calendars: type: array items: $ref: '#/components/schemas/ScheduleCalendar' title: Calendars description: Calendar-based specification of times. intervals: type: array items: $ref: '#/components/schemas/ScheduleInterval' title: Intervals description: Interval-based specification of times. cron_expressions: type: array items: type: string title: Cron Expressions description: Cron-based specification of times. skip: type: array items: $ref: '#/components/schemas/ScheduleCalendar' title: Skip description: Set of calendar times to skip. start_at: anyOf: - type: string format: date-time - type: 'null' title: Start At description: Time after which the first action may be run. end_at: anyOf: - type: string format: date-time - type: 'null' title: End At description: Time after which no more actions will be run. jitter: anyOf: - type: string format: duration - type: 'null' title: Jitter description: 'Jitter to apply each action. An action''s scheduled time will be incremented by a random value between 0 and this value if present (but not past the next schedule). ' time_zone_name: anyOf: - type: string - type: 'null' title: Time Zone Name description: IANA time zone name, for example ``US/Central``. policy: $ref: '#/components/schemas/SchedulePolicy' description: Policy for the schedule. max_executions: anyOf: - type: integer - type: 'null' title: Max Executions description: Maximum number of times this schedule will trigger a workflow execution. Once this limit is reached, no further executions are triggered automatically. null means unlimited. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Unique identifier for the schedule. title: ScheduleDefinition required: - input description: 'Specification of the times scheduled actions may occur. The times are the union of :py:attr:`calendars`, :py:attr:`intervals`, and :py:attr:`cron_expressions` excluding anything in :py:attr:`skip`. Used for input where schedule_id is optional (can be provided or auto-generated).' ScheduleDefinitionOutput: type: object properties: input: title: Input description: Input to provide to the workflow when starting it. calendars: type: array items: $ref: '#/components/schemas/ScheduleCalendar' title: Calendars description: Calendar-based specification of times. intervals: type: array items: $ref: '#/components/schemas/ScheduleInterval' title: Intervals description: Interval-based specification of times. cron_expressions: type: array items: type: string title: Cron Expressions description: Cron-based specification of times. skip: type: array items: $ref: '#/components/schemas/ScheduleCalendar' title: Skip description: Set of calendar times to skip. start_at: anyOf: - type: string format: date-time - type: 'null' title: Start At description: Time after which the first action may be run. end_at: anyOf: - type: string format: date-time - type: 'null' title: End At description: Time after which no more actions will be run. jitter: anyOf: - type: string format: duration - type: 'null' title: Jitter description: 'Jitter to apply each action. An action''s scheduled time will be incremented by a random value between 0 and this value if present (but not past the next schedule). ' time_zone_name: anyOf: - type: string - type: 'null' title: Time Zone Name description: IANA time zone name, for example ``US/Central``. policy: $ref: '#/components/schemas/SchedulePolicy' description: Policy for the schedule. schedule_id: type: string title: Schedule Id description: Unique identifier for the schedule. remaining_executions: anyOf: - type: integer - type: 'null' title: Remaining Executions description: Remaining workflow executions before this schedule stops triggering automatically. null means unlimited; 0 means the limit has been reached and the schedule is exhausted. workflow_name: type: string title: Workflow Name description: Name of the workflow this schedule triggers. deployment_name: anyOf: - type: string - type: 'null' title: Deployment Name description: Name of the deployment this schedule targets. paused: type: boolean title: Paused description: Whether the schedule is currently paused. note: anyOf: - type: string - type: 'null' title: Note description: Human-readable note associated with the current pause or resume state. future_executions: type: array items: $ref: '#/components/schemas/ScheduleFutureExecution' title: Future Executions description: Upcoming scheduled executions (10 next executions, earliest first). recent_executions: type: array items: $ref: '#/components/schemas/ScheduleRecentExecution' title: Recent Executions description: Most recent scheduled executions (10 most recent, newest last). title: ScheduleDefinitionOutput required: - input - schedule_id - workflow_name - paused description: 'Output representation of a schedule with required schedule_id. Used when returning schedules from the API where schedule_id is always present.' ScheduleFutureExecution: type: object properties: scheduled_at: type: string title: Scheduled At format: date-time description: Time the execution is scheduled to run. title: ScheduleFutureExecution required: - scheduled_at ScheduleInterval: type: object properties: every: type: string title: Every format: duration offset: anyOf: - type: string format: duration - type: 'null' title: Offset title: ScheduleInterval required: - every ScheduleOverlapPolicy: type: integer title: ScheduleOverlapPolicy enum: - 1 - 2 - 3 - 4 - 5 - 6 description: 'Controls what happens when a workflow would be started by a schedule but one is already running.' SchedulePolicy: type: object properties: catchup_window_seconds: type: integer title: Catchup Window Seconds description: After a Temporal server is unavailable, amount of time in seconds in the past to execute missed actions. default: 31536000 overlap: $ref: '#/components/schemas/ScheduleOverlapPolicy' description: Policy controlling what to do when a workflow is already running. default: 1 pause_on_failure: type: boolean title: Pause On Failure description: Whether to pause the schedule after a workflow failure. default: false title: SchedulePolicy ScheduleRange: type: object properties: start: type: integer title: Start end: type: integer title: End default: 0 step: type: integer title: Step default: 0 title: ScheduleRange required: - start ScheduleRecentExecution: type: object properties: scheduled_at: type: string title: Scheduled At format: date-time description: Time the execution was scheduled to run. started_at: type: string title: Started At format: date-time description: Actual time the execution started. execution_id: type: string title: Execution Id description: ID of the workflow execution that was started. title: ScheduleRecentExecution required: - scheduled_at - started_at - execution_id SignalDefinition: type: object properties: name: type: string title: Name description: Name of the signal description: anyOf: - type: string - type: 'null' title: Description description: Description of the signal input_schema: type: object title: Input Schema additionalProperties: true description: Input JSON schema of the signal's model title: SignalDefinition required: - name - input_schema SignalInvocationBody: type: object properties: name: type: string title: Name description: The name of the signal to send input: anyOf: - $ref: '#/components/schemas/NetworkEncodedInput' - type: object additionalProperties: true - type: 'null' title: Input additionalProperties: true description: Input data for the signal, matching its schema title: SignalInvocationBody required: - name SignalWorkflowResponse: type: object properties: message: type: string title: Message default: Signal accepted title: SignalWorkflowResponse StreamEventSseErrorData: type: object properties: error: type: string title: Error reason: type: string title: Reason title: StreamEventSseErrorData required: - error - reason StreamEventSsePayload: type: object properties: stream: type: string title: Stream timestamp: type: string title: Timestamp format: date-time data: oneOf: - $ref: '#/components/schemas/WorkflowExecutionStartedResponse' - $ref: '#/components/schemas/WorkflowExecutionCompletedResponse' - $ref: '#/components/schemas/WorkflowExecutionFailedResponse' - $ref: '#/components/schemas/WorkflowExecutionCanceledResponse' - $ref: '#/components/schemas/WorkflowExecutionContinuedAsNewResponse' - $ref: '#/components/schemas/WorkflowTaskTimedOutResponse' - $ref: '#/components/schemas/WorkflowTaskFailedResponse' - $ref: '#/components/schemas/CustomTaskStartedResponse' - $ref: '#/components/schemas/CustomTaskInProgressResponse' - $ref: '#/components/schemas/CustomTaskCompletedResponse' - $ref: '#/components/schemas/CustomTaskFailedResponse' - $ref: '#/components/schemas/CustomTaskTimedOutResponse' - $ref: '#/components/schemas/CustomTaskCanceledResponse' - $ref: '#/components/schemas/ActivityTaskStartedResponse' - $ref: '#/components/schemas/ActivityTaskCompletedResponse' - $ref: '#/components/schemas/ActivityTaskRetryingResponse' - $ref: '#/components/schemas/ActivityTaskFailedResponse' title: Data workflow_context: $ref: '#/components/schemas/StreamEventWorkflowContext' metadata: type: object title: Metadata additionalProperties: true broker_sequence: type: integer title: Broker Sequence title: StreamEventSsePayload required: - stream - data - workflow_context - broker_sequence StreamEventWorkflowContext: type: object properties: namespace: type: string title: Namespace workflow_name: type: string title: Workflow Name workflow_exec_id: type: string title: Workflow Exec Id parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id root_workflow_exec_id: anyOf: - type: string - type: 'null' title: Root Workflow Exec Id title: StreamEventWorkflowContext required: - namespace - workflow_name - workflow_exec_id TempoGetTraceResponse: type: object properties: batches: type: array items: $ref: '#/components/schemas/TempoTraceBatch' title: Batches description: The batches of the trace title: TempoGetTraceResponse description: 'Trace response in OpenTelemetry format. This is the unified trace format used across all trace providers (Tempo, ClickHouse, etc.). Regardless of the underlying backend, all trace data is normalized to this Tempo-compatible OpenTelemetry format to ensure consistency in the API response structure.' TempoTraceAttribute: type: object properties: key: type: string title: Key description: The key of the attribute value: anyOf: - $ref: '#/components/schemas/TempoTraceAttributeStringValue' - $ref: '#/components/schemas/TempoTraceAttributeIntValue' - $ref: '#/components/schemas/TempoTraceAttributeBoolValue' - $ref: '#/components/schemas/TempoTraceAttributeArrayValue' title: Value description: The value of the attribute title: TempoTraceAttribute required: - key - value TempoTraceAttributeArrayContainer: type: object properties: values: type: array items: $ref: '#/components/schemas/TempoTraceAttributeArrayElement' title: Values description: The values of the array title: TempoTraceAttributeArrayContainer TempoTraceAttributeArrayElement: type: object properties: stringValue: anyOf: - type: string - type: 'null' title: Stringvalue description: A string element in the array intValue: anyOf: - type: string - type: 'null' title: Intvalue description: An integer element in the array boolValue: anyOf: - type: boolean - type: 'null' title: Boolvalue description: A boolean element in the array title: TempoTraceAttributeArrayElement TempoTraceAttributeArrayValue: type: object properties: arrayValue: $ref: '#/components/schemas/TempoTraceAttributeArrayContainer' description: The array value of the attribute title: TempoTraceAttributeArrayValue required: - arrayValue TempoTraceAttributeBoolValue: type: object properties: boolValue: type: boolean title: Boolvalue description: The boolean value of the attribute title: TempoTraceAttributeBoolValue required: - boolValue TempoTraceAttributeIntValue: type: object properties: intValue: type: string title: Intvalue description: The integer value of the attribute title: TempoTraceAttributeIntValue required: - intValue TempoTraceAttributeStringValue: type: object properties: stringValue: type: string title: Stringvalue description: The string value of the attribute title: TempoTraceAttributeStringValue required: - stringValue TempoTraceBatch: type: object properties: resource: $ref: '#/components/schemas/TempoTraceResource' description: The resource of the batch scopeSpans: type: array items: $ref: '#/components/schemas/TempoTraceScopeSpan' title: Scopespans description: The spans of the scope title: TempoTraceBatch required: - resource TempoTraceEvent: type: object properties: name: type: string title: Name description: The name of the event timeUnixNano: type: string title: Timeunixnano description: The time of the event in Unix nano attributes: type: array items: $ref: '#/components/schemas/TempoTraceAttribute' title: Attributes description: The attributes of the event title: TempoTraceEvent required: - name - timeUnixNano TempoTraceResource: type: object properties: attributes: type: array items: $ref: '#/components/schemas/TempoTraceAttribute' title: Attributes description: The attributes of the resource title: TempoTraceResource TempoTraceScope: type: object properties: name: type: string title: Name description: The name of the span title: TempoTraceScope required: - name TempoTraceScopeKind: type: string title: TempoTraceScopeKind enum: - SPAN_KIND_INTERNAL - SPAN_KIND_SERVER - SPAN_KIND_CLIENT TempoTraceScopeSpan: type: object properties: scope: $ref: '#/components/schemas/TempoTraceScope' description: The scope of the span spans: type: array items: $ref: '#/components/schemas/TempoTraceSpan' title: Spans description: The spans of the scope title: TempoTraceScopeSpan required: - scope TempoTraceSpan: type: object properties: traceId: type: string title: Traceid description: The trace ID of the scope spanId: type: string title: Spanid description: The span ID of the scope parentSpanId: anyOf: - type: string - type: 'null' title: Parentspanid description: The parent span ID of the scope name: type: string title: Name description: The name of the scope kind: $ref: '#/components/schemas/TempoTraceScopeKind' description: The kind of the scope startTimeUnixNano: type: string title: Starttimeunixnano description: The start time of the scope in Unix nano endTimeUnixNano: type: string title: Endtimeunixnano description: The end time of the scope in Unix nano attributes: type: array items: $ref: '#/components/schemas/TempoTraceAttribute' title: Attributes description: The attributes of the scope events: type: array items: $ref: '#/components/schemas/TempoTraceEvent' title: Events description: The events of the scope title: TempoTraceSpan required: - traceId - spanId - name - kind - startTimeUnixNano - endTimeUnixNano TimeSeriesMetric: type: object properties: value: type: array items: type: array prefixItems: - type: integer - anyOf: - type: integer - type: number maxItems: 2 minItems: 2 title: Value title: TimeSeriesMetric required: - value description: Time-series metric with timestamp-value pairs. UpdateDefinition: type: object properties: name: type: string title: Name description: Name of the update description: anyOf: - type: string - type: 'null' title: Description description: Description of the update input_schema: type: object title: Input Schema additionalProperties: true description: Input JSON schema of the update's model output_schema: anyOf: - type: object additionalProperties: true - type: 'null' title: Output Schema additionalProperties: true description: Output JSON schema of the update's model title: UpdateDefinition required: - name - input_schema UpdateDeploymentRequest: type: object properties: spec: anyOf: - $ref: '#/components/schemas/WorkflowsWorkerSpecUpdate' - type: 'null' resources: anyOf: - $ref: '#/components/schemas/DeploymentResourceConfigUpdate' - type: 'null' title: UpdateDeploymentRequest UpdateInvocationBody: type: object properties: name: type: string title: Name description: The name of the update to request input: anyOf: - $ref: '#/components/schemas/NetworkEncodedInput' - type: object additionalProperties: true - type: 'null' title: Input description: Input data for the update, matching its schema title: UpdateInvocationBody required: - name UpdateWorkflowResponse: type: object properties: update_name: type: string title: Update Name result: title: Result description: The result of the Update workflow call title: UpdateWorkflowResponse required: - update_name - result Workflow: type: object properties: id: type: string title: Id format: uuid description: Unique identifier of the workflow name: type: string title: Name description: Name of the workflow display_name: type: string title: Display Name description: Display name of the workflow type: $ref: '#/components/schemas/WorkflowType' description: Type of the workflow description: anyOf: - type: string - type: 'null' title: Description description: Description of the workflow customer_id: type: string title: Customer Id format: uuid description: Customer ID of the workflow workspace_id: type: string title: Workspace Id format: uuid description: Workspace ID of the workflow shared_namespace: anyOf: - type: string - type: 'null' title: Shared Namespace description: Reserved namespace for shared workflows (e.g., 'shared:my-shared-workflow') available_in_chat_assistant: type: boolean title: Available In Chat Assistant description: Whether the workflow is available in chat assistant default: false is_technical: type: boolean title: Is Technical description: Whether the workflow is technical (e.g. SDK-managed) default: false archived: type: boolean title: Archived description: Whether the workflow is archived default: false tags: type: array items: type: string title: Tags description: Tags for filtering and discovery title: Workflow required: - id - name - display_name - type - customer_id - workspace_id WorkflowArchiveResponse: type: object properties: workflow: $ref: '#/components/schemas/Workflow' description: The workflow spec title: WorkflowArchiveResponse required: - workflow WorkflowBasicDefinition: type: object properties: id: type: string title: Id format: uuid name: type: string title: Name description: The name of the workflow display_name: type: string title: Display Name description: The display name of the workflow description: anyOf: - type: string - type: 'null' title: Description description: A description of the workflow metadata: $ref: '#/components/schemas/WorkflowMetadata' description: Workflow metadata archived: type: boolean title: Archived description: Whether the workflow is archived tags: type: array items: type: string title: Tags description: Workflow tags title: WorkflowBasicDefinition required: - id - name - display_name - archived WorkflowBulkArchiveRequest: type: object properties: workflow_ids: type: array items: type: string format: uuid title: Workflow Ids maxItems: 100 description: List of workflow IDs to archive title: WorkflowBulkArchiveRequest required: - workflow_ids WorkflowBulkArchiveResponse: type: object properties: archived: type: array items: $ref: '#/components/schemas/Workflow' title: Archived description: Workflows that were successfully archived or were already archived errored: type: array items: $ref: '#/components/schemas/WorkflowBulkError' title: Errored description: Workflows that could not be archived and the corresponding error messages title: WorkflowBulkArchiveResponse required: - archived WorkflowBulkError: type: object properties: workflow_id: type: string title: Workflow Id format: uuid description: The requested workflow ID workflow: anyOf: - $ref: '#/components/schemas/Workflow' - type: 'null' description: The workflow, if found message: type: string title: Message description: Error message describing why the operation failed title: WorkflowBulkError required: - workflow_id - message WorkflowBulkUnarchiveRequest: type: object properties: workflow_ids: type: array items: type: string format: uuid title: Workflow Ids maxItems: 100 description: List of workflow IDs to unarchive title: WorkflowBulkUnarchiveRequest required: - workflow_ids WorkflowBulkUnarchiveResponse: type: object properties: unarchived: type: array items: $ref: '#/components/schemas/Workflow' title: Unarchived description: Workflows that were successfully unarchived or were already unarchived errored: type: array items: $ref: '#/components/schemas/WorkflowBulkError' title: Errored description: Workflows that could not be unarchived and the corresponding error messages title: WorkflowBulkUnarchiveResponse required: - unarchived WorkflowCodeDefinition: type: object properties: input_schema: type: object title: Input Schema additionalProperties: true description: Input schema of the workflow's run method output_schema: anyOf: - type: object additionalProperties: true - type: 'null' title: Output Schema additionalProperties: true description: Output schema of the workflow's run method signals: type: array items: $ref: '#/components/schemas/SignalDefinition' title: Signals description: Signal handlers defined by the workflow queries: type: array items: $ref: '#/components/schemas/QueryDefinition' title: Queries description: Query handlers defined by the workflow updates: type: array items: $ref: '#/components/schemas/UpdateDefinition' title: Updates description: Update handlers defined by the workflow enforce_determinism: type: boolean title: Enforce Determinism description: Whether the workflow enforces deterministic execution default: false on_behalf_of: type: boolean title: On Behalf Of description: Whether the workflow must run associated to a user's identity default: false execution_timeout: type: number title: Execution Timeout description: Maximum total execution time including retries and continue-as-new plugin_metadata: anyOf: - type: object additionalProperties: true - type: 'null' title: Plugin Metadata description: Plugin-specific metadata (e.g. connector declarations) title: WorkflowCodeDefinition required: - input_schema WorkflowEventType: type: string title: WorkflowEventType enum: - WORKFLOW_EXECUTION_STARTED - WORKFLOW_EXECUTION_COMPLETED - WORKFLOW_EXECUTION_FAILED - WORKFLOW_EXECUTION_CANCELED - WORKFLOW_EXECUTION_CONTINUED_AS_NEW - WORKFLOW_TASK_TIMED_OUT - WORKFLOW_TASK_FAILED - CUSTOM_TASK_STARTED - CUSTOM_TASK_IN_PROGRESS - CUSTOM_TASK_COMPLETED - CUSTOM_TASK_FAILED - CUSTOM_TASK_TIMED_OUT - CUSTOM_TASK_CANCELED - ACTIVITY_TASK_STARTED - ACTIVITY_TASK_COMPLETED - ACTIVITY_TASK_RETRYING - ACTIVITY_TASK_FAILED WorkflowExecutionCanceledResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: WORKFLOW_EXECUTION_CANCELED const: WORKFLOW_EXECUTION_CANCELED attributes: $ref: '#/components/schemas/WorkflowExecutionCanceledAttributes' description: Event-specific attributes. title: WorkflowExecutionCanceled required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a workflow execution is canceled. This is a terminal event indicating the workflow was explicitly canceled.' WorkflowExecutionCanceledAttributes: type: object properties: task_id: type: string title: Task Id description: Unique identifier for the task within the workflow execution. reason: anyOf: - type: string - type: 'null' title: Reason description: Optional reason provided for the cancellation. attempt: type: integer title: Attempt description: Workflow retry attempt number. 1 on first run and CAN; >1 on workflow-level retries. default: 1 title: WorkflowExecutionCanceledAttributes required: - task_id description: Attributes for workflow execution canceled events. WorkflowExecutionCompletedResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: WORKFLOW_EXECUTION_COMPLETED const: WORKFLOW_EXECUTION_COMPLETED attributes: $ref: '#/components/schemas/WorkflowExecutionCompletedAttributesResponse' description: Event-specific attributes. title: WorkflowExecutionCompleted required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a workflow execution completes successfully. This is a terminal event indicating the workflow finished without errors.' WorkflowExecutionCompletedAttributesResponse: type: object properties: task_id: type: string title: Task Id description: Unique identifier for the task within the workflow execution. result: $ref: '#/components/schemas/JSONPayloadResponse' description: The final result returned by the workflow. attempt: type: integer title: Attempt description: Workflow retry attempt number. 1 on first run and CAN; >1 on workflow-level retries. default: 1 title: WorkflowExecutionCompletedAttributes required: - task_id - result description: Attributes for workflow execution completed events. WorkflowExecutionContinuedAsNewResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: WORKFLOW_EXECUTION_CONTINUED_AS_NEW const: WORKFLOW_EXECUTION_CONTINUED_AS_NEW attributes: $ref: '#/components/schemas/WorkflowExecutionContinuedAsNewAttributesResponse' description: Event-specific attributes. title: WorkflowExecutionContinuedAsNew required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a workflow continues as a new execution. This occurs when a workflow uses continue-as-new to reset its history while maintaining logical continuity.' WorkflowExecutionContinuedAsNewAttributesResponse: type: object properties: task_id: type: string title: Task Id description: Unique identifier for the task within the workflow execution. new_execution_run_id: type: string title: New Execution Run Id description: The run ID of the new workflow execution that continues this workflow. workflow_name: type: string title: Workflow Name description: The registered name of the continued workflow. input: $ref: '#/components/schemas/JSONPayloadResponse' description: The input arguments passed to the new workflow execution. title: WorkflowExecutionContinuedAsNewAttributes required: - task_id - new_execution_run_id - workflow_name - input description: Attributes for workflow execution continued-as-new events. WorkflowExecutionFailedResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: WORKFLOW_EXECUTION_FAILED const: WORKFLOW_EXECUTION_FAILED attributes: $ref: '#/components/schemas/WorkflowExecutionFailedAttributes' description: Event-specific attributes. title: WorkflowExecutionFailed required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a workflow execution fails due to an unhandled exception. This is a terminal event indicating the workflow ended with an error.' WorkflowExecutionFailedAttributes: type: object properties: task_id: type: string title: Task Id description: Unique identifier for the task within the workflow execution. failure: $ref: '#/components/schemas/Failure' description: Details about the failure that caused the workflow to fail. attempt: type: integer title: Attempt description: Workflow retry attempt number. 1 on first run and CAN; >1 on workflow-level retries. default: 1 title: WorkflowExecutionFailedAttributes required: - task_id - failure description: Attributes for workflow execution failed events. WorkflowExecutionListResponse: type: object properties: executions: type: array items: $ref: '#/components/schemas/WorkflowExecutionWithoutResultResponse' title: Executions description: A list of workflow executions next_page_token: anyOf: - type: string - type: 'null' title: Next Page Token description: Token to use for fetching the next page of results. Null if this is the last page. title: WorkflowExecutionListResponse required: - executions description: 'Deprecated: use WorkflowRunListResponse instead. Will be removed in the next major version.' WorkflowExecutionProgressTraceEvent: type: object properties: type: $ref: '#/components/schemas/EventType' default: EVENT_PROGRESS name: type: string title: Name description: Name of the event id: type: string title: Id description: The ID of the event timestamp_unix_nano: type: integer title: Timestamp Unix Nano description: The timestamp of the event in nanoseconds since the Unix epoch attributes: type: object title: Attributes additionalProperties: $ref: '#/components/schemas/WorkflowExecutionTraceSummaryAttributesValues' description: The attributes of the event internal: type: boolean title: Internal description: Whether the event is internal default: false status: $ref: '#/components/schemas/EventProgressStatus' description: The progress message default: RUNNING start_time_unix_ms: type: integer title: Start Time Unix Ms description: The start time of the event in milliseconds since the Unix epoch end_time_unix_ms: anyOf: - type: integer - type: 'null' title: End Time Unix Ms description: The end time of the event in milliseconds since the Unix epoch error: anyOf: - type: string - type: 'null' title: Error description: The error message, if any title: WorkflowExecutionProgressTraceEvent required: - name - id - timestamp_unix_nano - attributes - start_time_unix_ms WorkflowExecutionRequest: type: object properties: execution_id: anyOf: - type: string maxLength: 256 - type: 'null' title: Execution Id description: Allows you to specify a custom execution ID. If not provided, a random ID will be generated. input: anyOf: - type: object additionalProperties: true - type: object properties: {} - type: 'null' title: Input additionalProperties: true description: The input to the workflow. This should be a dictionary or a BaseModel that matches the workflow's input schema. wait_for_result: type: boolean title: Wait For Result description: If true, wait for the workflow to complete and return the result directly. default: false timeout_seconds: anyOf: - type: number - type: 'null' title: Timeout Seconds description: Maximum time to wait for completion when wait_for_result is true. custom_tracing_attributes: anyOf: - type: object additionalProperties: type: string - type: 'null' title: Custom Tracing Attributes force_new_trace: type: boolean title: Force New Trace description: If true, ignore the caller's trace context and start a new, independent trace for this execution instead of joining the caller's trace. default: false extensions: anyOf: - type: object additionalProperties: true - type: 'null' title: Extensions description: Plugin-specific data to propagate into WorkflowContext.extensions at execution time. task_queue: anyOf: - type: string - type: 'null' title: Task Queue description: Deprecated. Use deployment_name instead. deprecated: true deployment_name: anyOf: - type: string - type: 'null' title: Deployment Name description: Name of the deployment to route this execution to title: WorkflowExecutionRequest WorkflowExecutionResponse: type: object properties: workflow_name: type: string title: Workflow Name description: The name of the workflow workflow_id: anyOf: - type: string format: uuid - type: 'null' title: Workflow Id description: The ID of the workflow deployment_name: anyOf: - type: string - type: 'null' title: Deployment Name description: The name of the deployment that ran this execution execution_id: type: string title: Execution Id description: The ID of the workflow execution parent_execution_id: anyOf: - type: string - type: 'null' title: Parent Execution Id description: The parent execution ID of the workflow execution root_execution_id: type: string title: Root Execution Id description: The root execution ID of the workflow execution run_id: anyOf: - type: string - type: 'null' title: Run Id description: The unique run identifier (database UUID) user_id: anyOf: - type: string - type: 'null' title: User Id description: The ID of the user who triggered the execution status: anyOf: - $ref: '#/components/schemas/WorkflowExecutionStatus' - type: 'null' description: The status of the workflow execution start_time: type: string title: Start Time format: date-time description: The start time of the workflow execution end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time description: The end time of the workflow execution, if available total_duration_ms: anyOf: - type: integer - type: 'null' title: Total Duration Ms description: The total duration of the trace in milliseconds result: anyOf: - {} - type: 'null' title: Result description: The result of the workflow execution, if available title: WorkflowExecutionResponse required: - workflow_name - execution_id - root_execution_id - status - start_time - end_time - result WorkflowExecutionStartedResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: WORKFLOW_EXECUTION_STARTED const: WORKFLOW_EXECUTION_STARTED attributes: $ref: '#/components/schemas/WorkflowExecutionStartedAttributesResponse' description: Event-specific attributes. title: WorkflowExecutionStarted required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a workflow execution begins. This is the first event in any workflow execution lifecycle.' WorkflowExecutionStartedAttributesResponse: type: object properties: task_id: type: string title: Task Id description: Unique identifier for the task within the workflow execution. workflow_name: type: string title: Workflow Name description: The registered name of the workflow being executed. display_name: anyOf: - type: string - type: 'null' title: Display Name description: The user-friendly display name of the workflow, if available. input: $ref: '#/components/schemas/JSONPayloadResponse' description: The input arguments passed to the workflow. attempt: type: integer title: Attempt description: Workflow retry attempt number. 1 on first run and CAN; >1 on workflow-level retries. default: 1 title: WorkflowExecutionStartedAttributes required: - task_id - workflow_name - input description: Attributes for workflow execution started events. WorkflowExecutionStatus: type: string title: WorkflowExecutionStatus enum: - RUNNING - COMPLETED - FAILED - CANCELED - TERMINATED - CONTINUED_AS_NEW - TIMED_OUT - RETRYING_AFTER_ERROR WorkflowExecutionSyncResponse: type: object properties: workflow_name: type: string title: Workflow Name description: Name of the workflow that was executed execution_id: type: string title: Execution Id description: ID of the workflow execution result: title: Result description: The result of the workflow execution title: WorkflowExecutionSyncResponse required: - workflow_name - execution_id - result description: Response model for synchronous workflow execution WorkflowExecutionTraceEvent: type: object properties: type: $ref: '#/components/schemas/EventType' default: EVENT name: type: string title: Name description: Name of the event id: type: string title: Id description: The ID of the event timestamp_unix_nano: type: integer title: Timestamp Unix Nano description: The timestamp of the event in nanoseconds since the Unix epoch attributes: type: object title: Attributes additionalProperties: $ref: '#/components/schemas/WorkflowExecutionTraceSummaryAttributesValues' description: The attributes of the event internal: type: boolean title: Internal description: Whether the event is internal default: false title: WorkflowExecutionTraceEvent required: - name - id - timestamp_unix_nano - attributes WorkflowExecutionTraceEventsResponse: type: object properties: workflow_name: type: string title: Workflow Name description: The name of the workflow workflow_id: anyOf: - type: string format: uuid - type: 'null' title: Workflow Id description: The ID of the workflow deployment_name: anyOf: - type: string - type: 'null' title: Deployment Name description: The name of the deployment that ran this execution execution_id: type: string title: Execution Id description: The ID of the workflow execution parent_execution_id: anyOf: - type: string - type: 'null' title: Parent Execution Id description: The parent execution ID of the workflow execution root_execution_id: type: string title: Root Execution Id description: The root execution ID of the workflow execution run_id: anyOf: - type: string - type: 'null' title: Run Id description: The unique run identifier (database UUID) user_id: anyOf: - type: string - type: 'null' title: User Id description: The ID of the user who triggered the execution status: anyOf: - $ref: '#/components/schemas/WorkflowExecutionStatus' - type: 'null' description: The status of the workflow execution start_time: type: string title: Start Time format: date-time description: The start time of the workflow execution end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time description: The end time of the workflow execution, if available total_duration_ms: anyOf: - type: integer - type: 'null' title: Total Duration Ms description: The total duration of the trace in milliseconds result: anyOf: - {} - type: 'null' title: Result description: The result of the workflow execution, if available events: type: array items: anyOf: - $ref: '#/components/schemas/WorkflowExecutionTraceEvent' - $ref: '#/components/schemas/WorkflowExecutionProgressTraceEvent' title: Events description: The events of the workflow execution title: WorkflowExecutionTraceEventsResponse required: - workflow_name - execution_id - root_execution_id - status - start_time - end_time - result WorkflowExecutionTraceOTelResponse: type: object properties: workflow_name: type: string title: Workflow Name description: The name of the workflow workflow_id: anyOf: - type: string format: uuid - type: 'null' title: Workflow Id description: The ID of the workflow deployment_name: anyOf: - type: string - type: 'null' title: Deployment Name description: The name of the deployment that ran this execution execution_id: type: string title: Execution Id description: The ID of the workflow execution parent_execution_id: anyOf: - type: string - type: 'null' title: Parent Execution Id description: The parent execution ID of the workflow execution root_execution_id: type: string title: Root Execution Id description: The root execution ID of the workflow execution run_id: anyOf: - type: string - type: 'null' title: Run Id description: The unique run identifier (database UUID) user_id: anyOf: - type: string - type: 'null' title: User Id description: The ID of the user who triggered the execution status: anyOf: - $ref: '#/components/schemas/WorkflowExecutionStatus' - type: 'null' description: The status of the workflow execution start_time: type: string title: Start Time format: date-time description: The start time of the workflow execution end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time description: The end time of the workflow execution, if available total_duration_ms: anyOf: - type: integer - type: 'null' title: Total Duration Ms description: The total duration of the trace in milliseconds result: anyOf: - {} - type: 'null' title: Result description: The result of the workflow execution, if available data_source: type: string title: Data Source description: The data source of the trace otel_trace_id: anyOf: - type: string - type: 'null' title: Otel Trace Id description: The ID of the trace otel_trace_data: anyOf: - $ref: '#/components/schemas/TempoGetTraceResponse' - type: 'null' description: The raw OpenTelemetry trace data title: WorkflowExecutionTraceOTelResponse required: - workflow_name - execution_id - root_execution_id - status - start_time - end_time - result - data_source WorkflowExecutionTraceSummaryAttributesValues: anyOf: - type: string - type: integer - type: number - type: boolean - type: array items: {} - type: 'null' WorkflowExecutionTraceSummaryResponse: type: object properties: workflow_name: type: string title: Workflow Name description: The name of the workflow workflow_id: anyOf: - type: string format: uuid - type: 'null' title: Workflow Id description: The ID of the workflow deployment_name: anyOf: - type: string - type: 'null' title: Deployment Name description: The name of the deployment that ran this execution execution_id: type: string title: Execution Id description: The ID of the workflow execution parent_execution_id: anyOf: - type: string - type: 'null' title: Parent Execution Id description: The parent execution ID of the workflow execution root_execution_id: type: string title: Root Execution Id description: The root execution ID of the workflow execution run_id: anyOf: - type: string - type: 'null' title: Run Id description: The unique run identifier (database UUID) user_id: anyOf: - type: string - type: 'null' title: User Id description: The ID of the user who triggered the execution status: anyOf: - $ref: '#/components/schemas/WorkflowExecutionStatus' - type: 'null' description: The status of the workflow execution start_time: type: string title: Start Time format: date-time description: The start time of the workflow execution end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time description: The end time of the workflow execution, if available total_duration_ms: anyOf: - type: integer - type: 'null' title: Total Duration Ms description: The total duration of the trace in milliseconds result: anyOf: - {} - type: 'null' title: Result description: The result of the workflow execution, if available span_tree: anyOf: - $ref: '#/components/schemas/WorkflowExecutionTraceSummarySpan' - type: 'null' description: The root span of the trace title: WorkflowExecutionTraceSummaryResponse required: - workflow_name - execution_id - root_execution_id - status - start_time - end_time - result WorkflowExecutionTraceSummarySpan: type: object properties: span_id: type: string title: Span Id description: The ID of the span name: type: string title: Name description: The name of the span start_time_unix_nano: type: integer title: Start Time Unix Nano description: The start time of the span in nanoseconds since the Unix epoch end_time_unix_nano: anyOf: - type: integer - type: 'null' title: End Time Unix Nano description: The end time of the span in nanoseconds since the Unix epoch attributes: type: object title: Attributes additionalProperties: $ref: '#/components/schemas/WorkflowExecutionTraceSummaryAttributesValues' description: The attributes of the span events: type: array items: $ref: '#/components/schemas/WorkflowExecutionTraceEvent' title: Events description: The events of the span children: type: array items: $ref: '#/components/schemas/WorkflowExecutionTraceSummarySpan' title: Children description: The child spans of the span title: WorkflowExecutionTraceSummarySpan required: - span_id - name - start_time_unix_nano - end_time_unix_nano - attributes - events WorkflowExecutionWithoutResultResponse: type: object properties: workflow_name: type: string title: Workflow Name description: The name of the workflow workflow_id: anyOf: - type: string format: uuid - type: 'null' title: Workflow Id description: The ID of the workflow deployment_name: anyOf: - type: string - type: 'null' title: Deployment Name description: The name of the deployment that ran this execution execution_id: type: string title: Execution Id description: The ID of the workflow execution parent_execution_id: anyOf: - type: string - type: 'null' title: Parent Execution Id description: The parent execution ID of the workflow execution root_execution_id: type: string title: Root Execution Id description: The root execution ID of the workflow execution run_id: anyOf: - type: string - type: 'null' title: Run Id description: The unique run identifier (database UUID) user_id: anyOf: - type: string - type: 'null' title: User Id description: The ID of the user who triggered the execution status: anyOf: - $ref: '#/components/schemas/WorkflowExecutionStatus' - type: 'null' description: The status of the workflow execution start_time: type: string title: Start Time format: date-time description: The start time of the workflow execution end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time description: The end time of the workflow execution, if available total_duration_ms: anyOf: - type: integer - type: 'null' title: Total Duration Ms description: The total duration of the trace in milliseconds title: WorkflowExecutionWithoutResultResponse required: - workflow_name - execution_id - root_execution_id - status - start_time - end_time WorkflowGetResponse: type: object properties: workflow: $ref: '#/components/schemas/WorkflowWithWorkerStatus' description: The workflow spec title: WorkflowGetResponse required: - workflow WorkflowListResponse: type: object properties: workflows: type: array items: $ref: '#/components/schemas/WorkflowBasicDefinition' title: Workflows description: A list of workflows next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor title: WorkflowListResponse required: - workflows - next_cursor WorkflowMetadata: type: object properties: shared_namespace: anyOf: - type: string - type: 'null' title: Shared Namespace description: Namespace for shared workflows, None if user-owned title: WorkflowMetadata WorkflowMetrics: type: object properties: execution_count: $ref: '#/components/schemas/ScalarMetric' success_count: $ref: '#/components/schemas/ScalarMetric' error_count: $ref: '#/components/schemas/ScalarMetric' average_latency_ms: $ref: '#/components/schemas/ScalarMetric' latency_over_time: $ref: '#/components/schemas/TimeSeriesMetric' retry_rate: $ref: '#/components/schemas/ScalarMetric' title: WorkflowMetrics required: - execution_count - success_count - error_count - average_latency_ms - latency_over_time - retry_rate description: 'Complete metrics for a specific workflow. This type combines all metric categories.' WorkflowRegistration: type: object properties: id: type: string title: Id format: uuid description: Unique identifier of the workflow registration deployment_id: anyOf: - type: string format: uuid - type: 'null' title: Deployment Id description: Deprecated. Use deployment_name instead. Will be removed in a future release. deprecated: true task_queue: anyOf: - type: string - type: 'null' title: Task Queue description: Deprecated. Use deployment_name instead. Will be removed in a future release. deprecated: true definition: $ref: '#/components/schemas/WorkflowCodeDefinition' workflow_id: type: string title: Workflow Id format: uuid description: Workflow ID of the workflow workflow: anyOf: - $ref: '#/components/schemas/Workflow' - type: 'null' description: Workflow of the workflow registration deployment_name: anyOf: - type: string - type: 'null' title: Deployment Name description: Name of the deployment this registration belongs to compatible_with_chat_assistant: type: boolean title: Compatible With Chat Assistant description: Whether the workflow is compatible with chat assistant default: false title: WorkflowRegistration required: - id - definition - workflow_id WorkflowRegistrationGetResponse: type: object properties: workflow_registration: $ref: '#/components/schemas/WorkflowRegistrationWithWorkerStatus' description: The workflow registration workflow_version: $ref: '#/components/schemas/WorkflowRegistrationWithWorkerStatus' description: 'Deprecated: use workflow_registration' readOnly: true title: WorkflowRegistrationGetResponse required: - workflow_registration - workflow_version WorkflowRegistrationListResponse: type: object properties: workflow_registrations: type: array items: $ref: '#/components/schemas/WorkflowRegistration' title: Workflow Registrations description: A list of workflow registrations next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor workflow_versions: type: array items: $ref: '#/components/schemas/WorkflowRegistration' title: Workflow Versions description: 'Deprecated: use workflow_registrations' readOnly: true title: WorkflowRegistrationListResponse required: - workflow_registrations - next_cursor - workflow_versions WorkflowRegistrationWithWorkerStatus: type: object properties: id: type: string title: Id format: uuid description: Unique identifier of the workflow registration deployment_id: anyOf: - type: string format: uuid - type: 'null' title: Deployment Id description: Deprecated. Use deployment_name instead. Will be removed in a future release. deprecated: true task_queue: anyOf: - type: string - type: 'null' title: Task Queue description: Deprecated. Use deployment_name instead. Will be removed in a future release. deprecated: true definition: $ref: '#/components/schemas/WorkflowCodeDefinition' workflow_id: type: string title: Workflow Id format: uuid description: Workflow ID of the workflow workflow: anyOf: - $ref: '#/components/schemas/Workflow' - type: 'null' description: Workflow of the workflow registration deployment_name: anyOf: - type: string - type: 'null' title: Deployment Name description: Name of the deployment this registration belongs to compatible_with_chat_assistant: type: boolean title: Compatible With Chat Assistant description: Whether the workflow is compatible with chat assistant default: false active: type: boolean title: Active description: Whether the workflow registration is active title: WorkflowRegistrationWithWorkerStatus required: - id - definition - workflow_id - active WorkflowScheduleListResponse: type: object properties: schedules: type: array items: $ref: '#/components/schemas/ScheduleDefinitionOutput' title: Schedules description: A list of workflow schedules next_page_token: anyOf: - type: string - type: 'null' title: Next Page Token description: Token for the next page of results title: WorkflowScheduleListResponse required: - schedules WorkflowSchedulePauseRequest: type: object properties: note: anyOf: - type: string - type: 'null' title: Note description: Optional note recorded in Temporal when pausing or resuming a schedule title: WorkflowSchedulePauseRequest WorkflowScheduleRequest: type: object properties: schedule: $ref: '#/components/schemas/ScheduleDefinition' description: The schedule definition workflow_registration_id: anyOf: - type: string format: uuid - type: 'null' title: Workflow Registration Id description: The ID of the workflow registration to schedule workflow_version_id: anyOf: - type: string format: uuid - type: 'null' title: Workflow Version Id description: 'Deprecated: use workflow_registration_id' workflow_identifier: anyOf: - type: string - type: 'null' title: Workflow Identifier description: The name or ID of the workflow to schedule workflow_task_queue: anyOf: - type: string - type: 'null' title: Workflow Task Queue description: Deprecated. Use deployment_name instead. deprecated: true schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Allows you to specify a custom schedule ID. If not provided, a random ID will be generated. deployment_name: anyOf: - type: string - type: 'null' title: Deployment Name description: Name of the deployment to route this schedule to title: WorkflowScheduleRequest required: - schedule WorkflowScheduleResponse: type: object properties: schedule_id: type: string title: Schedule Id description: The ID of the schedule title: WorkflowScheduleResponse required: - schedule_id WorkflowScheduleTriggerRequest: type: object properties: overlap: anyOf: - $ref: '#/components/schemas/ScheduleOverlapPolicy' - type: 'null' description: Optional overlap policy override to use for the immediate trigger. title: WorkflowScheduleTriggerRequest WorkflowScheduleUpdateRequest: type: object properties: schedule: $ref: '#/components/schemas/PartialScheduleDefinition' description: Partial schedule definition to update. Unset fields preserve existing values. title: WorkflowScheduleUpdateRequest required: - schedule WorkflowTaskFailedResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: WORKFLOW_TASK_FAILED const: WORKFLOW_TASK_FAILED attributes: $ref: '#/components/schemas/WorkflowTaskFailedAttributes' description: Event-specific attributes. title: WorkflowTaskFailed required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a workflow task fails. This indicates an error occurred during workflow task execution, which may trigger a retry depending on configuration.' WorkflowTaskFailedAttributes: type: object properties: task_id: type: string title: Task Id description: Unique identifier for the task within the workflow execution. failure: $ref: '#/components/schemas/Failure' description: Details about the failure that caused the task to fail. title: WorkflowTaskFailedAttributes required: - task_id - failure description: Attributes for workflow task failed events. WorkflowTaskTimedOutResponse: type: object properties: event_id: type: string title: Event Id description: Unique identifier for this event instance. event_timestamp: type: integer title: Event Timestamp description: Unix timestamp in nanoseconds when the event was created. root_workflow_exec_id: type: string title: Root Workflow Exec Id description: Execution ID of the root workflow that initiated this execution chain. parent_workflow_exec_id: anyOf: - type: string - type: 'null' title: Parent Workflow Exec Id description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set. continued_run_id: anyOf: - type: string - type: 'null' title: Continued Run Id description: Run ID of the execution this run continued from. Non-null for continue-as-new runs. first_execution_run_id: anyOf: - type: string - type: 'null' title: First Execution Run Id description: Run ID of the first execution in this workflow chain. Equals workflow_run_id on fresh starts and resets (chain anchor resets on reset); differs on CAN and Retry runs where it stays anchored to the original first run. schedule_id: anyOf: - type: string - type: 'null' title: Schedule Id description: Temporal schedule ID that triggered this execution, if any. workflow_exec_id: type: string title: Workflow Exec Id description: Execution ID of the workflow that emitted this event. workflow_run_id: type: string title: Workflow Run Id description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same. workflow_name: type: string title: Workflow Name description: The registered name of the workflow that emitted this event. event_type: type: string title: Event Type description: Event type discriminator. default: WORKFLOW_TASK_TIMED_OUT const: WORKFLOW_TASK_TIMED_OUT attributes: $ref: '#/components/schemas/WorkflowTaskTimedOutAttributes' description: Event-specific attributes. title: WorkflowTaskTimedOut required: - event_id - event_timestamp - root_workflow_exec_id - parent_workflow_exec_id - continued_run_id - first_execution_run_id - schedule_id - workflow_exec_id - workflow_run_id - workflow_name - event_type - attributes description: 'Emitted when a workflow task times out. This indicates the workflow task (a unit of workflow execution) exceeded its configured timeout.' WorkflowTaskTimedOutAttributes: type: object properties: task_id: type: string title: Task Id description: Unique identifier for the task within the workflow execution. timeout_type: anyOf: - type: string - type: 'null' title: Timeout Type description: The type of timeout that occurred (e.g., 'START_TO_CLOSE', 'SCHEDULE_TO_START'). title: WorkflowTaskTimedOutAttributes required: - task_id description: Attributes for workflow task timed out events. WorkflowType: type: string title: WorkflowType enum: - code WorkflowUnarchiveResponse: type: object properties: workflow: $ref: '#/components/schemas/Workflow' description: The workflow spec title: WorkflowUnarchiveResponse required: - workflow WorkflowUpdateRequest: type: object properties: display_name: anyOf: - type: string maxLength: 128 - type: 'null' title: Display Name description: New display name value description: anyOf: - type: string - type: 'null' title: Description description: New description value available_in_chat_assistant: anyOf: - type: boolean - type: 'null' title: Available In Chat Assistant description: Whether to make the workflow available in the chat assistant tags: anyOf: - type: array items: type: string - type: 'null' title: Tags description: New tags. Replaces the existing tag list. title: WorkflowUpdateRequest WorkflowUpdateResponse: type: object properties: workflow: $ref: '#/components/schemas/Workflow' description: Updated workflow title: WorkflowUpdateResponse required: - workflow WorkflowWithWorkerStatus: type: object properties: id: type: string title: Id format: uuid description: Unique identifier of the workflow name: type: string title: Name description: Name of the workflow display_name: type: string title: Display Name description: Display name of the workflow type: $ref: '#/components/schemas/WorkflowType' description: Type of the workflow description: anyOf: - type: string - type: 'null' title: Description description: Description of the workflow customer_id: type: string title: Customer Id format: uuid description: Customer ID of the workflow workspace_id: type: string title: Workspace Id format: uuid description: Workspace ID of the workflow shared_namespace: anyOf: - type: string - type: 'null' title: Shared Namespace description: Reserved namespace for shared workflows (e.g., 'shared:my-shared-workflow') available_in_chat_assistant: type: boolean title: Available In Chat Assistant description: Whether the workflow is available in chat assistant default: false is_technical: type: boolean title: Is Technical description: Whether the workflow is technical (e.g. SDK-managed) default: false archived: type: boolean title: Archived description: Whether the workflow is archived default: false tags: type: array items: type: string title: Tags description: Tags for filtering and discovery active: type: boolean title: Active description: Whether the workflow is active title: WorkflowWithWorkerStatus required: - id - name - display_name - type - customer_id - workspace_id - active WorkflowsWorkerSpecUpdate: type: object properties: github_url: anyOf: - type: string - type: 'null' title: Github Url revision: anyOf: - type: string - type: 'null' title: Revision entrypoint: anyOf: - type: string - type: 'null' title: Entrypoint working_dir: anyOf: - type: string - type: 'null' title: Working Dir title: WorkflowsWorkerSpecUpdate StreamError: type: object properties: error: type: string title: Error reason: type: string title: Reason title: StreamError required: - error - reason CreateIngestionPipelineConfigurationRequest: type: object properties: name: type: string title: Name pipeline_composition: anyOf: - type: object additionalProperties: type: string - type: 'null' title: Pipeline Composition title: CreateIngestionPipelineConfigurationRequest required: - name GetDeploymentSummariesResponse: type: object properties: deployments: type: array items: $ref: '#/components/schemas/GetDeploymentSummariesResponseDeployment' title: Deployments title: GetDeploymentSummariesResponse required: - deployments GetDeploymentSummariesResponseDeployment: type: object properties: id: type: string title: Id format: uuid name: type: string title: Name creator_id: type: string title: Creator Id document_count: type: integer title: Document Count status: type: string title: Status enum: - online - offline created_at: type: string title: Created At format: date-time modified_at: type: string title: Modified At format: date-time deployment: oneOf: - $ref: '#/components/schemas/GetDeploymentSummariesResponseVespaDeployment' discriminator: propertyName: type mapping: vespa: '#/components/schemas/GetDeploymentSummariesResponseVespaDeployment' title: Deployment title: GetDeploymentSummariesResponseDeployment required: - id - name - creator_id - document_count - status - created_at - modified_at - deployment GetDeploymentSummariesResponseVespaDeployment: type: object properties: type: type: string title: Type default: vespa const: vespa indexes: type: array items: $ref: '#/components/schemas/GetDeploymentSummariesResponseVespaIndex' title: Indexes title: GetDeploymentSummariesResponseVespaDeployment required: - indexes GetDeploymentSummariesResponseVespaIndex: type: object properties: id: type: string title: Id format: uuid name: type: string title: Name document_count: anyOf: - type: integer - type: 'null' title: Document Count title: GetDeploymentSummariesResponseVespaIndex required: - id - name - document_count IngestionPipelineConfiguration: type: object properties: id: type: string title: Id format: uuid author_id: type: string title: Author Id name: type: string title: Name created_at: type: string title: Created At format: date-time modified_at: type: string title: Modified At format: date-time last_run_time: anyOf: - type: string format: date-time - type: 'null' title: Last Run Time last_run_chunks_count: type: integer title: Last Run Chunks Count total_chunks_count: type: integer title: Total Chunks Count pipeline_composition: anyOf: - type: object additionalProperties: type: string - type: 'null' title: Pipeline Composition title: IngestionPipelineConfiguration required: - id - author_id - name - created_at - modified_at - last_run_time - last_run_chunks_count - total_chunks_count - pipeline_composition RegisterDeploymentRequestDeployment: type: object properties: name: type: string title: Name status: type: string title: Status enum: - online - offline default: offline deployment: oneOf: - $ref: '#/components/schemas/RegisterDeploymentRequestVespaDeployment' discriminator: propertyName: type mapping: vespa: '#/components/schemas/RegisterDeploymentRequestVespaDeployment' title: Deployment title: RegisterDeploymentRequestDeployment required: - name - deployment RegisterDeploymentRequestVespaDeployment: type: object properties: type: type: string title: Type default: vespa const: vespa vespa_version: type: string title: Vespa Version indexes: type: array items: $ref: '#/components/schemas/RegisterDeploymentRequestVespaIndex' title: Indexes query_url: type: string title: Query Url title: RegisterDeploymentRequestVespaDeployment required: - vespa_version - indexes - query_url RegisterDeploymentRequestVespaField: type: object properties: name: type: string title: Name type: $ref: '#/components/schemas/SchemaFieldDataType' storage: $ref: '#/components/schemas/SchemaFieldStorage' ranking: $ref: '#/components/schemas/SchemaFieldRankingType' index_type: anyOf: - $ref: '#/components/schemas/SchemaFieldIndex' - type: 'null' multidimensional: type: boolean title: Multidimensional title: RegisterDeploymentRequestVespaField required: - name - type - storage - ranking - index_type - multidimensional RegisterDeploymentRequestVespaIndex: type: object properties: name: type: string title: Name fields: type: array items: $ref: '#/components/schemas/RegisterDeploymentRequestVespaField' title: Fields sd: type: string title: Sd title: RegisterDeploymentRequestVespaIndex required: - name - fields - sd RegisterSearchIndexResponseIndex: type: object properties: id: type: string title: Id format: uuid title: RegisterSearchIndexResponseIndex required: - id SchemaFieldDataType: type: string title: SchemaFieldDataType enum: - int - bool - string - embedding - long - float SchemaFieldIndex: type: string title: SchemaFieldIndex enum: - ann - bm25 - attribute SchemaFieldRankingType: type: string title: SchemaFieldRankingType enum: - count - embedding - timestamp - text - string - bool - int - language SchemaFieldStorage: type: string title: SchemaFieldStorage enum: - in_memory - on_disk UpdateMetricsRequestDeploymentMetricsOffline: type: object properties: status: type: string title: Status const: offline clear_metrics: type: boolean title: Clear Metrics default: false title: UpdateMetricsRequestDeploymentMetricsOffline required: - status UpdateMetricsRequestDeploymentMetricsOnline: type: object properties: status: type: string title: Status const: online document_count: type: integer title: Document Count index_metrics: type: array items: $ref: '#/components/schemas/UpdateMetricsRequestIndexMetrics' title: Index Metrics title: UpdateMetricsRequestDeploymentMetricsOnline required: - status - document_count - index_metrics UpdateMetricsRequestIndexMetrics: type: object properties: name: type: string title: Name document_count: type: integer title: Document Count title: UpdateMetricsRequestIndexMetrics required: - name - document_count UpdateRunInfo: type: object properties: execution_time: type: string title: Execution Time format: date-time chunks_count: type: integer title: Chunks Count maximum: 2147483647.0 minimum: 0 title: UpdateRunInfo required: - execution_time - chunks_count UserIdentity: type: object properties: id: type: string title: Id email: anyOf: - type: string - type: 'null' title: Email first_name: anyOf: - type: string - type: 'null' title: First Name last_name: anyOf: - type: string - type: 'null' title: Last Name workspace: anyOf: - $ref: '#/components/schemas/UserIdentityWorkspace' - type: 'null' organization: anyOf: - $ref: '#/components/schemas/UserIdentityOrganization' - type: 'null' api_key: anyOf: - $ref: '#/components/schemas/UserIdentityApiKey' - type: 'null' title: UserIdentity required: - id - email - first_name - last_name UserIdentityApiKey: type: object properties: id: type: string title: Id name: anyOf: - type: string - type: 'null' title: Name title: UserIdentityApiKey required: - id - name UserIdentityOrganization: type: object properties: id: type: string title: Id name: type: string title: Name title: UserIdentityOrganization required: - id - name UserIdentityWorkspace: type: object properties: id: type: string title: Id name: type: string title: Name title: UserIdentityWorkspace required: - id - name ListOrganizationsResponse: type: object properties: organizations: type: array items: $ref: '#/components/schemas/UserOrganization' title: Organizations description: The organizations the authenticated user is a member of. title: ListOrganizationsResponse required: - organizations UserOrganization: type: object properties: id: type: string examples: - 1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d title: Id description: The organization's unique identifier. name: type: string examples: - Acme Corp title: Name description: The organization's display name. title: UserOrganization required: - id - name ListWorkspacesResponse: type: object properties: workspaces: type: array items: $ref: '#/components/schemas/UserWorkspace' title: Workspaces description: The workspaces the authenticated user is a member of, each tagged with the organization it belongs to. title: ListWorkspacesResponse required: - workspaces UserWorkspace: type: object properties: id: type: string examples: - 7f8e9d0c-1b2a-4c3d-8e9f-0a1b2c3d4e5f title: Id description: The workspace's unique identifier. name: type: string examples: - production title: Name description: The workspace's display name. organization_id: type: string examples: - 1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d title: Organization Id description: The identifier of the organization this workspace belongs to. title: UserWorkspace required: - id - name - organization_id APIPlan: type: string title: APIPlan enum: - FREE - PAY_AS_YOU_GO AdminOrganizationMemberOUT: type: object properties: uuid: type: string title: Uuid format: uuid description: Organization member ID. oid_id: anyOf: - type: string format: uuid - type: 'null' title: Oid Id description: Identity provider ID for the member. name: anyOf: - type: string - type: 'null' examples: - Alice Martin title: Name description: Name of the Organization member. email: anyOf: - type: string - type: 'null' examples: - alice.martin@example.com title: Email description: Email address of the Organization member. is_sso_outsider: anyOf: - type: boolean - type: 'null' title: Is Sso Outsider description: Whether the member is outside the SSO domain. workspaces: anyOf: - type: array items: $ref: '#/components/schemas/MemberWorkspaceInfo' - type: 'null' title: Workspaces description: Workspaces the member belongs to. subscriptions: type: array items: $ref: '#/components/schemas/MemberSubscriptionOUT' title: Subscriptions description: Subscriptions assigned to the member. default: [] raw_roles: anyOf: - type: array items: $ref: '#/components/schemas/UserRole' minItems: 1 - type: array items: $ref: '#/components/schemas/StaticOrganizationRoles' minItems: 1 title: Raw Roles description: Organization roles assigned to the member. raw_role: anyOf: - $ref: '#/components/schemas/UserRole' - $ref: '#/components/schemas/StaticOrganizationRoles' title: Raw Role description: Deprecated single organization role. Use 'raw_roles' instead. deprecated: true subscription_types: anyOf: - type: array items: type: string enum: - CHAT - MISTRAL_CODE - type: 'null' title: Subscription Types description: Product seats assigned to the member. created_at: type: string title: Created At format: date-time description: Date the member was added to the Organization. title: AdminOrganizationMemberOUT required: - uuid - oid_id - name - email - raw_roles - raw_role - created_at ChatPlan: type: string title: ChatPlan enum: - INDIVIDUAL - EDU - TEAM CodePlan: type: string title: CodePlan enum: - ENTERPRISE MemberSubscriptionOUT: type: object properties: type: $ref: '#/components/schemas/PlanType' description: Type of subscription assigned to the member. plan: anyOf: - $ref: '#/components/schemas/APIPlan' - $ref: '#/components/schemas/ChatPlan' - $ref: '#/components/schemas/CodePlan' - type: 'null' title: Plan description: Plan assigned to the member. status: anyOf: - $ref: '#/components/schemas/SubscriptionStatus' - type: 'null' description: Current status of the member subscription. user: anyOf: - type: string - type: 'null' title: User description: User ID associated with the subscription. self_service: anyOf: - type: boolean - type: 'null' title: Self Service description: Whether the subscription was created through self-service. member_has_access: anyOf: - type: boolean - type: 'null' title: Member Has Access description: Whether the member currently has access to the plan. title: MemberSubscriptionOUT required: - type MemberWorkspaceInfo: type: object properties: uuid: type: string title: Uuid format: uuid description: Workspace ID. name: type: string examples: - Product Team title: Name maxLength: 255 description: Workspace name. is_default: type: boolean title: Is Default description: Whether this is the default Workspace for the Organization. raw_roles: anyOf: - type: array items: $ref: '#/components/schemas/WorkspaceRole' minItems: 1 - type: array items: $ref: '#/components/schemas/StaticWorkspaceRoles' minItems: 1 title: Raw Roles description: Workspace roles assigned to the member. raw_role: anyOf: - $ref: '#/components/schemas/WorkspaceRole' - $ref: '#/components/schemas/StaticWorkspaceRoles' title: Raw Role description: Deprecated single workspace role. Use 'raw_roles' instead. deprecated: true title: MemberWorkspaceInfo required: - uuid - name - is_default - raw_roles - raw_role OrganizationAdminUsersOUT: type: object properties: members: type: array items: $ref: '#/components/schemas/AdminOrganizationMemberOUT' title: Members description: Organization members on this page. invites: type: array items: $ref: '#/components/schemas/OrganizationInviteOUT' title: Invites description: Pending Organization invitations on this page. total: anyOf: - type: integer - type: 'null' title: Total description: Total number of users and invitations that match the request. page: anyOf: - type: integer - type: 'null' title: Page description: Page number returned. page_size: anyOf: - type: integer - type: 'null' title: Page Size description: Maximum number of results per page. title: OrganizationAdminUsersOUT required: - members - invites - total - page - page_size OrganizationInviteOUT: type: object properties: uuid: type: string title: Uuid format: uuid description: Organization invitation ID. raw_roles: anyOf: - type: array items: $ref: '#/components/schemas/UserRole' minItems: 1 - type: array items: $ref: '#/components/schemas/StaticOrganizationRoles' minItems: 1 title: Raw Roles description: Organization roles assigned by the invite. raw_role: anyOf: - $ref: '#/components/schemas/UserRole' - $ref: '#/components/schemas/StaticOrganizationRoles' title: Raw Role description: Deprecated single invite role. Use 'raw_roles' instead. deprecated: true email: type: string examples: - alice.martin@example.com title: Email description: Email address invited to the Organization. expired: type: boolean title: Expired description: Whether the invitation has expired. created_at: type: string title: Created At format: date-time description: Time when the invitation was created. workspace_uuids: type: array items: type: string format: uuid title: Workspace Uuids description: Workspace IDs the invited user will join. default: [] title: OrganizationInviteOUT required: - uuid - raw_roles - raw_role - email - expired - created_at PlanType: type: string title: PlanType enum: - API - CHAT - ON_PREMISE - LICENSE - MISTRAL_CODE StaticOrganizationRoles: type: string title: StaticOrganizationRoles enum: - 0d48f530-095c-43fe-8aea-6673bcacabe6 - c955f4e1-9477-43f0-8349-6fbc629fccc9 - 7bde5959-d676-47d2-b779-35b64323d278 StaticWorkspaceRoles: type: string title: StaticWorkspaceRoles enum: - d7ea77c5-9260-41d0-ab26-52b5add3ee56 - 48436751-ee56-44bd-8a2d-712233977821 - 375cd0db-3bbe-4b79-80f3-954ccf04f3d1 - 578584f1-4319-4c88-9948-38a5184483b6 - d79b3027-4eb2-4521-8722-825acfee7d8b - 252a0825-40b9-4b98-be80-7658956f13e9 - 17aa61c5-1c61-477e-a40a-e52c8ccd74b9 - b23cd6e0-91cd-4a8a-9869-b30366bf3966 - 731eb2be-a74f-4070-b797-35bf7009e553 - ff86d432-7f27-47f8-b02f-b5c102ef6a55 - 0f9acbf6-93b5-42c7-a227-fc7652755f65 - b23cd6e0-91cd-4a8a-9869-b30366bf3966 SubscriptionStatus: type: string title: SubscriptionStatus enum: - NS - S - A - CF - CG - C - GP UserRole: type: string title: UserRole enum: - A - M - B WorkspaceRole: type: string title: WorkspaceRole enum: - A - M OrganizationUsersCreateOUT: type: object properties: invalid_emails: type: array items: type: string title: Invalid Emails description: Email addresses that could not be created. email_to_user_id: type: object title: Email To User Id additionalProperties: type: string description: Mapping from created user email to user identifier. title: OrganizationUsersCreateOUT required: - invalid_emails - email_to_user_id OrganizationMemberCreate: type: object properties: role_names: anyOf: - type: array items: type: string enum: - member - billing_manager - organization_admin minItems: 1 - type: 'null' title: Role Names description: Simplified role names to assign. Mutually exclusive with 'roles'. roles: anyOf: - type: array items: $ref: '#/components/schemas/UserRole' minItems: 1 - type: array items: $ref: '#/components/schemas/StaticOrganizationRoles' minItems: 1 - type: 'null' title: Roles description: Role values to assign. Mutually exclusive with 'role_names'. role_name: anyOf: - type: string enum: - member - billing_manager - organization_admin - type: 'null' title: Role Name description: Deprecated single role name, kept for backward compatibility. Mutually exclusive with 'role'. deprecated: true role: anyOf: - $ref: '#/components/schemas/UserRole' - $ref: '#/components/schemas/StaticOrganizationRoles' - type: 'null' title: Role description: Deprecated legacy single role value, kept for backward compatibility. Mutually exclusive with 'role_name'. deprecated: true email: type: string examples: - alice.martin@example.com title: Email maxLength: 255 description: Email address of the user to create. first_name: type: string examples: - Alice title: First Name maxLength: 255 description: First name of the user to create. last_name: type: string examples: - Martin title: Last Name maxLength: 255 description: Last name of the user to create. subscription_types: anyOf: - type: array items: $ref: '#/components/schemas/PlanType' - type: 'null' title: Subscription Types description: Product seats to assign to the user. title: OrganizationMemberCreate required: - email - first_name - last_name OrganizationInvitesCreateOUT: type: object properties: invalid_emails: type: array items: type: string title: Invalid Emails description: Email addresses that could not be invited. already_members: type: array items: type: string title: Already Members description: Email addresses that already belong to the Organization. invited_members_count: anyOf: - type: integer - type: 'null' title: Invited Members Count description: Number of invitations successfully created. title: OrganizationInvitesCreateOUT required: - invalid_emails - already_members OrganizationInviteIN: type: object properties: role_names: anyOf: - type: array items: type: string enum: - member - billing_manager - organization_admin minItems: 1 - type: 'null' title: Role Names description: Simplified role names to assign. Mutually exclusive with 'roles'. roles: anyOf: - type: array items: $ref: '#/components/schemas/UserRole' minItems: 1 - type: array items: $ref: '#/components/schemas/StaticOrganizationRoles' minItems: 1 - type: 'null' title: Roles description: Role values to assign. Mutually exclusive with 'role_names'. role_name: anyOf: - type: string enum: - member - billing_manager - organization_admin - type: 'null' title: Role Name description: Deprecated single role name, kept for backward compatibility. Mutually exclusive with 'role'. deprecated: true role: anyOf: - $ref: '#/components/schemas/UserRole' - $ref: '#/components/schemas/StaticOrganizationRoles' - type: 'null' title: Role description: Deprecated legacy single role value, kept for backward compatibility. Mutually exclusive with 'role_name'. deprecated: true email: type: string examples: - alice.martin@example.com, bob.smith@example.com title: Email description: Email address, comma-separated emails, or newline-separated emails to invite. subscription_type: anyOf: - $ref: '#/components/schemas/PlanType' - type: 'null' description: Deprecated single product seat to assign. subscription_types: anyOf: - type: array items: $ref: '#/components/schemas/PlanType' - type: 'null' title: Subscription Types description: Product seats to assign to invited users. subscription_seat_automatic_granting: type: boolean title: Subscription Seat Automatic Granting description: Whether to grant subscription seats automatically. default: false email_language: anyOf: - type: string enum: - en - fr - es - de - it - pt_br - pl - ar - nl - type: 'null' title: Email Language description: Language used for invitation emails. workspace_uuids: anyOf: - type: array items: type: string format: uuid - type: 'null' title: Workspace Uuids description: Workspace IDs the invited users should join. title: OrganizationInviteIN required: - email OrganizationUserInviteOUT: type: object properties: invite_uuid: type: string title: Invite Uuid format: uuid description: Organization invitation ID. email: anyOf: - type: string - type: 'null' examples: - alice.martin@example.com title: Email description: Email address invited to the Organization. roles: anyOf: - type: array items: $ref: '#/components/schemas/UserRole' minItems: 1 - type: array items: $ref: '#/components/schemas/StaticOrganizationRoles' minItems: 1 title: Roles description: Organization roles assigned by the invite. role: anyOf: - $ref: '#/components/schemas/UserRole' - $ref: '#/components/schemas/StaticOrganizationRoles' title: Role description: Deprecated single invite role. Use 'roles' instead. deprecated: true title: OrganizationUserInviteOUT required: - invite_uuid - email - roles - role DeleteOUT: type: object properties: message: type: string examples: - Organization member deleted successfully title: Message description: Deletion result message. title: DeleteOUT required: - message AdminOrganizationMemberUpdate: type: object properties: role_names: anyOf: - type: array items: type: string enum: - member - billing_manager - organization_admin minItems: 1 - type: 'null' title: Role Names description: Simplified role names to assign. Mutually exclusive with 'roles'. roles: anyOf: - type: array items: $ref: '#/components/schemas/UserRole' minItems: 1 - type: array items: $ref: '#/components/schemas/StaticOrganizationRoles' minItems: 1 - type: 'null' title: Roles description: Role values to assign. Mutually exclusive with 'role_names'. role_name: anyOf: - type: string enum: - member - billing_manager - organization_admin - type: 'null' title: Role Name description: Deprecated single role name, kept for backward compatibility. Mutually exclusive with 'role'. deprecated: true role: anyOf: - $ref: '#/components/schemas/UserRole' - $ref: '#/components/schemas/StaticOrganizationRoles' - type: 'null' title: Role description: Deprecated legacy single role value, kept for backward compatibility. Mutually exclusive with 'role_name'. deprecated: true subscription_types: anyOf: - type: array items: type: string enum: - CHAT - MISTRAL_CODE - type: 'null' title: Subscription Types description: Product seats to assign to the member. title: AdminOrganizationMemberUpdate AdminUserOUT: type: object properties: uuid: type: string title: Uuid format: uuid description: Organization member ID. oid_id: anyOf: - type: string format: uuid - type: 'null' title: Oid Id description: Identity provider ID for the member. name: anyOf: - type: string - type: 'null' examples: - Alice Martin title: Name description: Name of the Organization member. email: anyOf: - type: string - type: 'null' examples: - alice.martin@example.com title: Email description: Email address of the Organization member. is_sso_outsider: anyOf: - type: boolean - type: 'null' title: Is Sso Outsider description: Whether the member is outside the SSO domain. workspaces: anyOf: - type: array items: $ref: '#/components/schemas/MemberWorkspaceInfo' - type: 'null' title: Workspaces description: Workspaces the member belongs to. subscriptions: type: array items: $ref: '#/components/schemas/MemberSubscriptionOUT' title: Subscriptions description: Subscriptions assigned to the member. default: [] raw_roles: anyOf: - type: array items: $ref: '#/components/schemas/UserRole' minItems: 1 - type: array items: $ref: '#/components/schemas/StaticOrganizationRoles' minItems: 1 title: Raw Roles description: Organization roles assigned to the member. raw_role: anyOf: - $ref: '#/components/schemas/UserRole' - $ref: '#/components/schemas/StaticOrganizationRoles' title: Raw Role description: Deprecated single organization role. Use 'raw_roles' instead. deprecated: true subscription_types: anyOf: - type: array items: type: string enum: - CHAT - MISTRAL_CODE - type: 'null' title: Subscription Types description: Product seats assigned to the member. created_at: type: string title: Created At format: date-time description: Date the member was added to the Organization. first_name: anyOf: - type: string - type: 'null' examples: - Alice title: First Name description: User first name. last_name: anyOf: - type: string - type: 'null' examples: - Martin title: Last Name description: User last name. title: AdminUserOUT required: - uuid - oid_id - name - email - raw_roles - raw_role - created_at - first_name - last_name RoleOut: type: object properties: name: type: string examples: - workspace_admin title: Name description: Role name. uuid: type: string title: Uuid format: uuid description: Role UUID. description: type: string examples: - Can manage workspace members and settings title: Description description: Short description of the role. is_custom_role: type: boolean title: Is Custom Role description: Whether this role is custom-defined. title: RoleOut required: - name - uuid - description - is_custom_role RolesOut: type: object properties: workspace_roles: type: array items: $ref: '#/components/schemas/RoleOut' title: Workspace Roles description: Workspace roles available to the Organization. organization_roles: type: array items: $ref: '#/components/schemas/RoleOut' title: Organization Roles description: Organization roles available to the Organization. title: RolesOut required: - workspace_roles - organization_roles ApiObjectType: type: string title: ApiObjectType enum: - list description: Type of API object for pagination responses. WorkspaceOUT: type: object properties: uuid: type: string title: Uuid format: uuid description: Workspace ID. name: type: string examples: - Product Team title: Name maxLength: 255 description: Workspace name. description: anyOf: - type: string - type: 'null' examples: - Workspace for product and design teams title: Description description: Workspace description. icon: anyOf: - type: string - type: 'null' examples: - ★ title: Icon description: Workspace icon. members_count: anyOf: - type: integer - type: 'null' title: Members Count description: Number of members in the Workspace. spend_limit: anyOf: - $ref: '#/components/schemas/WorkspaceSpendLimitOUT' - type: 'null' description: Workspace spending limit. is_default: type: boolean title: Is Default description: Whether this is the default Workspace for the Organization. title: WorkspaceOUT required: - uuid - name - description - icon - is_default WorkspaceSpendLimitOUT: type: object properties: value: anyOf: - type: number - type: 'null' title: Value description: Monthly spending limit for the Workspace. currency: anyOf: - type: string - type: 'null' examples: - USD title: Currency description: Currency used for the Workspace spending limit. no_monthly_limit: anyOf: - type: boolean - type: 'null' title: No Monthly Limit description: Whether the Workspace has no monthly spending limit. title: WorkspaceSpendLimitOUT required: - value - currency - no_monthly_limit WorkspacesOut: type: object properties: total: type: integer title: Total description: Total number of Workspaces that match the request. items: type: array items: $ref: '#/components/schemas/WorkspaceOUT' title: Items description: Workspaces on this page. object: allOf: - $ref: '#/components/schemas/ApiObjectType' description: Type of paginated API object. default: list page: type: integer title: Page description: Page number returned. page_size: type: integer title: Page Size description: Maximum number of results per page. title: WorkspacesOut required: - total - items - page - page_size WorkspaceEnrichedOUT: type: object properties: uuid: type: string title: Uuid format: uuid description: Workspace ID. name: type: string examples: - Product Team title: Name maxLength: 255 description: Workspace name. description: anyOf: - type: string - type: 'null' examples: - Workspace for product and design teams title: Description description: Workspace description. icon: anyOf: - type: string - type: 'null' examples: - ★ title: Icon description: Workspace icon. members_count: anyOf: - type: integer - type: 'null' title: Members Count description: Number of members in the Workspace. spend_limit: anyOf: - $ref: '#/components/schemas/WorkspaceSpendLimitOUT' - type: 'null' description: Workspace spending limit. is_default: type: boolean title: Is Default description: Whether this is the default Workspace for the Organization. raw_roles: type: array items: anyOf: - $ref: '#/components/schemas/WorkspaceRole' - $ref: '#/components/schemas/StaticWorkspaceRoles' - $ref: '#/components/schemas/StaticOrganizationRoles' title: Raw Roles minItems: 1 description: Roles granted for the Workspace. raw_role: anyOf: - $ref: '#/components/schemas/WorkspaceRole' - $ref: '#/components/schemas/StaticWorkspaceRoles' - $ref: '#/components/schemas/StaticOrganizationRoles' title: Raw Role description: Deprecated single role for the Workspace. Use 'raw_roles' instead. deprecated: true title: WorkspaceEnrichedOUT required: - uuid - name - description - icon - is_default - raw_roles - raw_role AdminWorkspaceIn: type: object properties: name: type: string examples: - Product Team title: Name maxLength: 255 description: Workspace name. description: type: string examples: - Workspace for product and design teams title: Description maxLength: 255 description: Workspace description. default: '' icon: type: string examples: - ★ title: Icon maxLength: 2 description: Workspace icon. default: '' add_all_org_members: type: boolean title: Add All Org Members description: Whether to add all Organization members to the Workspace. default: false admin_user_id: type: string title: Admin User Id format: uuid description: User ID to grant the Workspace Admin role to. title: AdminWorkspaceIn required: - name - admin_user_id UpdateWorkspaceIN: type: object properties: name: anyOf: - type: string maxLength: 255 - type: 'null' examples: - Product Team title: Name description: Updated Workspace name. description: anyOf: - type: string maxLength: 255 - type: 'null' examples: - Workspace for product and design teams title: Description description: Updated Workspace description. icon: anyOf: - type: string maxLength: 2 - type: 'null' examples: - ★ title: Icon description: Updated Workspace icon. title: UpdateWorkspaceIN AddUsersToWorkspaceOUT: type: object properties: added_members_count: type: integer title: Added Members Count description: Number of users added to the Workspace. title: AddUsersToWorkspaceOUT required: - added_members_count WorkspaceMemberIN: type: object properties: members: anyOf: - type: array items: $ref: '#/components/schemas/WorkspaceMemberSingleIN' - type: 'null' title: Members description: Workspace members to add or update. title: WorkspaceMemberIN WorkspaceMemberSingleIN: type: object properties: role_names: anyOf: - type: array items: type: string enum: - billing - user - contributor - dev - dev_contributor - mistral_code_user - cloud_user - workspace_contributor - workspace_admin - observability_viewer - workflow_executor minItems: 1 - type: 'null' title: Role Names description: Simplified role names to assign. Mutually exclusive with 'roles'. roles: anyOf: - type: array items: $ref: '#/components/schemas/WorkspaceRole' minItems: 1 - type: array items: $ref: '#/components/schemas/StaticWorkspaceRoles' minItems: 1 - type: 'null' title: Roles description: Role values to assign. Mutually exclusive with 'role_names'. role_name: anyOf: - type: string enum: - billing - user - contributor - dev - dev_contributor - mistral_code_user - cloud_user - workspace_contributor - workspace_admin - observability_viewer - workflow_executor - type: 'null' title: Role Name description: Deprecated single role name, kept for backward compatibility. Mutually exclusive with 'role'. deprecated: true role: anyOf: - $ref: '#/components/schemas/WorkspaceRole' - $ref: '#/components/schemas/StaticWorkspaceRoles' - type: 'null' title: Role description: Deprecated legacy single role value, kept for backward compatibility. Mutually exclusive with 'role_name'. deprecated: true user_uuid: type: string title: User Uuid format: uuid description: User ID of the Workspace member. title: WorkspaceMemberSingleIN required: - user_uuid AddOrUpdateUsersToWorkspaceOUT: type: object properties: added_members_count: type: integer title: Added Members Count description: Number of users added to the Workspace. updated_members_count: type: integer title: Updated Members Count description: Number of Workspace members updated. title: AddOrUpdateUsersToWorkspaceOUT required: - added_members_count - updated_members_count RemoveWorkspaceMembersOUT: type: object properties: deleted_members_count: type: integer title: Deleted Members Count description: Number of Workspace members removed. not_deleted_members: anyOf: - type: array items: type: string format: uuid - type: 'null' title: Not Deleted Members description: Users that could not be removed. title: RemoveWorkspaceMembersOUT required: - deleted_members_count BaseWorkspaceMemberIN: type: object properties: user_uuid: type: string title: User Uuid format: uuid description: User ID of the Workspace member. title: BaseWorkspaceMemberIN required: - user_uuid RemoveWorkspaceMembersIN: type: object properties: members: type: array items: $ref: '#/components/schemas/BaseWorkspaceMemberIN' title: Members description: Workspace members to remove. title: RemoveWorkspaceMembersIN required: - members RateLimitsOUT: type: object properties: requests_per_second: type: integer title: Requests Per Second description: Maximum API requests allowed per second. tokens_limits_by_model: type: object title: Tokens Limits By Model additionalProperties: $ref: '#/components/schemas/TokenLimitsByModel' description: Token limits for each model. title: RateLimitsOUT required: - requests_per_second - tokens_limits_by_model TokenLimitsByModel: type: object properties: tokens_per_minute: type: integer title: Tokens Per Minute description: Maximum tokens allowed per minute. tokens_per_month: type: integer title: Tokens Per Month description: Maximum tokens allowed per month. title: TokenLimitsByModel required: - tokens_per_minute - tokens_per_month LimitsContext: type: object properties: completion: $ref: '#/components/schemas/UsageLimits' description: Completion usage and rate limits. last_payment_failure: type: boolean title: Last Payment Failure description: Whether the latest payment attempt failed. last_payment_failure_protection: anyOf: - type: boolean - type: 'null' title: Last Payment Failure Protection description: Whether payment failure protection is enabled. currency: type: string examples: - USD title: Currency description: Currency used for usage and limit amounts. title: LimitsContext required: - completion - last_payment_failure - last_payment_failure_protection - currency LimitsOUT: type: object properties: limits: $ref: '#/components/schemas/LimitsContext' description: Usage, rate, and job limits for the Organization. title: LimitsOUT required: - limits UsageLimits: type: object properties: no_monthly_limit: type: boolean title: No Monthly Limit description: Whether no monthly usage limit is configured. default: false monthly_limit_reached: type: boolean title: Monthly Limit Reached description: Whether the monthly usage limit has been reached. usage: anyOf: - type: number - type: 'null' title: Usage description: Current usage counted against the limit. vibe_usage: anyOf: - type: number - type: 'null' title: Vibe Usage description: Current Vibe usage counted against the limit. total_usage: anyOf: - type: number - type: 'null' title: Total Usage description: Total current usage counted against the limit. usage_limit: anyOf: - type: number - type: 'null' title: Usage Limit description: Current usage limit. title: UsageLimits required: - monthly_limit_reached NewUsageLimitIN: type: object properties: amount: type: integer title: Amount description: New monthly usage limit amount. no_monthly_limit: type: boolean title: No Monthly Limit description: Whether to remove the monthly usage limit. default: false title: NewUsageLimitIN required: - amount ApiZone: type: string title: ApiZone enum: - global - us - eu BasicModelUsageDataJSON: type: object properties: models: type: object title: Models additionalProperties: type: object additionalProperties: type: array items: type: object additionalProperties: true description: Usage data grouped by model. title: BasicModelUsageDataJSON required: - models FineTuningDataJSON: type: object properties: training: type: object title: Training additionalProperties: type: object additionalProperties: type: array items: type: object additionalProperties: true description: Fine-tuning training usage. storage: type: object title: Storage additionalProperties: type: integer description: Fine-tuning storage usage. title: FineTuningDataJSON required: - training - storage LagoEventType: type: string title: LagoEventType enum: - api_tokens - api_pages - api_audio_seconds - api_audio_characters - api_connectors - api_libraries_tokens - api_libraries_pages - api_libraries_audio - deployment_tokens - gpu_hour - reserved_instance - vibe_tokens - vibe_connectors - vibe_pages - vibe_audio_seconds - vibe_audio_characters LibrariesAPIUsageDataJSON: type: object properties: pages: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Page usage for Libraries API. tokens: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Token usage for Libraries API. audio_seconds: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Audio usage for Libraries API. title: LibrariesAPIUsageDataJSON required: - pages - tokens - audio_seconds PriceData: type: object properties: event_type: anyOf: - $ref: '#/components/schemas/LagoEventType' - type: 'null' description: Billing event type for the price. billing_metric: type: string title: Billing Metric description: Billing metric this price applies to. billing_group: type: string title: Billing Group description: Billing metric group this price applies to. api_zone: $ref: '#/components/schemas/ApiZone' description: API zone this price applies to. service_tier: $ref: '#/components/schemas/ServiceTier' description: Service tier this price applies to. price: anyOf: - type: number - type: string title: Price description: Unit price for the billing metric. title: PriceData required: - event_type - billing_metric - billing_group - api_zone - service_tier - price ServiceTier: type: string title: ServiceTier enum: - standard - priority description: The service tier a request is resolved to and routed on. UsageOUTJSON: type: object properties: completion: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Completion usage data. ocr: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: OCR usage data. connectors: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Connector usage data. libraries_api: $ref: '#/components/schemas/LibrariesAPIUsageDataJSON' description: Libraries API usage data. fine_tuning: $ref: '#/components/schemas/FineTuningDataJSON' description: Fine-tuning usage data. audio: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Audio usage data. audio_characters: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Text-to-speech (audio characters) usage data. vibe_usage: type: number title: Vibe Usage description: Legacy Vibe usage field. Always 0; use the Vibe usage API instead. vibe_code: $ref: '#/components/schemas/VibeCodeUsageDataJSON' description: Vibe Code usage data, broken down by sub-usage type. chat: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Chat usage data. date: type: string title: Date format: date-time description: Reference date for the usage period. previous_month: anyOf: - type: string - type: 'null' title: Previous Month description: Previous month in the usage report. next_month: anyOf: - type: string - type: 'null' title: Next Month description: Next month in the usage report. start_date: type: string title: Start Date format: date-time description: Start of the usage period. end_date: type: string title: End Date format: date-time description: End of the usage period. currency: anyOf: - type: string - type: 'null' title: Currency description: Currency used for usage prices. currency_symbol: anyOf: - type: string - type: 'null' title: Currency Symbol description: Currency symbol used for usage prices. prices: anyOf: - type: array items: $ref: '#/components/schemas/PriceData' - type: 'null' title: Prices description: Prices used to calculate usage amounts. title: UsageOUTJSON required: - completion - ocr - connectors - libraries_api - fine_tuning - audio - audio_characters - vibe_usage - vibe_code - chat - date - previous_month - next_month - start_date - end_date - currency - currency_symbol - prices VibeCodeUsageDataJSON: type: object properties: completion: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Vibe Code completion (token) usage data. ocr: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Vibe Code OCR usage data. connectors: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Vibe Code connectors usage data. audio: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Vibe Code audio transcription usage data. audio_characters: $ref: '#/components/schemas/BasicModelUsageDataJSON' description: Vibe Code text-to-speech usage data. title: VibeCodeUsageDataJSON required: - completion - ocr - connectors - audio - audio_characters ActorType: type: string title: ActorType enum: - HUMAN - API_KEY - OTHER TargetType: type: string title: TargetType enum: - USER - USER_GROUP - ORGANIZATION - WORKSPACE - API_KEY - ADMIN_API_KEY - API_KEY_POLICY - SERVICE_ACCOUNT - AGENT - SKILL - PROMPT - KNOWLEDGE_BASE - CUSTOM_VOICE - DATASET - FINE_TUNING_JOB - BATCH_JOB - DATA_CAPTURE_EXTRACT_JOB - LE_CHAT_CONVERSATION - LE_CHAT_MEMORIES - LE_CHAT_FLASH_ANSWERS - LE_CHAT_LOCALISATION - LE_CHAT_DATA - INVOICE - WALLET - MONTHLY_LIMIT - WORKSPACE_MONTHLY_LIMIT - SHARED_BUDGET - AUTO_RECHARGE - PAYMENT_METHOD - SUBSCRIPTION - BILLING_INFO - LIBRARY - LIBRARY_DOCUMENT - INTEGRATION - CONNECTORS_GATEWAY - CONNECTORS_DEBUGGER - FEATURE_PERMISSION - SECRET_STORE_ENTRY - CRAWLER_CONFIG - SHARED_RESOURCE - RATE_LIMIT_RULE - APP - DEPLOYMENT - DOMAIN - PERSISTENT_VOLUME - SECRET - SERVICE - TRUSTED_ISSUER AuditLogOut: type: object properties: created_at: type: string title: Created At format: date-time description: Time when the audit log entry was created. actor_type: $ref: '#/components/schemas/ActorType' description: Type of actor that performed the action. actor_metadata: type: object title: Actor Metadata additionalProperties: type: string description: Details about who performed the action. event_type: $ref: '#/components/schemas/AuditLogEventType' description: Type of action recorded in the audit log. event_metadata: type: object title: Event Metadata additionalProperties: type: string description: Details about the recorded action. target_type: $ref: '#/components/schemas/TargetType' description: Type of resource affected by the action. target_metadata: type: object title: Target Metadata additionalProperties: type: string description: Details about the affected resource. log_id: type: integer title: Log Id description: Audit log entry ID. organization_uuid: anyOf: - type: string format: uuid - type: 'null' title: Organization Uuid description: Organization ID for the audit log entry. workspace_uuid: anyOf: - type: string format: uuid - type: 'null' title: Workspace Uuid description: Workspace ID for the audit log entry. title: AuditLogOut required: - created_at - actor_type - actor_metadata - event_type - event_metadata - target_type - target_metadata - log_id AdminUserGroupOut: type: object properties: uuid: type: string title: Uuid format: uuid description: User group ID. name: type: string examples: - Engineering Team title: Name maxLength: 255 description: Name of the user group. description: anyOf: - type: string maxLength: 255 - type: 'null' examples: - Members of the platform engineering team title: Description description: Optional description of the user group. externally_managed: anyOf: - type: boolean - type: 'null' title: Externally Managed description: Whether the group is managed by an external system. target_type: anyOf: - $ref: '#/components/schemas/UserGroupTargetType' - type: 'null' description: Type of resources this group can access. organization_role: anyOf: - type: string - type: 'null' title: Organization Role description: Organization role assigned to the group. parent_group_ids: type: array examples: - - a1b2c3d4-e5f6-7890-abcd-ef1234567890 items: type: string format: uuid title: Parent Group Ids description: UUIDs of the groups this group is directly nested inside. title: AdminUserGroupOut required: - uuid - name - description AdminUserGroupsOut: type: object properties: total: type: integer title: Total description: Total number of user groups that match the request. items: type: array items: $ref: '#/components/schemas/AdminUserGroupOut' title: Items description: User groups on this page. page: type: integer title: Page description: Page number returned. page_size: type: integer title: Page Size description: Maximum number of results per page. title: AdminUserGroupsOut required: - total - items - page - page_size UserGroupTargetType: type: string title: UserGroupTargetType enum: - W - O AdminUserGroupIn: type: object properties: name: type: string examples: - Engineering Team title: Name maxLength: 255 description: Name of the user group. description: anyOf: - type: string maxLength: 255 - type: 'null' examples: - Members of the platform engineering team title: Description description: Optional description of the user group. target_type: anyOf: - $ref: '#/components/schemas/UserGroupTargetType' - type: 'null' description: Type of resources this group can access. parent_group_ids: type: array examples: - - a1b2c3d4-e5f6-7890-abcd-ef1234567890 items: type: string format: uuid title: Parent Group Ids description: UUIDs of existing groups to nest this new group inside. Omit or pass an empty list to create a top-level group. title: AdminUserGroupIn required: - name AdminProvisionGroupToWorkspaceIn: type: object properties: user_group_uuid: type: string title: User Group Uuid format: uuid description: User group ID to provision. workspace_uuid: type: string title: Workspace Uuid format: uuid description: Workspace ID where the group is provisioned. workspace_role: anyOf: - $ref: '#/components/schemas/WorkspaceRole' - $ref: '#/components/schemas/StaticWorkspaceRoles' - type: 'null' title: Workspace Role description: Workspace role value to assign to the group. Mutually exclusive with 'workspace_role_name'. workspace_role_name: anyOf: - type: string enum: - billing - user - contributor - dev - dev_contributor - mistral_code_user - cloud_user - workspace_contributor - workspace_admin - observability_viewer - workflow_executor - type: 'null' title: Workspace Role Name description: Workspace role name to assign to the group. Mutually exclusive with 'workspace_role'. title: AdminProvisionGroupToWorkspaceIn required: - user_group_uuid - workspace_uuid AdminUpdateUserGroupIn: type: object properties: name: anyOf: - type: string maxLength: 255 - type: 'null' examples: - Engineering Team title: Name description: Updated name of the user group. description: anyOf: - type: string maxLength: 255 - type: 'null' examples: - Members of the platform engineering team title: Description description: Updated description of the user group. target_type: anyOf: - $ref: '#/components/schemas/UserGroupTargetType' - type: 'null' description: Updated permission target type for this group. parent_group_ids: anyOf: - type: array items: type: string format: uuid - type: 'null' examples: - - a1b2c3d4-e5f6-7890-abcd-ef1234567890 title: Parent Group Ids description: Full replacement list of parent group UUIDs. Pass an empty list to remove all parents; omit the field to leave the parent groups unchanged. title: AdminUpdateUserGroupIn AdminUserGroupMemberOut: type: object properties: user_uuid: type: string title: User Uuid format: uuid description: User ID of the group member. name: anyOf: - type: string - type: 'null' examples: - Alice Martin title: Name description: Name of the group member. email: anyOf: - type: string - type: 'null' examples: - alice.martin@example.com title: Email description: Email address of the group member. title: AdminUserGroupMemberOut required: - user_uuid - name - email AdminUserGroupMembersOut: type: object properties: total: type: integer title: Total description: Total number of group members that match the request. members: type: array items: $ref: '#/components/schemas/AdminUserGroupMemberOut' title: Members description: Group members on this page. page: type: integer title: Page description: Page number returned. page_size: type: integer title: Page Size description: Maximum number of results per page. title: AdminUserGroupMembersOut required: - total - members - page - page_size AdminAssignUsersToGroupIn: type: object properties: user_uuids: type: array items: type: string format: uuid title: User Uuids description: User IDs to add to the group. title: AdminAssignUsersToGroupIn required: - user_uuids GroupWorkspaceAssignmentOut: type: object properties: roles: type: array items: $ref: '#/components/schemas/WorkspaceRoleRef' title: Roles role_uuid: anyOf: - type: string format: uuid - type: 'null' title: Role Uuid role_name: anyOf: - type: string - type: 'null' title: Role Name workspace_uuid: type: string title: Workspace Uuid format: uuid workspace_name: type: string examples: - Product Team title: Workspace Name description: Name of the Workspace. created: type: string title: Created format: date-time title: GroupWorkspaceAssignmentOut required: - roles - workspace_uuid - workspace_name - created GroupWorkspaceAssignmentsOut: type: object properties: total: type: integer title: Total description: Total number of Workspace assignments that match the request. items: type: array items: $ref: '#/components/schemas/GroupWorkspaceAssignmentOut' title: Items description: Workspace assignments on this page. page: type: integer title: Page description: Page number returned. page_size: type: integer title: Page Size description: Maximum number of results per page. title: GroupWorkspaceAssignmentsOut required: - total - items - page - page_size WorkspaceRoleRef: type: object properties: name: type: string title: Name uuid: type: string title: Uuid format: uuid title: WorkspaceRoleRef required: - name - uuid AssignGroupToWorkspaceIn: type: object properties: role_names: anyOf: - type: array items: type: string enum: - billing - user - contributor - dev - dev_contributor - mistral_code_user - cloud_user - workspace_contributor - workspace_admin - observability_viewer - workflow_executor minItems: 1 - type: 'null' title: Role Names description: Simplified role names to assign. Mutually exclusive with 'roles'. roles: anyOf: - type: array items: anyOf: - $ref: '#/components/schemas/WorkspaceRole' - $ref: '#/components/schemas/StaticWorkspaceRoles' minItems: 1 - type: 'null' title: Roles description: Role values to assign. Mutually exclusive with 'role_names'. role: anyOf: - $ref: '#/components/schemas/WorkspaceRole' - $ref: '#/components/schemas/StaticWorkspaceRoles' - type: 'null' title: Role description: Deprecated single role value. Use 'role_names' instead. deprecated: true workspace_uuid: type: string title: Workspace Uuid format: uuid title: AssignGroupToWorkspaceIn required: - workspace_uuid UpdateGroupWorkspaceAssignmentIn: type: object properties: role_names: anyOf: - type: array items: type: string enum: - billing - user - contributor - dev - dev_contributor - mistral_code_user - cloud_user - workspace_contributor - workspace_admin - observability_viewer - workflow_executor minItems: 1 - type: 'null' title: Role Names description: Simplified role names to assign. Mutually exclusive with 'roles'. roles: anyOf: - type: array items: anyOf: - $ref: '#/components/schemas/WorkspaceRole' - $ref: '#/components/schemas/StaticWorkspaceRoles' minItems: 1 - type: 'null' title: Roles description: Role values to assign. Mutually exclusive with 'role_names'. role: anyOf: - $ref: '#/components/schemas/WorkspaceRole' - $ref: '#/components/schemas/StaticWorkspaceRoles' - type: 'null' title: Role description: Deprecated single role value. Use 'role_names' instead. deprecated: true title: UpdateGroupWorkspaceAssignmentIn UpdateUserGroupOrganizationRoleIn: type: object properties: organization_role: anyOf: - $ref: '#/components/schemas/UserRole' - $ref: '#/components/schemas/StaticOrganizationRoles' title: Organization Role description: Organization role to assign to the group. title: UpdateUserGroupOrganizationRoleIn required: - organization_role NestedGroupRef: type: object properties: uuid: type: string examples: - a1b2c3d4-e5f6-7890-abcd-ef1234567890 title: Uuid format: uuid description: UUID of the group. name: type: string examples: - Engineering Team title: Name description: Display name of the group. title: NestedGroupRef required: - uuid - name NestedGroupsOut: type: object properties: children: type: array examples: - - name: Engineering Team uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 items: $ref: '#/components/schemas/NestedGroupRef' title: Children description: Groups directly nested inside this group (its direct children). title: NestedGroupsOut required: - children SetNestedGroupsIn: type: object properties: child_group_uuids: type: array examples: - - a1b2c3d4-e5f6-7890-abcd-ef1234567890 items: type: string format: uuid title: Child Group Uuids description: Full replacement list of UUIDs of groups to nest directly inside this group. title: SetNestedGroupsIn required: - child_group_uuids APIKeyActions: type: object properties: rotate: anyOf: - oneOf: - $ref: '#/components/schemas/ActionAvailable' - $ref: '#/components/schemas/ActionUnavailable_RotateUnavailableReason_' discriminator: propertyName: status mapping: available: '#/components/schemas/ActionAvailable' unavailable: '#/components/schemas/ActionUnavailable_RotateUnavailableReason_' - type: 'null' title: Rotate delete: anyOf: - oneOf: - $ref: '#/components/schemas/ActionAvailable' - $ref: '#/components/schemas/ActionUnavailable_DeleteUnavailableReason_' discriminator: propertyName: status mapping: available: '#/components/schemas/ActionAvailable' unavailable: '#/components/schemas/ActionUnavailable_DeleteUnavailableReason_' - type: 'null' title: Delete title: APIKeyActions description: 'Per-action availability for an API key, keyed by action name. This is the generic, reusable shape for surfacing what a viewer may do with a resource on get/list endpoints: each action maps to a value that is either available or unavailable with an optional reason code. Add fields here as more actions are exposed. Every action is opt-in: fields default to ``None`` (the action is absent), and an absent action means "unavailable, with no specified reason". An action is only available when a producer explicitly sets it to ``ActionAvailable``. This keeps permissions opt-in rather than opt-out, so forgetting to populate an action can never accidentally expose it.' APIKeyExtendedOUT: type: object properties: key_id: type: string title: Key Id format: uuid description: API key ID. key: anyOf: - type: string - type: 'null' examples: - HQSxfB7IaJRKNHRv0e5OAYJNO1h2Ug6Y title: Key description: Plaintext API key value. Only returned at creation time. name: anyOf: - type: string - type: 'null' examples: - Production API Key title: Name description: Name of the API key. hidden_key: type: string examples: - HQSx...Ug6Y title: Hidden Key description: Masked API key value for display. created_at: anyOf: - type: string format: date-time - type: 'null' title: Created At description: Time when the API key was created. expiration_date: anyOf: - type: string format: date - type: 'null' title: Expiration Date description: Date when the API key expires. actions: $ref: '#/components/schemas/APIKeyActions' description: Per-action availability for this API key (e.g. whether it can be rotated or deleted). workspace_id: anyOf: - type: string format: uuid - type: 'null' title: Workspace Id description: Workspace ID for the API key. workspace_name: anyOf: - type: string - type: 'null' examples: - Product Team title: Workspace Name description: Name of the Workspace for the API key. created_by: anyOf: - type: string - type: 'null' examples: - alice.martin@example.com title: Created By description: User or API key that created this API key. product: anyOf: - $ref: '#/components/schemas/APIKeyProduct' - type: 'null' description: Product the API key belongs to. last_used: anyOf: - type: string format: date - type: 'null' title: Last Used description: Date when the API key was last used. can_delete: anyOf: - type: boolean - type: 'null' title: Can Delete description: Whether you can delete this API key. title: APIKeyExtendedOUT required: - key_id - key - name - hidden_key - created_at - expiration_date - actions - workspace_id - workspace_name - created_by - product - last_used - can_delete APIKeyProduct: type: string title: APIKeyProduct enum: - API - Mistral Code - Vibe APIKeysExtendedOUT: type: object properties: keys: type: array items: $ref: '#/components/schemas/APIKeyExtendedOUT' title: Keys description: API keys for the Organization. title: APIKeysExtendedOUT required: - keys ActionAvailable: type: object properties: status: type: string title: Status default: available const: available title: ActionAvailable description: The viewer may perform the action on the resource. ActionUnavailable_DeleteUnavailableReason_: type: object properties: status: type: string title: Status default: unavailable const: unavailable reason: anyOf: - $ref: '#/components/schemas/DeleteUnavailableReason' - type: 'null' title: ActionUnavailable[DeleteUnavailableReason] ActionUnavailable_RotateUnavailableReason_: type: object properties: status: type: string title: Status default: unavailable const: unavailable reason: anyOf: - $ref: '#/components/schemas/RotateUnavailableReason' - type: 'null' title: ActionUnavailable[RotateUnavailableReason] DeleteUnavailableReason: type: string title: DeleteUnavailableReason enum: - not_allowed description: 'Machine-readable reason why an API key cannot be deleted. Deletion eligibility currently turns on a single request-scoped permission: whether the acting user may delete (archive) the key. The reason is therefore determined where the acting user is known (e.g. the dashboard), not from the key''s scope or state. Consumers should treat unknown values as "delete unavailable".' RotateUnavailableReason: type: string title: RotateUnavailableReason enum: - unsupported_scope - key_expired - not_allowed description: 'Machine-readable reason why an API key cannot be rotated. This is the single field shared across services to describe rotation eligibility. An absent reason (None) means the key can be rotated; any value means it cannot, and identifies why so consumers (e.g. the dashboard rotate button) can show an appropriate message without hardcoding the rules. Consumers should treat unknown values as "rotation unavailable". Reasons fall into three kinds. Scope-based reasons are immutable (a function of the key''s scope alone) and are owned by services that hold the key, e.g. Albe. Key-state reasons depend on the key''s own state (e.g. expiry) and are likewise determined where the key lives. Permission-based reasons are request-scoped (they depend on who is asking) and can only be determined where the acting user is known, e.g. the dashboard. When several reasons apply, precedence runs immutable scope-based, then key-state, then request-scoped permission.' APIKeyOUT: type: object properties: key_id: type: string title: Key Id format: uuid description: API key ID. key: anyOf: - type: string - type: 'null' examples: - HQSxfB7IaJRKNHRv0e5OAYJNO1h2Ug6Y title: Key description: Plaintext API key value. Only returned at creation time. name: anyOf: - type: string - type: 'null' examples: - Production API Key title: Name description: Name of the API key. hidden_key: type: string examples: - HQSx...Ug6Y title: Hidden Key description: Masked API key value for display. created_at: anyOf: - type: string format: date-time - type: 'null' title: Created At description: Time when the API key was created. expiration_date: anyOf: - type: string format: date - type: 'null' title: Expiration Date description: Date when the API key expires. actions: $ref: '#/components/schemas/APIKeyActions' description: Per-action availability for this API key (e.g. whether it can be rotated or deleted). title: APIKeyOUT required: - key_id - key - name - hidden_key - created_at - expiration_date - actions AdminCreateAPIKeyIN: type: object properties: name: anyOf: - type: string maxLength: 255 - type: 'null' examples: - Production API Key title: Name description: Optional name for the API key. expiration: anyOf: - type: string format: date - type: 'null' title: Expiration description: Date when the API key should expire. workspace_uuid: type: string title: Workspace Uuid format: uuid description: Workspace ID for the API key. user_id: type: string title: User Id format: uuid description: ID of the user the API key is created for. title: AdminCreateAPIKeyIN required: - workspace_uuid - user_id DeleteAPIKeyOUT: type: object properties: detail: type: string examples: - API key deleted successfully title: Detail description: API key deletion result message. title: DeleteAPIKeyOUT required: - detail AdminScimSyncTriggerOUT: type: object properties: run_id: type: string examples: - 6f9619ff-8b86-d011-b42d-00cf4fc964ff title: Run Id format: uuid description: Unique identifier of the created SCIM synchronization run. title: AdminScimSyncTriggerOUT required: - run_id AdminScimSyncActiveRunOUT: type: object properties: run_id: type: string examples: - 6f9619ff-8b86-d011-b42d-00cf4fc964ff title: Run Id format: uuid description: Unique identifier of the already active SCIM synchronization run. status: $ref: '#/components/schemas/ScimSyncRunStatus' examples: - RUNNING description: Current lifecycle status of the active synchronization run. title: AdminScimSyncActiveRunOUT required: - run_id - status ScimSyncRunStatus: type: string title: ScimSyncRunStatus enum: - PENDING - RUNNING - SUCCESS - SKIPPED - FAILED AdminScimSyncConfig: type: object properties: delete_missing_groups: type: boolean examples: - false title: Delete Missing Groups description: Delete Organization groups that are absent from the SCIM provider. default: false deprovision_users: type: boolean examples: - false title: Deprovision Users description: Remove Organization users that are inactive or absent from the SCIM provider. default: false sync_users: type: boolean examples: - true title: Sync Users description: Add users found in the SCIM provider to the Organization. sync_groups: type: boolean examples: - true title: Sync Groups description: Synchronize group metadata from the SCIM provider. sync_memberships: type: boolean examples: - true title: Sync Memberships description: Synchronize additions and removals of users in SCIM groups. title: AdminScimSyncConfig required: - sync_users - sync_groups - sync_memberships AdminScimSyncTriggerIN: type: object properties: dry_run: type: boolean examples: - true title: Dry Run description: Preview all synchronization changes without applying them. default: true sync_config: anyOf: - $ref: '#/components/schemas/AdminScimSyncConfig' - type: 'null' examples: - delete_missing_groups: false deprovision_users: false sync_groups: true sync_memberships: true sync_users: true description: Categories to synchronize. Required when dry_run is false; ignored for dry runs. title: AdminScimSyncTriggerIN AdminScimSyncRunOUT: type: object properties: run_id: type: string examples: - 6f9619ff-8b86-d011-b42d-00cf4fc964ff title: Run Id format: uuid description: Unique identifier of the SCIM synchronization run. status: $ref: '#/components/schemas/ScimSyncRunStatus' examples: - SUCCESS description: Current lifecycle status of the synchronization run. dry_run: type: boolean examples: - true title: Dry Run description: Whether the run only previewed changes. sync_config: anyOf: - $ref: '#/components/schemas/AdminScimSyncConfig' - type: 'null' examples: - delete_missing_groups: true deprovision_users: true sync_groups: true sync_memberships: true sync_users: true description: Categories selected for this synchronization run. created_at: type: string examples: - '2026-07-28T10:00:00Z' title: Created At format: date-time description: Time at which the synchronization run was created. started_at: anyOf: - type: string format: date-time - type: 'null' examples: - '2026-07-28T10:00:01Z' title: Started At description: Time at which processing started, if it has started. finished_at: anyOf: - type: string format: date-time - type: 'null' examples: - '2026-07-28T10:00:05Z' title: Finished At description: Time at which processing finished, if it has finished. summary: anyOf: - $ref: '#/components/schemas/ScimSyncSummaryOut' - type: 'null' examples: - groups: {} memberships: [] users: deprovision: [] provision: [] description: Preview or result summary, available after the synchronization plan is built. error_message: anyOf: - type: string - type: 'null' examples: - Failed to fetch users from the SCIM provider. title: Error Message description: Failure detail when the synchronization run could not complete. title: AdminScimSyncRunOUT required: - run_id - status - dry_run - sync_config - created_at - started_at - finished_at - summary - error_message ScimSyncGroupActionOut: type: object properties: group: $ref: '#/components/schemas/ScimSyncGroupRefOut' title: ScimSyncGroupActionOut required: - group ScimSyncGroupRefOut: type: object properties: uuid: type: string title: Uuid groupName: type: string title: Groupname title: ScimSyncGroupRefOut required: - uuid - groupName ScimSyncGroupUpdateActionOut: type: object properties: group: $ref: '#/components/schemas/ScimSyncGroupRefOut' previous_groupName: type: string title: Previous Groupname title: ScimSyncGroupUpdateActionOut required: - group - previous_groupName ScimSyncGroupsSummaryOut: type: object properties: create: type: array items: $ref: '#/components/schemas/ScimSyncGroupActionOut' title: Create update: type: array items: $ref: '#/components/schemas/ScimSyncGroupUpdateActionOut' title: Update delete: type: array items: $ref: '#/components/schemas/ScimSyncGroupActionOut' title: Delete title: ScimSyncGroupsSummaryOut required: - create - update - delete ScimSyncMembershipActionOut: type: object properties: group: $ref: '#/components/schemas/ScimSyncGroupRefOut' users_added: type: array items: $ref: '#/components/schemas/ScimSyncUserRefOut' title: Users Added users_removed: type: array items: $ref: '#/components/schemas/ScimSyncUserRefOut' title: Users Removed title: ScimSyncMembershipActionOut required: - group - users_added - users_removed ScimSyncSummaryOut: type: object properties: users: $ref: '#/components/schemas/ScimSyncUsersSummaryOut' groups: $ref: '#/components/schemas/ScimSyncGroupsSummaryOut' memberships: type: array items: $ref: '#/components/schemas/ScimSyncMembershipActionOut' title: Memberships title: ScimSyncSummaryOut required: - users - groups - memberships ScimSyncUserActionOut: type: object properties: user: $ref: '#/components/schemas/ScimSyncUserRefOut' title: ScimSyncUserActionOut required: - user ScimSyncUserRefOut: type: object properties: uuid: type: string title: Uuid userName: type: string title: Username title: ScimSyncUserRefOut required: - uuid - userName ScimSyncUsersSummaryOut: type: object properties: provision: type: array items: $ref: '#/components/schemas/ScimSyncUserActionOut' title: Provision deprovision: type: array items: $ref: '#/components/schemas/ScimSyncUserActionOut' title: Deprovision title: ScimSyncUsersSummaryOut required: - provision - deprovision AuditLogEventType: type: string title: AuditLogEventType enum: - user.create - user.delete - user.log_in - user.info.update - user.password.update - user.phone_number.verify - user.organization.leave - user.organization.role.update - user.organization.delete - user.organization.join - organization.create - organization.update - organization.invite.send - organization.invite.resend - organization.invite.accepted - organization.invite.revoked - organization.join_by_email_domain - organization.domain_verification.disable - organization.domain_verification.enable - organization.email_domain_authentication.enable - organization.email_domain_authentication.disable - organization.saml_authentication.enable - organization.saml_authentication.disable - organization.saml_authentication.sso_user_provisioning.update - organization.scim_sync.trigger - organization.seat_auto_assign.enable - organization.seat_auto_assign.disable - organization.kind.update - organization.sso_seat_auto_assign.enable - organization.sso_seat_auto_assign.disable - workspace.create - workspace.update - workspace.delete - workspace.member.add - workspace.member.remove - workspace.member.role.update - user_group.create - user_group.update - user_group.delete - user_group.member.add - user_group.member.remove - user_group.workspace.provision - user_group.workspace.deprovision - user_group.workspace.update - billing.information.updated - billing.payment_method.added - billing.payment_method.removed - billing.payment_method.default_changed - billing.invoice.retried - billing.subscription.subscribe - billing.subscription.unsubscribe - billing.subscription.cancel_unsubscribe - billing.subscription.add_seats - billing.subscription.remove_seats - billing.subscription.termination_date.updated - billing.credits.added - billing.gift_code.used - billing.monthly_limit.updated - billing.workspace_monthly_limit.updated - billing.shared_budget_override.updated - billing.auto_recharge.updated - billing.seat.grant - billing.seat.revoke - billing.priority_service_tier.updated - billing.priority_service_tier.removed - le_chat.conversation.created - le_chat.conversation.deleted - le_chat.conversation_batch.deleted - le_chat.conversation.public_sharing.enabled - le_chat.conversation.public_sharing.disabled - le_chat.flash_answers.enabled - le_chat.flash_answers.disabled - le_chat.localisation_sharing.enabled - le_chat.localisation_sharing.disabled - le_chat.memories.enabled - le_chat.memories.disabled - le_chat.data.training_enabled - le_chat.data.training_disabled - le_chat.actions.external_link - admin_api_key.created - admin_api_key.delete - api_key.create - api_key.rotate - api_key.delete - api_key_policy.update - secret_store.entry.create - secret_store.entry.update - secret_store.entry.delete - service_account.create - service_account.update - service_account.delete - service_account.client_secret.create - service_account.client_secret.delete - service_account.roles.set - workload_identity.credential_registration.create - workload_identity.credential.create - trusted_issuer.create - trusted_issuer.update - trusted_issuer.delete - agent.create - agent.delete - agent.update - skill.create - skill.delete - skill.enable - skill.disable - skill.update - skill.share - skill.unshare - skill.load - skill.force_load - skill.version.create - prompt.create - prompt.delete - prompt.update - prompt.version.create - knowledge_base.create - knowledge_base.delete - knowledge_base.update - knowledge_base.version.create - custom_voice.create - custom_voice.update - custom_voice.delete - feature_permission.override.created - feature_permission.override.deleted - resource.share - resource.unshare - la_plateforme.training.enabled - la_plateforme.training.disabled - cloud_runtime.app.created - cloud_runtime.app.updated - cloud_runtime.app.deleted - cloud_runtime.app.paused - cloud_runtime.app.resumed - cloud_runtime.deployment.created - cloud_runtime.deployment.succeeded - cloud_runtime.deployment.canceled - cloud_runtime.deployment.stopped - cloud_runtime.deployment.failed - cloud_runtime.deployment.autoscaled - cloud_runtime.domain.created - cloud_runtime.domain.updated - cloud_runtime.domain.deleted - cloud_runtime.secret.created - cloud_runtime.secret.updated - cloud_runtime.secret.deleted - cloud_runtime.service.created - cloud_runtime.service.paused - cloud_runtime.service.resumed - cloud_runtime.service.deleted - cloud_runtime.service.manually_scaled - cloud_runtime.service.manual_scaling_deleted - cloud_runtime.persistent_volume.created - cloud_runtime.persistent_volume.deleted - cloud_runtime.persistent_volume.attached - cloud_runtime.persistent_volume.detached - fine_tuning_job.create - fine_tuning_job.cancel - batch_job.create - batch_job.cancel - batch_job.delete - data_capture.extract_job.create - data_capture.extract_job.cancel - dataset.create - dataset.delete - library.create - library.delete - library.update - library.share - library.unshare - library.document.create - library.document.delete - library.document.bulk_delete - library.document.update - library.document.reprocess - integration.connected - integration.disconnected - indexing.workflow.completed - indexing.deleted - connection.admin.setup_index - connection.admin.deleted - integration.activated_for_org - integration.deactivated_for_org - integration.activated_for_workspace - integration.deactivated_for_workspace - integration.activated_for_user - integration.deactivated_for_user - integration.created - integration.updated - integration.deleted - integration.tool_called - integration.credentials.created_or_updated - integration.credentials.deleted - integration.credentials.revoked - integration.credentials.revocation_failed - integration.preferences.created_or_updated - integration.preferences.deleted - integration.authentication_method.created_or_updated - integration.connection.created - integration.shared - integration.unshared - connectors_gateway.tool_called - connectors_debugger.tool_called - crawler.config.create - crawler.config.update - crawler.config.delete - crawler.run.create - crawler.run.cancel - rate_limit.rule.create - rate_limit.rule.update - rate_limit.rule.delete VibeActiveUsersStat: type: object properties: day: type: string examples: - '2025-12-17' title: Day format: date nb_active_users_total: type: integer examples: - 148 title: Nb Active Users Total nb_active_users_cli: type: integer examples: - 96 title: Nb Active Users Cli nb_active_users_acp: type: integer examples: - 40 title: Nb Active Users Acp nb_active_users_programmatic: type: integer examples: - 12 title: Nb Active Users Programmatic title: VibeActiveUsersStat required: - day - nb_active_users_total - nb_active_users_cli - nb_active_users_acp - nb_active_users_programmatic VibeConsumedTokensStat: type: object properties: day: type: string examples: - '2025-12-17' title: Day format: date model: type: string examples: - codestral-latest title: Model cached_tokens: type: integer examples: - 128000 title: Cached Tokens input_tokens: type: integer examples: - 512000 title: Input Tokens output_tokens: type: integer examples: - 98000 title: Output Tokens title: VibeConsumedTokensStat required: - day - model - cached_tokens - input_tokens - output_tokens VibeNextEditActiveUsersStat: type: object properties: day: type: string examples: - '2025-12-17' title: Day format: date nb_active_users: type: integer examples: - 87 title: Nb Active Users title: VibeNextEditActiveUsersStat required: - day - nb_active_users VibeNextEditModifiedLOCStat: type: object properties: day: type: string examples: - '2025-12-17' title: Day format: date lines_inserted: type: integer examples: - 4200 title: Lines Inserted lines_deleted: type: integer examples: - 1800 title: Lines Deleted lines_unchanged: type: integer examples: - 12000 title: Lines Unchanged lines_total: type: integer examples: - 18000 title: Lines Total title: VibeNextEditModifiedLOCStat required: - day - lines_inserted - lines_deleted - lines_unchanged - lines_total VibeNextEditSuggestionStat: type: object properties: day: type: string examples: - '2025-12-17' title: Day format: date total_suggestions: type: integer examples: - 5400 title: Total Suggestions outcome_accepted: type: integer examples: - 3100 title: Outcome Accepted outcome_rejected: type: integer examples: - 1500 title: Outcome Rejected outcome_timeout: type: integer examples: - 400 title: Outcome Timeout outcome_aborted: type: integer examples: - 250 title: Outcome Aborted outcome_dismissed: type: integer examples: - 150 title: Outcome Dismissed force_generated_true: type: integer examples: - 900 title: Force Generated True force_generated_false: type: integer examples: - 4500 title: Force Generated False surface_widget: type: integer examples: - 2000 title: Surface Widget surface_ghost_text: type: integer examples: - 3400 title: Surface Ghost Text title: VibeNextEditSuggestionStat required: - day - total_suggestions - outcome_accepted - outcome_rejected - outcome_timeout - outcome_aborted - outcome_dismissed - force_generated_true - force_generated_false - surface_widget - surface_ghost_text VibeOrganizationStatsOUT: type: object properties: start_time: type: integer examples: - 1764547200 title: Start Time description: Start of the queried window, as a Unix timestamp in seconds. end_time: type: integer examples: - 1767225600 title: End Time description: End of the queried window, as a Unix timestamp in seconds. next_edit_suggestions: type: array items: $ref: '#/components/schemas/VibeNextEditSuggestionStat' title: Next Edit Suggestions next_edit_active_users: type: array items: $ref: '#/components/schemas/VibeNextEditActiveUsersStat' title: Next Edit Active Users next_edit_modified_loc: type: array items: $ref: '#/components/schemas/VibeNextEditModifiedLOCStat' title: Next Edit Modified Loc title: VibeOrganizationStatsOUT required: - start_time - end_time - next_edit_suggestions - next_edit_active_users - next_edit_modified_loc VibeSessionDurationStat: type: object properties: day: type: string examples: - '2025-12-17' title: Day format: date total_duration_hours: type: number examples: - 214.5 title: Total Duration Hours title: VibeSessionDurationStat required: - day - total_duration_hours VibeSessionStat: type: object properties: day: type: string examples: - '2025-12-17' title: Day format: date nb_sessions: type: integer examples: - 342 title: Nb Sessions nb_sessions_cli: type: integer examples: - 210 title: Nb Sessions Cli nb_sessions_acp: type: integer examples: - 98 title: Nb Sessions Acp nb_sessions_programmatic: type: integer examples: - 34 title: Nb Sessions Programmatic title: VibeSessionStat required: - day - nb_sessions - nb_sessions_cli - nb_sessions_acp - nb_sessions_programmatic VibeToolCallsByNameStat: type: object properties: day: type: string examples: - '2025-12-17' title: Day format: date tool_name: type: string examples: - run_command title: Tool Name count: type: integer examples: - 342 title: Count title: VibeToolCallsByNameStat required: - day - tool_name - count VibeToolCallsStat: type: object properties: day: type: string examples: - '2025-12-17' title: Day format: date total: type: integer examples: - 890 title: Total status_success: type: integer examples: - 780 title: Status Success status_failure: type: integer examples: - 62 title: Status Failure status_skipped: type: integer examples: - 48 title: Status Skipped approval_ask: type: integer examples: - 120 title: Approval Ask approval_always: type: integer examples: - 700 title: Approval Always approval_never: type: integer examples: - 70 title: Approval Never title: VibeToolCallsStat required: - day - total - status_success - status_failure - status_skipped - approval_ask - approval_always - approval_never VibeUserPromptsStat: type: object properties: day: type: string examples: - '2025-12-17' title: Day format: date nb_prompts_total: type: integer examples: - 2450 title: Nb Prompts Total nb_prompts_cli: type: integer examples: - 1500 title: Nb Prompts Cli nb_prompts_acp: type: integer examples: - 720 title: Nb Prompts Acp nb_prompts_programmatic: type: integer examples: - 230 title: Nb Prompts Programmatic title: VibeUserPromptsStat required: - day - nb_prompts_total - nb_prompts_cli - nb_prompts_acp - nb_prompts_programmatic VibeWorkByAgentStat: type: object properties: messages_count: type: integer examples: - 1543 title: Messages Count files_count: type: integer examples: - 87 title: Files Count images_count: type: integer examples: - 42 title: Images Count spreadsheets_count: type: integer examples: - 15 title: Spreadsheets Count unique_conversations_count: type: integer examples: - 312 title: Unique Conversations Count agent_id: type: string examples: - 5d1f2a3b-4c5d-6e7f-8a9b-0c1d2e3f4a5b title: Agent Id last_message_at: type: string examples: - '2025-12-17T10:25:07Z' title: Last Message At format: date-time unique_users_count: type: integer examples: - 64 title: Unique Users Count title: VibeWorkByAgentStat required: - messages_count - files_count - images_count - spreadsheets_count - unique_conversations_count - agent_id - last_message_at - unique_users_count VibeWorkByAgentStatsOUT: type: object properties: start_time: type: integer examples: - 1764547200 title: Start Time description: Start of the queried window, as a Unix timestamp in seconds. end_time: type: integer examples: - 1767225600 title: End Time description: End of the queried window, as a Unix timestamp in seconds. data: type: array items: $ref: '#/components/schemas/VibeWorkByAgentStat' title: Data title: VibeWorkByAgentStatsOUT required: - start_time - end_time - data VibeWorkByTimeStat: type: object properties: messages_count: type: integer examples: - 1543 title: Messages Count files_count: type: integer examples: - 87 title: Files Count images_count: type: integer examples: - 42 title: Images Count spreadsheets_count: type: integer examples: - 15 title: Spreadsheets Count unique_conversations_count: type: integer examples: - 312 title: Unique Conversations Count time_bucket: anyOf: - type: string format: date-time - type: 'null' examples: - '2025-12-17T00:00:00Z' title: Time Bucket unique_users_count: type: integer examples: - 128 title: Unique Users Count messages_to_agents_count: type: integer examples: - 640 title: Messages To Agents Count unique_agents_count: type: integer examples: - 12 title: Unique Agents Count title: VibeWorkByTimeStat required: - messages_count - files_count - images_count - spreadsheets_count - unique_conversations_count - time_bucket - unique_users_count - messages_to_agents_count - unique_agents_count VibeWorkByTimeStatsOUT: type: object properties: start_time: type: integer examples: - 1764547200 title: Start Time description: Start of the queried window, as a Unix timestamp in seconds. end_time: type: integer examples: - 1767225600 title: End Time description: End of the queried window, as a Unix timestamp in seconds. data: type: array items: $ref: '#/components/schemas/VibeWorkByTimeStat' title: Data title: VibeWorkByTimeStatsOUT required: - start_time - end_time - data VibeWorkByUserStat: type: object properties: messages_count: type: integer examples: - 1543 title: Messages Count files_count: type: integer examples: - 87 title: Files Count images_count: type: integer examples: - 42 title: Images Count spreadsheets_count: type: integer examples: - 15 title: Spreadsheets Count unique_conversations_count: type: integer examples: - 312 title: Unique Conversations Count user_id: type: string examples: - 9c0ab39f-0cd0-46cd-bd30-8bf2d50be5ce title: User Id last_message_at: type: string examples: - '2025-12-17T10:25:07Z' title: Last Message At format: date-time unique_agents_count: type: integer examples: - 8 title: Unique Agents Count messages_to_agents_count: type: integer examples: - 214 title: Messages To Agents Count title: VibeWorkByUserStat required: - messages_count - files_count - images_count - spreadsheets_count - unique_conversations_count - user_id - last_message_at - unique_agents_count - messages_to_agents_count VibeWorkByUserStatsOUT: type: object properties: start_time: type: integer examples: - 1764547200 title: Start Time description: Start of the queried window, as a Unix timestamp in seconds. end_time: type: integer examples: - 1767225600 title: End Time description: End of the queried window, as a Unix timestamp in seconds. data: type: array items: $ref: '#/components/schemas/VibeWorkByUserStat' title: Data title: VibeWorkByUserStatsOUT required: - start_time - end_time - data VibeWorkspaceStatsOUT: type: object properties: start_time: type: integer examples: - 1764547200 title: Start Time description: Start of the queried window, as a Unix timestamp in seconds. end_time: type: integer examples: - 1767225600 title: End Time description: End of the queried window, as a Unix timestamp in seconds. sessions: type: array items: $ref: '#/components/schemas/VibeSessionStat' title: Sessions user_prompts: type: array items: $ref: '#/components/schemas/VibeUserPromptsStat' title: User Prompts active_users: type: array items: $ref: '#/components/schemas/VibeActiveUsersStat' title: Active Users consumed_tokens: type: array items: $ref: '#/components/schemas/VibeConsumedTokensStat' title: Consumed Tokens tool_calls: type: array items: $ref: '#/components/schemas/VibeToolCallsStat' title: Tool Calls tool_calls_by_name: type: array items: $ref: '#/components/schemas/VibeToolCallsByNameStat' title: Tool Calls By Name session_durations: type: array items: $ref: '#/components/schemas/VibeSessionDurationStat' title: Session Durations title: VibeWorkspaceStatsOUT required: - start_time - end_time - sessions - user_prompts - active_users - consumed_tokens - tool_calls - tool_calls_by_name - session_durations ResponseBase: type: object title: ResponseBase properties: id: type: string example: cmpl-e5cc70bb28c444948073e77776eb30ef object: type: string example: chat.completion model: type: string example: mistral-small-latest usage: $ref: '#/components/schemas/UsageInfo' ChatCompletionChoice: title: ChatCompletionChoice type: object required: - index - finish_reason properties: index: type: integer example: 0 message: $ref: '#/components/schemas/AssistantMessage' messages: type: array items: $ref: '#/components/schemas/DeltaMessage' finish_reason: type: string enum: - stop - length - model_length - error - tool_calls example: stop DeltaMessage: title: DeltaMessage type: object properties: role: anyOf: - type: string - type: 'null' content: anyOf: - type: string - type: 'null' - items: $ref: '#/components/schemas/ContentChunk' type: array tool_calls: anyOf: - type: 'null' - type: array items: $ref: '#/components/schemas/ToolCall' tool_call_id: anyOf: - type: string - type: 'null' index: anyOf: - type: integer minimum: 0.0 - type: 'null' description: If the completion returns multiple messages, this is to specify which message this delta is for. metadata: anyOf: - type: object additionalProperties: true - type: 'null' ChatCompletionResponseBase: allOf: - $ref: '#/components/schemas/ResponseBase' - type: object title: ChatCompletionResponseBase properties: created: type: integer example: 1702256327 ChatCompletionResponse: allOf: - $ref: '#/components/schemas/ChatCompletionResponseBase' - type: object title: ChatCompletionResponse properties: choices: type: array items: $ref: '#/components/schemas/ChatCompletionChoice' required: - id - object - data - model - usage - created - choices FIMCompletionResponse: allOf: - $ref: '#/components/schemas/ChatCompletionResponse' - type: object properties: model: type: string example: codestral-latest EmbeddingResponseData: title: EmbeddingResponseData type: object properties: object: type: string example: embedding embedding: type: array items: type: number example: - 0.1 - 0.2 - 0.3 index: type: integer example: 0 examples: - object: embedding embedding: - 0.1 - 0.2 - 0.3 index: 0 - object: embedding embedding: - 0.4 - 0.5 - 0.6 index: 1 EmbeddingResponse: allOf: - $ref: '#/components/schemas/ResponseBase' - type: object properties: data: type: array items: $ref: '#/components/schemas/EmbeddingResponseData' required: - id - object - data - model - usage CompletionEvent: title: CompletionEvent type: object required: - data properties: data: $ref: '#/components/schemas/CompletionChunk' CompletionChunk: title: CompletionChunk type: object required: - id - model - choices properties: id: type: string object: type: string created: type: integer model: type: string usage: $ref: '#/components/schemas/UsageInfo' choices: type: array items: $ref: '#/components/schemas/CompletionResponseStreamChoice' CompletionResponseStreamChoice: title: CompletionResponseStreamChoice type: object required: - index - delta - finish_reason properties: index: type: integer delta: $ref: '#/components/schemas/DeltaMessage' finish_reason: type: - string - 'null' enum: - stop - length - error - tool_calls - null DeleteModelResponse: type: object properties: id: type: string examples: - ft:open-mistral-7b:587a6b29:20240514:7e773925 title: Id description: The ID of the deleted model. object: type: string title: Object description: The object type that was deleted. default: model deleted: type: boolean examples: - true title: Deleted description: The deletion status. default: true title: DeleteModelResponse required: - id CreateAgentRequest: type: object properties: instructions: anyOf: - type: string - type: 'null' title: Instructions description: Instruction prompt the model will follow during the conversation. tools: type: array items: oneOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/WebSearchPremiumTool' - $ref: '#/components/schemas/CodeInterpreterTool' - $ref: '#/components/schemas/ImageGenerationTool' - $ref: '#/components/schemas/DocumentLibraryTool' - $ref: '#/components/schemas/CustomConnector' discriminator: propertyName: type mapping: code_interpreter: '#/components/schemas/CodeInterpreterTool' connector: '#/components/schemas/CustomConnector' document_library: '#/components/schemas/DocumentLibraryTool' function: '#/components/schemas/FunctionTool' image_generation: '#/components/schemas/ImageGenerationTool' web_search: '#/components/schemas/WebSearchTool' web_search_premium: '#/components/schemas/WebSearchPremiumTool' title: Tools description: List of tools which are available to the model during the conversation. completion_args: $ref: '#/components/schemas/CompletionArgs' description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. guardrails: anyOf: - type: array items: $ref: '#/components/schemas/GuardrailConfig' - type: 'null' title: Guardrails model: type: string title: Model name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description handoffs: anyOf: - type: array items: type: string minItems: 1 - type: 'null' title: Handoffs metadata: anyOf: - $ref: '#/components/schemas/MetadataDict' - type: 'null' version_message: anyOf: - type: string maxLength: 500 - type: 'null' title: Version Message title: CreateAgentRequest required: - model - name additionalProperties: false UpdateAgentRequest: type: object properties: instructions: anyOf: - type: string - type: 'null' title: Instructions description: Instruction prompt the model will follow during the conversation. tools: type: array items: oneOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/WebSearchPremiumTool' - $ref: '#/components/schemas/CodeInterpreterTool' - $ref: '#/components/schemas/ImageGenerationTool' - $ref: '#/components/schemas/DocumentLibraryTool' - $ref: '#/components/schemas/CustomConnector' discriminator: propertyName: type mapping: code_interpreter: '#/components/schemas/CodeInterpreterTool' connector: '#/components/schemas/CustomConnector' document_library: '#/components/schemas/DocumentLibraryTool' function: '#/components/schemas/FunctionTool' image_generation: '#/components/schemas/ImageGenerationTool' web_search: '#/components/schemas/WebSearchTool' web_search_premium: '#/components/schemas/WebSearchPremiumTool' title: Tools description: List of tools which are available to the model during the conversation. completion_args: $ref: '#/components/schemas/CompletionArgs' description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. guardrails: anyOf: - type: array items: $ref: '#/components/schemas/GuardrailConfig' - type: 'null' title: Guardrails model: anyOf: - type: string - type: 'null' title: Model name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description handoffs: anyOf: - type: array items: type: string minItems: 1 - type: 'null' title: Handoffs deployment_chat: anyOf: - type: boolean - type: 'null' title: Deployment Chat metadata: anyOf: - $ref: '#/components/schemas/MetadataDict' - type: 'null' version_message: anyOf: - type: string maxLength: 500 - type: 'null' title: Version Message title: UpdateAgentRequest additionalProperties: false AppendConversationRequest: type: object properties: inputs: $ref: '#/components/schemas/ConversationInputs' stream: type: boolean title: Stream description: Whether to stream back partial progress. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. default: false store: type: boolean title: Store description: Whether to store the results into our servers or not. default: true handoff_execution: type: string title: Handoff Execution enum: - client - server default: server completion_args: $ref: '#/components/schemas/CompletionArgs' description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. tool_confirmations: anyOf: - type: array items: $ref: '#/components/schemas/ToolCallConfirmation' - type: 'null' title: Tool Confirmations title: AppendConversationRequest additionalProperties: false RestartConversationRequest: type: object properties: inputs: $ref: '#/components/schemas/ConversationInputs' stream: type: boolean title: Stream description: Whether to stream back partial progress. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON. default: false store: type: boolean title: Store description: Whether to store the results into our servers or not. default: true handoff_execution: type: string title: Handoff Execution enum: - client - server default: server completion_args: $ref: '#/components/schemas/CompletionArgs' description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request. guardrails: anyOf: - type: array items: $ref: '#/components/schemas/GuardrailConfig' - type: 'null' title: Guardrails metadata: anyOf: - $ref: '#/components/schemas/MetadataDict' - type: 'null' description: Custom metadata for the conversation. from_entry_id: type: string title: From Entry Id agent_version: anyOf: - type: string - type: integer - type: 'null' title: Agent Version description: Specific version of the agent to use when restarting. If not provided, uses the current version. title: RestartConversationRequest required: - from_entry_id additionalProperties: false description: Request to restart a new conversation from a given entry in the conversation. CreateFileResponse: type: object properties: id: type: string examples: - 497f6eca-6276-4993-bfeb-53cbbbba6f09 title: Id format: uuid description: The unique identifier of the file. object: type: string examples: - file title: Object description: The object type, which is always "file". bytes: type: integer examples: - 13000 title: Bytes description: The size of the file, in bytes. created_at: type: integer examples: - 1716963433 title: Created At description: The UNIX timestamp (in seconds) of the event. filename: type: string examples: - files_upload.jsonl title: Filename description: The name of the uploaded file. purpose: $ref: '#/components/schemas/FilePurpose' examples: - fine-tune - ocr - batch - audio description: The intended purpose of the uploaded file, currently supports fine-tuning (`fine-tune`), OCR (`ocr`), Audio/Transcription (`audio`) and batch inference (`batch`). sample_type: $ref: '#/components/schemas/SampleType' num_lines: anyOf: - type: integer - type: 'null' title: Num Lines mimetype: anyOf: - type: string - type: 'null' title: Mimetype source: $ref: '#/components/schemas/Source' signature: anyOf: - type: string - type: 'null' title: Signature expires_at: anyOf: - type: integer - type: 'null' title: Expires At visibility: anyOf: - $ref: '#/components/schemas/FileVisibility' - type: 'null' title: CreateFileResponse required: - id - object - bytes - created_at - filename - purpose - sample_type - source ListFilesResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/FileSchema' title: Data object: type: string title: Object total: anyOf: - type: integer - type: 'null' title: Total title: ListFilesResponse required: - data - object GetFileResponse: type: object properties: id: type: string examples: - 497f6eca-6276-4993-bfeb-53cbbbba6f09 title: Id format: uuid description: The unique identifier of the file. object: type: string examples: - file title: Object description: The object type, which is always "file". bytes: type: integer examples: - 13000 title: Bytes description: The size of the file, in bytes. created_at: type: integer examples: - 1716963433 title: Created At description: The UNIX timestamp (in seconds) of the event. filename: type: string examples: - files_upload.jsonl title: Filename description: The name of the uploaded file. purpose: $ref: '#/components/schemas/FilePurpose' examples: - fine-tune - ocr - batch - audio description: The intended purpose of the uploaded file, currently supports fine-tuning (`fine-tune`), OCR (`ocr`), Audio/Transcription (`audio`) and batch inference (`batch`). sample_type: $ref: '#/components/schemas/SampleType' num_lines: anyOf: - type: integer - type: 'null' title: Num Lines mimetype: anyOf: - type: string - type: 'null' title: Mimetype source: $ref: '#/components/schemas/Source' signature: anyOf: - type: string - type: 'null' title: Signature expires_at: anyOf: - type: integer - type: 'null' title: Expires At visibility: anyOf: - $ref: '#/components/schemas/FileVisibility' - type: 'null' deleted: type: boolean title: Deleted title: GetFileResponse required: - id - object - bytes - created_at - filename - purpose - sample_type - source - deleted DeleteFileResponse: type: object properties: id: type: string examples: - 497f6eca-6276-4993-bfeb-53cbbbba6f09 title: Id format: uuid description: The ID of the deleted file. object: type: string examples: - file title: Object description: The object type that was deleted deleted: type: boolean examples: - true title: Deleted description: The deletion status. title: DeleteFileResponse required: - id - object - deleted GetSignedUrlResponse: type: object properties: url: type: string title: Url title: GetSignedUrlResponse required: - url ClassifierFineTunedModel: type: object properties: id: type: string title: Id object: type: string title: Object default: model const: model created: type: integer title: Created owned_by: type: string title: Owned By workspace_id: type: string title: Workspace Id root: type: string title: Root root_version: type: string title: Root Version archived: type: boolean title: Archived name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description capabilities: $ref: '#/components/schemas/FineTunedModelCapabilities' max_context_length: type: integer title: Max Context Length default: 32768 aliases: type: array items: type: string title: Aliases default: [] job: anyOf: - type: string format: uuid - type: 'null' title: Job classifier_targets: type: array items: $ref: '#/components/schemas/ClassifierTargetResult' title: Classifier Targets model_type: type: string title: Model Type default: classifier const: classifier title: ClassifierFineTunedModel required: - id - created - owned_by - workspace_id - root - root_version - archived - capabilities - classifier_targets ClassifierTargetResult: type: object properties: name: type: string title: Name labels: type: array items: type: string title: Labels weight: type: number title: Weight loss_function: $ref: '#/components/schemas/FTClassifierLossFunction' title: ClassifierTargetResult required: - name - labels - weight - loss_function CompletionFineTunedModel: type: object properties: id: type: string title: Id object: type: string title: Object default: model const: model created: type: integer title: Created owned_by: type: string title: Owned By workspace_id: type: string title: Workspace Id root: type: string title: Root root_version: type: string title: Root Version archived: type: boolean title: Archived name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description capabilities: $ref: '#/components/schemas/FineTunedModelCapabilities' max_context_length: type: integer title: Max Context Length default: 32768 aliases: type: array items: type: string title: Aliases default: [] job: anyOf: - type: string format: uuid - type: 'null' title: Job model_type: type: string title: Model Type default: completion const: completion title: CompletionFineTunedModel required: - id - created - owned_by - workspace_id - root - root_version - archived - capabilities FineTunedModelCapabilities: type: object properties: completion_chat: type: boolean title: Completion Chat default: true completion_fim: type: boolean title: Completion Fim default: false function_calling: type: boolean title: Function Calling default: false fine_tuning: type: boolean title: Fine Tuning default: false classification: type: boolean title: Classification default: false title: FineTunedModelCapabilities UpdateModelRequest: type: object properties: name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description title: UpdateModelRequest ArchiveModelResponse: type: object properties: id: type: string title: Id object: type: string title: Object default: model const: model archived: type: boolean title: Archived default: true title: ArchiveModelResponse required: - id UnarchiveModelResponse: type: object properties: id: type: string title: Id object: type: string title: Object default: model const: model archived: type: boolean title: Archived default: false title: UnarchiveModelResponse required: - id BatchJob: type: object properties: id: type: string title: Id object: type: string title: Object default: batch const: batch input_files: type: array items: type: string format: uuid title: Input Files metadata: anyOf: - type: object additionalProperties: true - type: 'null' title: Metadata endpoint: type: string title: Endpoint model: anyOf: - type: string - type: 'null' title: Model agent_id: anyOf: - type: string - type: 'null' title: Agent Id output_file: anyOf: - type: string format: uuid - type: 'null' title: Output File error_file: anyOf: - type: string format: uuid - type: 'null' title: Error File errors: type: array items: $ref: '#/components/schemas/BatchError' title: Errors outputs: anyOf: - type: array items: type: object additionalProperties: true - type: 'null' title: Outputs status: $ref: '#/components/schemas/BatchJobStatus' created_at: type: integer title: Created At total_requests: type: integer title: Total Requests completed_requests: type: integer title: Completed Requests succeeded_requests: type: integer title: Succeeded Requests failed_requests: type: integer title: Failed Requests started_at: anyOf: - type: integer - type: 'null' title: Started At completed_at: anyOf: - type: integer - type: 'null' title: Completed At title: BatchJob required: - id - input_files - endpoint - errors - status - created_at - total_requests - completed_requests - succeeded_requests - failed_requests ListBatchJobsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/BatchJob' title: Data default: [] object: type: string title: Object default: list const: list total: type: integer title: Total title: ListBatchJobsResponse required: - total CreateBatchJobRequest: type: object properties: input_files: anyOf: - type: array items: type: string format: uuid - type: 'null' title: Input Files description: 'A list of `.jsonl` files for batch inference. Each line must be a JSON object with a `body` field containing the request payload: ```json {"custom_id": "0", "body": {"max_tokens": 100, "messages": [{"role": "user", "content": "What is the best French cheese?"}]}} {"custom_id": "1", "body": {"max_tokens": 100, "messages": [{"role": "user", "content": "What is the best French wine?"}]}} ```' requests: anyOf: - type: array items: $ref: '#/components/schemas/BatchRequest' maxItems: 10000 - type: 'null' title: Requests endpoint: $ref: '#/components/schemas/ApiEndpoint' examples: - /v1/chat/completions - /v1/embeddings - /v1/fim/completions description: The endpoint to be used for batch inference. model: anyOf: - type: string - type: 'null' examples: - mistral-small-latest - mistral-medium-latest title: Model description: The model to be used for batch inference. agent_id: anyOf: - type: string - type: 'null' title: Agent Id description: In case you want to use a specific agent from the **deprecated** agents api for batch inference, you can specify the agent ID here. metadata: anyOf: - type: object propertyNames: maxLength: 32 minLength: 1 additionalProperties: type: string maxLength: 512 minLength: 1 - type: 'null' title: Metadata description: The metadata of your choice to be associated with the batch inference job. timeout_hours: type: integer title: Timeout Hours maximum: 168 minimum: 1 description: The timeout in hours for the batch inference job. default: 24 title: CreateBatchJobRequest required: - endpoint DeleteBatchJobResponse: type: object properties: id: type: string title: Id object: type: string title: Object default: batch const: batch deleted: type: boolean title: Deleted default: true title: DeleteBatchJobResponse required: - id Document: type: object properties: id: type: string title: Id format: uuid library_id: type: string title: Library Id format: uuid hash: anyOf: - type: string - type: 'null' title: Hash deprecated: true mime_type: anyOf: - type: string - type: 'null' title: Mime Type extension: anyOf: - type: string - type: 'null' title: Extension size: anyOf: - type: integer - type: 'null' title: Size name: type: string title: Name summary: anyOf: - type: string - type: 'null' title: Summary created_at: type: string title: Created At format: date-time last_processed_at: anyOf: - type: string format: date-time - type: 'null' title: Last Processed At number_of_pages: anyOf: - type: integer - type: 'null' title: Number Of Pages process_status: $ref: '#/components/schemas/ProcessStatus' description: 'Processing status of the document. ' uploaded_by_id: anyOf: - type: string format: uuid - type: 'null' title: Uploaded By Id uploaded_by_type: type: string tokens_processing_main_content: anyOf: - type: integer - type: 'null' title: Tokens Processing Main Content deprecated: true tokens_processing_summary: anyOf: - type: integer - type: 'null' title: Tokens Processing Summary deprecated: true url: anyOf: - type: string - type: 'null' title: Url attributes: anyOf: - type: object additionalProperties: true - type: 'null' title: Attributes expires_at: anyOf: - type: string format: date-time - type: 'null' title: Expires At description: If set, the document will be automatically deleted after this date. processing_status: type: string title: Processing Status readOnly: true deprecated: true tokens_processing_total: type: integer title: Tokens Processing Total readOnly: true title: Document required: - id - library_id - hash - mime_type - extension - size - name - created_at - process_status - uploaded_by_id - uploaded_by_type - processing_status - tokens_processing_total UpdateDocumentRequest: type: object properties: name: type: string title: Name attributes: anyOf: - type: object additionalProperties: anyOf: - type: boolean - type: string - type: integer - type: number - type: string format: date-time - type: array items: type: string - type: array items: type: integer - type: array items: type: number - type: array items: type: boolean - type: 'null' title: Attributes expires_at: anyOf: - type: string format: date-time - type: 'null' title: Expires At description: If set, the document will be automatically deleted after this date. title: UpdateDocumentRequest CreateLibraryRequest: type: object properties: name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description chunk_size: anyOf: - type: integer maximum: 32768 minimum: 256 - type: 'null' title: Chunk Size description: The size of the chunks (in characters) to split document text into. Must be between 256 and 32768. deprecated: true owner_type: anyOf: - type: string enum: - User - Workspace - type: 'null' description: Determines who owns the created library. 'User' creates a private library accessible only to its owner. 'Workspace' creates a library shared with the workspace. Defaults to 'Workspace' for API key sessions. Only API keys with the 'Private and shared connectors' connector access scope can create private, user-owned libraries. title: CreateLibraryRequest required: - name UpdateLibraryRequest: type: object properties: name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description title: UpdateLibraryRequest Library: type: object properties: id: type: string title: Id format: uuid name: type: string title: Name created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time owner_id: anyOf: - type: string format: uuid - type: 'null' title: Owner Id owner_type: type: string total_size: type: integer title: Total Size nb_documents: type: integer title: Nb Documents chunk_size: anyOf: - type: integer - type: 'null' title: Chunk Size deprecated: true emoji: anyOf: - type: string - type: 'null' title: Emoji deprecated: true description: anyOf: - type: string - type: 'null' title: Description generated_description: anyOf: - type: string - type: 'null' title: Generated Description deprecated: true explicit_user_members_count: anyOf: - type: integer - type: 'null' title: Explicit User Members Count deprecated: true explicit_workspace_members_count: anyOf: - type: integer - type: 'null' title: Explicit Workspace Members Count deprecated: true org_sharing_role: anyOf: - type: string - type: 'null' deprecated: true generated_name: anyOf: - type: string - type: 'null' description: Generated Name deprecated: true title: Library required: - id - name - created_at - updated_at - owner_id - owner_type - total_size - nb_documents - chunk_size ListDocumentsResponse: type: object properties: pagination: $ref: '#/components/schemas/PaginationInfo' data: type: array items: $ref: '#/components/schemas/Document' title: Data title: ListDocumentsResponse required: - pagination - data ListLibrariesResponse: type: object properties: pagination: anyOf: - $ref: '#/components/schemas/PaginationInfo' - type: 'null' description: 'Deprecated: offset pagination metadata. Only populated for callers using the deprecated `page` parameter; omitted when `page_token` is used. While RBAC filtering is being rolled out `total_items` is a rough estimate (candidate count before per-library checks). Use `next_page_token` instead — this field will be removed once offset paging is retired.' deprecated: true data: type: array items: $ref: '#/components/schemas/Library' title: Data next_page_token: anyOf: - type: string - type: 'null' title: Next Page Token description: Opaque continuation token for the next page. Pass it back as `page_token` to fetch the next page. Null when there are no more results. Prefer this over the deprecated offset `page` parameter. title: ListLibrariesResponse required: - data ListSharingResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Sharing' title: Data title: ListSharingResponse required: - data ProcessingStatus: type: object properties: document_id: type: string title: Document Id format: uuid process_status: $ref: '#/components/schemas/ProcessStatus' description: Processing status of the document. processing_status: type: string title: Processing Status readOnly: true deprecated: true title: ProcessingStatus required: - document_id - process_status - processing_status SharingRequest: type: object properties: org_id: anyOf: - type: string format: uuid - type: 'null' title: Org Id deprecated: true level: $ref: '#/components/schemas/ShareEnum' share_with_uuid: type: string format: uuid description: The id of the entity (user, workspace or organization) to share with share_with_type: $ref: '#/components/schemas/EntityType' title: SharingRequest required: - share_with_uuid - share_with_type - level Sharing: type: object properties: library_id: type: string title: Library Id format: uuid user_id: anyOf: - type: string format: uuid - type: 'null' title: User Id deprecated: true org_id: type: string title: Org Id format: uuid deprecated: true role: type: string share_with_type: type: string share_with_uuid: anyOf: - type: string format: uuid - type: 'null' title: Share With Uuid title: Sharing required: - library_id - org_id - role - share_with_type - share_with_uuid AggregationRequest: type: object properties: metric: $ref: '#/components/schemas/MetricDefinition' dimensions: type: array items: type: string title: Dimensions default: [] time_dimension: anyOf: - $ref: '#/components/schemas/TimeDimension' - type: 'null' search_expression: anyOf: - type: string - type: 'null' title: Search Expression order_by: anyOf: - type: array items: $ref: '#/components/schemas/OrderByClause' - type: 'null' title: Order By limit: type: integer title: Limit maximum: 10000 minimum: 1 default: 1000 title: AggregationRequest required: - metric Campaign: type: object properties: id: type: string title: Id format: uuid created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At name: type: string title: Name owner_id: type: string title: Owner Id format: uuid workspace_id: type: string title: Workspace Id format: uuid description: type: string title: Description max_nb_events: type: integer title: Max Nb Events search_params: $ref: '#/components/schemas/FilterPayload' judge: $ref: '#/components/schemas/Judge' title: Campaign required: - id - created_at - updated_at - deleted_at - name - owner_id - workspace_id - description - max_nb_events - search_params - judge ListCampaignsResponse: type: object properties: campaigns: $ref: '#/components/schemas/PaginatedResultCampaignPreview' title: ListCampaignsResponse required: - campaigns ListCampaignSelectedEventsResponse: type: object properties: completion_events: $ref: '#/components/schemas/PaginatedResultChatCompletionEventPreview' title: ListCampaignSelectedEventsResponse required: - completion_events FetchCampaignStatusResponse: type: object properties: status: $ref: '#/components/schemas/BaseTaskStatus' title: FetchCampaignStatusResponse required: - status SearchChatCompletionEventIdsResponse: type: object properties: completion_event_ids: type: array items: type: string title: Completion Event Ids title: SearchChatCompletionEventIdsResponse required: - completion_event_ids SearchChatCompletionEventsResponse: type: object properties: completion_events: $ref: '#/components/schemas/FeedResultChatCompletionEventPreview' title: SearchChatCompletionEventsResponse required: - completion_events FetchChatCompletionFieldOptionsResponse: type: object properties: options: anyOf: - type: array items: anyOf: - type: string - type: boolean - type: 'null' - type: 'null' title: Options title: FetchChatCompletionFieldOptionsResponse ListChatCompletionFieldsResponse: type: object properties: field_definitions: type: array items: $ref: '#/components/schemas/BaseFieldDefinition' title: Field Definitions field_groups: type: array items: $ref: '#/components/schemas/FieldGroup' title: Field Groups title: ListChatCompletionFieldsResponse required: - field_definitions - field_groups ExportDatasetResponse: type: object properties: file_url: type: string title: File Url title: ExportDatasetResponse required: - file_url ListDatasetImportTasksResponse: type: object properties: tasks: $ref: '#/components/schemas/PaginatedResultDatasetImportTask' title: ListDatasetImportTasksResponse required: - tasks ListDatasetsResponse: type: object properties: datasets: $ref: '#/components/schemas/PaginatedResultDatasetPreview' title: ListDatasetsResponse required: - datasets ListDatasetRecordsResponse: type: object properties: records: $ref: '#/components/schemas/PaginatedResultDatasetRecord' title: ListDatasetRecordsResponse required: - records DeleteDatasetRecordsRequest: type: object properties: dataset_record_ids: type: array items: type: string format: uuid title: Dataset Record Ids maxItems: 500 minItems: 1 title: DeleteDatasetRecordsRequest required: - dataset_record_ids FeedResultChatCompletionEventPreview: type: object properties: results: type: array items: $ref: '#/components/schemas/ChatCompletionEventPreview' title: Results next: anyOf: - type: string - type: 'null' title: Next cursor: anyOf: - type: string - type: 'null' title: Cursor title: FeedResultChatCompletionEventPreview FeedResultGetLog: type: object properties: results: type: array items: $ref: '#/components/schemas/GetLog' title: Results next: anyOf: - type: string - type: 'null' title: Next cursor: anyOf: - type: string - type: 'null' title: Cursor title: FeedResultGetLog FeedResultGetSpanEvaluation: type: object properties: results: type: array items: $ref: '#/components/schemas/GetSpanEvaluation' title: Results next: anyOf: - type: string - type: 'null' title: Next cursor: anyOf: - type: string - type: 'null' title: Cursor title: FeedResultGetSpanEvaluation FeedResultGetSpan: type: object properties: results: type: array items: $ref: '#/components/schemas/GetSpan' title: Results next: anyOf: - type: string - type: 'null' title: Next cursor: anyOf: - type: string - type: 'null' title: Cursor title: FeedResultGetSpan FeedResultGetTrace: type: object properties: results: type: array items: $ref: '#/components/schemas/GetTrace' title: Results next: anyOf: - type: string - type: 'null' title: Next cursor: anyOf: - type: string - type: 'null' title: Cursor title: FeedResultGetTrace FetchFieldOptionCountsRequest: type: object properties: filter_params: anyOf: - $ref: '#/components/schemas/FilterPayload' - type: 'null' title: FetchFieldOptionCountsRequest FetchFieldOptionCountsResponse: type: object properties: counts: type: array items: $ref: '#/components/schemas/FieldOptionCountItem' title: Counts title: FetchFieldOptionCountsResponse required: - counts SearchChatCompletionEventIdsRequest: type: object properties: search_params: $ref: '#/components/schemas/FilterPayload' extra_fields: anyOf: - type: array items: type: string - type: 'null' title: Extra Fields title: SearchChatCompletionEventIdsRequest required: - search_params SearchChatCompletionEventsRequest: type: object properties: search_params: $ref: '#/components/schemas/FilterPayload' extra_fields: anyOf: - type: array items: type: string - type: 'null' title: Extra Fields title: SearchChatCompletionEventsRequest required: - search_params LogsRequest: type: object properties: search_expression: anyOf: - type: string - type: 'null' title: Search Expression order: type: string title: Order enum: - asc - desc default: desc title: LogsRequest SpanEvaluationsRequest: type: object properties: search_expression: anyOf: - type: string - type: 'null' title: Search Expression title: SpanEvaluationsRequest SpansRequest: type: object properties: search_expression: anyOf: - type: string - type: 'null' title: Search Expression title: SpansRequest TracesRequest: type: object properties: search_expression: anyOf: - type: string - type: 'null' title: Search Expression title: TracesRequest Judge: type: object properties: id: type: string title: Id format: uuid created_at: type: string title: Created At format: date-time updated_at: type: string title: Updated At format: date-time deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At owner_id: type: string title: Owner Id format: uuid workspace_id: type: string title: Workspace Id format: uuid name: type: string title: Name description: type: string title: Description model_name: type: string title: Model Name output: oneOf: - $ref: '#/components/schemas/JudgeClassificationOutput' - $ref: '#/components/schemas/JudgeRegressionOutput' discriminator: propertyName: type mapping: CLASSIFICATION: '#/components/schemas/JudgeClassificationOutput' REGRESSION: '#/components/schemas/JudgeRegressionOutput' title: Output instructions: type: string title: Instructions tools: type: array items: type: string title: Tools up_revision: anyOf: - type: string format: uuid - type: 'null' title: Up Revision down_revision: anyOf: - type: string format: uuid - type: 'null' title: Down Revision base_revision: anyOf: - type: string format: uuid - type: 'null' title: Base Revision title: Judge required: - id - created_at - updated_at - deleted_at - owner_id - workspace_id - name - description - model_name - output - instructions - tools ListJudgesResponse: type: object properties: judges: $ref: '#/components/schemas/PaginatedResultJudgePreview' title: ListJudgesResponse required: - judges PaginatedResultCampaignPreview: type: object properties: results: type: array items: $ref: '#/components/schemas/Campaign' title: Results count: type: integer title: Count next: anyOf: - type: string - type: 'null' title: Next previous: anyOf: - type: string - type: 'null' title: Previous title: PaginatedResultCampaignPreview required: - count PaginatedResultChatCompletionEventPreview: type: object properties: results: type: array items: $ref: '#/components/schemas/ChatCompletionEventPreview' title: Results count: type: integer title: Count next: anyOf: - type: string - type: 'null' title: Next previous: anyOf: - type: string - type: 'null' title: Previous title: PaginatedResultChatCompletionEventPreview required: - count PaginatedResultDatasetImportTask: type: object properties: results: type: array items: $ref: '#/components/schemas/DatasetImportTask' title: Results count: type: integer title: Count next: anyOf: - type: string - type: 'null' title: Next previous: anyOf: - type: string - type: 'null' title: Previous title: PaginatedResultDatasetImportTask required: - count PaginatedResultDatasetPreview: type: object properties: results: type: array items: $ref: '#/components/schemas/DatasetPreview' title: Results count: type: integer title: Count next: anyOf: - type: string - type: 'null' title: Next previous: anyOf: - type: string - type: 'null' title: Previous title: PaginatedResultDatasetPreview required: - count PaginatedResultDatasetRecord: type: object properties: results: type: array items: $ref: '#/components/schemas/DatasetRecord' title: Results count: type: integer title: Count next: anyOf: - type: string - type: 'null' title: Next previous: anyOf: - type: string - type: 'null' title: Previous title: PaginatedResultDatasetRecord required: - count PaginatedResultJudgePreview: type: object properties: results: type: array items: $ref: '#/components/schemas/Judge' title: Results count: type: integer title: Count next: anyOf: - type: string - type: 'null' title: Next previous: anyOf: - type: string - type: 'null' title: Previous title: PaginatedResultJudgePreview required: - count UpdateDatasetRequest: type: object properties: name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description title: UpdateDatasetRequest CreateCampaignRequest: type: object properties: search_params: $ref: '#/components/schemas/FilterPayload' judge_id: type: string title: Judge Id format: uuid name: type: string title: Name maxLength: 50 minLength: 5 description: type: string title: Description max_nb_events: exclusiveMinimum: 0 type: integer title: Max Nb Events maximum: 10000 title: CreateCampaignRequest required: - search_params - judge_id - name - description - max_nb_events JudgeChatCompletionEventRequest: type: object properties: judge_definition: $ref: '#/components/schemas/CreateJudgeRequest' title: JudgeChatCompletionEventRequest required: - judge_definition ImportDatasetFromCampaignRequest: type: object properties: campaign_id: type: string title: Campaign Id format: uuid title: ImportDatasetFromCampaignRequest required: - campaign_id ImportDatasetFromDatasetRequest: type: object properties: dataset_record_ids: type: array items: type: string format: uuid title: Dataset Record Ids maxItems: 10000 minItems: 1 title: ImportDatasetFromDatasetRequest required: - dataset_record_ids ImportDatasetFromExplorerRequest: type: object properties: completion_event_ids: type: array items: type: string title: Completion Event Ids maxItems: 500 title: ImportDatasetFromExplorerRequest required: - completion_event_ids ImportDatasetFromFileRequest: type: object properties: file_id: type: string title: File Id title: ImportDatasetFromFileRequest required: - file_id ImportDatasetFromPlaygroundRequest: type: object properties: conversation_ids: type: array items: type: string title: Conversation Ids title: ImportDatasetFromPlaygroundRequest required: - conversation_ids CreateDatasetRequest: type: object properties: name: type: string title: Name maxLength: 50 minLength: 5 description: type: string title: Description maxLength: 200 title: CreateDatasetRequest required: - name - description CreateDatasetRecordRequest: type: object properties: payload: $ref: '#/components/schemas/DatasetRecordPayload' properties: type: object title: Properties additionalProperties: true title: CreateDatasetRecordRequest required: - payload JudgeDatasetRecordRequest: type: object properties: judge_definition: $ref: '#/components/schemas/CreateJudgeRequest' title: JudgeDatasetRecordRequest required: - judge_definition JudgeConversationRequest: type: object properties: messages: type: array items: type: object additionalProperties: true title: Messages properties: anyOf: - type: object additionalProperties: true - type: 'null' title: Properties title: JudgeConversationRequest required: - messages CreateJudgeRequest: type: object properties: name: type: string title: Name maxLength: 50 minLength: 5 description: type: string title: Description maxLength: 500 model_name: type: string title: Model Name maxLength: 500 output: oneOf: - $ref: '#/components/schemas/JudgeClassificationOutput' - $ref: '#/components/schemas/JudgeRegressionOutput' discriminator: propertyName: type mapping: CLASSIFICATION: '#/components/schemas/JudgeClassificationOutput' REGRESSION: '#/components/schemas/JudgeRegressionOutput' title: Output instructions: type: string title: Instructions maxLength: 10000 tools: type: array items: type: string title: Tools title: CreateJudgeRequest required: - name - description - model_name - output - instructions - tools UpdateDatasetRecordPayloadRequest: type: object properties: payload: $ref: '#/components/schemas/DatasetRecordPayload' title: UpdateDatasetRecordPayloadRequest required: - payload UpdateDatasetRecordPropertiesRequest: type: object properties: properties: type: object title: Properties additionalProperties: true title: UpdateDatasetRecordPropertiesRequest required: - properties UpdateJudgeRequest: type: object properties: name: type: string title: Name maxLength: 50 minLength: 5 description: type: string title: Description maxLength: 500 model_name: type: string title: Model Name maxLength: 500 output: oneOf: - $ref: '#/components/schemas/JudgeClassificationOutput' - $ref: '#/components/schemas/JudgeRegressionOutput' discriminator: propertyName: type mapping: CLASSIFICATION: '#/components/schemas/JudgeClassificationOutput' REGRESSION: '#/components/schemas/JudgeRegressionOutput' title: Output instructions: type: string title: Instructions maxLength: 10000 tools: type: array items: type: string title: Tools title: UpdateJudgeRequest required: - name - description - model_name - output - instructions - tools CreateConnectorRequest: type: object properties: protocol: type: string title: Protocol description: Protocol of the connector. Only 'mcp' is supported on the public endpoint; creating HTTP connectors here is explicitly refused. default: mcp const: mcp name: type: string title: Name description: The name of the connector. Should be 64 char length maximum, alphanumeric, only underscores/dashes. title: anyOf: - type: string maxLength: 255 - type: 'null' title: Title description: Optional human-readable title for the connector. description: type: string title: Description description: The description of the connector. icon_url: anyOf: - type: string - type: 'null' title: Icon Url description: The optional url of the icon you want to associate to the connector. visibility: $ref: '#/components/schemas/PublicResourceVisibility' description: Visibility of the connector. Use 'shared_workspace' for workspace scoped connectors, or 'private' for private connectors. default: private server: type: string title: Server maxLength: 2083 minLength: 1 format: uri description: The url of the MCP server. headers: anyOf: - type: object additionalProperties: true - type: 'null' title: Headers description: Optional organization-level headers to be sent with the request to the mcp server. global_headers: type: object title: Global Headers additionalProperties: $ref: '#/components/schemas/GlobalHeaderValue' description: Optional connector-wide headers, keyed by header name, set at creation and applied to every credential. Secret values are encrypted at rest and never returned in clear. default: {} auth_data: anyOf: - $ref: '#/components/schemas/AuthData' - type: 'null' description: Optional additional authentication data for the connector. oauth2_server_metadata: anyOf: - $ref: '#/components/schemas/ExtendedOAuthServerMetadata' - type: 'null' description: Optional OAuth2 authorization server metadata (authorization_endpoint, token_endpoint, etc.). When provided, skips .well-known discovery and uses these endpoints directly. oauth2_server_metadata_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Oauth2 Server Metadata Url description: Optional URL to fetch OAuth2 authorization server metadata from (RFC 8414). When provided, the metadata is fetched from this URL and used instead of .well-known discovery. Mutually exclusive with oauth2_server_metadata. system_prompt: anyOf: - type: string - type: 'null' title: System Prompt description: Optional system prompt for the connector. title: CreateConnectorRequest required: - name - description - server description: 'Public create schema for MCP connectors. Standalone model that excludes internal-only fields (``hosted_internally``, ``mistral_integration``, ``private_tool_execution``, ``auth_scheme``, ``locale``, ``github_app_data``) and restricts visibility to :class:`PublicResourceVisibility` (no ``shared_global``).' UpdateConnectorRequest: type: object properties: title: anyOf: - type: string maxLength: 255 - type: 'null' title: Title description: Optional human-readable title for the connector. name: anyOf: - type: string - type: 'null' title: Name description: The name of the connector. description: anyOf: - type: string - type: 'null' title: Description description: The description of the connector. icon_url: anyOf: - type: string - type: 'null' title: Icon Url description: The optional url of the icon you want to associate to the connector. system_prompt: anyOf: - type: string - type: 'null' title: System Prompt description: Optional system prompt for the connector. protocol: type: string title: Protocol default: mcp const: mcp server: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Server description: New server url for your mcp connector. auth_methods: anyOf: - type: array items: $ref: '#/components/schemas/AuthenticationMethodCreateOrUpdateRequest' - type: 'null' title: Auth Methods description: list of authentication methods to add to the connector or to update title: UpdateConnectorRequest ConnectorToolResultMetadata: type: object properties: isError: type: boolean title: Iserror default: false structuredContent: anyOf: - type: object additionalProperties: true - type: 'null' title: Structuredcontent _meta: anyOf: - type: object additionalProperties: true - type: 'null' title: Meta title: ConnectorToolResultMetadata additionalProperties: true description: MCP-specific result metadata (isError, structuredContent, _meta). ConnectorToolCallMetadata: type: object properties: mcp_meta: anyOf: - $ref: '#/components/schemas/ConnectorToolResultMetadata' - type: 'null' title: ConnectorToolCallMetadata additionalProperties: true description: 'Metadata wrapper for MCP tool call responses. Nests MCP-specific fields under `mcp_meta` to avoid collisions with other metadata keys (e.g. `tool_call_result`) in Harmattan''s streaming deltas.' ConnectorCallToolRequest: type: object properties: arguments: type: object title: Arguments additionalProperties: true title: ConnectorCallToolRequest description: Request body for calling an MCP tool. ConnectorToolCallResponse: type: object properties: content: type: array items: anyOf: - $ref: '#/components/schemas/TextContent' - $ref: '#/components/schemas/ImageContent' - $ref: '#/components/schemas/AudioContent' - $ref: '#/components/schemas/ResourceLink' - $ref: '#/components/schemas/EmbeddedResource' title: Content metadata: anyOf: - $ref: '#/components/schemas/ConnectorToolCallMetadata' - type: 'null' title: ConnectorToolCallResponse required: - content additionalProperties: true description: 'Response from calling an MCP tool. We override mcp_types.CallToolResult because: - Models only support `content`, not `structuredContent` at top level - Downstream consumers (le-chat, etc.) need structuredContent/isError/_meta via metadata SYNC: Keep in sync with Harmattan (orchestrator) for harmonized tool result processing.' PublicConnectorExecutionData: type: object properties: integrations: type: array items: $ref: '#/components/schemas/PublicExecutionConnector' title: Integrations tools: type: array items: $ref: '#/components/schemas/ExecutionTool' title: Tools use_connectors_gateway: type: boolean title: Use Connectors Gateway default: false title: PublicConnectorExecutionData required: - integrations - tools ConnectorToolLocale: type: object properties: name: type: object propertyNames: $ref: '#/components/schemas/ConnectorSupportedLanguage' title: Name additionalProperties: type: string description: type: object propertyNames: $ref: '#/components/schemas/ConnectorSupportedLanguage' title: Description additionalProperties: type: string usage_sentence: type: object propertyNames: $ref: '#/components/schemas/ConnectorSupportedLanguage' title: Usage Sentence additionalProperties: type: string title: ConnectorToolLocale required: - name - description - usage_sentence JSONPatch: oneOf: - $ref: '#/components/schemas/JSONPatchAppend' - $ref: '#/components/schemas/JSONPatchAdd' - $ref: '#/components/schemas/JSONPatchReplace' - $ref: '#/components/schemas/JSONPatchRemove' discriminator: propertyName: op mapping: add: '#/components/schemas/JSONPatchAdd' append: '#/components/schemas/JSONPatchAppend' remove: '#/components/schemas/JSONPatchRemove' replace: '#/components/schemas/JSONPatchReplace' securitySchemes: DashboardUserContextAuth: type: apiKey description: Public API key. The gateway validates the key and forwards authenticated user context to the dashboard. name: x-api-key in: header AdminApiKey: type: http description: Admin-scoped API key passed as a bearer token. Standard workspace/inference API keys are rejected. scheme: bearer ApiKey: type: http scheme: bearer security: - ApiKey: [] tags: - name: chat x-displayName: Chat description: Chat Completion API. - name: fim x-displayName: FIM description: Fill-in-the-middle API. - name: agents x-displayName: Agents description: Agents API. - name: embeddings x-displayName: Embeddings description: Embeddings API. - name: classifiers x-displayName: Classifiers description: Classifiers API. - name: files x-displayName: Files description: Files API - name: fine-tuning x-displayName: Fine Tuning description: Fine-tuning API - name: models x-displayName: Models description: Model Management API - name: batch x-displayName: Batch description: Batch API - name: ocr x-displayName: OCR API description: OCR API - name: audio.transcriptions x-displayName: Transcriptions API description: API for audio transcription. - name: beta.agents x-displayName: (beta) Agents API description: (beta) Agents API - name: beta.conversations x-displayName: (beta) Conversations API description: (beta) Conversations API - name: beta.libraries x-displayName: (beta) Libraries API - Main description: (beta) Libraries API to create and manage libraries - index your documents to enhance agent capabilities. - name: beta.libraries.documents x-displayName: (beta) Libraries API - Documents description: (beta) Libraries API - manage documents in a library. - name: beta.libraries.accesses x-displayName: (beta) Libraries API - Access description: (beta) Libraries API - manage access to a library. - name: beta.connectors x-displayName: (beta) Connectors API description: (beta) Connectors API - manage your connectors - name: beta.admin.users x-displayName: (beta) Admin - Users description: (beta) Admin API - manage users. Requires an admin API key. - name: beta.admin.workspaces x-displayName: (beta) Admin - Workspaces description: (beta) Admin API - manage workspaces. Requires an admin API key. - name: beta.admin.api-keys x-displayName: (beta) Admin - API Keys description: (beta) Admin API - manage API keys. Requires an admin API key. - name: beta.admin.billing x-displayName: (beta) Admin - Billing description: (beta) Admin API - manage spend limits, rate limits and roles. Requires an admin API key. - name: beta.admin.audit-logs x-displayName: (beta) Admin - Audit Logs description: (beta) Admin API - access audit logs. Requires an admin API key. - name: beta.admin.user-groups x-displayName: (beta) Admin - User Groups description: (beta) Admin API - manage user groups. Requires an admin API key. - name: audio.speech x-displayName: Speech API description: API for speech generation. - name: audio.voices x-displayName: Voices API description: API for voice management. - name: beta.admin.scim x-displayName: (beta) Admin - Scim description: (beta) Admin - Scim API. - name: beta.admin.vibe-code-analytics x-displayName: Vibe Code Analytics description: Admin usage analytics for Vibe Code. - name: beta.admin.vibe-work-analytics x-displayName: Vibe Work Analytics description: Admin usage analytics for Vibe Work. - name: beta.observability.campaigns x-displayName: (beta) Observability - Campaigns description: (beta) Observability API - campaigns. - name: beta.observability.chat_completion_events x-displayName: (beta) Observability - Chat Completion Events description: (beta) Observability API - chat completion events. - name: beta.observability.chat_completion_events.fields x-displayName: (beta) Observability - Chat Completion Event Fields description: (beta) Observability API - chat completion event fields. - name: beta.observability.datasets x-displayName: (beta) Observability - Datasets description: (beta) Observability API - datasets. - name: beta.observability.datasets.records x-displayName: (beta) Observability - Dataset Records description: (beta) Observability API - dataset records. - name: beta.observability.judges x-displayName: (beta) Observability - Judges description: (beta) Observability API - judges. - name: beta.observability.logs x-displayName: (beta) Observability - Logs description: (beta) Observability API - logs. - name: beta.observability.spans x-displayName: (beta) Observability - Spans description: (beta) Observability API - spans. - name: beta.observability.traces x-displayName: (beta) Observability - Traces description: (beta) Observability API - traces. - name: beta.prompts x-displayName: (beta) Prompts description: (beta) Prompts API. - name: beta.rag.ingestion_pipeline_configurations x-displayName: (beta) RAG - Ingestion Pipeline Configurations description: (beta) RAG API - ingestion pipeline configurations. - name: beta.rag.search_indexes x-displayName: (beta) RAG - Search Indexes description: (beta) RAG API - search indexes. - name: beta.skills x-displayName: (beta) Skills description: (beta) Skills API. - name: beta.users x-displayName: (beta) Users description: (beta) Users API. - name: events x-displayName: Events description: Events API. - name: workflows x-displayName: Workflows description: Workflows API. - name: workflows.deployments x-displayName: Workflow Deployments description: Workflows API - deployments. - name: workflows.events x-displayName: Workflow Events description: Workflows API - events. - name: workflows.executions x-displayName: Workflow Executions description: Workflows API - executions. - name: workflows.metrics x-displayName: Workflow Metrics description: Workflows API - metrics. - name: workflows.runs x-displayName: Workflow Runs description: Workflows API - runs. - name: workflows.schedules x-displayName: Workflow Schedules description: Workflows API - schedules. servers: - url: https://api.mistral.ai description: Production server