{"openapi":"3.1.0","info":{"title":"mxbai-omni","version":"0.1.0"},"servers":[{"url":"https://api.mixedbread.com","description":"mixedbread ai production server"},{"url":"https://api.dev.mixedbread.com","description":"mixedbread ai development server"},{"url":"http://127.0.0.1:8000","description":"mixedbread local server"},{"url":"http://localhost:8000","description":"mixedbread local server"}],"paths":{"/":{"get":{"summary":"Info","description":"Returns service information, including name and version.\n\nReturns:\n    InfoResponse: A response containing the service name and version.","operationId":"info","responses":{"200":{"description":"Info response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfoResponse"}}}},"500":{"description":"Info failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/files":{"post":{"tags":["files"],"summary":"Upload file","description":"Upload a new file.\n\nArgs:\n    file: The file to upload.\n\nReturns:\n    FileResponse: The response containing the details of the uploaded file.","operationId":"create_file","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_create_file"}}}},"responses":{"201":{"description":"The uploaded file details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["files"],"summary":"List files","description":"List all files for the authenticated user.\n\nArgs:\n    pagination: The pagination options\n\nReturns:\n    A list of files belonging to the user.","operationId":"list_files","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"Search query for fuzzy matching over name and description fields","title":"Q"},"description":"Search query for fuzzy matching over name and description fields"}],"responses":{"200":{"description":"A list of files for the user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/files/uploads":{"get":{"tags":["files"],"summary":"List in-progress multipart uploads","description":"List all in-progress multipart uploads for the authenticated organization.","operationId":"list_multipart_uploads","responses":{"200":{"description":"All in-progress multipart uploads for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipartUploadListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"tags":["files"],"summary":"Create multipart upload","description":"Initiate a multipart upload and receive presigned URLs for uploading parts directly to storage.","operationId":"create_multipart_upload","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMultipartUploadRequest"}}},"required":true},"responses":{"201":{"description":"The multipart upload details with presigned URLs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMultipartUploadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/files/uploads/{upload_id}/complete":{"post":{"tags":["files"],"summary":"Complete multipart upload","description":"Complete a multipart upload after all parts have been uploaded.\nCreates the file object and returns it.","operationId":"complete_multipart_upload","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"upload_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the multipart upload","title":"Upload Id"},"description":"The ID of the multipart upload"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteMultipartUploadRequest"}}}},"responses":{"200":{"description":"The completed file details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/files/uploads/{upload_id}/abort":{"post":{"tags":["files"],"summary":"Abort multipart upload","description":"Abort a multipart upload and clean up any uploaded parts.","operationId":"abort_multipart_upload","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"upload_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the multipart upload to abort","title":"Upload Id"},"description":"The ID of the multipart upload to abort"}],"responses":{"200":{"description":"The details of the aborted upload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/files/uploads/{upload_id}":{"get":{"tags":["files"],"summary":"Get multipart upload details","description":"Get a multipart upload's details with fresh presigned URLs for any parts not yet uploaded.","operationId":"get_multipart_upload","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"upload_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the multipart upload","title":"Upload Id"},"description":"The ID of the multipart upload"}],"responses":{"200":{"description":"Upload details with presigned URLs for incomplete parts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipartUploadDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/files/{file_id}":{"get":{"tags":["files"],"summary":"Get file details","description":"Retrieve details of a specific file by its ID.\n\nArgs:\n    file_id: The ID of the file to retrieve.\n\nReturns:\n    FileResponse: The response containing the file details.","operationId":"retrieve_file","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the file to retrieve","title":"File Id"},"description":"The ID of the file to retrieve"}],"responses":{"200":{"description":"The details of the requested file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["files"],"summary":"Update file","description":"Update the details of a specific file.\n\nArgs:\n    file_id: The ID of the file to update.\n    file: The new details for the file.\n\nReturns:\n    FileObject: The updated file details.","operationId":"update_file","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the file to update","title":"File Id"},"description":"The ID of the file to update"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_update_file"}}}},"responses":{"200":{"description":"The updated file details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["files"],"summary":"Delete file","description":"Delete a specific file by its ID.\n\nRemoves the file from every store that references it (cleaning up chunks\nand store stats) before deleting the file object itself.\n\nArgs:\n    file_id: The ID of the file to delete.\n\nReturns:\n    FileDeleted: The response containing the details of the deleted file.","operationId":"delete_file","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the file to delete","title":"File Id"},"description":"The ID of the file to delete"}],"responses":{"200":{"description":"The details of the deleted file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/files/{file_id}/content":{"get":{"tags":["files"],"summary":"Download file","description":"Download a specific file by its ID.\n\nArgs:\n    file_id: The ID of the file to download.\n\nReturns:\n    FileStreamResponse: The response containing the file to be downloaded.","operationId":"download_file","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the file to download","title":"File Id"},"description":"The ID of the file to download"}],"responses":{"200":{"description":"The file to be downloaded","content":{"application/octet-stream":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/api-keys":{"post":{"tags":["api_keys"],"summary":"Create API key","description":"Create a new API key.\n\nArgs:\n    params: The parameters for creating the API key.\n\nReturns:\n    ApiKeyCreated: The response containing the details of the created API key.","operationId":"create_api_key","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreateParams"}}}},"responses":{"201":{"description":"The created API key details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["api_keys"],"summary":"List API keys","description":"List all API keys for the authenticated user.\n\nArgs:\n    pagination: The pagination options\n\nReturns:\n    A list of API keys belonging to the user.","operationId":"list_api_keys","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"description":"Maximum number of items to return per page","default":100,"title":"Limit"},"description":"Maximum number of items to return per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"Offset of the first item to return","default":0,"title":"Offset"},"description":"Offset of the first item to return"}],"responses":{"200":{"description":"A list of API keys for the user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/api-keys/{api_key_id}":{"get":{"tags":["api_keys"],"summary":"Get API key details","description":"Retrieve details of a specific API key by its ID.\n\nArgs:\n    api_key_id: The ID of the API key to retrieve.\n\nReturns:\n    ApiKey: The response containing the API key details.","operationId":"retrieve_api_key","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"api_key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the API key to retrieve","title":"Api Key Id"},"description":"The ID of the API key to retrieve"}],"responses":{"200":{"description":"The details of the requested API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["api_keys"],"summary":"Update API key","description":"Update a specific API key by its ID.\n\nArgs:\n    api_key_id: The ID of the API key to update.\n    params: The parameters to update.\n\nReturns:\n    ApiKey: The updated API key details.","operationId":"update_api_key","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"api_key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the API key to update","title":"Api Key Id"},"description":"The ID of the API key to update"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUpdateParams"}}}},"responses":{"200":{"description":"The updated API key details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["api_keys"],"summary":"Delete API key","description":"Delete a specific API key by its ID.\n\nArgs:\n    api_key_id: The ID of the API key to delete.\n\nReturns:\n    ApiKeyDeleted: The response containing the details of the deleted API key.","operationId":"delete_api_key","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"api_key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the API key to delete","title":"Api Key Id"},"description":"The ID of the API key to delete"}],"responses":{"200":{"description":"The details of the deleted API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/api-keys/{api_key_id}/revoke":{"post":{"tags":["api_keys"],"summary":"Revoke API key","description":"Revoke a specific API key by its ID.\n\nArgs:\n    api_key_id: The ID of the API key to revoke.\n\nReturns:\n    ApiKey: The response containing the details of the revoked API key.","operationId":"revoke_api_key","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"api_key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the API key to revoke","title":"Api Key Id"},"description":"The ID of the API key to revoke"}],"responses":{"200":{"description":"The revoked API key details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/api-keys/{api_key_id}/reroll":{"post":{"tags":["api_keys"],"summary":"Reroll API key","description":"Reroll the secret for a specific API key by its ID.\n\nThis generates a new secret key, invalidating the old one.\n\nArgs:\n    api_key_id: The ID of the API key to reroll.\n\nReturns:\n    ApiKeyCreated: The response containing the API key details with the new secret key.","operationId":"reroll_api_key","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"api_key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the API key to reroll","title":"Api Key Id"},"description":"The ID of the API key to reroll"}],"responses":{"200":{"description":"The API key details with the new secret key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schemas/mxjson":{"get":{"tags":["schemas"],"summary":"Get mxbai json schema","description":"Get the mxbai json schema.\n\nReturns:\n    The mxbai json schema.","operationId":"get_mxbai_json_schema","responses":{"200":{"description":"The mxbai json schema","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/billing/summary":{"get":{"tags":["billing"],"summary":"Get billing summary","operationId":"get_billing_summary","responses":{"200":{"description":"Billing summary for the current period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingPeriodSummary"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/billing/stores":{"get":{"tags":["billing"],"summary":"List store cost information","operationId":"list_store_cost_info","responses":{"200":{"description":"The list of store cost information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreCostListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/billing/stores/{store_id}/costs/histogram":{"get":{"tags":["billing"],"summary":"Get store cost histogram","operationId":"get_store_cost_histogram","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the store","title":"Store Id"},"description":"The ID of the store"}],"responses":{"200":{"description":"Histogram of store costs over time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostHistogramResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/billing/parsing/costs/histogram":{"get":{"tags":["billing"],"summary":"Get parsing cost histogram","operationId":"get_parsing_cost_histogram","responses":{"200":{"description":"Histogram of parsing costs over time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostHistogramResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/buckets":{"get":{"tags":["buckets"],"summary":"List buckets","description":"List the organization's connected buckets.\n\nNon-secret auth metadata (auth type, role ARN, external ID) is included;\naccess-key credentials are never returned.\n\nArgs:\n    options: The pagination options.\n\nReturns:\n    BucketListResponse: The list of buckets.","operationId":"list_buckets","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"}],"responses":{"200":{"description":"The organization's buckets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BucketListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["buckets"],"summary":"Add a bucket","description":"Attach a customer-owned storage bucket to the organization.\n\nAccess is validated against the bucket (reachability + write/delete probe) before\nanything is stored, so an unreachable or unwritable bucket is rejected here.\nWith `assume_role` credentials (recommended for AWS) the probe performs the actual\nSTS AssumeRole and nothing secret is persisted — only the role ARN and the\norganization's external ID. With `access_key` credentials (S3-compatible\nendpoints) the keys are encrypted before they are stored.\n\nArgs:\n    params: The bucket connection details and credentials.\n\nReturns:\n    Bucket: The attached bucket. Credentials are never returned.","operationId":"create_bucket","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BucketCreateParams"}}}},"responses":{"201":{"description":"The attached bucket details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bucket"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/buckets/{bucket_id}/credentials":{"post":{"tags":["buckets"],"summary":"Rotate bucket credentials","description":"Replace a bucket's stored credentials.\n\nOnly available for `access_key` buckets — `assume_role` buckets store no\ncredentials (manage access via the role's trust policy instead). The new\ncredentials are re-validated against the bucket's existing (immutable) identity\nbefore they are persisted. The credentials version is bumped so cached storage clients rebuild.\n\nArgs:\n    bucket_id: The ID of the bucket to rotate credentials for.\n    params: The new bucket access credentials.\n\nReturns:\n    Bucket: The updated bucket. Credentials are never returned.","operationId":"rotate_bucket_credentials","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"bucket_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the bucket to rotate credentials for","title":"Bucket Id"},"description":"The ID of the bucket to rotate credentials for"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BucketRotateCredentialsParams"}}}},"responses":{"200":{"description":"The bucket with rotated credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bucket"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trace-destinations":{"get":{"tags":["trace_destinations"],"summary":"List trace destinations","description":"List every configured destination, with the outcome of its last delivery.","operationId":"list_trace_destinations","responses":{"200":{"description":"The organization's trace destinations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceDestinationListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"tags":["trace_destinations"],"summary":"Create trace destination","description":"Send this organization's agent traces to an OpenTelemetry backend it owns.\n\nEvery finished agentic search, chat completion, and question-answering run is converted to OTLP spans\nand pushed to the destination: the agent's query, the tool calls it made with\ntheir arguments and results, the model turns with their token usage, and the\nchunks it returned, which is the same trace the dashboard shows. Mixedbread's own\ninternal spans are never exported.\n\n`langfuse` destinations take the host and the project key pair; `otlp` takes\na traces endpoint and its auth headers, which covers any OTLP/HTTP collector.\nThe credentials are checked against the destination before it is stored.","operationId":"create_trace_destination","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceDestinationCreateParams"}}},"required":true},"responses":{"201":{"description":"The connected trace destination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceDestination"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/trace-destinations/{destination_id}":{"get":{"tags":["trace_destinations"],"summary":"Get trace destination","description":"Retrieve one destination, including why its last delivery failed.","operationId":"retrieve_trace_destination","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the trace destination","title":"Destination Id"},"description":"The ID of the trace destination"}],"responses":{"200":{"description":"The trace destination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceDestination"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["trace_destinations"],"summary":"Update trace destination","description":"Change a destination. Credentials are write-only: supply them to rotate, omit them to keep.","operationId":"update_trace_destination","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the trace destination","title":"Destination Id"},"description":"The ID of the trace destination"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceDestinationUpdateParams"}}}},"responses":{"200":{"description":"The updated trace destination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceDestination"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["trace_destinations"],"summary":"Delete trace destination","description":"Stop exporting to a destination and forget its credentials.","operationId":"delete_trace_destination","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the trace destination","title":"Destination Id"},"description":"The ID of the trace destination"}],"responses":{"200":{"description":"Confirmation that the destination was removed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceDestinationDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/stores/{organization_id}/{store_identifier}/reingest":{"post":{"tags":["admin"],"summary":"Reingest all stores","description":"Reingest all stores across all organizations (admin only).\n\nThis endpoint creates StoreFileReingestionJob for each store.\n\nReturns:\n    dict: Confirmation message with count of jobs created.","operationId":"reingest_all_stores","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Organization Id"}},{"name":"store_identifier","in":"path","required":true,"schema":{"type":"string","title":"Store Identifier"}},{"name":"statuses","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/VectorStoreFileStatus"}},{"type":"null"}],"description":"Statuses of files to reingest","title":"Statuses"},"description":"Statuses of files to reingest"},{"name":"billable","in":"query","required":false,"schema":{"type":"boolean","description":"Whether the reingestion is billable to the user","default":false,"title":"Billable"},"description":"Whether the reingestion is billable to the user"}],"responses":{"200":{"description":"Confirmation that reingestion jobs have been created","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/{store_identifier}/events":{"get":{"tags":["stores"],"summary":"List events for a store","description":"List events for a store.\n\nArgs:\n    store_identifier: The ID or name of the store.\n    options: The pagination options.\n\nReturns:\n    StoreEventListResponse: The list of events for the store.","operationId":"list_store_events","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"},{"name":"filter_before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Time to filter events before","title":"Filter Before"},"description":"Time to filter events before"},{"name":"filter_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Time to filter events after","title":"Filter After"},"description":"Time to filter events after"},{"name":"event_type","in":"query","required":true,"schema":{"enum":["ingestion","search","agentic_search","grep","completion","qa"],"type":"string","description":"The type of event to list","examples":["ingestion","search","agentic_search","grep"],"title":"Event Type"},"description":"The type of event to list"}],"responses":{"200":{"description":"The list of events for the store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreEventListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/{store_identifier}/events/histogram":{"post":{"tags":["stores"],"summary":"Get store event histogram","description":"Get histogram of store events over time.\n\nArgs:\n    store_identifier: The ID or name of the store.\n    histogram_params: Parameters for histogram generation.\n\nReturns:\n    StoreEventHistogramResponse: The event histogram.","operationId":"get_store_event_histogram","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreEventHistogramParams"}}}},"responses":{"200":{"description":"Histogram of store events over time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreEventHistogramResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/{store_identifier}/files":{"post":{"tags":["stores"],"summary":"Upload file to store","description":"Upload a file to a store.\n\nArgs:\n    store_identifier: The ID or name of the store.\n    file_add_params: The file to add to the store.\n\nReturns:\n    VectorStoreFile: The uploaded file details.","operationId":"create_store_file","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeprecatedStoreFileUpsertParams","description":"The file to add to the store"}}}},"responses":{"201":{"description":"The uploaded store file details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["stores"],"summary":"[DEPRECATED] List store files","description":"DEPRECATED: Use POST /stores/{store_identifier}/files/list instead","operationId":"list_store_files","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"},{"name":"statuses","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/StoreFileStatus"}},{"type":"null"}],"description":"Status to filter by","title":"Statuses"},"description":"Status to filter by"}],"responses":{"200":{"description":"The list of store files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFileListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/{store_identifier}/files/upload":{"post":{"tags":["stores"],"summary":"Upload file via form to store","description":"Upload a file via form to a store.\n\nArgs:\n    store_identifier: The ID or name of the store.\n    config: The config for the file.\n    metadata: The metadata for the file.\n    file: The file to upload.\n\nReturns:\n    VectorStoreFile: The uploaded file details.","operationId":"upload_store_file","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_store_file"}}}},"responses":{"201":{"description":"The uploaded store file details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/{store_identifier}/files/list":{"post":{"tags":["stores"],"summary":"List store files with metadata filter","description":"List files indexed in a vector store with pagination and metadata filter.\n\nArgs:\n    vector_store_identifier: The ID or name of the vector store\n    pagination: Pagination parameters and metadata filter\n\nReturns:\n    VectorStoreFileListResponse: Paginated list of vector store files","operationId":"list_store_files_with_metadata_filter","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCursorPagination","description":"For pagination"}}}},"responses":{"200":{"description":"List of files in the store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFileListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/{store_identifier}/files/{file_identifier}":{"get":{"tags":["stores"],"summary":"Get store file","description":"Get a file from a store.\n\nArgs:\n    store_identifier: The ID or name of the store.\n    file_id: The ID or name of the file.\n    options: Get file options.\n\nReturns:\n    VectorStoreFile: The file details.","operationId":"retrieve_store_file","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"},{"name":"file_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the file","title":"File Identifier"},"description":"The ID or name of the file"},{"name":"return_chunks","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"array","items":{"type":"integer"}}],"description":"Whether to return the chunks for the file. If a list of integers is provided, only the chunks at the specified indices will be returned.","default":false,"title":"Return Chunks"},"description":"Whether to return the chunks for the file. If a list of integers is provided, only the chunks at the specified indices will be returned."}],"responses":{"200":{"description":"The store file details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["stores"],"summary":"Update store file metadata","description":"Update metadata on a file within a store.\n\nArgs:\n    store_identifier: The ID or name of the store.\n    file_identifier: The ID or name of the file to update.\n    update_params: Metadata update payload.\n\nReturns:\n    StoreFile: The updated file details.","operationId":"update_store_file","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"},{"name":"file_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the file to update","title":"File Identifier"},"description":"The ID or name of the file to update"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFileMetadataUpdateParams","description":"Fields to update for the store file"}}}},"responses":{"200":{"description":"The updated store file details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["stores"],"summary":"Delete store file","description":"Delete a file from a store.\n\nArgs:\n    store_identifier: The ID or name of the store.\n    file_id: The ID or name of the file to delete.\n\nReturns:\n    VectorStoreFileDeleted: The deleted file details.","operationId":"delete_store_file","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"},{"name":"file_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the file to delete","title":"File Identifier"},"description":"The ID or name of the file to delete"}],"responses":{"200":{"description":"The deleted store file details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFileDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/{store_identifier}/rules":{"post":{"tags":["stores"],"summary":"Create search rule","description":"Create a new search rule for a store.\n\nArgs:\n    store_identifier: The ID or name of the store\n    rule_create: Search rule creation parameters\n\nReturns:\n    SearchRuleResponse: The created search rule details","operationId":"create_search_rule","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleCreateParams","description":"The search rule to create"}}}},"responses":{"201":{"description":"The created search rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/{store_identifier}/rules/{rule_id}":{"get":{"tags":["stores"],"summary":"Get a search rule","description":"Get a search rule by ID.\n\nArgs:\n    store_identifier: The ID or name of the store\n    rule_id: The ID of the search rule to retrieve\n\nReturns:\n    SearchRuleResponse: The search rule details","operationId":"retrieve_search_rule","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"},{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the search rule","title":"Rule Id"},"description":"The ID of the search rule"}],"responses":{"200":{"description":"The search rule details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["stores"],"summary":"Update a search rule","description":"Update a search rule by ID.\n\nArgs:\n    store_identifier: The ID or name of the store\n    rule_id: The ID of the search rule to update\n    rule_update: SearchRuleUpdateParams object containing the fields to update\n\nReturns:\n    SearchRuleResponse: The updated search rule details","operationId":"update_search_rule","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"},{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the search rule to update","title":"Rule Id"},"description":"The ID of the search rule to update"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleUpdateParams","description":"The fields to update"}}}},"responses":{"200":{"description":"The updated search rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["stores"],"summary":"Delete a search rule","description":"Delete a search rule by ID.\n\nArgs:\n    store_identifier: The ID or name of the store\n    rule_id: The ID of the search rule to delete\n\nReturns:\n    SearchRuleDeleted: The deleted search rule details","operationId":"delete_search_rule","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"},{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the search rule to delete","title":"Rule Id"},"description":"The ID of the search rule to delete"}],"responses":{"200":{"description":"The deleted search rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/{store_identifier}/rules/{rule_id}/specific":{"delete":{"tags":["stores"],"summary":"Delete a specific rule from rules array","description":"Delete a specific rule from within a search rule's rules array.\n\nArgs:\n    store_identifier: The ID or name of the store\n    rule_id: The ID of the search rule containing the rule to delete\n    rule_delete: The specific rule to delete from the rules array\n\nReturns:\n    SearchRuleSpecificDeleted: Details about the deletion operation","operationId":"delete_specific_search_rule","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"},{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the search rule","title":"Rule Id"},"description":"The ID of the search rule"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleSpecificDeleteParams","description":"The specific rule to delete"}}}},"responses":{"200":{"description":"The updated search rule after deleting specific rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleSpecificDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores":{"post":{"tags":["stores"],"summary":"Create a store","description":"Create a new vector store.\n\nArgs:\n    vector_store_create: VectorStoreCreate object containing the name, description, and metadata.\n\nReturns:\n    VectorStore: The response containing the created vector store details.","operationId":"create_store","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreCreateParams","description":"The store details for creation"}}}},"responses":{"201":{"description":"The details of the created store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["stores"],"summary":"List stores","description":"List all stores with optional search.\n\nArgs:\n    pagination: The pagination options.\n    q: Optional search query to filter vector stores.\n\nReturns:\n    StoreListResponse: The list of stores.","operationId":"list_stores","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"Search query for fuzzy matching over name and description fields","title":"Q"},"description":"Search query for fuzzy matching over name and description fields"}],"responses":{"200":{"description":"The list of stores","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/{store_identifier}":{"get":{"tags":["stores"],"summary":"Get a store","description":"Get a store by ID or name.\n\nArgs:\n    store_identifier: The ID or name of the store to retrieve.\n\nReturns:\n    Store: The response containing the store details.","operationId":"retrieve_store","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"}],"responses":{"200":{"description":"The details of the store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["stores"],"summary":"Update a store","description":"Update a store by ID or name.\n\nArgs:\n    store_identifier: The ID or name of the store to update.\n    store_update: StoreCreate object containing the name, description, and metadata.\n\nReturns:\n    Store: The response containing the updated store details.","operationId":"update_store","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store","title":"Store Identifier"},"description":"The ID or name of the store"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreUpdateParams","description":"The fields to update"}}}},"responses":{"200":{"description":"The details of the updated store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["stores"],"summary":"Delete a store","description":"Delete a store by ID or name.\n\nArgs:\n    store_identifier: The ID or name of the store to delete.\n\nReturns:\n    Store: The response containing the deleted store details.","operationId":"delete_store","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the store to delete","title":"Store Identifier"},"description":"The ID or name of the store to delete"}],"responses":{"200":{"description":"The details of the deleted store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/search":{"post":{"tags":["stores"],"summary":"Perform semantic search across store chunks","description":"Perform semantic search across store chunks.\n\nThis endpoint searches through store chunks using semantic similarity matching.\nIt supports complex search queries with filters and returns relevance-scored results.\nAgentic searches can set `stream=true` to receive live trace events as\nserver-sent events while the search runs, followed by the final search response.\n\nFor the special 'mixedbread/web' store, this endpoint performs web search using\na mixture of different providers instead of semantic search. Web search results are always\nreranked for consistent scoring.\n\nArgs:\n    search_params: Search configuration including:\n        - query text or embeddings\n        - store_identifiers: List of store identifiers to search\n        - file_ids: Optional list of file IDs to filter chunks by (or tuple of list and condition operator)\n        - metadata filters\n        - pagination parameters\n        - sorting preferences\n    _state: API state dependency\n    _ctx: Service context dependency\n\nReturns:\n    StoreSearchResponse containing:\n        - List of matched chunks with relevance scores\n        - Pagination details including total result count\n\nRaises:\n    HTTPException (400): If search parameters are invalid\n    HTTPException (404): If no vector stores are found to search","operationId":"search_store_chunks","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"X-Mxbai-Tool-Ticket","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticket from a chat completion's `tool_tickets`, proving this call runs a tool call that completion asked for. Redeems once, and bills the operation at the discounted agent rate.","title":"X-Mxbai-Tool-Ticket"},"description":"Ticket from a chat completion's `tool_tickets`, proving this call runs a tool call that completion asked for. Redeems once, and bills the operation at the discounted agent rate."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreChunkSearchParams","description":"Search parameters including query text, filters and pagination options"}}}},"responses":{"200":{"description":"List of semantically similar chunks with relevance scores and pagination details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreSearchResponse"}},"text/event-stream":{"schema":{"type":"string"},"example":"data: {\"type\":\"search.started\",\"started_at\":\"2026-08-19T12:00:00Z\",\"query\":\"How does authentication work?\"}\n\ndata: {\"type\":\"search.completed\",\"response\":{\"object\":\"list\",\"data\":[]}}\n\ndata: [DONE]\n\n"}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/grep":{"post":{"tags":["stores"],"summary":"Match store chunks against a regular expression","description":"Match store chunks against a regular expression.\n\nUnlike `/stores/search`, this runs your regex against the literal text of each\nchunk. Use it to find chunks containing a specific token, identifier, error code,\nor literal phrase.\n\ngrep targets a single store and does not support pagination; raise `top_k` to\nretrieve more matches.\n\nArgs:\n    grep_params: Grep configuration including:\n        - pattern: RE2 regular expression matched against chunk text\n        - targets: chunk content groups to match (`text`, `generated`)\n        - case_sensitive: whether the pattern is case-sensitive\n        - store_identifiers: the single store to grep\n        - file_ids: optional list of file IDs to filter chunks by\n        - filters: optional metadata filter conditions\n        - top_k: number of matches to return\n\nReturns:\n    StoreGrepResponse containing the list of matching chunks.\n\nRaises:\n    HTTPException (400): If grep parameters are invalid\n    HTTPException (404): If the store is not found","operationId":"grep_store_chunks","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"X-Mxbai-Tool-Ticket","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ticket from a chat completion's `tool_tickets`, proving this call runs a tool call that completion asked for. Redeems once, and bills the operation at the discounted agent rate.","title":"X-Mxbai-Tool-Ticket"},"description":"Ticket from a chat completion's `tool_tickets`, proving this call runs a tool call that completion asked for. Redeems once, and bills the operation at the discounted agent rate."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreChunkGrepParams","description":"Grep parameters including the regular expression pattern, targets and filters"}}}},"responses":{"200":{"description":"List of chunks whose text matches the pattern","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreGrepResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/stores/list-chunks":{"post":{"tags":["stores"],"summary":"List store chunks by metadata filter and numeric ranking","description":"List store chunks purely by metadata filters — no embeddings, no semantic similarity, no reranking.\n\nUnlike `/stores/search`, this endpoint does not require a query and never runs a vector lookup.\nIt returns chunks whose file and chunk metadata satisfy `filters`, optionally ordered by a\nnumeric metadata field via `sort_by`. Useful for ranked retrieval over numeric attributes\n(e.g. price, BPM) and for reproducing the agentic `filter_chunks` tool externally.\n\nlist-chunks targets a single store and does not support pagination; raise `top_k` to\nretrieve more chunks.\n\nArgs:\n    filter_params: Filter configuration including:\n        - store_identifiers: the single store to filter against\n        - filters: optional metadata filter conditions\n        - file_ids: optional list of file IDs to filter chunks by\n        - sort_by: optional metadata field path, or `(field, ascending)` tuple, for numeric ordering\n        - top_k: number of chunks to return\n\nReturns:\n    StoreListChunksResponse containing the list of matching chunks.\n\nRaises:\n    HTTPException (400): If filter parameters are invalid or multiple stores are passed\n    HTTPException (404): If the store is not found","operationId":"list_store_chunks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreChunkFilterParams","description":"Filter parameters including metadata filters, optional numeric sort, and pagination options"}}},"required":true},"responses":{"200":{"description":"List of chunks matching the metadata filters, optionally ordered by a numeric metadata field","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreListChunksResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/stores/question-answering":{"post":{"tags":["stores"],"summary":"Question answering","operationId":"create_question_answering","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreQAParams","description":"The question answering query"}}},"required":true},"responses":{"200":{"description":"The answer to the question","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreQAResults"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/stores/queries/enhance":{"post":{"tags":["stores"],"summary":"Enhance a search query","description":"Extract metadata filters and ranking preferences from a search query.","operationId":"enhance_query","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryEnhanceParams","description":"Search query and enhancement options"}}},"required":true},"responses":{"200":{"description":"A single enhanced query item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryEnhanceResults"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/stores/metadata-facets":{"post":{"tags":["stores"],"summary":"Get metadata facets","operationId":"get_metadata_facets","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFacetsParams","description":"The parameters for getting metadata facets"}}},"required":true},"responses":{"200":{"description":"The metadata facets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataFacets"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/vector_stores/{vector_store_identifier}/files":{"post":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Upload file to vector store","description":"DEPRECATED: Use POST /stores/{store_identifier}/files instead","operationId":"create_vector_store_file","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeprecatedStoreFileUpsertParams","description":"The file to add to the vector store"}}}},"responses":{"201":{"description":"The uploaded vector store file details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] List vector store files","description":"DEPRECATED: Use POST /stores/{store_identifier}/files/list instead","operationId":"list_vector_store_files","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"},{"name":"statuses","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/StoreFileStatus"}},{"type":"null"}],"description":"Status to filter by","title":"Statuses"},"description":"Status to filter by"}],"responses":{"200":{"description":"The list of vector store files","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFileListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vector_stores/{vector_store_identifier}/files/list":{"post":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] List vector store files with metadata filter","description":"DEPRECATED: Use POST /stores/{store_identifier}/files/list instead","operationId":"list_vector_store_files_with_metadata_filter","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataCursorPagination","description":"For pagination"}}}},"responses":{"200":{"description":"List of files in the vector store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFileListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vector_stores/{vector_store_identifier}/files/{file_id}":{"get":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Get vector store file","description":"DEPRECATED: Use GET /stores/{store_identifier}/files/{file_id} instead","operationId":"retrieve_vector_store_file","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"},{"name":"file_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the file","title":"File Id"},"description":"The ID or name of the file"},{"name":"return_chunks","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to return the chunks for the file","default":false,"title":"Return Chunks"},"description":"Whether to return the chunks for the file"}],"responses":{"200":{"description":"The vector store file details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Delete vector store file","description":"DEPRECATED: Use DELETE /stores/{store_identifier}/files/{file_id} instead","operationId":"delete_vector_store_file","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"},{"name":"file_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the file to delete","title":"File Id"},"description":"The ID or name of the file to delete"}],"responses":{"200":{"description":"The deleted vector store file details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreFileDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vector_stores/{vector_store_identifier}/rules":{"post":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Create search rule","description":"DEPRECATED: Use POST /stores/{store_identifier}/rules instead","operationId":"deprecated_create_search_rule","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleCreateParams","description":"The search rule to create"}}}},"responses":{"201":{"description":"The created search rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vector_stores/{vector_store_identifier}/rules/{rule_id}":{"get":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Get a search rule","description":"DEPRECATED: Use GET /stores/{store_identifier}/rules/{rule_id} instead","operationId":"deprecated_retrieve_search_rule","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"},{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the search rule","title":"Rule Id"},"description":"The ID of the search rule"}],"responses":{"200":{"description":"The search rule details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Update a search rule","description":"DEPRECATED: Use PUT /stores/{store_identifier}/rules/{rule_id} instead","operationId":"deprecated_update_search_rule","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"},{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the search rule to update","title":"Rule Id"},"description":"The ID of the search rule to update"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleUpdateParams","description":"The fields to update"}}}},"responses":{"200":{"description":"The updated search rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Delete a search rule","description":"DEPRECATED: Use DELETE /stores/{store_identifier}/rules/{rule_id} instead","operationId":"deprecated_delete_search_rule","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"},{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the search rule to delete","title":"Rule Id"},"description":"The ID of the search rule to delete"}],"responses":{"200":{"description":"The deleted search rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vector_stores/{vector_store_identifier}/rules/{rule_id}/specific":{"delete":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Delete a specific rule from rules array","description":"DEPRECATED: Use DELETE /stores/{store_identifier}/rules/{rule_id}/specific instead","operationId":"deprecated_delete_specific_search_rule","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"},{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the search rule","title":"Rule Id"},"description":"The ID of the search rule"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleSpecificDeleteParams","description":"The specific rule to delete"}}}},"responses":{"200":{"description":"The updated search rule after deleting specific rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleSpecificDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vector_stores":{"post":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Create a vector store","description":"DEPRECATED: Use POST /stores instead","operationId":"create_vector_store","deprecated":true,"security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreCreateParams","description":"The vector store details for creation"}}}},"responses":{"201":{"description":"The details of the created vector store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStore"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] List vector stores","description":"DEPRECATED: Use GET /stores instead","operationId":"list_vector_stores","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"Search query for fuzzy matching over name and description fields","title":"Q"},"description":"Search query for fuzzy matching over name and description fields"}],"responses":{"200":{"description":"The list of vector stores","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vector_stores/{vector_store_identifier}":{"get":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Get a vector store","description":"DEPRECATED: Use GET /stores/{store_identifier} instead","operationId":"retrieve_vector_store","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"}],"responses":{"200":{"description":"The details of the vector store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStore"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Update a vector store","description":"DEPRECATED: Use PUT /stores/{store_identifier} instead","operationId":"update_vector_store","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store","title":"Vector Store Identifier"},"description":"The ID or name of the vector store"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreUpdateParams","description":"The fields to update"}}}},"responses":{"200":{"description":"The details of the updated vector store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStore"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Delete a vector store","description":"DEPRECATED: Use DELETE /stores/{store_identifier} instead","operationId":"delete_vector_store","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"vector_store_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"description":"The ID or name of the vector store to delete","title":"Vector Store Identifier"},"description":"The ID or name of the vector store to delete"}],"responses":{"200":{"description":"The details of the deleted vector store","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vector_stores/search":{"post":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Perform semantic search across vector store chunks","description":"DEPRECATED: Use POST /stores/search instead","operationId":"search_vector_store_chunks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreChunkSearchParams","description":"Search parameters including query text, filters and pagination options"}}},"required":true},"responses":{"200":{"description":"List of semantically similar chunks with relevance scores and pagination details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreSearchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"ApiKeyAuth":[]}]}},"/v1/vector_stores/question-answering":{"post":{"tags":["deprecated_vector_stores"],"summary":"[DEPRECATED] Question answering","description":"DEPRECATED: Use POST /stores/question-answering instead","operationId":"deprecated_create_question_answering","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreQAParams","description":"The question answering query"}}},"required":true},"responses":{"200":{"description":"The answer to the question","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorStoreQAResults"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"ApiKeyAuth":[]}]}},"/v1/chat/completions":{"post":{"tags":["chat"],"summary":"Create a chat completion","description":"Create a chat completion, optionally grounded in the caller's stores.\n\nSupports the OpenAI Chat Completions API subset: a message list, function\ntools, streaming via server-sent events, and persistence via `store`. A\nrequest without hosted tools is one generation over exactly what was sent:\nno instructions, tools, or turns are added. The `previous_completion_id`\ngroups stored turns into a conversation and restores the full model\ncontext; callers normally send only the new suffix. (`previous_messages`\nand `terminal_tool_name` are deprecated: resend the full edited history in\n`messages` instead.)\nRetrieval is opt-in: declare the hosted store tools (`store_search`,\n`store_grep`, `store_list_chunks`, `store_metadata_facets`, `list_stores`)\nin `tools` to let the model search, grep, filter, and read the caller's\nstores server-side, scoped by each declaration. Those executions are\nreported in the `hosted_tool_calls` extension field (and as extra streaming\nchunks), with chunk results included only for the requested `include` keys.\nA model call to a caller-declared function tool ends the completion with\n`tool_calls` on the choice message (finish_reason `tool_calls`); execute the\nfunctions and continue the conversation by appending the assistant message\nand the matching `tool` messages to the next request.","operationId":"create_chat_completion","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompletionCreateParams","description":"Completion parameters including messages and tools"}}}},"responses":{"200":{"description":"The generated chat completion, or a server-sent event stream of completion chunks","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletion"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["chat"],"summary":"List chat completions","description":"List stored chat completions, one per conversation.\n\nOnly conversation tips are returned: a completion is listed unless another\nstored completion continues from it via previous_completion_id.","operationId":"list_chat_completions","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of completions to return","default":20,"title":"Limit"},"description":"Number of completions to return"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Completion ID to list completions after (older than)","title":"After"},"description":"Completion ID to list completions after (older than)"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"description":"Filter by title (case-insensitive substring)","title":"Q"},"description":"Filter by title (case-insensitive substring)"},{"name":"include","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Extra fields to include, e.g. store_search_call.results, store_grep_call.results, store_list_chunks_call.results or transcript; unsupported values are ignored","title":"Include"},"description":"Extra fields to include, e.g. store_search_call.results, store_grep_call.results, store_list_chunks_call.results or transcript; unsupported values are ignored"}],"responses":{"200":{"description":"The latest completion of each conversation, newest first","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/chat/completions/{completion_id}":{"get":{"tags":["chat"],"summary":"Retrieve a chat completion","description":"Retrieve a previously stored chat completion by ID.","operationId":"retrieve_chat_completion","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"completion_id","in":"path","required":true,"schema":{"type":"string","description":"ID of the chat completion","title":"Completion Id"},"description":"ID of the chat completion"},{"name":"include","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Extra fields to include, e.g. store_search_call.results, store_grep_call.results, store_list_chunks_call.results or transcript; unsupported values are ignored","title":"Include"},"description":"Extra fields to include, e.g. store_search_call.results, store_grep_call.results, store_list_chunks_call.results or transcript; unsupported values are ignored"}],"responses":{"200":{"description":"The stored chat completion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletion"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["chat"],"summary":"Delete a chat completion and its conversation","description":"Delete a stored chat completion together with its entire conversation.\n\nEvery completion connected through previous_completion_id (earlier and\nlater turns, including branches) is deleted; a conversation is removed as\na unit.","operationId":"delete_chat_completion","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"completion_id","in":"path","required":true,"schema":{"type":"string","description":"ID of the chat completion","title":"Completion Id"},"description":"ID of the chat completion"}],"responses":{"200":{"description":"Deletion confirmation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/chat/completions/{completion_id}/turns":{"get":{"tags":["chat"],"summary":"List the turns of a conversation","description":"List every stored completion of the conversation the given one belongs to, oldest first.\n\nEach turn carries its own hosted tool calls, so together with the tip's\nrequest messages the whole conversation reconstructs with full detail.","operationId":"list_chat_completion_turns","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"completion_id","in":"path","required":true,"schema":{"type":"string","description":"ID of the chat completion","title":"Completion Id"},"description":"ID of the chat completion"},{"name":"include","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Extra fields to include, e.g. store_search_call.results, store_grep_call.results, store_list_chunks_call.results or transcript; unsupported values are ignored","title":"Include"},"description":"Extra fields to include, e.g. store_search_call.results, store_grep_call.results, store_list_chunks_call.results or transcript; unsupported values are ignored"}],"responses":{"200":{"description":"Every completion of the conversation, oldest first","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/chat/completions/{completion_id}/messages":{"get":{"tags":["chat"],"summary":"List the messages of a stored chat completion","description":"List the request messages a stored completion was created with.\n\nA stored completion keeps the full conversation it was asked with, so the\nlatest completion of a conversation reconstructs the entire history; the\ncompletion's own answer is its choice message, not part of this list.","operationId":"list_chat_completion_messages","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"completion_id","in":"path","required":true,"schema":{"type":"string","description":"ID of the chat completion","title":"Completion Id"},"description":"ID of the chat completion"}],"responses":{"200":{"description":"The stored request messages, oldest first","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompletionMessageList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/chat/completions/{completion_id}/transcript/close":{"post":{"tags":["chat"],"summary":"Close a stored completion transcript (deprecated)","description":"Deprecated: append a client-side terminal tool's result and answer to a stored transcript.\n\nCompletions end with the model's plain-text answer, so nothing needs\nclosing; harnesses that still end turns with their own terminal tool\nshould resend the full history in `messages` on the next request instead.","operationId":"close_chat_completion_transcript","deprecated":true,"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"completion_id","in":"path","required":true,"schema":{"type":"string","description":"ID of the chat completion","title":"Completion Id"},"description":"ID of the chat completion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompletionTranscriptCloseParams"}}}},"responses":{"200":{"description":"The stored chat completion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletion"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/events":{"get":{"tags":["events"],"summary":"List events","description":"List the organization's events of one type across all stores.\n\nCovers store activity (`search`, `agentic_search`, `grep`, `ingestion`) and\nchat completions (`completion`, one event per Chat Completions or Responses\nturn). Without `store_identifier` the listing spans every store and also\nreturns events tied to none, such as completions that never called a\nstore tool.","operationId":"list_events","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"},{"name":"filter_before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Time to filter events before","title":"Filter Before"},"description":"Time to filter events before"},{"name":"filter_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Time to filter events after","title":"Filter After"},"description":"Time to filter events after"},{"name":"event_type","in":"query","required":true,"schema":{"enum":["ingestion","search","agentic_search","grep","completion","qa"],"type":"string","description":"The type of event to list","examples":["ingestion","search","agentic_search","grep"],"title":"Event Type"},"description":"The type of event to list"},{"name":"store_identifier","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"},{"type":"null"}],"description":"Restrict to one store by ID or name; omit to span every store","title":"Store Identifier"},"description":"Restrict to one store by ID or name; omit to span every store"}],"responses":{"200":{"description":"The organization's events of the requested type, newest first","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/events/metrics":{"post":{"tags":["events"],"summary":"Get event metrics","description":"Aggregate what the events carry beyond their count, per time bucket.\n\nIngestion volume (files, chunks, tokens, bytes, timings), searches by kind\n(semantic, reranked, rewritten, agentic, grep) with latency percentiles and\nagentic token usage, and chat completions with their prompt, cached, and\ncompletion tokens, hosted tool calls, and turn durations. Buckets with no\nevents are omitted.","operationId":"get_event_metrics","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_identifier","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"},{"type":"null"}],"description":"Restrict to one store by ID or name; omit to span every store","title":"Store Identifier"},"description":"Restrict to one store by ID or name; omit to span every store"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventHistogramParams"}}}},"responses":{"200":{"description":"Usage aggregates of the organization's events per time bucket","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventMetricsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/responses":{"post":{"tags":["responses"],"summary":"Create a response","description":"Create a text response with function and Mixedbread hosted-store tools.","operationId":"create_response","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreateParams","description":"OpenAI-compatible response parameters"}}},"required":true},"responses":{"200":{"description":"The generated response, or a semantic server-sent event stream","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/responses/{response_id}":{"get":{"tags":["responses"],"summary":"Retrieve a response","description":"Retrieve a stored response by ID.","operationId":"retrieve_response","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"response_id","in":"path","required":true,"schema":{"type":"string","description":"ID of the response","title":"Response Id"},"description":"ID of the response"},{"name":"include[]","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Additional response fields to include; unsupported values are ignored","title":"Include[]"},"description":"Additional response fields to include; unsupported values are ignored"},{"name":"stream","in":"query","required":false,"schema":{"type":"boolean","description":"Replay the stored response as server-sent events","default":false,"title":"Stream"},"description":"Replay the stored response as server-sent events"},{"name":"starting_after","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Sequence number the caller already received; the replay resumes after it and always ends with the terminal event","title":"Starting After"},"description":"Sequence number the caller already received; the replay resumes after it and always ends with the terminal event"}],"responses":{"200":{"description":"The stored response or a replayed semantic event stream","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["responses"],"summary":"Delete a response","description":"Delete a stored response and its persisted conversation chain.","operationId":"delete_response","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"response_id","in":"path","required":true,"schema":{"type":"string","description":"ID of the response","title":"Response Id"},"description":"ID of the response"}],"responses":{"200":{"description":"Deletion confirmation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/responses/{response_id}/input_items":{"get":{"tags":["responses"],"summary":"List response input items","description":"List the text and function items supplied to a stored response.","operationId":"list_response_input_items","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"response_id","in":"path","required":true,"schema":{"type":"string","description":"ID of the response","title":"Response Id"},"description":"ID of the response"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}},{"name":"order","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","default":"desc","title":"Order"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Input item ID to list after","title":"After"},"description":"Input item ID to list after"}],"responses":{"200":{"description":"The input items used to generate the response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseItemList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/parsing/jobs":{"post":{"tags":["parsing"],"summary":"Start a parse job","description":"Start a parse job for the provided file.\n\nArgs:\n    params: The parameters for creating a parse job.\n\nReturns:\n    The created parsing job.","operationId":"create_parsing_job","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParsingJobCreateParams","description":"The parameters for creating a parse job"}}}},"responses":{"201":{"description":"The created parse job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParsingJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["parsing"],"summary":"List parsing jobs","description":"List parsing jobs with pagination.\n\nArgs:\n    limit: The number of items to return.\n    offset: The number of items to skip.\n\nReturns:\n    List of parsing jobs with pagination.","operationId":"list_parsing_jobs","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"},{"name":"statuses","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/ParsingJobStatus"}},{"type":"null"}],"description":"Status to filter by","title":"Statuses"},"description":"Status to filter by"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"Search query to filter by","title":"Q"},"description":"Search query to filter by"}],"responses":{"200":{"description":"List of parsing jobs with pagination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParsingJobListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/parsing/jobs/{job_id}":{"get":{"tags":["parsing"],"summary":"Get parsing job result","description":"Get detailed information about a specific parse job.\n\nArgs:\n    job_id: The ID of the parse job.\n\nReturns:\n    Detailed information about the parse job.","operationId":"retrieve_parsing_job","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the parse job to retrieve","title":"Job Id"},"description":"The ID of the parse job to retrieve"}],"responses":{"200":{"description":"Detailed information about a parsing job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParsingJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["parsing"],"summary":"Cancel a parsing job","description":"Cancel a specific parse job.\n\nArgs:\n    job_id: The ID of the parse job to cancel.\n\nReturns:\n    The cancelled parsing job.","operationId":"cancel_parsing_job","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the parse job to cancel","title":"Job Id"},"description":"The ID of the parse job to cancel"}],"responses":{"200":{"description":"The cancelled parse job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParsingJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["parsing"],"summary":"Delete a parsing job","description":"Delete a specific parse job.\n\nArgs:\n    job_id: The ID of the parse job to delete.\n\nReturns:\n    The deleted parsing job.","operationId":"delete_parsing_job","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the parse job to delete","title":"Job Id"},"description":"The ID of the parse job to delete"}],"responses":{"200":{"description":"The deleted parse job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParsingJobDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/extractions/jobs":{"post":{"tags":["extractions"],"summary":"Start an extraction job","description":"Start an extraction job for the provided file and schema.\n\nArgs:\n    params: The parameters for creating an extraction job.\n\nReturns:\n    The created extraction job.","operationId":"create_extraction_job","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractJobCreateParams","description":"The parameters for creating an extraction job"}}},"required":true},"responses":{"200":{"description":"The created extraction job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractionJob"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/extractions/jobs/{job_id}":{"get":{"tags":["extractions"],"summary":"Get extraction job result","description":"Get detailed information about a specific extraction job.\n\nArgs:\n    job_id: The ID of the extraction job.\n\nReturns:\n    Detailed information about the extraction job.","operationId":"retrieve_extraction_job","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the extraction job to retrieve","title":"Job Id"},"description":"The ID of the extraction job to retrieve"}],"responses":{"200":{"description":"Detailed information about an extraction job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractionJob"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/extractions/schema":{"post":{"tags":["extractions"],"summary":"Create a schema","description":"Create a schema with the provided parameters.\n\nArgs:\n    params: The parameters for creating a schema.\n\nReturns:\n    The created schema.","operationId":"create_schema","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonSchemaCreateParams","description":"The parameters for creating a schema"}}},"required":true},"responses":{"200":{"description":"The created schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedJsonSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/extractions/schema/enhance":{"post":{"tags":["extractions"],"summary":"Enhance a schema","description":"Enhance a schema by enriching the descriptions to aid extraction.\n\nArgs:\n    params: The parameters for enhancing a schema.\n\nReturns:\n    The enhanced schema.","operationId":"enhance_schema","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonSchemaEnhanceParams","description":"The parameters for enhancing a schema"}}},"required":true},"responses":{"200":{"description":"The enhanced schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnhancedJsonSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/extractions/schema/validate":{"post":{"tags":["extractions"],"summary":"Validate a schema","description":"Validate a schema.\n\nArgs:\n    params: The parameters for validating a schema.\n\nReturns:\n    The validation result.","operationId":"validate_schema","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonSchemaValidateParams","description":"The parameters for validating a schema"}}},"required":true},"responses":{"200":{"description":"The validation result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatedJsonSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/extractions/content":{"post":{"tags":["extractions"],"summary":"Extract content from a string","description":"Extract content from a string using the provided schema.\n\nArgs:\n    params: The parameters for extracting content from a string.\n\nReturns:\n    The extracted content.","operationId":"extract_content","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractContentCreateParams","description":"The parameters for extracting content from a string"}}},"required":true},"responses":{"200":{"description":"The extracted content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractionResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/embeddings":{"post":{"summary":"Create embeddings for text and images","description":"Create embeddings for text or images using the specified model, encoding format, and normalization.\n\nArgs:\n    params: The parameters for creating embeddings.\n\nReturns:\n    EmbeddingCreateResponse: The response containing the embeddings.","operationId":"create_embeddings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingCreateParams","description":"The parameters for creating embeddings"}}},"required":true},"responses":{"200":{"description":"The embeddings for the input text or image","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/reranking":{"post":{"summary":"Rerank different kind of documents for a given query","description":"Rerank different kind of documents for a given query.\n\nArgs:\n    params: RerankParams: The parameters for reranking.\n\nReturns:\n    RerankResponse: The reranked documents for the input query.","operationId":"rerank","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RerankParams","description":"The parameters for reranking"}}},"required":true},"responses":{"200":{"description":"The reranked documents for the input query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RerankResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/data_sources/{data_source_id}/connectors":{"post":{"tags":["data_sources","data_sources"],"summary":"Create a new connector","description":"Create a new connector.\n\nArgs:\n    data_source_id: The ID of the data source to create a connector for.\n    params: The connector to create.\n\nReturns:\n    The created connector.","operationId":"create_connector","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"data_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the data source to create a connector for","title":"Data Source Id"},"description":"The ID of the data source to create a connector for"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSourceConnectorCreateParams","description":"The connector to create"}}}},"responses":{"201":{"description":"The created connector","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSourceConnector"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["data_sources","data_sources"],"summary":"Get all connectors for a data source","description":"Get all connectors for a data source.\n\nArgs:\n    data_source_id: The ID of the data source to get connectors for.\n    pagination: The pagination options.\n\nReturns:\n    The list of connectors.","operationId":"list_connectors","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"data_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the data source to get connectors for","title":"Data Source Id"},"description":"The ID of the data source to get connectors for"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"}],"responses":{"200":{"description":"The list of connectors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data_sources/{data_source_id}/connectors/{connector_id}":{"get":{"tags":["data_sources","data_sources"],"summary":"Get a connector by ID","description":"Get a connector by ID.\n\nArgs:\n    data_source_id: The ID of the data source to get a connector for.\n    connector_id: The ID of the connector to get.\n\nReturns:\n    The connector.","operationId":"get_connector","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"data_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the data source to get a connector for","title":"Data Source Id"},"description":"The ID of the data source to get a connector for"},{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the connector to get","title":"Connector Id"},"description":"The ID of the connector to get"}],"responses":{"200":{"description":"The connector","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSourceConnector"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["data_sources","data_sources"],"summary":"Update a connector","description":"Update a connector.\n\nArgs:\n    data_source_id: The ID of the data source to update a connector for.\n    connector_id: The ID of the connector to update.\n    params: The connector to update.\n\nReturns:\n    The updated connector.","operationId":"update_connector","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"data_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the data source to update a connector for","title":"Data Source Id"},"description":"The ID of the data source to update a connector for"},{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the connector to update","title":"Connector Id"},"description":"The ID of the connector to update"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSourceConnectorUpdateParams","description":"The connector to update"}}}},"responses":{"200":{"description":"The updated connector","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSourceConnector"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["data_sources","data_sources"],"summary":"Delete a connector","description":"Delete a connector.\n\nArgs:\n    data_source_id: The ID of the data source to delete a connector for.\n    connector_id: The ID of the connector to delete.\n\nReturns:\n    The deleted connector.","operationId":"delete_connector","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"data_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the data source to delete a connector for","title":"Data Source Id"},"description":"The ID of the data source to delete a connector for"},{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the connector to delete","title":"Connector Id"},"description":"The ID of the connector to delete"}],"responses":{"200":{"description":"The deleted connector","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSourceConnectorDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data_sources/":{"post":{"tags":["data_sources"],"summary":"Create a new data source","description":"Create a new data source.\n\nArgs:\n    params: The data source to create.\n\nReturns:\n    The created data source.","operationId":"create_data_source","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/NotionDataSourceCreateOrUpdateParams"},{"$ref":"#/components/schemas/LinearDataSourceCreateOrUpdateParams"}],"description":"The data source to create","title":"Params"}}}},"responses":{"201":{"description":"The created data source","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSource"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["data_sources"],"summary":"Get all data sources","description":"Get all data sources.\n\nReturns:\n    The list of data sources.","operationId":"list_data_sources","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"}],"responses":{"200":{"description":"The list of data sources","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSourceListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data_sources/{data_source_id}":{"get":{"tags":["data_sources"],"summary":"Get a data source by ID","description":"Get a data source by ID.\n\nArgs:\n    data_source_id: The ID of the data source to fetch.\n\nReturns:\n    The data source.","operationId":"get_data_source","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"data_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the data source to fetch","title":"Data Source Id"},"description":"The ID of the data source to fetch"}],"responses":{"200":{"description":"The data source","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSource"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["data_sources"],"summary":"Update a data source","description":"Update a data source.\n\nArgs:\n    data_source_id: The ID of the data source to update.\n    params: The data source to update.\n\nReturns:\n    The updated data source.","operationId":"update_data_source","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"data_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the data source to update","title":"Data Source Id"},"description":"The ID of the data source to update"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/NotionDataSourceCreateOrUpdateParams"},{"$ref":"#/components/schemas/LinearDataSourceCreateOrUpdateParams"}],"description":"The data source to update","title":"Params"}}}},"responses":{"200":{"description":"The updated data source","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSource"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["data_sources"],"summary":"Delete a data source","description":"Delete a data source.\n\nArgs:\n    data_source_id: The ID of the data source to delete.","operationId":"delete_data_source","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"data_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the data source to delete","title":"Data Source Id"},"description":"The ID of the data source to delete"}],"responses":{"200":{"description":"The ID of the deleted data source and if it was deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSourceDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data_sources/{data_source_id}/oauth2/authorize":{"get":{"tags":["data_sources"],"summary":"Authorize a data source","description":"Start OAuth2 authorization flow for a data source.\n\nInitiates the OAuth2 authorization process by redirecting the user\nto the external service's authorization page. After authorization,\nthe user will be redirected back to the oauth2_callback endpoint.\n\nArgs:\n    data_source_id: The ID of the data source to authorize\n\nReturns:\n    Redirect to the OAuth2 provider's authorization page\n\nRaises:\n    DataSourceNotFoundError: When data source doesn't exist\n    DataSourceAuthTypeNotSupportedError: When OAuth2 is not supported for this data source type","operationId":"authorize_data_source","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"data_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the data source to authorize","title":"Data Source Id"},"description":"The ID of the data source to authorize"}],"responses":{"200":{"description":"The authorization URL","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data_sources/oauth2/callback":{"get":{"tags":["data_sources"],"summary":"OAuth2 callback for data source authorization","description":"OAuth2 callback endpoint for completing data source authorization.\n\nThis endpoint is called by OAuth2 providers after user authorization.\nIt exchanges the authorization code for access tokens and stores them\nsecurely for the data source.\n\nArgs:\n    state: OAuth2 state parameter used for CSRF protection\n    code: Authorization code from the OAuth2 provider\n    error: OAuth2 error code if authorization was denied or failed\n    error_description: Human-readable description of the error\n\nReturns:\n    Redirect to the data source details page on success\n\nRaises:\n    OAuth2TokenExchangeError: When OAuth2 provider returns an error\n    InvalidStateError: When state parameter is invalid or expired","operationId":"oauth2_callback","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","description":"OAuth2 state parameter for CSRF protection","title":"State"},"description":"OAuth2 state parameter for CSRF protection"},{"name":"code","in":"query","required":true,"schema":{"type":"string","description":"Authorization code from OAuth2 provider","title":"Code"},"description":"Authorization code from OAuth2 provider"},{"name":"error","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"OAuth2 error code if authorization failed","title":"Error"},"description":"OAuth2 error code if authorization failed"},{"name":"error_description","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Human-readable error description","title":"Error Description"},"description":"Human-readable error description"}],"responses":{"307":{"description":"Successful authorization, redirect to data source","content":{"application/json":{"schema":{}}}},"400":{"description":"OAuth2 error or invalid parameters"},"404":{"description":"Invalid or expired state parameter"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/providers":{"get":{"tags":["integrations"],"summary":"List integration providers","description":"List supported integration provider manifests.","operationId":"list_integration_providers","responses":{"200":{"description":"The supported integration providers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationProviderListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/installations":{"get":{"tags":["integrations"],"summary":"List integration installations","description":"List installed provider integrations for the current organization.","operationId":"list_integration_installations","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of items to return per page (1-100)","examples":[10,20,50],"default":20,"title":"Limit"},"description":"Maximum number of items to return per page (1-100)"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"After"},"description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response."},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="],"title":"Before"},"description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response."},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count in response (expensive operation)","examples":[false,true],"default":false,"title":"Include Total"},"description":"Whether to include total count in response (expensive operation)"}],"responses":{"200":{"description":"The installed provider integrations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/data-sources":{"get":{"tags":["integrations"],"summary":"List connected data sources","description":"List every connected data source across providers for the current organization.","operationId":"list_data_source_installations","responses":{"200":{"description":"Connected data sources across providers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSourceInstallationListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/slack/installations":{"get":{"tags":["integrations"],"summary":"List connected Slack workspaces","description":"List connected Slack workspaces with their selected ingestion channel counts.","operationId":"list_slack_installations","responses":{"200":{"description":"Connected Slack workspaces for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackInstallationOverviewListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/slack/channels":{"get":{"tags":["integrations"],"summary":"List Slack channels for store ingestion","description":"List one page of public Slack channels and whether each channel is selected for store ingestion.","operationId":"get_slack_channel_selection","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Slack installation ID","title":"Installation Id"},"description":"Slack installation ID"},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pagination cursor from a previous page","title":"Cursor"},"description":"Pagination cursor from a previous page"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Channels to return per page","default":200,"title":"Limit"},"description":"Channels to return per page"},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"description":"Filter channels by name","title":"Query"},"description":"Filter channels by name"}],"responses":{"200":{"description":"Slack channel selection for a workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackChannelSelectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["integrations"],"summary":"Update Slack channels for store ingestion","description":"Replace the Slack channels selected for ingestion into a store.","operationId":"update_slack_channel_selection","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackChannelSelectionUpdateParams","description":"The Slack channel selection"}}}},"responses":{"200":{"description":"Updated Slack channel selection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackChannelSelectionUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/slack/channels/sync":{"post":{"tags":["integrations"],"summary":"Sync selected Slack channels","description":"Queue historical ingestion for selected Slack channels.","operationId":"sync_slack_channels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackChannelSyncParams","description":"The Slack channels to sync"}}},"required":true},"responses":{"200":{"description":"Queued Slack channel sync jobs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackChannelSyncResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/slack/channels/refresh":{"post":{"tags":["integrations"],"summary":"Refresh the Slack channel catalog","description":"Queue a fresh walk of the workspace's channels into the local catalog.","operationId":"refresh_slack_channel_catalog","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Slack installation ID","title":"Installation Id"},"description":"Slack installation ID"}],"responses":{"200":{"description":"Slack channel selection with a refreshed catalog sync in progress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackChannelSelectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/slack/installations/{installation_id}":{"delete":{"tags":["integrations"],"summary":"Disconnect Slack","description":"Disconnect a specific Slack installation from the current organization.","operationId":"disconnect_slack_installation","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Slack installation ID","title":"Installation Id"},"description":"Slack installation ID"}],"responses":{"200":{"description":"The deleted Slack installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/slack/oauth/authorize":{"get":{"tags":["integrations"],"summary":"Authorize Slack integration","description":"Start Slack OAuth for the current organization.","operationId":"authorize_slack_integration","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional ingestion store name","title":"Store Name"},"description":"Optional ingestion store name"},{"name":"metadata_contextualization","in":"query","required":false,"schema":{"type":"boolean","description":"Contextualize chunks with the connector's curated metadata fields","default":true,"title":"Metadata Contextualization"},"description":"Contextualize chunks with the connector's curated metadata fields"},{"name":"file_contextualization","in":"query","required":false,"schema":{"type":"boolean","description":"Generate an LLM context for each chunk situating it within the full document","default":true,"title":"File Contextualization"},"description":"Generate an LLM context for each chunk situating it within the full document"},{"name":"ingestion_mode","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StoreFileParsingStrategy","description":"Parsing strategy for imported files","default":"high_quality"},"description":"Parsing strategy for imported files"}],"responses":{"307":{"description":"Redirect to Slack OAuth","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/slack/manifest":{"get":{"tags":["integrations"],"summary":"Get Slack app manifest","description":"Return the Slack app manifest pre-filled with this deployment's public URLs.","operationId":"get_slack_manifest","responses":{"200":{"description":"Slack app manifest for bring-your-own-app setup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackManifestResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/slack/connect":{"post":{"tags":["integrations"],"summary":"Connect Slack with a customer-provided app","description":"Connect a Slack workspace using a customer-created app's bot token and signing secret.","operationId":"connect_slack_manual","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackManualConnectBody","description":"Slack bot token and signing secret"}}},"required":true},"responses":{"200":{"description":"The connected Slack installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/slack/oauth/callback":{"get":{"tags":["integrations"],"summary":"Slack OAuth callback","description":"Complete Slack OAuth and persist the workspace installation.","operationId":"slack_oauth_callback","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","description":"Slack OAuth state","title":"State"},"description":"Slack OAuth state"},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Slack OAuth authorization code","title":"Code"},"description":"Slack OAuth authorization code"},{"name":"error","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Slack OAuth error","title":"Error"},"description":"Slack OAuth error"}],"responses":{"307":{"description":"Redirect after Slack installation","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/slack/events":{"post":{"tags":["integrations"],"summary":"Slack events webhook","description":"Receive signed Slack Events API requests.","operationId":"handle_slack_event","responses":{"200":{"description":"Slack event acknowledgement","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/slack/commands":{"post":{"tags":["integrations"],"summary":"Slack slash command webhook","description":"Receive signed Slack slash command requests.","operationId":"handle_slack_command","responses":{"200":{"description":"Slack command acknowledgement","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/google_drive/oauth/authorize":{"get":{"tags":["integrations"],"summary":"Authorize Google Drive integration","description":"Start Google Drive OAuth for the current organization.","operationId":"authorize_google_drive_integration","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional ingestion store name","title":"Store Name"},"description":"Optional ingestion store name"},{"name":"metadata_contextualization","in":"query","required":false,"schema":{"type":"boolean","description":"Contextualize chunks with the connector's curated metadata fields","default":true,"title":"Metadata Contextualization"},"description":"Contextualize chunks with the connector's curated metadata fields"},{"name":"file_contextualization","in":"query","required":false,"schema":{"type":"boolean","description":"Generate an LLM context for each chunk situating it within the full document","default":false,"title":"File Contextualization"},"description":"Generate an LLM context for each chunk situating it within the full document"},{"name":"ingestion_mode","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StoreFileParsingStrategy","description":"Parsing strategy for imported files","default":"fast"},"description":"Parsing strategy for imported files"}],"responses":{"307":{"description":"Redirect to Google OAuth","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/google_drive/oauth/callback":{"get":{"tags":["integrations"],"summary":"Google Drive OAuth callback","description":"Complete Google Drive OAuth and persist the installation.","operationId":"google_drive_oauth_callback","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","description":"Google OAuth state","title":"State"},"description":"Google OAuth state"},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Google OAuth authorization code","title":"Code"},"description":"Google OAuth authorization code"},{"name":"error","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Google OAuth error","title":"Error"},"description":"Google OAuth error"}],"responses":{"307":{"description":"Redirect after Google Drive installation","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/google_drive/installations":{"get":{"tags":["integrations"],"summary":"List connected Google Drive accounts","description":"List connected Google Drive accounts with their selected folder counts.","operationId":"list_google_drive_installations","responses":{"200":{"description":"Connected Google Drive accounts for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDriveInstallationOverviewListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/google_drive/folders":{"get":{"tags":["integrations"],"summary":"List Google Drive folders for store ingestion","description":"List Google Drive files and folders and whether each is selected for store ingestion.","operationId":"get_google_drive_folder_selection","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Google Drive installation ID","title":"Installation Id"},"description":"Google Drive installation ID"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Google Drive folder ID to browse","title":"Folder Id"},"description":"Google Drive folder ID to browse"}],"responses":{"200":{"description":"Google Drive folder selection for an account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDriveFolderSelectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["integrations"],"summary":"Update Google Drive folders for store ingestion","description":"Replace the Google Drive folders selected for ingestion into a store.","operationId":"update_google_drive_folder_selection","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDriveFolderSelectionUpdateParams","description":"The Google Drive folder selection"}}}},"responses":{"200":{"description":"Updated Google Drive folder selection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDriveFolderSelectionUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/google_drive/sync":{"post":{"tags":["integrations"],"summary":"Sync a Google Drive connector","description":"Queue an incremental Google Drive change sync.","operationId":"sync_google_drive","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDriveSyncParams","description":"The Google Drive connector to sync"}}},"required":true},"responses":{"200":{"description":"Queued Google Drive sync","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDriveSyncResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/google_drive/installations/{installation_id}":{"delete":{"tags":["integrations"],"summary":"Disconnect Google Drive","description":"Disconnect a specific Google Drive installation from the current organization.","operationId":"disconnect_google_drive_installation","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Google Drive installation ID","title":"Installation Id"},"description":"Google Drive installation ID"}],"responses":{"200":{"description":"The deleted Google Drive installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/google_drive/installations/{installation_id}/config":{"put":{"tags":["integrations"],"summary":"Update Google Drive data source config","description":"Update a Google Drive data source config (sync entire Drive). Enabling syncs the whole Drive.","operationId":"update_google_drive_installation_config","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Google Drive installation ID","title":"Installation Id"},"description":"Google Drive installation ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDriveInstallationConfigUpdateBody","description":"The Google Drive data source config"}}}},"responses":{"200":{"description":"Updated Google Drive folder selection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleDriveFolderSelectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/google_drive/events":{"post":{"tags":["integrations"],"summary":"Google Drive push webhook","description":"Receive Google Drive push notifications and enqueue an incremental sync.","operationId":"google_drive_events","responses":{"200":{"description":"Google Drive change notification acknowledgement","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/gmail/oauth/authorize":{"get":{"tags":["integrations"],"summary":"Authorize Gmail integration","description":"Start Gmail OAuth for the current organization.","operationId":"authorize_gmail_integration","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional ingestion store name","title":"Store Name"},"description":"Optional ingestion store name"},{"name":"installation_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Gmail installation ID when reconnecting an existing installation","title":"Installation Id"},"description":"Gmail installation ID when reconnecting an existing installation"},{"name":"metadata_contextualization","in":"query","required":false,"schema":{"type":"boolean","description":"Contextualize chunks with the connector's curated metadata fields","default":true,"title":"Metadata Contextualization"},"description":"Contextualize chunks with the connector's curated metadata fields"},{"name":"file_contextualization","in":"query","required":false,"schema":{"type":"boolean","description":"Generate an LLM context for each chunk situating it within the full document","default":true,"title":"File Contextualization"},"description":"Generate an LLM context for each chunk situating it within the full document"},{"name":"ingestion_mode","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StoreFileParsingStrategy","description":"Parsing strategy for imported files","default":"high_quality"},"description":"Parsing strategy for imported files"}],"responses":{"307":{"description":"Redirect to Google OAuth","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/gmail/oauth/callback":{"get":{"tags":["integrations"],"summary":"Gmail OAuth callback","description":"Complete Gmail OAuth and persist the installation.","operationId":"gmail_oauth_callback","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","description":"Google OAuth state","title":"State"},"description":"Google OAuth state"},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Google OAuth authorization code","title":"Code"},"description":"Google OAuth authorization code"},{"name":"error","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Google OAuth error","title":"Error"},"description":"Google OAuth error"}],"responses":{"307":{"description":"Redirect after Gmail installation","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/gmail/installations":{"get":{"tags":["integrations"],"summary":"List connected Gmail accounts","description":"List connected Gmail accounts with their selected label counts.","operationId":"list_gmail_installations","responses":{"200":{"description":"Connected Gmail accounts for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmailInstallationOverviewListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/gmail/labels":{"get":{"tags":["integrations"],"summary":"List Gmail labels for store ingestion","description":"List Gmail labels and whether each label is selected for store ingestion.","operationId":"get_gmail_label_selection","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Gmail installation ID","title":"Installation Id"},"description":"Gmail installation ID"}],"responses":{"200":{"description":"Gmail label selection for an account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmailLabelSelectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["integrations"],"summary":"Update Gmail labels for store ingestion","description":"Update Gmail labels and optional Gmail search query selected for ingestion into a store.","operationId":"update_gmail_label_selection","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmailLabelSelectionUpdateParams","description":"The Gmail label selection"}}}},"responses":{"200":{"description":"Updated Gmail label selection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmailLabelSelectionUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/gmail/sync":{"post":{"tags":["integrations"],"summary":"Sync a Gmail connector","description":"Validate the Gmail connector and return whether a sync was queued.","operationId":"sync_gmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmailSyncParams","description":"The Gmail connector to sync"}}},"required":true},"responses":{"202":{"description":"Gmail sync state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmailSyncResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/gmail/installations/{installation_id}":{"delete":{"tags":["integrations"],"summary":"Disconnect Gmail","description":"Disconnect a specific Gmail installation from the current organization.","operationId":"disconnect_gmail_installation","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Gmail installation ID","title":"Installation Id"},"description":"Gmail installation ID"}],"responses":{"200":{"description":"The deleted Gmail installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/granola/connect":{"post":{"tags":["integrations"],"summary":"Connect Granola with an API key","description":"Connect Granola using a customer-provided API key.","operationId":"connect_granola_manual","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GranolaManualConnectBody","description":"Granola API key"}}},"required":true},"responses":{"200":{"description":"The connected Granola installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/granola/installations":{"get":{"tags":["integrations"],"summary":"List connected Granola API keys","description":"List connected Granola installations with selected folder counts.","operationId":"list_granola_installations","responses":{"200":{"description":"Connected Granola API keys for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GranolaInstallationOverviewListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/granola/folders":{"get":{"tags":["integrations"],"summary":"List Granola folders for store ingestion","description":"List Granola folders and whether each is selected for store ingestion.","operationId":"get_granola_folder_selection","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Granola installation ID","title":"Installation Id"},"description":"Granola installation ID"},{"name":"folder_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Granola folder ID to browse","title":"Folder Id"},"description":"Granola folder ID to browse"}],"responses":{"200":{"description":"Granola folder selection for an API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GranolaFolderSelectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["integrations"],"summary":"Update Granola folders for store ingestion","description":"Replace the Granola folders selected for ingestion into a store.","operationId":"update_granola_folder_selection","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GranolaFolderSelectionUpdateParams","description":"The Granola folder selection"}}}},"responses":{"200":{"description":"Updated Granola folder selection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GranolaFolderSelectionUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/granola/sync":{"post":{"tags":["integrations"],"summary":"Sync a Granola connector","description":"Queue a manual sync for selected Granola folders.","operationId":"sync_granola","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GranolaSyncParams","description":"The Granola connector to sync"}}},"required":true},"responses":{"200":{"description":"Queued Granola sync","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GranolaSyncResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/granola/catalog/refresh":{"post":{"tags":["integrations"],"summary":"Refresh a Granola resource catalog","description":"Refresh folder and note metadata without triggering ingestion.","operationId":"refresh_granola_catalog","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GranolaSyncParams","description":"The Granola installation to refresh"}}},"required":true},"responses":{"200":{"description":"Queued Granola catalog refresh","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GranolaSyncResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/granola/schedule":{"put":{"tags":["integrations"],"summary":"Update Granola sync schedule","description":"Update the periodic sync schedule for a Granola installation.","operationId":"update_granola_sync_schedule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GranolaSyncScheduleUpdateParams","description":"The Granola sync schedule"}}},"required":true},"responses":{"200":{"description":"Updated Granola sync schedule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GranolaSyncScheduleUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/granola/installations/{installation_id}":{"delete":{"tags":["integrations"],"summary":"Disconnect Granola","description":"Disconnect a specific Granola installation from the current organization.","operationId":"disconnect_granola_installation","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Granola installation ID","title":"Installation Id"},"description":"Granola installation ID"}],"responses":{"200":{"description":"The deleted Granola installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/linear/oauth/authorize":{"get":{"tags":["integrations"],"summary":"Authorize Linear integration","description":"Start Linear OAuth for the current organization.","operationId":"authorize_linear_integration","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional ingestion store name","title":"Store Name"},"description":"Optional ingestion store name"},{"name":"metadata_contextualization","in":"query","required":false,"schema":{"type":"boolean","description":"Contextualize chunks with the connector's curated metadata fields","default":true,"title":"Metadata Contextualization"},"description":"Contextualize chunks with the connector's curated metadata fields"},{"name":"file_contextualization","in":"query","required":false,"schema":{"type":"boolean","description":"Generate an LLM context for each chunk situating it within the full document","default":true,"title":"File Contextualization"},"description":"Generate an LLM context for each chunk situating it within the full document"},{"name":"ingestion_mode","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StoreFileParsingStrategy","description":"Parsing strategy for imported files","default":"high_quality"},"description":"Parsing strategy for imported files"}],"responses":{"307":{"description":"Redirect to Linear OAuth","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/linear/oauth/callback":{"get":{"tags":["integrations"],"summary":"Linear OAuth callback","description":"Complete Linear OAuth and persist the installation.","operationId":"linear_oauth_callback","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","description":"Linear OAuth state","title":"State"},"description":"Linear OAuth state"},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Linear OAuth authorization code","title":"Code"},"description":"Linear OAuth authorization code"},{"name":"error","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Linear OAuth error","title":"Error"},"description":"Linear OAuth error"}],"responses":{"307":{"description":"Redirect after Linear installation","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/linear/events":{"post":{"tags":["integrations"],"summary":"Linear events webhook","description":"Receive signed Linear webhook requests.","operationId":"handle_linear_event","responses":{"200":{"description":"Linear event acknowledgement","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/linear/installations":{"get":{"tags":["integrations"],"summary":"List connected Linear workspaces","description":"List connected Linear workspaces with their selected team counts.","operationId":"list_linear_installations","responses":{"200":{"description":"Connected Linear workspaces for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinearInstallationOverviewListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/linear/teams":{"get":{"tags":["integrations"],"summary":"List Linear teams for store ingestion","description":"List Linear teams and whether each team is selected for store ingestion.","operationId":"get_linear_team_selection","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Linear installation ID","title":"Installation Id"},"description":"Linear installation ID"}],"responses":{"200":{"description":"Linear team selection for a workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinearTeamSelectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["integrations"],"summary":"Update Linear teams for store ingestion","description":"Replace the Linear teams selected for ingestion into a store.","operationId":"update_linear_team_selection","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinearTeamSelectionUpdateParams","description":"The Linear team selection"}}}},"responses":{"200":{"description":"Updated Linear team selection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinearTeamSelectionUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/linear/sync":{"post":{"tags":["integrations"],"summary":"Sync a Linear connector","description":"Queue Linear issue ingestion for selected teams.","operationId":"sync_linear","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinearSyncParams","description":"The Linear connector to sync"}}},"required":true},"responses":{"200":{"description":"Queued Linear sync","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinearSyncResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/linear/installations/{installation_id}":{"delete":{"tags":["integrations"],"summary":"Disconnect Linear","description":"Disconnect a specific Linear installation from the current organization.","operationId":"disconnect_linear_installation","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Linear installation ID","title":"Installation Id"},"description":"Linear installation ID"}],"responses":{"200":{"description":"The deleted Linear installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/notion/oauth/authorize":{"get":{"tags":["integrations"],"summary":"Authorize Notion integration","description":"Start Notion OAuth for the current organization.","operationId":"authorize_notion_integration","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"store_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional ingestion store name","title":"Store Name"},"description":"Optional ingestion store name"},{"name":"metadata_contextualization","in":"query","required":false,"schema":{"type":"boolean","description":"Contextualize chunks with the connector's curated metadata fields","default":true,"title":"Metadata Contextualization"},"description":"Contextualize chunks with the connector's curated metadata fields"},{"name":"file_contextualization","in":"query","required":false,"schema":{"type":"boolean","description":"Generate an LLM context for each chunk situating it within the full document","default":true,"title":"File Contextualization"},"description":"Generate an LLM context for each chunk situating it within the full document"},{"name":"ingestion_mode","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StoreFileParsingStrategy","description":"Parsing strategy for imported files","default":"high_quality"},"description":"Parsing strategy for imported files"}],"responses":{"307":{"description":"Redirect to Notion OAuth","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/notion/connect":{"post":{"tags":["integrations"],"summary":"Connect Notion with an internal integration token","description":"Connect a Notion workspace using a customer-created internal integration token (no OAuth).","operationId":"connect_notion_manual","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotionManualConnectBody","description":"Notion internal integration token"}}},"required":true},"responses":{"200":{"description":"The connected Notion installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/notion/oauth/callback":{"get":{"tags":["integrations"],"summary":"Notion OAuth callback","description":"Complete Notion OAuth and persist the installation.","operationId":"notion_oauth_callback","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"state","in":"query","required":true,"schema":{"type":"string","description":"Notion OAuth state","title":"State"},"description":"Notion OAuth state"},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Notion OAuth authorization code","title":"Code"},"description":"Notion OAuth authorization code"},{"name":"error","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Notion OAuth error","title":"Error"},"description":"Notion OAuth error"}],"responses":{"307":{"description":"Redirect after Notion installation","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/notion/events":{"post":{"tags":["integrations"],"summary":"Notion events webhook","description":"Shared Notion webhook (OAuth/public app): one subscription, so the handshake has no workspace scope.","operationId":"handle_notion_event","responses":{"200":{"description":"Notion event acknowledgement","content":{"application/json":{"schema":{}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/notion/events/{workspace_id}":{"post":{"tags":["integrations"],"summary":"Notion events webhook for a workspace","description":"Per-workspace Notion webhook (internal-integration installs): the URL carries the workspace id.","operationId":"handle_notion_workspace_event","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","description":"Notion workspace id (keys the handshake per workspace)","title":"Workspace Id"},"description":"Notion workspace id (keys the handshake per workspace)"}],"responses":{"200":{"description":"Notion event acknowledgement","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/notion/installations":{"get":{"tags":["integrations"],"summary":"List connected Notion workspaces","description":"List connected Notion workspaces with their discovered resource counts.","operationId":"list_notion_installations","responses":{"200":{"description":"Connected Notion workspaces for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotionInstallationOverviewListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/notion/resources":{"get":{"tags":["integrations"],"summary":"List Notion resources for store ingestion","description":"List one page of Notion pages and databases discovered for the installation.","operationId":"get_notion_resource_selection","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Notion installation ID","title":"Installation Id"},"description":"Notion installation ID"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Resources to skip","default":0,"title":"Offset"},"description":"Resources to skip"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Resources to return per page","default":100,"title":"Limit"},"description":"Resources to return per page"},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"description":"Filter resources by title","title":"Query"},"description":"Filter resources by title"}],"responses":{"200":{"description":"Notion resource selection for a workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotionResourceSelectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/notion/tree":{"get":{"tags":["integrations"],"summary":"Browse the Notion resource tree","description":"List the children of ``parent_id`` (or the roots), or flat search matches, with each node's sync state.","operationId":"get_notion_tree","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Notion installation ID","title":"Installation Id"},"description":"Notion installation ID"},{"name":"parent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Browse this node's children; omit for the roots","title":"Parent Id"},"description":"Browse this node's children; omit for the roots"},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"description":"Flat-search resources by title","title":"Query"},"description":"Flat-search resources by title"}],"responses":{"200":{"description":"One level of the Notion resource tree","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotionTreeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/notion/installations/{installation_id}/webhook-token":{"get":{"tags":["integrations"],"summary":"Get the Notion webhook verification token","description":"Return the verification token Notion sent for this installation's workspace, if one has been captured.","operationId":"get_notion_webhook_token","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Notion installation ID","title":"Installation Id"},"description":"Notion installation ID"}],"responses":{"200":{"description":"The captured Notion webhook verification token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotionWebhookTokenResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/notion/installations/{installation_id}":{"delete":{"tags":["integrations"],"summary":"Disconnect Notion","description":"Disconnect a specific Notion installation from the current organization.","operationId":"disconnect_notion_installation","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Notion installation ID","title":"Installation Id"},"description":"Notion installation ID"}],"responses":{"200":{"description":"The deleted Notion installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/salesforce/connect":{"post":{"tags":["integrations"],"summary":"Connect Salesforce with a customer Connected App","description":"Connect a Salesforce org using a customer-created Connected App (client-credentials flow, no OAuth).","operationId":"connect_salesforce_manual","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceManualConnectBody","description":"Connected App client credentials"}}},"required":true},"responses":{"200":{"description":"The connected Salesforce installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/salesforce/installations":{"get":{"tags":["integrations"],"summary":"List connected Salesforce orgs","description":"List connected Salesforce orgs with their selected object counts.","operationId":"list_salesforce_installations","responses":{"200":{"description":"Connected Salesforce orgs for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceInstallationOverviewListResponse"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/salesforce/objects":{"get":{"tags":["integrations"],"summary":"List Salesforce object types for store ingestion","description":"List the Salesforce object types available for ingestion, with the current selection and sync status.","operationId":"get_salesforce_object_selection","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Salesforce installation ID","title":"Installation Id"},"description":"Salesforce installation ID"}],"responses":{"200":{"description":"Salesforce object selection for an org","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceObjectSelectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["integrations"],"summary":"Update the Salesforce object selection","description":"Persist a new object-type selection and queue a full sync of it.","operationId":"update_salesforce_object_selection","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Salesforce installation ID","title":"Installation Id"},"description":"Salesforce installation ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceObjectSelectionBody","description":"The object API names to ingest"}}}},"responses":{"200":{"description":"The updated Salesforce object selection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceObjectSelectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/salesforce/sync-schedule":{"put":{"tags":["integrations"],"summary":"Update the Salesforce sync schedule","description":"Update how often Salesforce selected objects are synced automatically.","operationId":"update_salesforce_sync_schedule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceSyncScheduleUpdateParams","description":"The periodic sync interval to apply"}}},"required":true},"responses":{"200":{"description":"The updated Salesforce sync schedule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceSyncScheduleUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/v1/integrations/salesforce/sync":{"post":{"tags":["integrations"],"summary":"Sync Salesforce now","description":"Queue an incremental Salesforce sync now (refused while one is already running).","operationId":"sync_salesforce","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Salesforce installation ID","title":"Installation Id"},"description":"Salesforce installation ID"}],"responses":{"200":{"description":"Whether an incremental sync was queued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesforceSyncResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/integrations/salesforce/installations/{installation_id}":{"delete":{"tags":["integrations"],"summary":"Disconnect Salesforce","description":"Disconnect a specific Salesforce installation from the current organization.","operationId":"disconnect_salesforce_installation","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"installation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Salesforce installation ID","title":"Installation Id"},"description":"Salesforce installation ID"}],"responses":{"200":{"description":"The deleted Salesforce installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AgenticSearchConfig":{"properties":{"max_rounds":{"type":"integer","maximum":10.0,"minimum":1.0,"title":"Max Rounds","description":"Maximum number of search rounds","default":3},"queries_per_round":{"type":"integer","maximum":10.0,"minimum":1.0,"title":"Queries Per Round","description":"Maximum queries per round","default":4},"strict_top_k":{"type":"boolean","title":"Strict Top K","description":"Whether the final retrieved chunk list must provide exactly top_k ranked chunks","default":false},"media_content":{"type":"string","enum":["auto","never","always"],"title":"Media Content","description":"Controls when retrieved image content is provided to the agent. `auto` sends images only when no OCR text or summary is available, `never` disables image content, and `always` sends image content when available. Currently not forwarded: the search agent runs without image content.","default":"auto"},"instructions":{"anyOf":[{"type":"string","maxLength":5000,"minLength":1},{"type":"null"}],"title":"Instructions","description":"Additional custom instructions (followed only when not in conflict with existing rules)"},"verbose":{"type":"boolean","title":"Verbose","description":"Internal: when set, the response includes a `trace` field with the full tool-call timeline. Used by the Mixedbread playground; not part of the documented public API.","default":false}},"type":"object","title":"AgenticSearchConfig","description":"Configuration for agentic multi-query search."},"AgenticSearchTokenUsage":{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens","description":"Number of prompt tokens consumed","default":0},"completion_tokens":{"type":"integer","title":"Completion Tokens","description":"Number of completion tokens generated","default":0},"total_tokens":{"type":"integer","title":"Total Tokens","description":"Total tokens consumed (prompt + completion)","default":0}},"type":"object","title":"AgenticSearchTokenUsage","description":"Token usage for LLM calls made during an agentic search."},"AgenticToolCall":{"properties":{"tool_call_id":{"type":"string","title":"Tool Call Id","description":"Unique identifier for the tool call (gen_ai.tool.call.id)"},"tool_name":{"type":"string","title":"Tool Name","description":"Name of the tool invoked (gen_ai.tool.name)","examples":["search_batch"]},"tool_type":{"type":"string","enum":["function","extension","datastore"],"title":"Tool Type","description":"Category of the tool (gen_ai.tool.type)","default":"function"},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"Time when the tool call began"},"duration":{"type":"string","format":"duration","title":"Duration","description":"Time taken to execute the tool call"},"arguments":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Arguments","description":"Arguments passed to the tool (gen_ai.tool.call.arguments)"},"result":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Result","description":"Result returned to the model (gen_ai.tool.call.result). None if the tool errored."},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Error message if the tool call failed"},"error_kind":{"anyOf":[{"type":"string","enum":["provider","agent"]},{"type":"null"}],"title":"Error Kind","description":"Failure classification when the tool call errored: `provider` is an infrastructure failure outside the agent's control, `agent` is feedback the agent received and can recover from."}},"type":"object","required":["tool_call_id","tool_name","started_at","duration"],"title":"AgenticToolCall","description":"Represents a single tool call made by the agent during an agentic search.\n\nFields follow the OpenTelemetry GenAI semantic conventions for tool calls:\nhttps://opentelemetry.io/docs/specs/semconv/gen-ai/gen-ai-spans/"},"ApiKey":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the API key"},"name":{"type":"string","title":"Name","description":"The name of the API key"},"redacted_value":{"type":"string","title":"Redacted Value","description":"The redacted value of the API key"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"The expiration datetime of the API key"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The creation datetime of the API key"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The last update datetime of the API key"},"last_active_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Active At","description":"The last active datetime of the API key"},"object":{"type":"string","const":"api_key","title":"Object","description":"The type of the object","default":"api_key"},"scope":{"anyOf":[{"items":{"$ref":"#/components/schemas/Scope"},"type":"array"},{"type":"null"}],"title":"Scope","description":"The scope of the API key"}},"type":"object","required":["id","name","redacted_value","created_at","updated_at"],"title":"ApiKey","description":"Response model for an API key."},"ApiKeyCreateOrUpdateParams":{"properties":{"type":{"type":"string","const":"api_key","title":"Type","default":"api_key"},"api_key":{"type":"string","title":"Api Key","description":"The API key"}},"type":"object","required":["api_key"],"title":"ApiKeyCreateOrUpdateParams","description":"Base class for API key create or update parameters."},"ApiKeyCreateParams":{"properties":{"name":{"type":"string","title":"Name","description":"A name/description for the API key","default":"API Key"},"scope":{"anyOf":[{"items":{"$ref":"#/components/schemas/Scope"},"type":"array"},{"type":"null"}],"title":"Scope","description":"The scope of the API key"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"Optional expiration datetime"}},"type":"object","title":"ApiKeyCreateParams","description":"Parameters for creating an API key."},"ApiKeyCreated":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the API key"},"name":{"type":"string","title":"Name","description":"The name of the API key"},"redacted_value":{"type":"string","title":"Redacted Value","description":"The redacted value of the API key"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"The expiration datetime of the API key"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The creation datetime of the API key"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The last update datetime of the API key"},"last_active_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Active At","description":"The last active datetime of the API key"},"object":{"type":"string","const":"api_key","title":"Object","description":"The type of the object","default":"api_key"},"scope":{"anyOf":[{"items":{"$ref":"#/components/schemas/Scope"},"type":"array"},{"type":"null"}],"title":"Scope","description":"The scope of the API key"},"value":{"type":"string","title":"Value","description":"The value of the API key"}},"type":"object","required":["id","name","redacted_value","created_at","updated_at","value"],"title":"ApiKeyCreated","description":"Response model for creating an API key."},"ApiKeyDeleted":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the deleted API key"},"deleted":{"type":"boolean","title":"Deleted","description":"Whether the API key was deleted"},"object":{"type":"string","const":"api_key","title":"Object","description":"The type of the object deleted","default":"api_key"}},"type":"object","required":["id","deleted"],"title":"ApiKeyDeleted","description":"Response model for deleting an API key."},"ApiKeyListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationWithTotal"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"$ref":"#/components/schemas/ApiKey"},"type":"array","title":"Data","description":"The list of API keys"}},"type":"object","required":["pagination","data"],"title":"ApiKeyListResponse"},"ApiKeyUpdateParams":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"A name/description for the API key"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"Optional expiration datetime"}},"type":"object","title":"ApiKeyUpdateParams","description":"Parameters for updating an API key."},"AssistantMessage-Input":{"properties":{"role":{"type":"string","const":"assistant","title":"Role"},"content":{"anyOf":[{"type":"string"},{"items":{"$ref":"#/components/schemas/TextPart"},"type":"array"},{"type":"null"}],"title":"Content"},"tool_calls":{"items":{"$ref":"#/components/schemas/MessageToolCall"},"type":"array","title":"Tool Calls"},"reasoning_content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reasoning Content"}},"type":"object","required":["role"],"title":"AssistantMessage"},"AssistantMessage-Output":{"properties":{"role":{"type":"string","const":"assistant","title":"Role"},"content":{"anyOf":[{"type":"string"},{"items":{"$ref":"#/components/schemas/TextPart"},"type":"array"},{"type":"null"}],"title":"Content"},"tool_calls":{"items":{"$ref":"#/components/schemas/MessageToolCall"},"type":"array","title":"Tool Calls"},"reasoning_content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reasoning Content"}},"type":"object","required":["role"],"title":"AssistantMessage"},"AudioChunkGeneratedMetadata":{"properties":{"type":{"type":"string","const":"audio","title":"Type","default":"audio"},"file_type":{"type":"string","title":"File Type","default":"audio/mpeg"},"file_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Size"},"total_duration_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Duration Seconds"},"sample_rate":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sample Rate"},"channels":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Channels"},"audio_format":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Audio Format"},"bpm":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bpm"},"file_extension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Extension"}},"additionalProperties":true,"type":"object","title":"AudioChunkGeneratedMetadata"},"AudioUrl":{"properties":{"url":{"type":"string","title":"Url","description":"The audio URL. Can be either a URL or a Data URI."}},"type":"object","required":["url"],"title":"AudioUrl","description":"Model for audio URL validation."},"AudioUrlInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"audio/mpeg","examples":["audio/mpeg"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"type":{"type":"string","const":"audio_url","title":"Type","description":"Input type identifier","default":"audio_url"},"transcription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcription","description":"speech recognition (sr) text of the audio","examples":["The year 2025 reports for .."]},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this audio chunk within its source file","examples":["This segment introduces ACME's quarterly earnings call."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the audio","examples":["A financial report audio for 2025"]},"audio_url":{"anyOf":[{"$ref":"#/components/schemas/AudioUrl"},{"type":"null"}],"description":"Audio URL"},"sampling_rate":{"type":"integer","title":"Sampling Rate","description":"The sampling rate of the audio."}},"type":"object","required":["chunk_index","sampling_rate"],"title":"AudioUrlInputChunk"},"BalanceInfo":{"properties":{"current_balance":{"type":"number","title":"Current Balance","description":"The current balance"},"next_effective_balance":{"type":"number","title":"Next Effective Balance","description":"The next effective balance"},"next_effective_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Effective Date","description":"The next effective date"}},"type":"object","title":"BalanceInfo","description":"Information about an organization's credit balance."},"BillingPeriodSummary":{"properties":{"period":{"$ref":"#/components/schemas/Period","description":"The billing period"},"cost":{"$ref":"#/components/schemas/CostInfo","description":"The cost information"},"balance":{"$ref":"#/components/schemas/BalanceInfo","description":"The balance information"},"usages":{"additionalProperties":{"$ref":"#/components/schemas/UsageInfo"},"type":"object","title":"Usages","description":"The monthly usages information per metric"},"generated_at":{"type":"string","format":"date-time","title":"Generated At","description":"The date and time the summary was generated"}},"type":"object","required":["period","cost","balance","usages","generated_at"],"title":"BillingPeriodSummary","description":"High level billing summary for the currently active period."},"Body_create_file":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File","description":"The file to upload"}},"type":"object","required":["file"],"title":"Body_create_file"},"Body_update_file":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File","description":"The file to update"}},"type":"object","required":["file"],"title":"Body_update_file"},"Body_upload_store_file":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File","description":"The file to upload and index"},"params":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Params"}},"type":"object","required":["file"],"title":"Body_upload_store_file"},"Bucket":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the bucket"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation time"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Last update time"},"name":{"type":"string","title":"Name","description":"Display name"},"provider":{"$ref":"#/components/schemas/BucketProvider","description":"Object storage provider"},"bucket":{"type":"string","title":"Bucket","description":"The bucket name"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region","description":"The bucket region"},"endpoint_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endpoint Url","description":"Custom S3-compatible endpoint"},"prefix":{"type":"string","title":"Prefix","description":"Key prefix within the bucket"},"sse_kms_key_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sse Kms Key Id","description":"KMS key id/ARN used to encrypt writes (SSE-KMS)"},"auth_type":{"$ref":"#/components/schemas/BucketAuthType","description":"Authentication type"},"role_arn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Arn","description":"IAM role Mixedbread assumes (auth_type=assume_role); not a secret"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"sts:ExternalId the role's trust policy must require (auth_type=assume_role); not a secret"},"status":{"$ref":"#/components/schemas/BucketStatus","description":"Validation status"},"last_validated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Validated At","description":"When the bucket was last validated"},"has_credentials":{"type":"boolean","title":"Has Credentials","description":"Whether secret credentials are stored (always false for assume-role buckets)"},"credentials_version":{"type":"integer","title":"Credentials Version","description":"Increments on every credential rotation"},"object":{"type":"string","const":"bucket","title":"Object","description":"The type of the object","default":"bucket"}},"type":"object","required":["id","created_at","updated_at","name","provider","bucket","region","endpoint_url","prefix","sse_kms_key_id","auth_type","role_arn","external_id","status","last_validated_at","has_credentials","credentials_version"],"title":"Bucket","description":"Service-level representation of a bucket. Credentials are never returned."},"BucketAccessKeyCredentials":{"properties":{"type":{"type":"string","const":"access_key","title":"Type","default":"access_key"},"access_key_id":{"type":"string","minLength":1,"title":"Access Key Id","description":"Access key id"},"secret_access_key":{"type":"string","minLength":1,"title":"Secret Access Key","description":"Secret access key"}},"type":"object","required":["access_key_id","secret_access_key"],"title":"BucketAccessKeyCredentials","description":"AWS-style access key credentials for a customer bucket (write-only, never returned)."},"BucketAssumeRoleCredentials":{"properties":{"type":{"type":"string","const":"assume_role","title":"Type","default":"assume_role"},"role_arn":{"type":"string","minLength":1,"title":"Role Arn","description":"ARN of the IAM role Mixedbread assumes"}},"type":"object","required":["role_arn"],"title":"BucketAssumeRoleCredentials","description":"Cross-account IAM role the platform assumes via STS (recommended for AWS).\n\nNothing secret is stored: the role ARN and the server-generated external id\nare plain metadata, and access is granted/revoked entirely through the\nrole's trust policy in the customer's account."},"BucketAuthType":{"type":"string","enum":["assume_role","access_key"],"title":"BucketAuthType","description":"How omni authenticates against a customer bucket.\n\nASSUME_ROLE is the recommended default for AWS: nothing secret is stored,\nevery service assumes the customer's IAM role via STS on use. ACCESS_KEY\nremains for S3-compatible providers that have no STS."},"BucketCreateParams":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"Display name for the bucket"},"provider":{"type":"string","const":"aws_s3","title":"Provider","description":"Object storage provider","default":"aws_s3"},"bucket":{"type":"string","minLength":1,"title":"Bucket","description":"The bucket name"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region","description":"The bucket region"},"endpoint_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endpoint Url","description":"Custom S3-compatible endpoint (omit for AWS)"},"prefix":{"type":"string","title":"Prefix","description":"Key prefix within the bucket","default":""},"sse_kms_key_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sse Kms Key Id","description":"KMS key id/ARN to encrypt writes with (SSE-KMS); omit for the bucket's default encryption"},"credentials":{"oneOf":[{"$ref":"#/components/schemas/BucketAssumeRoleCredentials"},{"$ref":"#/components/schemas/BucketAccessKeyCredentials"}],"title":"Credentials","description":"How Mixedbread authenticates against the bucket. `assume_role` is the recommended default for AWS; `access_key` is for S3-compatible providers with a custom endpoint.","discriminator":{"propertyName":"type","mapping":{"access_key":"#/components/schemas/BucketAccessKeyCredentials","assume_role":"#/components/schemas/BucketAssumeRoleCredentials"}}}},"type":"object","required":["name","bucket","credentials"],"title":"BucketCreateParams","description":"Parameters for attaching a customer-owned bucket."},"BucketListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"$ref":"#/components/schemas/Bucket"},"type":"array","title":"Data","description":"The list of buckets"}},"type":"object","required":["pagination","data"],"title":"BucketListResponse"},"BucketProvider":{"type":"string","enum":["aws_s3"],"title":"BucketProvider","description":"Object-storage provider backing a bring-your-own bucket."},"BucketRotateCredentialsParams":{"properties":{"credentials":{"$ref":"#/components/schemas/BucketAccessKeyCredentials","description":"New bucket access credentials"}},"type":"object","required":["credentials"],"title":"BucketRotateCredentialsParams","description":"Parameters for rotating a bucket's credentials."},"BucketStatus":{"type":"string","enum":["pending","active","error"],"title":"BucketStatus","description":"Validation lifecycle of a customer bucket."},"ChatCompletion":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","const":"chat.completion","title":"Object","default":"chat.completion"},"created":{"type":"integer","title":"Created"},"model":{"type":"string","title":"Model"},"choices":{"items":{"$ref":"#/components/schemas/ChatCompletionChoice"},"type":"array","title":"Choices"},"usage":{"anyOf":[{"$ref":"#/components/schemas/CompletionUsage"},{"type":"null"}]},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Short display title of the conversation this completion belongs to (Mixedbread extension)"},"hosted_tool_calls":{"items":{"oneOf":[{"$ref":"#/components/schemas/StoreSearchCallItem"},{"$ref":"#/components/schemas/StoreGrepCallItem"},{"$ref":"#/components/schemas/StoreListChunksCallItem"},{"$ref":"#/components/schemas/MetadataFacetsCallItem"},{"$ref":"#/components/schemas/ListStoresCallItem"}],"discriminator":{"propertyName":"type","mapping":{"list_stores_call":"#/components/schemas/ListStoresCallItem","store_grep_call":"#/components/schemas/StoreGrepCallItem","store_list_chunks_call":"#/components/schemas/StoreListChunksCallItem","store_metadata_facets_call":"#/components/schemas/MetadataFacetsCallItem","store_search_call":"#/components/schemas/StoreSearchCallItem"}}},"type":"array","title":"Hosted Tool Calls","description":"Server-side hosted tool executions of this completion (Mixedbread extension); chunk results ride along only for requested include keys, e.g. store_search_call.results"},"tool_tickets":{"items":{"$ref":"#/components/schemas/ToolTicket"},"type":"array","title":"Tool Tickets","description":"One short-lived ticket per client-executed tool call (Mixedbread extension). Send the matching ticket as the X-Mxbai-Tool-Ticket header on the store search or grep you run for that call, and it bills at the discounted agent rate. Each ticket redeems once."},"transcript":{"anyOf":[{"items":{"oneOf":[{"$ref":"#/components/schemas/SystemMessage"},{"$ref":"#/components/schemas/DeveloperMessage"},{"$ref":"#/components/schemas/UserMessage"},{"$ref":"#/components/schemas/AssistantMessage-Output"},{"$ref":"#/components/schemas/ToolMessage"}],"discriminator":{"propertyName":"role","mapping":{"assistant":"#/components/schemas/AssistantMessage-Output","developer":"#/components/schemas/DeveloperMessage","system":"#/components/schemas/SystemMessage","tool":"#/components/schemas/ToolMessage","user":"#/components/schemas/UserMessage"}}},"type":"array"},{"type":"null"}],"title":"Transcript","description":"Complete stored conversation transcript when requested through include"}},"type":"object","required":["id","created","model","choices"],"title":"ChatCompletion","description":"A chat completion object, as returned by the API and persisted for retrieval."},"ChatCompletionChoice":{"properties":{"index":{"type":"integer","title":"Index","default":0},"message":{"$ref":"#/components/schemas/ChatCompletionMessage"},"finish_reason":{"type":"string","enum":["stop","tool_calls","length"],"title":"Finish Reason","default":"stop"},"logprobs":{"type":"null","title":"Logprobs"}},"type":"object","required":["message"],"title":"ChatCompletionChoice"},"ChatCompletionDeleted":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","const":"chat.completion.deleted","title":"Object","default":"chat.completion.deleted"},"deleted":{"type":"boolean","title":"Deleted","default":true}},"type":"object","required":["id"],"title":"ChatCompletionDeleted"},"ChatCompletionList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/ChatCompletion"},"type":"array","title":"Data"},"first_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Id"},"last_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Id"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","title":"ChatCompletionList","description":"List envelope of stored completions, newest first."},"ChatCompletionMessage":{"properties":{"role":{"type":"string","const":"assistant","title":"Role","default":"assistant"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"tool_calls":{"anyOf":[{"items":{"$ref":"#/components/schemas/MessageToolCall"},"type":"array"},{"type":"null"}],"title":"Tool Calls"},"reasoning_content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reasoning Content"}},"type":"object","title":"ChatCompletionMessage","description":"The assistant message of one completion choice."},"ChunkElementResponse":{"properties":{"type":{"$ref":"#/components/schemas/ElementType","description":"The type of the extracted element"},"confidence":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Confidence","description":"The confidence score of the extraction"},"bbox":{"prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"},{"type":"number"}],"type":"array","maxItems":4,"minItems":4,"title":"Bbox","description":"The bounding box coordinates [x1, y1, x2, y2]"},"page":{"type":"integer","minimum":0.0,"title":"Page","description":"The page number where the element was found"},"content":{"type":"string","title":"Content","description":"The extracted text content of the element"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"A brief summary of the element's content"},"image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image","description":"The base64-encoded image data for figure elements"}},"type":"object","required":["type","confidence","bbox","page","content"],"title":"ChunkElementResponse","description":"An element extracted from a document with its content and metadata."},"ChunkResponse":{"properties":{"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"The full content of the chunk"},"content_to_embed":{"type":"string","title":"Content To Embed","description":"The content of the chunk to embed"},"elements":{"items":{"$ref":"#/components/schemas/ChunkElementResponse"},"type":"array","title":"Elements","description":"List of elements contained in this chunk"}},"type":"object","required":["content_to_embed","elements"],"title":"ChunkResponse","description":"A chunk of a parsed document in a job response."},"ChunkSearchResultRule":{"properties":{"query":{"type":"string","title":"Query","description":"The query to trigger the rule"},"store_id":{"type":"string","title":"Store Id","description":"The store identifier to apply the rule to"},"type":{"type":"string","const":"chunk_search_result","title":"Type","description":"The type of substitution"},"file_id":{"type":"string","title":"File Id","description":"The file ID of the chunk to substitute"},"chunk_index":{"type":"integer","minimum":0.0,"title":"Chunk Index","description":"The index of the chunk to substitute"},"result_index":{"type":"integer","minimum":0.0,"title":"Result Index","description":"The index where the result will be inserted"}},"type":"object","required":["query","store_id","type","file_id","chunk_index","result_index"],"title":"ChunkSearchResultRule","description":"Represents a chunk search result rule for a vector store search."},"ChunkingStrategy":{"type":"string","enum":["page"],"title":"ChunkingStrategy","description":"Strategy used for chunking document content."},"CodeChunkGeneratedMetadata":{"properties":{"type":{"type":"string","const":"code","title":"Type","default":"code"},"file_type":{"type":"string","title":"File Type"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"word_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Word Count"},"file_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Size"},"start_line":{"type":"integer","title":"Start Line","default":0},"num_lines":{"type":"integer","title":"Num Lines","default":0},"file_extension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Extension"}},"additionalProperties":true,"type":"object","required":["file_type"],"title":"CodeChunkGeneratedMetadata"},"CompleteMultipartUploadRequest":{"properties":{"parts":{"items":{"$ref":"#/components/schemas/MultipartUploadPart"},"type":"array","minItems":1,"title":"Parts","description":"List of completed parts with their ETags"}},"type":"object","required":["parts"],"title":"CompleteMultipartUploadRequest"},"CompletionCreateParams":{"properties":{"messages":{"items":{"oneOf":[{"$ref":"#/components/schemas/SystemMessage"},{"$ref":"#/components/schemas/DeveloperMessage"},{"$ref":"#/components/schemas/UserMessage"},{"$ref":"#/components/schemas/AssistantMessage-Input"},{"$ref":"#/components/schemas/ToolMessage"}],"discriminator":{"propertyName":"role","mapping":{"assistant":"#/components/schemas/AssistantMessage-Input","developer":"#/components/schemas/DeveloperMessage","system":"#/components/schemas/SystemMessage","tool":"#/components/schemas/ToolMessage","user":"#/components/schemas/UserMessage"}}},"type":"array","minItems":1,"title":"Messages","description":"The conversation, or its new suffix when continuing a stored completion"},"model":{"type":"string","title":"Model","description":"Public model ID. Defaults to toast-1","default":"toast-1"},"tools":{"items":{"oneOf":[{"$ref":"#/components/schemas/StoreSearchTool"},{"$ref":"#/components/schemas/StoreGrepTool"},{"$ref":"#/components/schemas/StoreListChunksTool"},{"$ref":"#/components/schemas/MetadataFacetsTool"},{"$ref":"#/components/schemas/ListStoresTool"},{"$ref":"#/components/schemas/FunctionTool"}],"discriminator":{"propertyName":"type","mapping":{"function":"#/components/schemas/FunctionTool","list_stores":"#/components/schemas/ListStoresTool","store_grep":"#/components/schemas/StoreGrepTool","store_list_chunks":"#/components/schemas/StoreListChunksTool","store_metadata_facets":"#/components/schemas/MetadataFacetsTool","store_search":"#/components/schemas/StoreSearchTool"}}},"type":"array","title":"Tools","description":"Tools the model may call; the hosted tools are opt-in and run server-side for the completions that declare them"},"tool_choice":{"anyOf":[{"type":"string","enum":["auto","none","required"]},{"$ref":"#/components/schemas/ToolChoiceFunction"},{"$ref":"#/components/schemas/ToolChoiceStoreSearch"},{"$ref":"#/components/schemas/ToolChoiceListStores"},{"$ref":"#/components/schemas/ToolChoiceStoreGrep"},{"$ref":"#/components/schemas/ToolChoiceStoreListChunks"},{"$ref":"#/components/schemas/ToolChoiceMetadataFacets"}],"title":"Tool Choice","default":"auto"},"store":{"type":"boolean","title":"Store","description":"Whether to persist this completion for later retrieval","default":true},"previous_completion_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous Completion Id","description":"ID of a stored completion this one continues (Mixedbread extension). Groups turns into a conversation for listing and deletion, and always restores the previous completion's full model context, including hosted tool calls and results"},"previous_messages":{"anyOf":[{"items":{"oneOf":[{"$ref":"#/components/schemas/SystemMessage"},{"$ref":"#/components/schemas/DeveloperMessage"},{"$ref":"#/components/schemas/UserMessage"},{"$ref":"#/components/schemas/AssistantMessage-Input"},{"$ref":"#/components/schemas/ToolMessage"}],"discriminator":{"propertyName":"role","mapping":{"assistant":"#/components/schemas/AssistantMessage-Input","developer":"#/components/schemas/DeveloperMessage","system":"#/components/schemas/SystemMessage","tool":"#/components/schemas/ToolMessage","user":"#/components/schemas/UserMessage"}}},"type":"array","minItems":1},{"type":"null"}],"title":"Previous Messages","description":"Deprecated. Replacement for the previous completion's stored model context after client-side pruning. Send the full edited history in `messages` without `previous_completion_id` instead; the request is honored exactly as sent","deprecated":true},"terminal_tool_name":{"anyOf":[{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,64}$"},{"type":"null"}],"title":"Terminal Tool Name","description":"Deprecated and ignored. The stored transcript is never rewritten around a terminal tool call; the completion ends with the model's plain-text answer","deprecated":true},"stream":{"type":"boolean","title":"Stream","description":"Stream the completion as server-sent events","default":false},"temperature":{"anyOf":[{"type":"number","maximum":2.0,"minimum":0.0},{"type":"null"}],"title":"Temperature"},"top_p":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Top P"},"max_completion_tokens":{"anyOf":[{"type":"integer","minimum":16.0},{"type":"null"}],"title":"Max Completion Tokens"},"max_tokens":{"anyOf":[{"type":"integer","minimum":16.0},{"type":"null"}],"title":"Max Tokens","description":"Deprecated alias of max_completion_tokens, honored when it is absent"},"max_tool_calls":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Max Tool Calls","description":"Maximum number of hosted retrieval calls executed for this completion"},"parallel_tool_calls":{"type":"boolean","title":"Parallel Tool Calls","description":"Whether the model may call multiple tools in one turn; when false, at most one is honored","default":true},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"include":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Include","description":"Extra fields to include, e.g. store_search_call.results; unsupported values are ignored"}},"type":"object","required":["messages"],"title":"CompletionCreateParams","description":"Request body for POST /v1/chat/completions."},"CompletionMessageList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"oneOf":[{"$ref":"#/components/schemas/SystemMessage"},{"$ref":"#/components/schemas/DeveloperMessage"},{"$ref":"#/components/schemas/UserMessage"},{"$ref":"#/components/schemas/AssistantMessage-Output"},{"$ref":"#/components/schemas/ToolMessage"}],"discriminator":{"propertyName":"role","mapping":{"assistant":"#/components/schemas/AssistantMessage-Output","developer":"#/components/schemas/DeveloperMessage","system":"#/components/schemas/SystemMessage","tool":"#/components/schemas/ToolMessage","user":"#/components/schemas/UserMessage"}}},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","title":"CompletionMessageList","description":"The stored request messages of a completion, oldest first.\n\nA stored completion keeps the full conversation it was asked with, so the\nlatest completion of a conversation carries the entire history; its answer\nis the completion's own choice message, not part of this list."},"CompletionTextSegment":{"properties":{"type":{"type":"string","enum":["reasoning","message"],"title":"Type"},"text":{"type":"string","title":"Text"}},"type":"object","required":["type","text"],"title":"CompletionTextSegment","description":"One contiguous reasoning or answer run emitted by the completion loop."},"CompletionTranscriptCloseParams":{"properties":{"tool_call_id":{"type":"string","minLength":1,"title":"Tool Call Id"},"tool_content":{"anyOf":[{"type":"string"},{"items":{"$ref":"#/components/schemas/TextPart"},"type":"array"}],"title":"Tool Content"},"answer":{"type":"string","minLength":1,"title":"Answer"}},"type":"object","required":["tool_call_id","tool_content","answer"],"title":"CompletionTranscriptCloseParams"},"CompletionUsage":{"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},"prompt_tokens_details":{"$ref":"#/components/schemas/PromptTokensDetails"}},"type":"object","title":"CompletionUsage"},"ConditionOperator":{"type":"string","enum":["eq","not_eq","gt","gte","lt","lte","in","not_in","like","contains","starts_with","not_like","regex"],"title":"ConditionOperator","description":"Operator for a filter condition."},"ConnectorListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse"},"data":{"items":{"$ref":"#/components/schemas/DataSourceConnector"},"type":"array","title":"Data","description":"The list of connectors"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"}},"type":"object","required":["pagination","data"],"title":"ConnectorListResponse","description":"A list of connectors with pagination."},"ContextualizationConfig":{"properties":{"with_metadata":{"anyOf":[{"type":"boolean"},{"items":{"type":"string"},"type":"array"}],"title":"With Metadata","description":"Include all metadata or specific fields in the contextualization. Supports dot notation for nested fields (e.g., 'author.name'). When True, all metadata is included (flattened). When a list, only specified fields are included.","default":false,"examples":[true,false,["title","author.name","author.email","tags"]]},"with_file_context":{"type":"boolean","title":"With File Context","description":"Use an LLM to generate a short context for each chunk that situates it within the full document, improving retrieval accuracy.","default":false}},"type":"object","title":"ContextualizationConfig"},"CostHistogramResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DailyCostBucket"},"type":"array","title":"Data","description":"The histogram of cost information"},"object":{"type":"string","const":"cost.histogram","title":"Object","description":"The object type of the response","default":"cost.histogram"}},"type":"object","required":["data"],"title":"CostHistogramResponse"},"CostInfo":{"properties":{"net_usage_cost":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Net Usage Cost","description":"The net usage cost","default":"0"},"gross_usage_cost":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Gross Usage Cost","description":"The gross usage cost","default":"0"},"balance_applied":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Balance Applied","description":"The balance applied","default":"0"},"phases":{"items":{"$ref":"#/components/schemas/PhaseCostInfo"},"type":"array","title":"Phases","description":"The cost for each phase in descending order of end date","default":[]},"products":{"items":{"$ref":"#/components/schemas/ProductCostInfo"},"type":"array","title":"Products","description":"The cost for each product. Store, Parsing, Reranking, Embeddings","default":[]}},"type":"object","title":"CostInfo","description":"Cost information for a billing period.\n\n- net_usage_cost: portion of usage that actually ends up on the invoice after credits,\n    computed as gross_usage_cost - balance_applied.\n- gross_usage_cost: metered usage value before balance applied."},"CreateMultipartUploadRequest":{"properties":{"filename":{"type":"string","minLength":1,"title":"Filename","description":"Name of the file including extension","examples":["document.pdf"]},"file_size":{"type":"integer","exclusiveMinimum":0.0,"title":"File Size","description":"Total size of the file in bytes","examples":[10485760]},"mime_type":{"type":"string","pattern":"^[\\w\\.\\-\\+]+/[\\w\\.\\-\\+]+(\\.\\w+)*$","title":"Mime Type","description":"MIME type of the file","examples":["application/pdf"]},"part_count":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Part Count","description":"Number of parts to split the upload into","default":1,"examples":[3]}},"type":"object","required":["filename","file_size","mime_type"],"title":"CreateMultipartUploadRequest"},"CreateMultipartUploadResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The multipart upload ID (use this to complete or abort)"},"part_urls":{"items":{"$ref":"#/components/schemas/MultipartUploadPartUrl"},"type":"array","title":"Part Urls","description":"Presigned URLs for uploading parts"}},"type":"object","required":["id","part_urls"],"title":"CreateMultipartUploadResponse"},"CreatedJsonSchema":{"properties":{"json_schema":{"additionalProperties":true,"type":"object","title":"Json Schema","description":"The created JSON schema"}},"type":"object","required":["json_schema"],"title":"CreatedJsonSchema","description":"Result of creating a JSON schema."},"CursorPaginationResponse":{"properties":{"has_more":{"type":"boolean","title":"Has More","description":"Contextual direction-aware flag: True if more items exist in the requested pagination direction. For 'after': more items after this page. For 'before': more items before this page.","examples":[true,false]},"first_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Cursor","description":"Cursor of the first item in this page. Use for backward pagination. None if page is empty.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==",null]},"last_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Cursor","description":"Cursor of the last item in this page. Use for forward pagination. None if page is empty.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMFQyMzo1OTo1OS4wMDBaIiwiaWQiOiJ4eXo3ODkifQ==",null]},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Total number of items available across all pages. Only included when include_total=true was requested. Expensive operation - use sparingly.","examples":[42,0,null]}},"type":"object","required":["has_more","first_cursor","last_cursor"],"title":"CursorPaginationResponse","description":"Response model for cursor-based pagination."},"DailyCostBucket":{"properties":{"day":{"type":"string","format":"date-time","title":"Day","description":"The date of the cost bucket"},"cost":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Cost","description":"The cost of the cost bucket"},"cost_per_metric":{"additionalProperties":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},"type":"object","title":"Cost Per Metric","description":"The cost per metric"}},"type":"object","required":["day","cost","cost_per_metric"],"title":"DailyCostBucket","description":"Daily cost bucket."},"DataSource":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the data source"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The creation time of the data source"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The last update time of the data source"},"type":{"$ref":"#/components/schemas/DataSourceType","description":"The type of data source"},"name":{"type":"string","title":"Name","description":"The name of the data source"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"The metadata of the data source"},"auth_params":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/DataSourceOAuth2Params"},{"$ref":"#/components/schemas/DataSourceApiKeyParams"}],"discriminator":{"propertyName":"type","mapping":{"api_key":"#/components/schemas/DataSourceApiKeyParams","oauth2":"#/components/schemas/DataSourceOAuth2Params"}}},{"type":"null"}],"title":"Auth Params","description":"Authentication parameters"},"object":{"type":"string","const":"data_source","title":"Object","description":"The type of the object","default":"data_source"}},"type":"object","required":["id","created_at","updated_at","type","name","metadata","auth_params"],"title":"DataSource","description":"Service-level representation of a data source."},"DataSourceApiKeyParams":{"properties":{"type":{"type":"string","const":"api_key","title":"Type","default":"api_key"},"api_key":{"type":"string","title":"Api Key","description":"The API key"}},"type":"object","required":["api_key"],"title":"DataSourceApiKeyParams","description":"Authentication parameters for a API key data source."},"DataSourceConnector":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the connector"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The creation time of the connector"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The last update time of the connector"},"store_id":{"type":"string","title":"Store Id","description":"The ID of the store"},"data_source_id":{"type":"string","title":"Data Source Id","description":"The ID of the data source"},"name":{"type":"string","title":"Name","description":"The name of the connector","default":"New Connector"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"The metadata of the connector"},"polling_interval":{"type":"string","format":"duration","title":"Polling Interval","description":"The polling interval of the connector"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At","description":"The start time of the connector"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At","description":"The finish time of the connector"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At","description":"The last sync time of the connector"},"status":{"$ref":"#/components/schemas/SyncStatus","description":"The sync status of the connector"},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error","description":"The sync error of the connector"},"object":{"type":"string","const":"data_source.connector","title":"Object","description":"The type of the object","default":"data_source.connector"}},"type":"object","required":["id","created_at","updated_at","store_id","data_source_id","metadata","polling_interval","started_at","finished_at","last_synced_at","status","error"],"title":"DataSourceConnector","description":"Service-level representation of a connector."},"DataSourceConnectorCreateParams":{"properties":{"store_id":{"type":"string","title":"Store Id","description":"The ID of the store"},"name":{"type":"string","title":"Name","description":"The name of the connector","default":"New Connector"},"trigger_sync":{"type":"boolean","title":"Trigger Sync","description":"Whether the connector should be synced after creation","default":true},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"The metadata of the connector"},"polling_interval":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Polling Interval","description":"Polling interval for the connector. Defaults to 30 minutes if not specified. Can be provided as:\n- int: Number of seconds (e.g., 1800 for 30 minutes)\n- str: Duration string (e.g., '30m', '1h', '2d') or ISO 8601 format (e.g., 'PT30M', 'P1D')\nValid range: 15 seconds to 30 days","examples":[1800,"30m","1h","PT30M"]}},"type":"object","required":["store_id"],"title":"DataSourceConnectorCreateParams","description":"Parameters for creating a connector."},"DataSourceConnectorDeleted":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the connector"},"deleted":{"type":"boolean","title":"Deleted","description":"Whether the connector was deleted","default":true},"object":{"type":"string","const":"data_source.connector","title":"Object","description":"The type of the object","default":"data_source.connector"}},"type":"object","required":["id"],"title":"DataSourceConnectorDeleted","description":"Deleted connector."},"DataSourceConnectorUpdateParams":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the connector"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"The metadata of the connector"},"trigger_sync":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Trigger Sync","description":"Whether the connector should be synced after update"},"polling_interval":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Polling Interval","description":"Polling interval for the connector. Defaults to 30 minutes if not specified. Can be provided as:\n- int: Number of seconds (e.g., 1800 for 30 minutes)\n- str: Duration string (e.g., '30m', '1h', '2d') or ISO 8601 format (e.g., 'PT30M', 'P1D')\nValid range: 15 seconds to 30 days","examples":[1800,"30m","1h","PT30M"]}},"type":"object","title":"DataSourceConnectorUpdateParams","description":"Parameters for updating a connector."},"DataSourceDeleted":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the data source"},"deleted":{"type":"boolean","title":"Deleted","description":"Whether the data source was deleted","default":true},"object":{"type":"string","const":"data_source","title":"Object","description":"The type of the object","default":"data_source"}},"type":"object","required":["id"],"title":"DataSourceDeleted","description":"Deleted data source."},"DataSourceInstallation":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Integration installation ID"},"provider":{"type":"string","title":"Provider","description":"The integration provider identifier"},"display_name":{"type":"string","title":"Display Name","description":"Human-readable connected account/workspace name"},"status":{"type":"string","title":"Status","description":"The installation status"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread ingestion store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread ingestion store name"},"item_count":{"type":"integer","title":"Item Count","description":"Number of selected ingestion items (channels/folders)","default":0}},"type":"object","required":["installation_id","provider","display_name","status"],"title":"DataSourceInstallation","description":"Provider-agnostic summary of a connected data source for the overview list."},"DataSourceInstallationListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DataSourceInstallation"},"type":"array","title":"Data","description":"Connected data sources"}},"type":"object","required":["data"],"title":"DataSourceInstallationListResponse","description":"List of all connected data sources across providers."},"DataSourceListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse"},"data":{"items":{"$ref":"#/components/schemas/DataSource"},"type":"array","title":"Data","description":"The list of data sources"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"}},"type":"object","required":["pagination","data"],"title":"DataSourceListResponse","description":"A list of data sources with pagination."},"DataSourceOAuth2Params":{"properties":{"type":{"type":"string","const":"oauth2","title":"Type","default":"oauth2"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The timestamp when the OAuth2 credentials were created"},"scope":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope","description":"The OAuth2 scope","default":"read"},"access_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Access Token","description":"The OAuth2 access token"},"refresh_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Refresh Token","description":"The OAuth2 refresh token"},"token_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Token Type","description":"The OAuth2 token type"},"expires_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires On","description":"The OAuth2 token expiration timestamp"},"additional_params":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Additional Params","description":"Additional parameters for the OAuth2 flow"}},"type":"object","title":"DataSourceOAuth2Params","description":"Authentication parameters for a OAuth data source."},"DataSourceType":{"type":"string","enum":["notion","linear"],"title":"DataSourceType"},"DeprecatedStoreFileUpsertParams":{"properties":{"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"Optional metadata for the file"},"config":{"$ref":"#/components/schemas/StoreFileConfig","description":"Configuration for adding the file"},"external_id":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"External Id","description":"External identifier for this file in the store"},"overwrite":{"type":"boolean","title":"Overwrite","description":"If true, overwrite an existing file with the same external_id","default":true,"examples":[false,true]},"file_id":{"type":"string","format":"uuid","title":"File Id","description":"ID of the file to add"},"experimental":{"anyOf":[{"$ref":"#/components/schemas/StoreFileConfig"},{"type":"null"}],"description":"Strategy for adding the file. This field is deprecated. Please use the top-level 'config' field instead. If this is provided, it will override the top-level 'config' field.","deprecated":true}},"type":"object","required":["file_id"],"title":"DeprecatedStoreFileUpsertParams"},"DeveloperMessage":{"properties":{"role":{"type":"string","const":"developer","title":"Role"},"content":{"anyOf":[{"type":"string"},{"items":{"$ref":"#/components/schemas/TextPart"},"type":"array"}],"title":"Content"}},"type":"object","required":["role","content"],"title":"DeveloperMessage","description":"Alias of the system role; forwarded to the provider as system instructions."},"DocumentParserResultResponse":{"properties":{"chunking_strategy":{"$ref":"#/components/schemas/ChunkingStrategy","description":"The strategy used for chunking the document"},"return_format":{"$ref":"#/components/schemas/ReturnFormat","description":"The format of the returned content"},"element_types":{"items":{"$ref":"#/components/schemas/ElementType"},"type":"array","title":"Element Types","description":"The types of elements extracted"},"chunks":{"items":{"$ref":"#/components/schemas/ChunkResponse"},"type":"array","title":"Chunks","description":"List of extracted chunks from the document"},"page_sizes":{"items":{"prefixItems":[{"type":"integer"},{"type":"integer"}],"type":"array","maxItems":2,"minItems":2},"type":"array","title":"Page Sizes","description":"List of (width, height) tuples for each page"}},"type":"object","required":["chunking_strategy","return_format","element_types","chunks"],"title":"DocumentParserResultResponse","description":"The public result of a parsing job."},"ElementType":{"type":"string","enum":["header","footer","title","section-header","page-number","list-item","figure","table","form","text","footnote"],"title":"ElementType","description":"Types of elements that can be extracted from a document."},"Embedding":{"properties":{"embedding":{"$ref":"#/components/schemas/EmbeddingItem","description":"The encoded embedding."},"index":{"type":"integer","title":"Index","description":"The index of the embedding.","examples":[0]},"object":{"type":"string","const":"embedding","title":"Object","description":"The object type of the embedding.","default":"embedding","examples":["embedding"]}},"type":"object","required":["embedding","index"],"title":"Embedding"},"EmbeddingCreateParams":{"properties":{"model":{"type":"string","maxLength":500,"minLength":1,"title":"Model","description":"The model to use for creating embeddings.","examples":["mixedbread-ai/mxbai-embed-large-v1"]},"input":{"anyOf":[{"type":"string","maxLength":64000,"minLength":1},{"items":{"type":"string"},"type":"array","maxItems":256,"minItems":1}],"title":"Input","description":"The input to create embeddings for."},"dimensions":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Dimensions","description":"The number of dimensions to use for the embeddings.","examples":[768]},"prompt":{"anyOf":[{"type":"string","maxLength":32000,"minLength":1},{"type":"null"}],"title":"Prompt","description":"The prompt to use for the embedding creation.","examples":["Provide a detailed summary of the following text."]},"normalized":{"type":"boolean","title":"Normalized","description":"Whether to normalize the embeddings.","default":true,"examples":[true]},"encoding_format":{"anyOf":[{"$ref":"#/components/schemas/EncodingFormat"},{"items":{"$ref":"#/components/schemas/EncodingFormat"},"type":"array"}],"title":"Encoding Format","description":"The encoding format(s) of the embeddings. Can be a single format or a list of formats.","default":"float","examples":["float",["int8","float"]]}},"type":"object","required":["model","input"],"title":"EmbeddingCreateParams","description":"Parameters for creating embeddings."},"EmbeddingCreateResponse":{"properties":{"usage":{"$ref":"#/components/schemas/Usage","description":"The usage of the model","examples":[{"completion_tokens":10,"prompt_tokens":10,"total_tokens":20}]},"model":{"type":"string","title":"Model","description":"The model used"},"data":{"anyOf":[{"items":{"$ref":"#/components/schemas/Embedding"},"type":"array"},{"items":{"$ref":"#/components/schemas/MultiEncodingEmbedding"},"type":"array"}],"title":"Data","description":"The created embeddings."},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"normalized":{"type":"boolean","title":"Normalized","description":"Whether the embeddings are normalized.","examples":[true]},"encoding_format":{"anyOf":[{"$ref":"#/components/schemas/EncodingFormat"},{"items":{"$ref":"#/components/schemas/EncodingFormat"},"type":"array"}],"title":"Encoding Format","description":"The encoding formats of the embeddings.","examples":["float"]},"dimensions":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Dimensions","description":"The number of dimensions used for the embeddings.","examples":[768]}},"type":"object","required":["usage","model","data","normalized","encoding_format","dimensions"],"title":"EmbeddingCreateResponse"},"EmbeddingItem":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"items":{"type":"integer"},"type":"array"},{"type":"string"}],"title":"EmbeddingItem","description":"The encoded embedding data by encoding format.","examples":[0.1,0.2,0.3]},"EncodingFormat":{"type":"string","enum":["float","float16","base64","binary","ubinary","int8","uint8"],"title":"EncodingFormat","description":"Enumeration of encoding formats."},"EnhancedJsonSchema":{"properties":{"json_schema":{"additionalProperties":true,"type":"object","title":"Json Schema","description":"The enhanced JSON schema"}},"type":"object","required":["json_schema"],"title":"EnhancedJsonSchema","description":"Result of enhancing a JSON schema."},"ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/InnerErrorResponse"}},"type":"object","required":["error"],"title":"ErrorResponse","description":"Error Pydantic Response Service Message"},"EventHistogramParams":{"properties":{"start_time":{"type":"string","format":"date-time","title":"Start Time","description":"Start time of the histogram"},"end_time":{"type":"string","format":"date-time","title":"End Time","description":"End time of the histogram"},"bucket_seconds":{"type":"integer","title":"Bucket Seconds","description":"Number of seconds in each bucket","default":7200}},"type":"object","title":"EventHistogramParams","description":"Time window and bucket size of an event histogram."},"EventListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"oneOf":[{"$ref":"#/components/schemas/StoreIngestionEvent"},{"$ref":"#/components/schemas/StoreSearchEvent"},{"$ref":"#/components/schemas/StoreAgenticSearchEvent"},{"$ref":"#/components/schemas/StoreGrepEvent"},{"$ref":"#/components/schemas/StoreCompletionEvent"},{"$ref":"#/components/schemas/StoreQAEvent"}],"discriminator":{"propertyName":"type","mapping":{"agentic_search":"#/components/schemas/StoreAgenticSearchEvent","completion":"#/components/schemas/StoreCompletionEvent","grep":"#/components/schemas/StoreGrepEvent","ingestion":"#/components/schemas/StoreIngestionEvent","qa":"#/components/schemas/StoreQAEvent","search":"#/components/schemas/StoreSearchEvent"}}},"type":"array","title":"Data","description":"The list of events"}},"type":"object","required":["pagination","data"],"title":"EventListResponse"},"EventMetricsBucket":{"properties":{"bucket_start":{"type":"string","format":"date-time","title":"Bucket Start","description":"Start time of the bucket"},"bucket_end":{"type":"string","format":"date-time","title":"Bucket End","description":"End time of the bucket"},"ingestion":{"$ref":"#/components/schemas/EventMetricsIngestion"},"search":{"$ref":"#/components/schemas/EventMetricsSearch"},"completion":{"$ref":"#/components/schemas/EventMetricsCompletion"}},"type":"object","required":["bucket_start","bucket_end","ingestion","search","completion"],"title":"EventMetricsBucket","description":"Usage aggregates of one time bucket across ingestion, search, and chat events."},"EventMetricsCompletion":{"properties":{"count":{"type":"integer","title":"Count","description":"Completion turns across both APIs","default":0},"responses":{"type":"integer","title":"Responses","description":"Turns created through the Responses API","default":0},"prompt_tokens":{"type":"integer","title":"Prompt Tokens","description":"Prompt tokens consumed, including cached ones","default":0},"cached_tokens":{"type":"integer","title":"Cached Tokens","description":"Prompt tokens served from the prompt cache","default":0},"completion_tokens":{"type":"integer","title":"Completion Tokens","description":"Completion tokens generated","default":0},"tool_calls":{"type":"integer","title":"Tool Calls","description":"Hosted store tool calls executed server-side","default":0},"function_tool_calls":{"type":"integer","title":"Function Tool Calls","description":"Client-executed function tool calls the model requested","default":0},"avg_total_time":{"anyOf":[{"type":"string","format":"duration"},{"type":"null"}],"title":"Avg Total Time","description":"Mean wall-clock time of a turn"}},"type":"object","title":"EventMetricsCompletion","description":"Chat completion activity within one bucket."},"EventMetricsIngestion":{"properties":{"files":{"type":"integer","title":"Files","description":"Files whose ingestion completed","default":0},"high_quality_files":{"type":"integer","title":"High Quality Files","description":"Files ingested with the high-quality strategy","default":0},"chunks":{"type":"integer","title":"Chunks","description":"Chunks produced","default":0},"tokens":{"type":"integer","title":"Tokens","description":"Tokens embedded during ingestion","default":0},"bytes":{"type":"integer","title":"Bytes","description":"Bytes of source files ingested","default":0},"avg_ingestion_time":{"anyOf":[{"type":"string","format":"duration"},{"type":"null"}],"title":"Avg Ingestion Time","description":"Mean processing time, excluding queueing"},"avg_queue_time":{"anyOf":[{"type":"string","format":"duration"},{"type":"null"}],"title":"Avg Queue Time","description":"Mean time files waited before processing"}},"type":"object","title":"EventMetricsIngestion","description":"Ingestion volume and timings within one bucket."},"EventMetricsResponse":{"properties":{"object":{"type":"string","const":"event_metrics","title":"Object","description":"The object type of the response","default":"event_metrics"},"data":{"items":{"$ref":"#/components/schemas/EventMetricsBucket"},"type":"array","title":"Data","description":"Usage aggregates per time bucket, oldest first"}},"type":"object","required":["data"],"title":"EventMetricsResponse"},"EventMetricsSearch":{"properties":{"semantic":{"type":"integer","title":"Semantic","description":"Plain semantic searches, including the reranked ones","default":0},"reranked":{"type":"integer","title":"Reranked","description":"Semantic searches that applied a reranker","default":0},"rewritten":{"type":"integer","title":"Rewritten","description":"Semantic searches that enabled query rewriting","default":0},"agentic":{"type":"integer","title":"Agentic","description":"Agentic searches","default":0},"grep":{"type":"integer","title":"Grep","description":"Grep searches","default":0},"avg_search_time":{"anyOf":[{"type":"string","format":"duration"},{"type":"null"}],"title":"Avg Search Time","description":"Mean latency of semantic searches"},"p95_search_time":{"anyOf":[{"type":"string","format":"duration"},{"type":"null"}],"title":"P95 Search Time","description":"95th-percentile latency of semantic searches"},"avg_agentic_search_time":{"anyOf":[{"type":"string","format":"duration"},{"type":"null"}],"title":"Avg Agentic Search Time","description":"Mean wall-clock time of agentic searches"},"agentic_prompt_tokens":{"type":"integer","title":"Agentic Prompt Tokens","description":"Prompt tokens consumed by agentic searches","default":0},"agentic_completion_tokens":{"type":"integer","title":"Agentic Completion Tokens","description":"Completion tokens generated by agentic searches","default":0},"avg_agentic_rounds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg Agentic Rounds","description":"Mean rounds an agentic search executed"}},"type":"object","title":"EventMetricsSearch","description":"Search activity within one bucket, split by kind."},"ExpiresAfter":{"properties":{"anchor":{"type":"string","const":"last_active_at","title":"Anchor","description":"Anchor date for the expiration policy","default":"last_active_at"},"days":{"type":"integer","title":"Days","description":"Number of days after which the store expires","default":30}},"type":"object","title":"ExpiresAfter","description":"Represents an expiration policy for a store."},"ExtractContentCreateParams":{"properties":{"content":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"items":{"anyOf":[{"$ref":"#/components/schemas/TextInput"},{"$ref":"#/components/schemas/ImageUrlInput"}]},"type":"array"}],"minLength":1,"title":"Content","description":"The content to extract from"},"json_schema":{"additionalProperties":true,"type":"object","title":"Json Schema","description":"The JSON schema to use for extraction"},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instructions","description":"Additional instructions for the extraction"}},"type":"object","required":["content","json_schema"],"title":"ExtractContentCreateParams","description":"Parameters for extracting content using a schema."},"ExtractJobCreateParams":{"properties":{"file_id":{"type":"string","title":"File Id","description":"The ID of the file to extract from"},"json_schema":{"additionalProperties":true,"type":"object","title":"Json Schema","description":"The JSON schema to use for extraction"}},"type":"object","required":["file_id","json_schema"],"title":"ExtractJobCreateParams","description":"Parameters for creating an extraction job."},"ExtractionJob":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for the extraction job"},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"ID of the organization that owns this job"},"file_id":{"type":"string","format":"uuid","title":"File Id","description":"ID of the file being extracted"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the job was created"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When the job was last updated"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At","description":"When the job started processing"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At","description":"When the job finished processing"},"status":{"$ref":"#/components/schemas/ParsingJobStatus","description":"Current status of the job"},"result":{"anyOf":[{"$ref":"#/components/schemas/ExtractionResult"},{"type":"null"}],"description":"The extraction results if completed"},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error","description":"Error information if failed"},"json_schema":{"additionalProperties":true,"type":"object","title":"Json Schema","description":"The JSON schema used for extraction"}},"type":"object","required":["id","organization_id","file_id","created_at","updated_at","started_at","finished_at","status","result","error","json_schema"],"title":"ExtractionJob","description":"A job for extracting structured data from documents."},"ExtractionResult":{"properties":{"data":{"additionalProperties":true,"type":"object","title":"Data"},"warnings":{"items":{"type":"string"},"type":"array","title":"Warnings"}},"type":"object","required":["data","warnings"],"title":"ExtractionResult","description":"The result of an extraction job."},"FileCounts":{"properties":{"pending":{"type":"integer","title":"Pending","description":"Number of files waiting to be processed","default":0,"examples":[5]},"in_progress":{"type":"integer","title":"In Progress","description":"Number of files currently being processed","default":0,"examples":[5]},"cancelled":{"type":"integer","title":"Cancelled","description":"Number of files whose processing was cancelled","default":0,"examples":[2]},"completed":{"type":"integer","title":"Completed","description":"Number of successfully processed files","default":0,"examples":[42]},"failed":{"type":"integer","title":"Failed","description":"Number of files that failed processing","default":0,"examples":[1]},"total":{"type":"integer","title":"Total","description":"Total number of files","default":0,"examples":[50]}},"type":"object","title":"FileCounts","description":"Tracks counts of files in different states within a store."},"FileDeleted":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the deleted file"},"deleted":{"type":"boolean","title":"Deleted","description":"Whether the file was deleted","default":true},"object":{"type":"string","const":"file","title":"Object","description":"The type of the deleted object","default":"file"}},"type":"object","required":["id"],"title":"FileDeleted"},"FileListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"$ref":"#/components/schemas/FileObject"},"type":"array","title":"Data","description":"The list of files"}},"type":"object","required":["pagination","data"],"title":"FileListResponse"},"FileObject":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the file","examples":["file_abc123","file_xyz789"]},"filename":{"type":"string","minLength":1,"title":"Filename","description":"Name of the file including extension","examples":["document.pdf","image.jpg"]},"bytes":{"type":"integer","exclusiveMinimum":0.0,"title":"Bytes","description":"Size of the file in bytes","examples":[1024,2048]},"mime_type":{"type":"string","pattern":"^[\\w\\.\\-\\+]+/[\\w\\.\\-\\+]+(\\.\\w+)*$","title":"Mime Type","description":"MIME type of the file","examples":["application/pdf","image/jpeg","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/x-ipynb+json"]},"version":{"type":"integer","minimum":1.0,"title":"Version","description":"Version of the file","examples":[1,2]},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the file was created"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Timestamp when the file was last updated"}},"type":"object","required":["id","filename","bytes","mime_type","version","created_at","updated_at"],"title":"FileObject","description":"A model representing a file object in the system.\n\nThis model contains metadata about files stored in the system, including\nidentifiers, size information, and timestamps."},"FileSearchResultRule":{"properties":{"query":{"type":"string","title":"Query","description":"The query to trigger the rule"},"store_id":{"type":"string","title":"Store Id","description":"The store identifier to apply the rule to"},"type":{"type":"string","const":"file_search_result","title":"Type","description":"The type of substitution"},"file_id":{"type":"string","title":"File Id","description":"The file ID of the file to substitute"},"chunk_index":{"type":"integer","minimum":0.0,"title":"Chunk Index","description":"An optional chunk index to use for the chunk substitution","default":0},"result_index":{"type":"integer","minimum":0.0,"title":"Result Index","description":"The index where the result will be inserted"}},"type":"object","required":["query","store_id","type","file_id","result_index"],"title":"FileSearchResultRule","description":"Represents a file search result rule for a vector store search."},"FunctionDefinition":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,64}$","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"parameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Parameters"},"strict":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Strict"}},"type":"object","required":["name"],"title":"FunctionDefinition","description":"Definition of a client-executed function tool, as in the OpenAI Chat Completions API.\n\nAny name is usable; hosted tool names are only reserved against the\nrequests that declare that hosted tool (checked at the params level)."},"FunctionTool":{"properties":{"type":{"type":"string","const":"function","title":"Type","default":"function"},"function":{"$ref":"#/components/schemas/FunctionDefinition"}},"type":"object","required":["function"],"title":"FunctionTool","description":"Client-executed function tool, as in the OpenAI Chat Completions API."},"GmailInstallationOverview":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Gmail installation ID"},"account_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Email","description":"Connected Gmail account email"},"status":{"type":"string","title":"Status","description":"The installation status"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread ingestion store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread ingestion store name"},"syncing_label_count":{"type":"integer","title":"Syncing Label Count","description":"Number of Gmail labels selected for ingestion","default":0}},"type":"object","required":["installation_id","account_email","status"],"title":"GmailInstallationOverview","description":"Summary of a connected Gmail account for the data sources overview."},"GmailInstallationOverviewListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GmailInstallationOverview"},"type":"array","title":"Data","description":"Connected Gmail accounts"}},"type":"object","required":["data"],"title":"GmailInstallationOverviewListResponse","description":"List of connected Gmail accounts for the data sources overview."},"GmailLabel":{"properties":{"id":{"type":"string","title":"Id","description":"Gmail label ID"},"name":{"type":"string","title":"Name","description":"Gmail label display name"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Whether this is a system or user label"},"is_selected":{"type":"boolean","title":"Is Selected","description":"Whether this label is selected for ingestion","default":false},"messages_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Messages Total","description":"Approximate total messages for the label"},"messages_unread":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Messages Unread","description":"Approximate unread messages for the label"}},"type":"object","required":["id","name"],"title":"GmailLabel","description":"Gmail label exposed for connector configuration."},"GmailLabelSelection":{"properties":{"is_installed":{"type":"boolean","title":"Is Installed","description":"Whether Gmail is installed for the organization"},"installation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installation Id","description":"Gmail installation ID"},"account_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Email","description":"Connected Gmail account email"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread store name"},"labels":{"items":{"$ref":"#/components/schemas/GmailLabel"},"type":"array","title":"Labels","description":"Available Gmail labels"},"selected_label_ids":{"items":{"type":"string"},"type":"array","title":"Selected Label Ids","description":"Every Gmail label ID selected for ingestion"}},"type":"object","required":["is_installed","labels"],"title":"GmailLabelSelection","description":"Gmail label and search selection for a store connector."},"GmailLabelSelectionResponse":{"properties":{"data":{"$ref":"#/components/schemas/GmailLabelSelection","description":"Gmail label selection"}},"type":"object","required":["data"],"title":"GmailLabelSelectionResponse","description":"Gmail label selection response."},"GmailLabelSelectionUpdate":{"properties":{"store_id":{"type":"string","title":"Store Id","description":"Mixedbread store ID"},"selected_label_ids":{"items":{"type":"string"},"type":"array","title":"Selected Label Ids","description":"Selected Gmail label IDs"},"backfill_label_ids":{"items":{"type":"string"},"type":"array","title":"Backfill Label Ids","description":"Labels newly selected and ready for backfill"},"skipped_labels":{"additionalProperties":{"type":"string"},"type":"object","title":"Skipped Labels","description":"Label IDs skipped with a reason"}},"type":"object","required":["store_id","selected_label_ids","backfill_label_ids","skipped_labels"],"title":"GmailLabelSelectionUpdate","description":"Result of updating Gmail label selection."},"GmailLabelSelectionUpdateParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Gmail installation ID"},"label_ids":{"items":{"type":"string"},"type":"array","title":"Label Ids","description":"Complete set of Gmail label IDs to sync"}},"type":"object","required":["installation_id"],"title":"GmailLabelSelectionUpdateParams","description":"Operation for updating Gmail label ingestion selection."},"GmailLabelSelectionUpdateResponse":{"properties":{"data":{"$ref":"#/components/schemas/GmailLabelSelectionUpdate","description":"Gmail label selection update"}},"type":"object","required":["data"],"title":"GmailLabelSelectionUpdateResponse","description":"Gmail label selection update response."},"GmailSync":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Gmail installation ID"},"enqueued_label_count":{"type":"integer","title":"Enqueued Label Count","description":"Number of Gmail label sync jobs enqueued"}},"type":"object","required":["installation_id","enqueued_label_count"],"title":"GmailSync","description":"Result of triggering a Gmail sync."},"GmailSyncParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Gmail installation ID"}},"type":"object","required":["installation_id"],"title":"GmailSyncParams","description":"Parameters for manually syncing a Gmail connector."},"GmailSyncResponse":{"properties":{"data":{"$ref":"#/components/schemas/GmailSync","description":"Gmail manual sync result"}},"type":"object","required":["data"],"title":"GmailSyncResponse","description":"Gmail manual sync response."},"GoogleDriveBreadcrumb":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Google Drive folder ID, or null for My Drive root"},"name":{"type":"string","title":"Name","description":"Google Drive folder name"}},"type":"object","required":["name"],"title":"GoogleDriveBreadcrumb","description":"A folder location in the Google Drive browser breadcrumb trail."},"GoogleDriveExcludedChildren":{"properties":{"parent_folder_id":{"type":"string","title":"Parent Folder Id","description":"Selected Google Drive parent folder ID"},"child_ids":{"items":{"type":"string"},"type":"array","title":"Child Ids","description":"Direct child Drive file or folder IDs excluded under the parent"}},"type":"object","required":["parent_folder_id","child_ids"],"title":"GoogleDriveExcludedChildren","description":"Direct Drive children excluded from a selected parent folder."},"GoogleDriveFolder":{"properties":{"id":{"type":"string","title":"Id","description":"Google Drive folder ID"},"name":{"type":"string","title":"Name","description":"Google Drive folder name"},"is_selected":{"type":"boolean","title":"Is Selected","description":"Whether this folder is selected for store ingestion","default":false},"web_view_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Web View Link","description":"Google Drive web view link"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At","description":"Last successful sync time"}},"type":"object","required":["id","name"],"title":"GoogleDriveFolder","description":"Google Drive folder exposed for connector configuration."},"GoogleDriveFolderSelection":{"properties":{"is_installed":{"type":"boolean","title":"Is Installed","description":"Whether Google Drive is installed for the organization"},"installation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installation Id","description":"Google Drive installation ID"},"account_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Email","description":"Connected Google account email"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread store name"},"auto_sync_all":{"type":"boolean","title":"Auto Sync All","description":"Whether the entire Drive (all current and future files) is synced automatically","default":false},"current_folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Current Folder Id","description":"Current Google Drive browser folder ID"},"breadcrumbs":{"items":{"$ref":"#/components/schemas/GoogleDriveBreadcrumb"},"type":"array","title":"Breadcrumbs","description":"Breadcrumb path for the current Google Drive browser folder"},"items":{"items":{"$ref":"#/components/schemas/GoogleDriveItem"},"type":"array","title":"Items","description":"Files and folders in the current Google Drive browser folder"},"selected_folder_ids":{"items":{"type":"string"},"type":"array","title":"Selected Folder Ids","description":"Every Google Drive folder ID selected for ingestion"},"selected_file_ids":{"items":{"type":"string"},"type":"array","title":"Selected File Ids","description":"Every Google Drive file ID selected for ingestion"},"excluded_children":{"items":{"$ref":"#/components/schemas/GoogleDriveExcludedChildren"},"type":"array","title":"Excluded Children","description":"Direct child exclusions grouped by selected parent folder"},"folders":{"items":{"$ref":"#/components/schemas/GoogleDriveFolder"},"type":"array","title":"Folders","description":"Available Google Drive folders"}},"type":"object","required":["is_installed","folders"],"title":"GoogleDriveFolderSelection","description":"Google Drive folder selection for a store connector."},"GoogleDriveFolderSelectionResponse":{"properties":{"data":{"$ref":"#/components/schemas/GoogleDriveFolderSelection","description":"Google Drive folder selection"}},"type":"object","required":["data"],"title":"GoogleDriveFolderSelectionResponse","description":"Google Drive folder selection response."},"GoogleDriveFolderSelectionUpdate":{"properties":{"store_id":{"type":"string","title":"Store Id","description":"Mixedbread store ID"},"selected_folder_ids":{"items":{"type":"string"},"type":"array","title":"Selected Folder Ids","description":"Selected Google Drive folder IDs"},"selected_file_ids":{"items":{"type":"string"},"type":"array","title":"Selected File Ids","description":"Selected Google Drive file IDs"},"excluded_children":{"items":{"$ref":"#/components/schemas/GoogleDriveExcludedChildren"},"type":"array","title":"Excluded Children","description":"Direct child exclusions grouped by selected parent folder"},"backfill_folder_ids":{"items":{"type":"string"},"type":"array","title":"Backfill Folder Ids","description":"Folders queued for backfill ingestion"},"backfill_file_ids":{"items":{"type":"string"},"type":"array","title":"Backfill File Ids","description":"Files queued for backfill ingestion"},"skipped_folders":{"additionalProperties":{"type":"string"},"type":"object","title":"Skipped Folders","description":"Folder IDs skipped with a reason"},"skipped_files":{"additionalProperties":{"type":"string"},"type":"object","title":"Skipped Files","description":"File IDs skipped with a reason"}},"type":"object","required":["store_id","selected_folder_ids","backfill_folder_ids","skipped_folders"],"title":"GoogleDriveFolderSelectionUpdate","description":"Result of updating Google Drive folder selection."},"GoogleDriveFolderSelectionUpdateParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Google Drive installation ID"},"operation":{"type":"string","enum":["sync","unsync"],"title":"Operation","description":"Whether to sync or unsync the requested Drive items"},"folder_ids":{"items":{"type":"string"},"type":"array","title":"Folder Ids","description":"Google Drive folder IDs to apply the operation to"},"file_ids":{"items":{"type":"string"},"type":"array","title":"File Ids","description":"Google Drive file IDs to apply the operation to"}},"type":"object","required":["installation_id","operation"],"title":"GoogleDriveFolderSelectionUpdateParams","description":"Operation for updating Google Drive file and folder ingestion selection."},"GoogleDriveFolderSelectionUpdateResponse":{"properties":{"data":{"$ref":"#/components/schemas/GoogleDriveFolderSelectionUpdate","description":"Google Drive folder selection update"}},"type":"object","required":["data"],"title":"GoogleDriveFolderSelectionUpdateResponse","description":"Google Drive folder selection update response."},"GoogleDriveImportResult":{"properties":{"status":{"type":"string","enum":["indexed","skipped","failed"],"title":"Status","description":"Last import outcome for this Drive file"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When this import outcome was recorded"},"error_code":{"anyOf":[{"type":"string","enum":["unsupported_file_type","unsupported_export","empty_file","invalid_file","unsupported_detected_mime","google_drive_api_error"]},{"type":"null"}],"title":"Error Code","description":"Machine-readable import failure reason, if the file was skipped or failed"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"User-facing import failure reason, if the file was skipped or failed"}},"type":"object","required":["status","updated_at"],"title":"GoogleDriveImportResult","description":"Last async import outcome for a Google Drive file."},"GoogleDriveInstallationConfigUpdateBody":{"properties":{"auto_sync_all":{"type":"boolean","title":"Auto Sync All","description":"Whether the entire Drive (all current and future files) is synced automatically"}},"type":"object","required":["auto_sync_all"],"title":"GoogleDriveInstallationConfigUpdateBody","description":"Request body for updating a Google Drive installation's data source config."},"GoogleDriveInstallationOverview":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Google Drive installation ID"},"account_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Email","description":"Connected Google account email"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name","description":"Connected Google account name"},"status":{"type":"string","title":"Status","description":"The installation status"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread ingestion store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread ingestion store name"},"syncing_folder_count":{"type":"integer","title":"Syncing Folder Count","description":"Number of Google Drive folders selected for ingestion","default":0},"auto_sync_all":{"type":"boolean","title":"Auto Sync All","description":"Whether the entire Drive is synced automatically","default":false}},"type":"object","required":["installation_id","account_email","account_name","status"],"title":"GoogleDriveInstallationOverview","description":"Summary of a connected Google Drive account for the data sources overview."},"GoogleDriveInstallationOverviewListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GoogleDriveInstallationOverview"},"type":"array","title":"Data","description":"Connected Google Drive accounts"}},"type":"object","required":["data"],"title":"GoogleDriveInstallationOverviewListResponse","description":"List of connected Google Drive accounts for the data sources overview."},"GoogleDriveItem":{"properties":{"id":{"type":"string","title":"Id","description":"Google Drive file or folder ID"},"name":{"type":"string","title":"Name","description":"Google Drive item name"},"type":{"type":"string","enum":["file","folder"],"title":"Type","description":"Whether this Drive item is a file or folder"},"mime_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mime Type","description":"Google Drive MIME type"},"web_view_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Web View Link","description":"Google Drive web view link"},"modified_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Modified Time","description":"Google Drive modified time"},"is_selected":{"type":"boolean","title":"Is Selected","description":"Whether this item is directly selected for store ingestion","default":false},"sync_state":{"type":"string","enum":["syncing","partial","not_syncing"],"title":"Sync State","description":"Current sync state for this visible Drive item","default":"not_syncing"},"unsupported_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unsupported Reason","description":"Reason this file cannot be imported, or null when import is supported"},"import_status":{"anyOf":[{"$ref":"#/components/schemas/GoogleDriveImportResult"},{"type":"null"}],"description":"Last async import outcome for this Drive file, or null when no import has run"}},"type":"object","required":["id","name","type"],"title":"GoogleDriveItem","description":"Google Drive file or folder exposed for connector configuration."},"GoogleDriveSync":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Google Drive installation ID"},"queued":{"type":"boolean","title":"Queued","description":"Whether an incremental sync was queued"}},"type":"object","required":["installation_id","queued"],"title":"GoogleDriveSync","description":"Result of triggering a Google Drive sync."},"GoogleDriveSyncParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Google Drive installation ID"}},"type":"object","required":["installation_id"],"title":"GoogleDriveSyncParams","description":"Parameters for manually syncing a Google Drive connector."},"GoogleDriveSyncResponse":{"properties":{"data":{"$ref":"#/components/schemas/GoogleDriveSync","description":"Google Drive manual sync result"}},"type":"object","required":["data"],"title":"GoogleDriveSyncResponse","description":"Google Drive manual sync response."},"GranolaBreadcrumb":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Granola folder ID, or null for the top level"},"name":{"type":"string","title":"Name","description":"Granola folder name"}},"type":"object","required":["name"],"title":"GranolaBreadcrumb","description":"A folder location in the Granola browser breadcrumb trail."},"GranolaExcludedChildren":{"properties":{"parent_folder_id":{"type":"string","title":"Parent Folder Id","description":"Selected Granola parent folder ID"},"child_ids":{"items":{"type":"string"},"type":"array","title":"Child Ids","description":"Direct child Granola folder or note IDs excluded under the parent"}},"type":"object","required":["parent_folder_id","child_ids"],"title":"GranolaExcludedChildren","description":"Direct Granola children excluded from a selected parent folder."},"GranolaFolder":{"properties":{"id":{"type":"string","title":"Id","description":"Granola folder ID"},"name":{"type":"string","title":"Name","description":"Granola folder name"},"is_selected":{"type":"boolean","title":"Is Selected","description":"Whether this folder is selected for store ingestion","default":false},"web_view_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Web View Link","description":"Granola folder web link"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At","description":"Last successful sync time"}},"type":"object","required":["id","name"],"title":"GranolaFolder","description":"Granola folder exposed for connector configuration."},"GranolaFolderSelection":{"properties":{"is_installed":{"type":"boolean","title":"Is Installed","description":"Whether Granola is installed for the organization"},"installation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installation Id","description":"Granola installation ID"},"account_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Email","description":"Connected Granola account email, if known"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread store name"},"auto_sync_all":{"type":"boolean","title":"Auto Sync All","description":"Whether all Granola notes are synced automatically. Always false for Granola.","default":false},"current_folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Current Folder Id","description":"Current Granola browser folder ID"},"breadcrumbs":{"items":{"$ref":"#/components/schemas/GranolaBreadcrumb"},"type":"array","title":"Breadcrumbs","description":"Breadcrumb path for the current Granola browser folder"},"items":{"items":{"$ref":"#/components/schemas/GranolaItem"},"type":"array","title":"Items","description":"Notes and folders in the current Granola browser folder"},"selected_folder_ids":{"items":{"type":"string"},"type":"array","title":"Selected Folder Ids","description":"Every Granola folder ID selected for ingestion"},"selected_file_ids":{"items":{"type":"string"},"type":"array","title":"Selected File Ids","description":"Every Granola note ID directly selected for ingestion"},"excluded_children":{"items":{"$ref":"#/components/schemas/GranolaExcludedChildren"},"type":"array","title":"Excluded Children","description":"Direct child folder or note exclusions grouped by selected parent folder"},"sync_schedule":{"$ref":"#/components/schemas/GranolaSyncSchedule","description":"Periodic sync schedule for this installation"},"resource_catalog_status":{"type":"string","enum":["queued","syncing","ready","failed"],"title":"Resource Catalog Status","description":"Current Granola resource catalog refresh status"},"folders":{"items":{"$ref":"#/components/schemas/GranolaFolder"},"type":"array","title":"Folders","description":"Available Granola folders"}},"type":"object","required":["is_installed","resource_catalog_status","folders"],"title":"GranolaFolderSelection","description":"Granola folder selection for a store connector."},"GranolaFolderSelectionResponse":{"properties":{"data":{"$ref":"#/components/schemas/GranolaFolderSelection","description":"Granola folder selection"}},"type":"object","required":["data"],"title":"GranolaFolderSelectionResponse","description":"Granola folder selection response."},"GranolaFolderSelectionUpdate":{"properties":{"store_id":{"type":"string","title":"Store Id","description":"Mixedbread store ID"},"selected_folder_ids":{"items":{"type":"string"},"type":"array","title":"Selected Folder Ids","description":"Selected Granola folder IDs"},"selected_file_ids":{"items":{"type":"string"},"type":"array","title":"Selected File Ids","description":"Selected Granola note IDs"},"excluded_children":{"items":{"$ref":"#/components/schemas/GranolaExcludedChildren"},"type":"array","title":"Excluded Children","description":"Direct child folder or note exclusions grouped by selected parent folder"},"backfill_folder_ids":{"items":{"type":"string"},"type":"array","title":"Backfill Folder Ids","description":"Folders queued for backfill ingestion"},"backfill_file_ids":{"items":{"type":"string"},"type":"array","title":"Backfill File Ids","description":"Granola notes queued for backfill ingestion"},"skipped_folders":{"additionalProperties":{"type":"string"},"type":"object","title":"Skipped Folders","description":"Folder IDs skipped with a reason"},"skipped_files":{"additionalProperties":{"type":"string"},"type":"object","title":"Skipped Files","description":"Note IDs skipped with a reason"}},"type":"object","required":["store_id","selected_folder_ids","backfill_folder_ids","skipped_folders"],"title":"GranolaFolderSelectionUpdate","description":"Result of updating Granola folder selection."},"GranolaFolderSelectionUpdateParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Granola installation ID"},"operation":{"type":"string","enum":["sync","unsync"],"title":"Operation","description":"Whether to sync or unsync the requested Granola folders"},"folder_ids":{"items":{"type":"string"},"type":"array","title":"Folder Ids","description":"Granola folder IDs to apply the operation to"},"file_ids":{"items":{"type":"string"},"type":"array","title":"File Ids","description":"Granola note IDs to apply the operation to"},"current_folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Current Folder Id","description":"Current Granola folder context for note-level operations"}},"type":"object","required":["installation_id","operation"],"title":"GranolaFolderSelectionUpdateParams","description":"Operation for updating Granola folder ingestion selection."},"GranolaFolderSelectionUpdateResponse":{"properties":{"data":{"$ref":"#/components/schemas/GranolaFolderSelectionUpdate","description":"Granola folder selection update"}},"type":"object","required":["data"],"title":"GranolaFolderSelectionUpdateResponse","description":"Granola folder selection update response."},"GranolaInstallationOverview":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Granola installation ID"},"account_id":{"type":"string","title":"Account Id","description":"Stable derived Granola account/API-key identity"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name","description":"Connected Granola account name"},"status":{"type":"string","title":"Status","description":"The installation status"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread ingestion store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread ingestion store name"},"syncing_folder_count":{"type":"integer","title":"Syncing Folder Count","description":"Number of Granola folders selected for ingestion","default":0},"syncing_item_count":{"type":"integer","title":"Syncing Item Count","description":"Number of Granola folders and notes selected for ingestion","default":0},"sync_schedule":{"$ref":"#/components/schemas/GranolaSyncSchedule","description":"Periodic sync schedule for this installation"}},"type":"object","required":["installation_id","account_id","account_name","status"],"title":"GranolaInstallationOverview","description":"Summary of a connected Granola API key for the data sources overview."},"GranolaInstallationOverviewListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GranolaInstallationOverview"},"type":"array","title":"Data","description":"Connected Granola API keys"}},"type":"object","required":["data"],"title":"GranolaInstallationOverviewListResponse","description":"List of connected Granola API keys for the data sources overview."},"GranolaItem":{"properties":{"id":{"type":"string","title":"Id","description":"Granola note or folder ID"},"name":{"type":"string","title":"Name","description":"Granola item name"},"type":{"type":"string","enum":["note","folder"],"title":"Type","description":"Whether this item is a note or folder"},"mime_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mime Type","description":"MIME type for notes"},"web_view_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Web View Link","description":"Granola web URL"},"modified_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Modified Time","description":"Granola note updated time"},"is_selected":{"type":"boolean","title":"Is Selected","description":"Whether this item is directly selected for store ingestion","default":false},"sync_state":{"type":"string","enum":["syncing","partial","not_syncing"],"title":"Sync State","description":"Current sync state for this visible Granola item","default":"not_syncing"},"unsupported_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unsupported Reason","description":"Reason this item cannot be selected directly, or null when selectable"},"import_status":{"anyOf":[{"$ref":"#/components/schemas/GoogleDriveImportResult"},{"type":"null"}],"description":"Reserved for a future Granola per-note import outcome"}},"type":"object","required":["id","name","type"],"title":"GranolaItem","description":"Granola note or folder exposed for connector configuration."},"GranolaManualConnectBody":{"properties":{"api_key":{"type":"string","minLength":1,"title":"Api Key","description":"Granola API key"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Optional ingestion store name"},"store_config":{"$ref":"#/components/schemas/IntegrationStoreConfig","description":"Configuration applied to the ingestion store and imported files","default":{"metadata_contextualization":true,"file_contextualization":true,"ingestion_mode":"high_quality"}},"sync_schedule_interval":{"type":"string","enum":["off","ten_minutes","hourly","daily","weekly"],"title":"Sync Schedule Interval","description":"Initial periodic sync interval","default":"ten_minutes"}},"type":"object","required":["api_key"],"title":"GranolaManualConnectBody","description":"Request body for connecting Granola with an API key."},"GranolaSync":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Granola installation ID"},"queued":{"type":"boolean","title":"Queued","description":"Whether selected folders were queued"}},"type":"object","required":["installation_id","queued"],"title":"GranolaSync","description":"Result of triggering a Granola sync."},"GranolaSyncParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Granola installation ID"}},"type":"object","required":["installation_id"],"title":"GranolaSyncParams","description":"Parameters for manually syncing a Granola connector."},"GranolaSyncResponse":{"properties":{"data":{"$ref":"#/components/schemas/GranolaSync","description":"Granola manual sync result"}},"type":"object","required":["data"],"title":"GranolaSyncResponse","description":"Granola manual sync response."},"GranolaSyncSchedule":{"properties":{"interval":{"type":"string","enum":["off","ten_minutes","hourly","daily","weekly"],"title":"Interval","description":"Selected periodic sync interval","default":"off"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"When the schedule metadata was last changed"}},"type":"object","title":"GranolaSyncSchedule","description":"Persisted periodic sync schedule for a Granola installation."},"GranolaSyncScheduleUpdate":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Granola installation ID"},"sync_schedule":{"$ref":"#/components/schemas/GranolaSyncSchedule","description":"Updated Granola sync schedule"}},"type":"object","required":["installation_id","sync_schedule"],"title":"GranolaSyncScheduleUpdate","description":"Result of updating a Granola sync schedule."},"GranolaSyncScheduleUpdateParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Granola installation ID"},"interval":{"type":"string","enum":["off","ten_minutes","hourly","daily","weekly"],"title":"Interval","description":"Periodic sync interval to apply"}},"type":"object","required":["installation_id","interval"],"title":"GranolaSyncScheduleUpdateParams","description":"Parameters for updating a Granola installation sync schedule."},"GranolaSyncScheduleUpdateResponse":{"properties":{"data":{"$ref":"#/components/schemas/GranolaSyncScheduleUpdate","description":"Granola sync schedule update result"}},"type":"object","required":["data"],"title":"GranolaSyncScheduleUpdateResponse","description":"Granola sync schedule update response."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ImageChunkGeneratedMetadata":{"properties":{"type":{"type":"string","const":"image","title":"Type","default":"image"},"file_type":{"type":"string","title":"File Type","default":"image/jpeg"},"file_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Size"},"width":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Width"},"height":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Height"},"file_extension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Extension"},"layout":{"anyOf":[{"$ref":"#/components/schemas/LayoutMetadata"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"ImageChunkGeneratedMetadata"},"ImageUrl-Input":{"properties":{"url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"string","pattern":"data:(?P<mimetype>[\\w]+\\/[\\w\\-\\+\\.]+)?(?:\\;name\\=(?P<name>[\\w\\.\\-%!*'~\\(\\)]+))?(?:\\;charset\\=(?P<charset>[\\w\\-\\+\\.]+))?(?P<base64>\\;base64)?,(?P<data>.*)","examples":["data:text/plain;charset=utf-8;base64,VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZWQgb3ZlciB0aGUgbGF6eSBkb2cu"]}],"title":"Url","description":"The image URL. Can be either a URL or a Data URI."},"format":{"type":"string","title":"Format","description":"The image format/mimetype","default":""}},"type":"object","required":["url"],"title":"ImageUrl","description":"Model for image URL validation."},"ImageUrl-Output":{"properties":{"url":{"type":"string","title":"Url","description":"The image URL. Can be either a URL or a Data URI."},"format":{"type":"string","title":"Format","description":"The image format/mimetype","default":""}},"type":"object","required":["url"],"title":"ImageUrl","description":"Model for image URL validation."},"ImageUrlInput":{"properties":{"type":{"type":"string","const":"image_url","title":"Type","description":"Input type identifier","default":"image_url"},"image_url":{"$ref":"#/components/schemas/ImageUrl-Input","description":"The image input specification."}},"type":"object","required":["image_url"],"title":"ImageUrlInput","description":"Model for image input validation."},"ImageUrlInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"image/jpeg","examples":["image/jpeg"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"type":{"type":"string","const":"image_url","title":"Type","description":"Input type identifier","default":"image_url"},"ocr_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ocr Text","description":"ocr text of the image","examples":["2025 Financial Report"]},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this image within its source document","examples":["This page contains ACME's Q2 2023 financial results."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the image","examples":["A financial report for 2025"]},"image_url":{"anyOf":[{"$ref":"#/components/schemas/ImageUrl-Output"},{"type":"null"}],"description":"Image URL"}},"type":"object","required":["chunk_index"],"title":"ImageUrlInputChunk"},"InfoResponse":{"properties":{"name":{"type":"string","title":"Name"},"version":{"type":"string","title":"Version"}},"type":"object","required":["name","version"],"title":"InfoResponse","description":"Info Pydantic Response Service Message"},"InnerErrorResponse":{"properties":{"message":{"type":"string","title":"Message","description":"The error message"},"code":{"type":"integer","title":"Code","description":"The error code"},"type":{"type":"string","title":"Type","description":"The error type"}},"type":"object","required":["message","code","type"],"title":"InnerErrorResponse","description":"Inner Error Pydantic Response Service Message"},"IntegrationInstallation":{"properties":{"id":{"type":"string","title":"Id","description":"The integration installation ID"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The creation time"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The last update time"},"organization_id":{"type":"string","title":"Organization Id","description":"The organization ID"},"provider":{"type":"string","title":"Provider","description":"The integration provider identifier"},"external_account_id":{"type":"string","title":"External Account Id","description":"The provider workspace/account ID"},"external_account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Account Name","description":"The provider workspace/account name"},"installed_by_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installed By User Id","description":"The Mixedbread user who installed the provider"},"status":{"type":"string","title":"Status","description":"The installation status"},"scopes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Scopes","description":"Granted provider scopes"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Provider-specific metadata"}},"type":"object","required":["id","created_at","updated_at","organization_id","provider","external_account_id","external_account_name","installed_by_user_id","status","scopes","metadata"],"title":"IntegrationInstallation","description":"Service-level representation of an installed provider integration."},"IntegrationInstallationListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IntegrationInstallation"},"type":"array","title":"Data","description":"Integration installations"},"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"IntegrationInstallationListResponse","description":"List of integration installations with pagination."},"IntegrationInstallationResponse":{"properties":{"data":{"$ref":"#/components/schemas/IntegrationInstallation","description":"Integration installation"}},"type":"object","required":["data"],"title":"IntegrationInstallationResponse","description":"Integration installation response."},"IntegrationProviderListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IntegrationProviderManifest"},"type":"array","title":"Data","description":"Supported integration providers"}},"type":"object","required":["data"],"title":"IntegrationProviderListResponse","description":"List of supported integration providers."},"IntegrationProviderManifest":{"properties":{"provider":{"type":"string","enum":["slack","notion","linear","google_drive","gmail","granola","salesforce"],"title":"Provider","description":"The integration provider identifier"},"display_name":{"type":"string","title":"Display Name","description":"Human-readable provider name"},"auth_type":{"type":"string","enum":["oauth2","bot_token","api_key"],"title":"Auth Type","description":"Primary authorization method"},"capabilities":{"items":{"type":"string","enum":["ingest_to_store","notify","external_action"]},"type":"array","title":"Capabilities","description":"Supported integration capabilities"},"required_scopes":{"items":{"type":"string"},"type":"array","title":"Required Scopes","description":"Provider scopes required for the initial install"},"ingestion_backing":{"anyOf":[{"type":"string","enum":["data_source_connector","integration_job"]},{"type":"null"}],"title":"Ingestion Backing","description":"The backend subsystem used for ingestion, if ingestion is supported"}},"type":"object","required":["provider","display_name","auth_type","capabilities","required_scopes"],"title":"IntegrationProviderManifest","description":"Provider metadata exposed to product surfaces."},"IntegrationStoreConfig":{"properties":{"metadata_contextualization":{"type":"boolean","title":"Metadata Contextualization","description":"Contextualize chunks with the connector's curated metadata fields","default":true},"file_contextualization":{"type":"boolean","title":"File Contextualization","description":"Generate an LLM context for each chunk situating it within the full document","default":true},"ingestion_mode":{"$ref":"#/components/schemas/StoreFileParsingStrategy","description":"Parsing strategy for imported files","default":"high_quality"}},"type":"object","title":"IntegrationStoreConfig","description":"Store and file configuration chosen when connecting a data source.\n\nApplied to the ingestion store when the connector creates it and to every imported file.\nThe defaults (contextualization on, high-quality ingestion) give the best retrieval quality\nand downstream availability. A pre-existing store keeps its own configuration; only the\ningestion mode still applies to newly imported files."},"JsonSchemaCreateParams":{"properties":{"description":{"type":"string","title":"Description","description":"Description of the data to extract"}},"type":"object","required":["description"],"title":"JsonSchemaCreateParams","description":"Parameters for creating a JSON schema."},"JsonSchemaEnhanceParams":{"properties":{"json_schema":{"additionalProperties":true,"type":"object","title":"Json Schema","description":"The JSON schema to enhance"}},"type":"object","required":["json_schema"],"title":"JsonSchemaEnhanceParams","description":"Parameters for enhancing a JSON schema."},"JsonSchemaValidateParams":{"properties":{"json_schema":{"additionalProperties":true,"type":"object","title":"Json Schema","description":"The JSON schema to validate"}},"type":"object","required":["json_schema"],"title":"JsonSchemaValidateParams","description":"Parameters for validating a JSON schema."},"LayoutElement":{"properties":{"bbox":{"prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"},{"type":"number"}],"type":"array","maxItems":4,"minItems":4,"title":"Bbox"},"type":{"type":"string","title":"Type"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"}},"type":"object","required":["bbox","type"],"title":"LayoutElement","description":"A single detected layout element and its location on the page image."},"LayoutMetadata":{"properties":{"width":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Width"},"height":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Height"},"elements":{"items":{"$ref":"#/components/schemas/LayoutElement"},"type":"array","title":"Elements"}},"type":"object","title":"LayoutMetadata","description":"Per-page layout for chunks parsed in high-quality (visual) mode.\n\n``elements`` are ordered by reading order (list position == reading order).\n``width``/``height`` are the page-image dimensions the ``bbox`` coords are\nrelative to, so consumers can normalize/render without a second fetch.\n\nLayout is part of the generated metadata payload and is returned with the\nchunk whenever present."},"LinearDataSourceCreateOrUpdateParams":{"properties":{"type":{"type":"string","const":"linear","title":"Type","description":"The type of data source to create","default":"linear"},"name":{"type":"string","title":"Name","description":"The name of the data source"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"The metadata of the data source"},"auth_params":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/OAuth2CreateOrUpdateParams"}],"discriminator":{"propertyName":"type","mapping":{"oauth2":"#/components/schemas/OAuth2CreateOrUpdateParams"}}},{"type":"null"}],"title":"Auth Params","description":"The authentication parameters of the data source. Linear only supports OAuth2."}},"type":"object","required":["name"],"title":"LinearDataSourceCreateOrUpdateParams","description":"Parameters for creating or updating a Linear data source."},"LinearInstallationOverview":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Linear installation ID"},"workspace_id":{"type":"string","title":"Workspace Id","description":"Linear workspace ID"},"workspace_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workspace Name","description":"Linear workspace name"},"status":{"type":"string","title":"Status","description":"The installation status"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread ingestion store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread ingestion store name"},"syncing_team_count":{"type":"integer","title":"Syncing Team Count","description":"Number of Linear teams selected for ingestion","default":0}},"type":"object","required":["installation_id","workspace_id","workspace_name","status"],"title":"LinearInstallationOverview","description":"Summary of a connected Linear workspace for the data sources overview."},"LinearInstallationOverviewListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LinearInstallationOverview"},"type":"array","title":"Data","description":"Connected Linear workspaces"}},"type":"object","required":["data"],"title":"LinearInstallationOverviewListResponse","description":"List of connected Linear workspaces for the data sources overview."},"LinearSync":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Linear installation ID"},"queued_team_ids":{"items":{"type":"string"},"type":"array","title":"Queued Team Ids","description":"Linear team IDs queued for issue sync"}},"type":"object","required":["installation_id","queued_team_ids"],"title":"LinearSync","description":"Result of triggering a Linear sync."},"LinearSyncParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Linear installation ID"}},"type":"object","required":["installation_id"],"title":"LinearSyncParams","description":"Parameters for manually syncing a Linear connector."},"LinearSyncResponse":{"properties":{"data":{"$ref":"#/components/schemas/LinearSync","description":"Linear manual sync result"}},"type":"object","required":["data"],"title":"LinearSyncResponse","description":"Linear manual sync response."},"LinearTeam":{"properties":{"id":{"type":"string","title":"Id","description":"Linear team ID"},"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key","description":"Linear team key"},"name":{"type":"string","title":"Name","description":"Linear team name"},"is_selected":{"type":"boolean","title":"Is Selected","description":"Whether this team is selected for store ingestion","default":false},"sync_status":{"type":"string","enum":["syncing","not_syncing","error"],"title":"Sync Status","description":"Current Linear ingestion status","default":"not_syncing"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At","description":"Last successful Linear sync time"},"sync_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sync Error","description":"Last Linear sync error"},"last_sync_status":{"anyOf":[{"type":"string","enum":["queued","in_progress","completed","skipped","error"]},{"type":"null"}],"title":"Last Sync Status","description":"Most recent Linear backfill status"},"last_sync_started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sync Started At","description":"Most recent Linear backfill start time"},"last_sync_completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sync Completed At","description":"Most recent Linear backfill completion time"},"last_sync_issue_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Sync Issue Count","description":"Issues fetched in the most recent Linear backfill"},"last_sync_run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Sync Run Id","description":"Most recent Linear backfill run ID"},"syncs_in_progress":{"type":"integer","title":"Syncs In Progress","description":"Number of active Linear backfills for this team","default":0},"last_sync_failed_count":{"type":"integer","title":"Last Sync Failed Count","description":"Issues that failed during the most recent Linear backfill","default":0}},"type":"object","required":["id","name"],"title":"LinearTeam","description":"Linear team exposed for connector configuration."},"LinearTeamSelection":{"properties":{"is_installed":{"type":"boolean","title":"Is Installed","description":"Whether Linear is installed for the organization"},"installation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installation Id","description":"Linear installation ID"},"workspace_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workspace Id","description":"Linear workspace ID"},"workspace_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workspace Name","description":"Linear workspace name"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread store name"},"teams":{"items":{"$ref":"#/components/schemas/LinearTeam"},"type":"array","title":"Teams","description":"Available Linear teams"},"selected_team_ids":{"items":{"type":"string"},"type":"array","title":"Selected Team Ids","description":"Every Linear team ID selected for ingestion"}},"type":"object","required":["is_installed","teams"],"title":"LinearTeamSelection","description":"Linear team selection for a store connector."},"LinearTeamSelectionResponse":{"properties":{"data":{"$ref":"#/components/schemas/LinearTeamSelection","description":"Linear team selection"}},"type":"object","required":["data"],"title":"LinearTeamSelectionResponse","description":"Linear team selection response."},"LinearTeamSelectionUpdate":{"properties":{"store_id":{"type":"string","title":"Store Id","description":"Mixedbread store ID"},"selected_team_ids":{"items":{"type":"string"},"type":"array","title":"Selected Team Ids","description":"Selected Linear team IDs"},"backfill_team_ids":{"items":{"type":"string"},"type":"array","title":"Backfill Team Ids","description":"Teams queued for backfill ingestion"},"skipped_teams":{"additionalProperties":{"type":"string"},"type":"object","title":"Skipped Teams","description":"Team IDs skipped with a reason"}},"type":"object","required":["store_id","selected_team_ids","backfill_team_ids","skipped_teams"],"title":"LinearTeamSelectionUpdate","description":"Result of updating Linear team selection."},"LinearTeamSelectionUpdateParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Linear installation ID"},"team_ids":{"items":{"type":"string"},"type":"array","title":"Team Ids","description":"Linear team IDs to ingest into the store"}},"type":"object","required":["installation_id","team_ids"],"title":"LinearTeamSelectionUpdateParams","description":"Parameters for selecting Linear teams for store ingestion."},"LinearTeamSelectionUpdateResponse":{"properties":{"data":{"$ref":"#/components/schemas/LinearTeamSelectionUpdate","description":"Linear team selection update"}},"type":"object","required":["data"],"title":"LinearTeamSelectionUpdateResponse","description":"Linear team selection update response."},"ListStoresCallItem":{"properties":{"type":{"type":"string","const":"list_stores_call","title":"Type","default":"list_stores_call"},"id":{"type":"string","title":"Id"},"status":{"type":"string","enum":["in_progress","completed","failed"],"title":"Status","default":"completed"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"stores":{"anyOf":[{"items":{"$ref":"#/components/schemas/ListStoresResult"},"type":"array"},{"type":"null"}],"title":"Stores"},"has_more":{"type":"boolean","title":"Has More","default":false},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"error":{"anyOf":[{"$ref":"#/components/schemas/ToolCallError"},{"type":"null"}]},"reasoning_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reasoning Offset"}},"type":"object","required":["id"],"title":"ListStoresCallItem","description":"Record of one server-side store listing execution."},"ListStoresResult":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"connectors":{"items":{"type":"string"},"type":"array","title":"Connectors","description":"Providers of the connectors ingesting into this store, e.g. slack or notion"}},"type":"object","required":["name"],"title":"ListStoresResult","description":"One store entry returned by the hosted list stores tool."},"ListStoresTool":{"properties":{"type":{"type":"string","const":"list_stores","title":"Type","default":"list_stores"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Number of stores returned per listing call","default":20}},"type":"object","title":"ListStoresTool","description":"Hosted tool: paginated listing of the caller's stores, executed server-side.\n\nPair it with the store-scoped tools that are left unpinned, so the model can\ndiscover which stores it may name."},"MarkdownChunkGeneratedMetadata":{"properties":{"type":{"type":"string","const":"markdown","title":"Type","default":"markdown"},"file_type":{"type":"string","const":"text/markdown","title":"File Type","default":"text/markdown"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"word_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Word Count"},"file_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Size"},"chunk_headings":{"items":{"$ref":"#/components/schemas/MarkdownHeading"},"type":"array","title":"Chunk Headings"},"heading_context":{"items":{"$ref":"#/components/schemas/MarkdownHeading"},"type":"array","title":"Heading Context"},"start_line":{"type":"integer","title":"Start Line","default":0},"num_lines":{"type":"integer","title":"Num Lines","default":0},"file_extension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Extension"},"frontmatter":{"additionalProperties":true,"type":"object","title":"Frontmatter"}},"additionalProperties":true,"type":"object","title":"MarkdownChunkGeneratedMetadata"},"MarkdownHeading":{"properties":{"level":{"type":"integer","title":"Level"},"text":{"type":"string","title":"Text"}},"type":"object","required":["level","text"],"title":"MarkdownHeading"},"MessageToolCall":{"properties":{"id":{"type":"string","title":"Id"},"type":{"type":"string","const":"function","title":"Type","default":"function"},"function":{"$ref":"#/components/schemas/ToolCallFunction"}},"type":"object","required":["id","function"],"title":"MessageToolCall","description":"One function tool call of an assistant message."},"MetadataCursorPagination":{"properties":{"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Maximum number of items to return per page (1-100)","default":20,"examples":[10,20,50]},"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="]},"before":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Before","description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="]},"include_total":{"type":"boolean","title":"Include Total","description":"Whether to include total count in response (expensive operation)","default":false,"examples":[false,true]},"statuses":{"anyOf":[{"items":{"$ref":"#/components/schemas/StoreFileStatus"},"type":"array"},{"type":"null"}],"title":"Statuses","description":"Status to filter by"},"metadata_filter":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Metadata Filter","description":"Metadata filter to apply to the query"}},"type":"object","title":"MetadataCursorPagination","description":"Cursor pagination with status and metadata."},"MetadataFacets":{"properties":{"facets":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Facets","description":"Metadata facets","examples":[{"author":{"count":1,"value":"John Doe"},"year":{"count":2,"value":"2024"}}]}},"type":"object","required":["facets"],"title":"MetadataFacets","description":"Represents metadata facets for a store."},"MetadataFacetsCallItem":{"properties":{"type":{"type":"string","const":"store_metadata_facets_call","title":"Type","default":"store_metadata_facets_call"},"id":{"type":"string","title":"Id"},"status":{"type":"string","enum":["in_progress","completed","failed"],"title":"Status","default":"completed"},"store":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store"},"facets":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Facets"},"error":{"anyOf":[{"$ref":"#/components/schemas/ToolCallError"},{"type":"null"}]},"reasoning_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reasoning Offset"}},"type":"object","required":["id"],"title":"MetadataFacetsCallItem","description":"Record of one server-side metadata facets lookup."},"MetadataFacetsParams":{"properties":{"store_identifiers":{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","maxItems":16,"minItems":1,"title":"Store Identifiers","description":"IDs or names of stores"},"top_k":{"type":"integer","minimum":1.0,"title":"Top K","description":"Number of results to return","default":10},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions"},"file_ids":{"anyOf":[{"prefixItems":[{"$ref":"#/components/schemas/ConditionOperator"},{"items":{"type":"string","format":"uuid"},"type":"array"}],"type":"array","maxItems":2,"minItems":2},{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"File Ids","description":"Optional list of file IDs to filter chunks by (inclusion filter)","examples":[["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],["in",["123e4567-e89b-12d3-a456-426614174000"]],["not_in",["123e4567-e89b-12d3-a456-426614174000"]]]},"query":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Query","description":"Search query text","examples":["how to configure SSL"]},"search_options":{"$ref":"#/components/schemas/StoreChunkSearchOptions","description":"Search configuration options"},"facets":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Facets","description":"Optional list of facets to return. Use dot for nested fields.","examples":["author","year","author.name"]},"max_fields":{"type":"integer","maximum":256.0,"minimum":1.0,"title":"Max Fields","description":"Maximum number of distinct metadata fields (keys) to return.","default":64},"max_values_per_field":{"type":"integer","maximum":256.0,"minimum":1.0,"title":"Max Values Per Field","description":"Maximum number of distinct values returned per field, ranked by count.","default":32},"max_files":{"type":"integer","maximum":100000.0,"minimum":1.0,"title":"Max Files","description":"Maximum number of store files scanned to compute facets.","default":10000}},"type":"object","required":["store_identifiers"],"title":"MetadataFacetsParams","description":"Parameters for getting metadata facets."},"MetadataFacetsTool":{"properties":{"store_identifiers":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","minItems":1},{"type":"null"}],"title":"Store Identifiers","description":"IDs or names of the stores the tool runs against; omit to let the model pick a store per call"},"type":{"type":"string","const":"store_metadata_facets","title":"Type","default":"store_metadata_facets"},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions restricting the files the facets are computed over"},"max_values_per_field":{"type":"integer","maximum":32.0,"minimum":1.0,"title":"Max Values Per Field","description":"Number of representative values reported per metadata field","default":5}},"type":"object","title":"MetadataFacetsTool","description":"Hosted tool: metadata field/value overview of the caller's stores, executed server-side.\n\nFacets tell the model which metadata keys exist and what their values look\nlike, so it can filter (`store_grep`, `store_list_chunks`) and phrase queries\nagainst real values instead of guessing."},"MetadataFilter":{"properties":{"key":{"type":"string","minLength":1,"title":"Key","description":"Metadata field key"},"operator":{"$ref":"#/components/schemas/ConditionOperator","description":"Comparison operator"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"type":"array"},{"type":"null"}],"title":"Value","description":"Value to compare against. Use a list for `in`/`not_in`."}},"type":"object","required":["key","operator","value"],"title":"MetadataFilter","description":"One metadata filter condition the model may attach to a hosted tool call."},"Mode":{"type":"string","enum":["fast","high_quality"],"title":"Mode","description":"The mode of the document parser."},"MultiEncodingEmbedding":{"properties":{"embedding":{"$ref":"#/components/schemas/MultipleEncodingsEmbeddingItem","description":"The encoded embedding data by encoding format.Returned, if more than one encoding format is used.","examples":[{"float":[0.1,0.2,0.3],"int8":[1,2,3]}]},"index":{"type":"integer","title":"Index","description":"The index of the embedding.","examples":[0]},"object":{"type":"string","const":"embedding_dict","title":"Object","description":"The object type of the embedding.","default":"embedding_dict","examples":["embedding_dict"]}},"type":"object","required":["embedding","index"],"title":"MultiEncodingEmbedding"},"MultiModalQuery":{"anyOf":[{"type":"string","minLength":1,"description":"The text input document to create embeddings for.","examples":["This is a sample text input."]},{"oneOf":[{"$ref":"#/components/schemas/ImageUrlInput"},{"$ref":"#/components/schemas/TextInput"}],"description":"The input to create embeddings for.","discriminator":{"propertyName":"type","mapping":{"image_url":"#/components/schemas/ImageUrlInput","text":"#/components/schemas/TextInput"}}}]},"MultipartUploadDetailResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The multipart upload record ID"},"filename":{"type":"string","title":"Filename","description":"Original filename"},"file_size":{"type":"integer","title":"File Size","description":"Total file size in bytes"},"mime_type":{"type":"string","title":"Mime Type","description":"MIME type of the file"},"part_count":{"type":"integer","title":"Part Count","description":"Number of parts the file was split into"},"created_at":{"type":"string","title":"Created At","description":"When the upload was initiated"},"completed_parts":{"items":{"$ref":"#/components/schemas/MultipartUploadPart"},"type":"array","title":"Completed Parts","description":"Parts that have already been uploaded"},"part_urls":{"items":{"$ref":"#/components/schemas/MultipartUploadPartUrl"},"type":"array","title":"Part Urls","description":"Presigned URLs for the parts that still need to be uploaded"}},"type":"object","required":["id","filename","file_size","mime_type","part_count","created_at","completed_parts","part_urls"],"title":"MultipartUploadDetailResponse"},"MultipartUploadListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MultipartUploadObject"},"type":"array","title":"Data","description":"List of in-progress multipart uploads"}},"type":"object","required":["data"],"title":"MultipartUploadListResponse"},"MultipartUploadObject":{"properties":{"id":{"type":"string","title":"Id","description":"The multipart upload record ID"},"filename":{"type":"string","title":"Filename","description":"Original filename"},"file_size":{"type":"integer","title":"File Size","description":"Total file size in bytes"},"mime_type":{"type":"string","title":"Mime Type","description":"MIME type of the file"},"part_count":{"type":"integer","title":"Part Count","description":"Number of parts the file was split into"},"created_at":{"type":"string","title":"Created At","description":"When the upload was initiated"}},"type":"object","required":["id","filename","file_size","mime_type","part_count","created_at"],"title":"MultipartUploadObject"},"MultipartUploadPart":{"properties":{"part_number":{"type":"integer","minimum":1.0,"title":"Part Number","description":"1-based part number"},"etag":{"type":"string","title":"Etag","description":"ETag returned by the storage backend after uploading the part"}},"type":"object","required":["part_number","etag"],"title":"MultipartUploadPart"},"MultipartUploadPartUrl":{"properties":{"part_number":{"type":"integer","minimum":1.0,"title":"Part Number","description":"1-based part number"},"url":{"type":"string","title":"Url","description":"Presigned URL for uploading this part"}},"type":"object","required":["part_number","url"],"title":"MultipartUploadPartUrl"},"MultipleEncodingsEmbeddingItem":{"properties":{"float":{"items":{"type":"number"},"type":"array","title":"Float"},"int8":{"items":{"type":"integer"},"type":"array","title":"Int8"},"uint8":{"items":{"type":"integer"},"type":"array","title":"Uint8"},"binary":{"items":{"type":"integer"},"type":"array","title":"Binary"},"ubinary":{"items":{"type":"integer"},"type":"array","title":"Ubinary"},"base64":{"type":"string","title":"Base64"}},"type":"object","title":"MultipleEncodingsEmbeddingItem"},"NotionDataSourceCreateOrUpdateParams":{"properties":{"type":{"type":"string","const":"notion","title":"Type","description":"The type of data source to create","default":"notion"},"name":{"type":"string","title":"Name","description":"The name of the data source"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"The metadata of the data source"},"auth_params":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/OAuth2CreateOrUpdateParams"},{"$ref":"#/components/schemas/ApiKeyCreateOrUpdateParams"}],"discriminator":{"propertyName":"type","mapping":{"api_key":"#/components/schemas/ApiKeyCreateOrUpdateParams","oauth2":"#/components/schemas/OAuth2CreateOrUpdateParams"}}},{"type":"null"}],"title":"Auth Params","description":"The authentication parameters of the data source. Notion supports OAuth2 and API key."}},"type":"object","required":["name"],"title":"NotionDataSourceCreateOrUpdateParams","description":"Parameters for creating or updating a Notion data source."},"NotionInstallationOverview":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Notion installation ID"},"workspace_id":{"type":"string","title":"Workspace Id","description":"Notion workspace ID"},"workspace_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workspace Name","description":"Notion workspace name"},"status":{"type":"string","title":"Status","description":"The installation status"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread ingestion store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread ingestion store name"},"item_count":{"type":"integer","title":"Item Count","description":"Number of Notion pages and databases discovered for ingestion","default":0}},"type":"object","required":["installation_id","workspace_id","workspace_name","status"],"title":"NotionInstallationOverview","description":"Summary of a connected Notion workspace for the data sources overview."},"NotionInstallationOverviewListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NotionInstallationOverview"},"type":"array","title":"Data","description":"Connected Notion workspaces"}},"type":"object","required":["data"],"title":"NotionInstallationOverviewListResponse","description":"List of connected Notion workspaces for the data sources overview."},"NotionManualConnectBody":{"properties":{"access_token":{"type":"string","minLength":1,"title":"Access Token","description":"Notion internal integration token (ntn_… or secret_…)"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Optional ingestion store name"},"store_config":{"$ref":"#/components/schemas/IntegrationStoreConfig","description":"Configuration applied to the ingestion store and imported files","default":{"metadata_contextualization":true,"file_contextualization":true,"ingestion_mode":"high_quality"}}},"type":"object","required":["access_token"],"title":"NotionManualConnectBody","description":"Request body for connecting Notion with a customer-created internal integration token."},"NotionResource":{"properties":{"id":{"type":"string","title":"Id","description":"Notion resource external ID"},"name":{"type":"string","title":"Name","description":"Notion resource title"},"resource_type":{"type":"string","enum":["notion_page","notion_database"],"title":"Resource Type","description":"Whether the resource is a page or a database"}},"type":"object","required":["id","name","resource_type"],"title":"NotionResource","description":"A Notion page or database discovered in the workspace catalog."},"NotionResourceSelection":{"properties":{"is_installed":{"type":"boolean","title":"Is Installed","description":"Whether Notion is installed for the organization"},"installation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installation Id","description":"Notion installation ID"},"workspace_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workspace Id","description":"Notion workspace ID"},"workspace_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workspace Name","description":"Notion workspace name"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread store name"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"title":"Auth Type","description":"How the workspace is connected: OAuth or an internal integration token","default":"oauth2"},"resources":{"items":{"$ref":"#/components/schemas/NotionResource"},"type":"array","title":"Resources","description":"Notion pages and databases for the current page"},"total_resources":{"type":"integer","title":"Total Resources","description":"Total Notion resources matching the current search across all pages","default":0},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset","description":"Offset for the next page of Notion resources, or null when there are no more"},"sync_status":{"type":"string","enum":["syncing","not_syncing","error"],"title":"Sync Status","description":"Current Notion ingestion status","default":"not_syncing"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At","description":"Last successful Notion sync time"},"sync_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sync Error","description":"Last Notion sync error"},"last_sync_status":{"anyOf":[{"type":"string","enum":["queued","in_progress","completed","skipped","error"]},{"type":"null"}],"title":"Last Sync Status","description":"Most recent Notion import status"},"last_sync_started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sync Started At","description":"Most recent Notion import start time"},"last_sync_completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sync Completed At","description":"Most recent Notion import completion time"},"syncs_in_progress":{"type":"integer","title":"Syncs In Progress","description":"Number of active Notion imports for this installation","default":0}},"type":"object","required":["is_installed"],"title":"NotionResourceSelection","description":"Notion workspace ingestion overview.\n\nNotion's sharing model makes the workspace the unit of ingestion: whatever a member shares with the\nintegration is ingested, so resource selection is implicit rather than per-resource."},"NotionResourceSelectionResponse":{"properties":{"data":{"$ref":"#/components/schemas/NotionResourceSelection","description":"Notion resource selection"}},"type":"object","required":["data"],"title":"NotionResourceSelectionResponse","description":"Notion resource selection response."},"NotionTreeItem":{"properties":{"id":{"type":"string","title":"Id","description":"Notion resource ID"},"name":{"type":"string","title":"Name","description":"Notion resource title"},"resource_type":{"type":"string","enum":["notion_page","notion_database"],"title":"Resource Type","description":"Whether the resource is a page or a database"},"has_children":{"type":"boolean","title":"Has Children","description":"Whether this resource has children to expand into"},"status":{"type":"string","enum":["pending","processing","completed","failed"],"title":"Status","description":"Ingestion status of this resource (pending until it has been ingested)","default":"pending"}},"type":"object","required":["id","name","resource_type","has_children"],"title":"NotionTreeItem","description":"A page/database in the resource tree, with whether it can be expanded and its ingestion status."},"NotionTreeResponse":{"properties":{"data":{"$ref":"#/components/schemas/NotionTreeView","description":"One level of the Notion resource tree"}},"type":"object","required":["data"],"title":"NotionTreeResponse","description":"Notion resource tree level response."},"NotionTreeView":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Notion installation ID"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id","description":"The browsed node, or null when listing the roots"},"items":{"items":{"$ref":"#/components/schemas/NotionTreeItem"},"type":"array","title":"Items","description":"Children of the browsed node (or flat search matches)"},"total":{"type":"integer","title":"Total","description":"Number of items returned","default":0}},"type":"object","required":["installation_id"],"title":"NotionTreeView","description":"One level of the Notion resource tree: the children of ``parent_id`` (or the roots), fetched lazily.\n\nEverything shared with the integration is ingested; this is a read-only view of that shared resource tree."},"NotionWebhookToken":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Notion installation ID"},"verification_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Token","description":"The captured Notion webhook verification token, or null if none has been received yet"}},"type":"object","required":["installation_id"],"title":"NotionWebhookToken","description":"The Notion webhook verification token Notion sent for a workspace, to be pasted back into Notion."},"NotionWebhookTokenResponse":{"properties":{"data":{"$ref":"#/components/schemas/NotionWebhookToken","description":"Notion webhook verification token"}},"type":"object","required":["data"],"title":"NotionWebhookTokenResponse","description":"Notion webhook verification token response."},"OAuth2CreateOrUpdateParams":{"properties":{"type":{"type":"string","const":"oauth2","title":"Type","default":"oauth2"}},"type":"object","title":"OAuth2CreateOrUpdateParams","description":"Base class for OAuth2 create or update parameters."},"PDFChunkGeneratedMetadata":{"properties":{"type":{"type":"string","const":"pdf","title":"Type","default":"pdf"},"file_type":{"type":"string","const":"application/pdf","title":"File Type","default":"application/pdf"},"total_pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Pages"},"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"file_extension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Extension"},"layout":{"anyOf":[{"$ref":"#/components/schemas/LayoutMetadata"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"PDFChunkGeneratedMetadata"},"PaginationWithTotal":{"properties":{"limit":{"type":"integer","maximum":1000.0,"title":"Limit","description":"Maximum number of items to return per page","default":100},"offset":{"type":"integer","title":"Offset","description":"Offset of the first item to return","default":0},"total":{"type":"integer","title":"Total","description":"Total number of items available","default":0}},"type":"object","title":"PaginationWithTotal","description":"Pagination model that includes total count of items."},"ParsingJobCreateParams":{"properties":{"file_id":{"type":"string","title":"File Id","description":"The ID of the file to parse"},"element_types":{"anyOf":[{"items":{"$ref":"#/components/schemas/ElementType"},"type":"array"},{"type":"null"}],"title":"Element Types","description":"The elements to extract from the document"},"chunking_strategy":{"$ref":"#/components/schemas/ChunkingStrategy","description":"The strategy to use for chunking the content","default":"page"},"return_format":{"$ref":"#/components/schemas/ReturnFormat","description":"The format of the returned content","default":"markdown"},"mode":{"$ref":"#/components/schemas/Mode","description":"The strategy to use for OCR","default":"high_quality"}},"type":"object","required":["file_id"],"title":"ParsingJobCreateParams","description":"Parameters for creating a parsing job."},"ParsingJobDeleted":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the deleted job"},"deleted":{"type":"boolean","title":"Deleted","description":"Whether the job was deleted","default":true},"object":{"type":"string","const":"parsing_job","title":"Object","description":"The type of the object","default":"parsing_job"}},"type":"object","required":["id"],"title":"ParsingJobDeleted","description":"A deleted parsing job."},"ParsingJobListItem":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the job"},"file_id":{"type":"string","title":"File Id","description":"The ID of the file to parse"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename","description":"The name of the file"},"status":{"$ref":"#/components/schemas/ParsingJobStatus","description":"The status of the job"},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error","description":"The error of the job"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At","description":"The started time of the job"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At","description":"The finished time of the job"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The creation time of the job"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The updated time of the job"},"object":{"type":"string","const":"parsing_job","title":"Object","description":"The type of the object","default":"parsing_job"}},"type":"object","required":["id","file_id","status"],"title":"ParsingJobListItem","description":"A parsing job item for list responses."},"ParsingJobListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse"},"data":{"items":{"$ref":"#/components/schemas/ParsingJobListItem"},"type":"array","title":"Data","description":"The list of parsing jobs"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"}},"type":"object","required":["pagination","data"],"title":"ParsingJobListResponse","description":"A list of parsing jobs with pagination."},"ParsingJobResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the job"},"file_id":{"type":"string","title":"File Id","description":"The ID of the file to parse"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename","description":"The name of the file"},"status":{"$ref":"#/components/schemas/ParsingJobStatus","description":"The status of the job"},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error","description":"The error of the job"},"result":{"anyOf":[{"$ref":"#/components/schemas/DocumentParserResultResponse"},{"type":"null"}],"description":"The result of the job"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At","description":"The started time of the job"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At","description":"The finished time of the job"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The creation time of the job"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The updated time of the job"},"object":{"type":"string","const":"parsing_job","title":"Object","description":"The type of the object","default":"parsing_job"}},"type":"object","required":["id","file_id","status"],"title":"ParsingJobResponse","description":"A parsing job with its result narrowed to the public fields."},"ParsingJobStatus":{"type":"string","enum":["pending","in_progress","cancelled","completed","failed"],"title":"ParsingJobStatus"},"Period":{"properties":{"start":{"type":"string","format":"date-time","title":"Start","description":"The start of the billing period"},"end":{"type":"string","format":"date-time","title":"End","description":"The end of the billing period"}},"type":"object","required":["start","end"],"title":"Period","description":"Inclusive/exclusive window describing a billing period."},"PhaseCostInfo":{"properties":{"period":{"$ref":"#/components/schemas/Period","description":"The period"},"net_usage_cost":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Net Usage Cost","description":"The net usage cost"},"gross_usage_cost":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Gross Usage Cost","description":"The gross usage cost"},"balance_applied":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Balance Applied","description":"The balance applied"}},"type":"object","required":["period","net_usage_cost","gross_usage_cost","balance_applied"],"title":"PhaseCostInfo","description":"Cost information for a billing phase."},"ProductCostInfo":{"properties":{"product_name":{"type":"string","title":"Product Name","description":"The name of the product. Store, Parsing, Reranking, Embeddings"},"gross_usage_cost":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Gross Usage Cost","description":"The gross usage cost of the product"},"net_usage_cost":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Net Usage Cost","description":"The net usage cost of the product"},"balance_applied":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Balance Applied","description":"The balance applied to the product"}},"type":"object","required":["product_name","gross_usage_cost","net_usage_cost","balance_applied"],"title":"ProductCostInfo","description":"Cost information for a product."},"PromptTokensDetails":{"properties":{"cached_tokens":{"type":"integer","title":"Cached Tokens","description":"Prompt tokens served from the cache; part of prompt_tokens, not extra","default":0}},"type":"object","title":"PromptTokensDetails","description":"Breakdown of the prompt tokens, as in the OpenAI usage object."},"QueryEnhanceMetadataFilter":{"properties":{"key":{"type":"string","minLength":1,"title":"Key","description":"Metadata field key"},"operator":{"$ref":"#/components/schemas/ConditionOperator","description":"Comparison operator"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"type":"array"},{"type":"null"}],"title":"Value","description":"Value to compare against. Use a list for `in`/`not_in`."}},"additionalProperties":false,"type":"object","required":["key","operator","value"],"title":"QueryEnhanceMetadataFilter","description":"Metadata filter condition."},"QueryEnhanceParams":{"properties":{"store_identifiers":{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","maxItems":16,"minItems":1,"title":"Store Identifiers","description":"IDs or names of stores"},"top_k":{"type":"integer","minimum":1.0,"title":"Top K","description":"Number of results to return","default":10},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions"},"file_ids":{"anyOf":[{"prefixItems":[{"$ref":"#/components/schemas/ConditionOperator"},{"items":{"type":"string","format":"uuid"},"type":"array"}],"type":"array","maxItems":2,"minItems":2},{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"File Ids","description":"Optional list of file IDs to filter chunks by (inclusion filter)","examples":[["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],["in",["123e4567-e89b-12d3-a456-426614174000"]],["not_in",["123e4567-e89b-12d3-a456-426614174000"]]]},"query":{"$ref":"#/components/schemas/MultiModalQuery","description":"Search query text","examples":["how to configure SSL"]},"search_options":{"$ref":"#/components/schemas/StoreChunkSearchOptions","description":"Search configuration options"},"instructions":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Instructions","description":"Optional guidance for query enhancement."}},"type":"object","required":["store_identifiers","query"],"title":"QueryEnhanceParams","description":"Parameters for enhancing a search query."},"QueryEnhanceQueryItem":{"properties":{"type":{"type":"string","const":"query","title":"Type","default":"query"},"query":{"type":"string","minLength":1,"title":"Query","description":"Search query text"},"metadata_filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/QueryEnhanceMetadataFilter"},"type":"array"},{"type":"null"}],"title":"Metadata Filters","description":"Metadata filters to apply"},"filter_mode":{"type":"string","enum":["all","any"],"title":"Filter Mode","description":"How to combine filters","default":"all"},"rank_by":{"type":"null","title":"Rank By","description":"Always null for semantic query items. Use a sort item to rank by metadata."},"direction":{"type":"null","title":"Direction","description":"Always null for semantic query items. Use a sort item to set rank direction."}},"type":"object","required":["query"],"title":"QueryEnhanceQueryItem","description":"Enhanced semantic search query with optional filters."},"QueryEnhanceResults":{"properties":{"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/QueryEnhanceQueryItem"},{"$ref":"#/components/schemas/QueryEnhanceSortItem"}],"discriminator":{"propertyName":"type","mapping":{"query":"#/components/schemas/QueryEnhanceQueryItem","sort":"#/components/schemas/QueryEnhanceSortItem"}}},"type":"array","maxItems":1,"minItems":1,"title":"Items","description":"Enhanced query item"}},"type":"object","required":["items"],"title":"QueryEnhanceResults","description":"Enhanced query response."},"QueryEnhanceSortItem":{"properties":{"type":{"type":"string","const":"sort","title":"Type","default":"sort"},"metadata_filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/QueryEnhanceMetadataFilter"},"type":"array"},{"type":"null"}],"title":"Metadata Filters","description":"Metadata filters to apply"},"filter_mode":{"type":"string","enum":["all","any"],"title":"Filter Mode","description":"How to combine filters","default":"all"},"rank_by":{"type":"string","minLength":1,"title":"Rank By","description":"Metadata field to rank results by"},"direction":{"type":"string","enum":["asc","desc"],"title":"Direction","description":"Ranking direction"}},"type":"object","required":["rank_by","direction"],"title":"QueryEnhanceSortItem","description":"Ranking request based on metadata."},"QueryRegexSubstitutionRule":{"properties":{"query":{"type":"string","title":"Query","description":"The query to trigger the rule"},"store_id":{"type":"string","title":"Store Id","description":"The store identifier to apply the rule to"},"type":{"type":"string","const":"query_regex","title":"Type","description":"The type of substitution"},"pattern":{"type":"string","title":"Pattern","description":"The regex pattern to match","examples":["\\b(\\w+)\\s+world\\b"]},"flags":{"items":{"$ref":"#/components/schemas/RegexFlag"},"type":"array","title":"Flags","description":"The regex flags to use","default":[]},"replacement":{"type":"string","title":"Replacement","description":"The replacement string (can use regex groups)","examples":["\\1\\sglobe"]}},"type":"object","required":["query","store_id","type","pattern","replacement"],"title":"QueryRegexSubstitutionRule","description":"Represents a regex query substitution rule for a vector store search."},"QueryStringSubstitutionRule":{"properties":{"query":{"type":"string","title":"Query","description":"The query to trigger the rule"},"store_id":{"type":"string","title":"Store Id","description":"The store identifier to apply the rule to"},"type":{"type":"string","const":"query_string","title":"Type","description":"The type of substitution"},"substitution":{"type":"string","title":"Substitution","description":"The substitution to apply","examples":["query1","query2"]}},"type":"object","required":["query","store_id","type","substitution"],"title":"QueryStringSubstitutionRule","description":"Represents a string query substitution rule for a vector store search."},"QuestionAnsweringOptions":{"properties":{"cite":{"type":"boolean","title":"Cite","description":"Whether to use citations","default":true},"multimodal":{"type":"boolean","title":"Multimodal","description":"Whether to use multimodal context","default":true}},"type":"object","title":"QuestionAnsweringOptions","description":"Options for question answering."},"RankedDocument":{"properties":{"index":{"type":"integer","title":"Index","description":"The index of the document.","examples":[0]},"score":{"type":"number","title":"Score","description":"The score of the document.","examples":[0.95]},"input":{"anyOf":[{},{"type":"null"}],"title":"Input","description":"The input document.","examples":[{"field1":"value1","field2":"value2"},"Hello, world!"]},"object":{"type":"string","const":"rank_result","title":"Object","description":"The object type.","default":"rank_result","examples":["rank_result"]}},"type":"object","required":["index","score"],"title":"RankedDocument"},"RegexFlag":{"type":"string","enum":["IGNORECASE","MULTILINE","DOTALL","VERBOSE","ASCII","UNICODE"],"title":"RegexFlag","description":"Supported regex flags."},"RerankConfig":{"properties":{"model":{"type":"string","maxLength":500,"minLength":1,"title":"Model","description":"The name of the reranking model","default":"mixedbread-ai/mxbai-rerank-v3.1-listwise","examples":["rerank_model"]},"with_metadata":{"anyOf":[{"type":"boolean"},{"items":{"type":"string"},"type":"array"}],"title":"With Metadata","description":"Whether to include metadata in the reranked results","default":false,"examples":[true,false,["metadata1","metadata2"]]},"top_k":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Top K","description":"Maximum number of results to return after reranking. If None, returns all reranked results.","examples":[10,50,100]}},"type":"object","title":"RerankConfig","description":"Represents a reranking configuration."},"RerankParams":{"properties":{"model":{"type":"string","maxLength":500,"minLength":1,"title":"Model","description":"The model to use for reranking documents.","default":"mixedbread-ai/mxbai-rerank-v3.1-listwise","examples":["mixedbread-ai/mxbai-rerank-v3.1-listwise"]},"query":{"type":"string","maxLength":32000,"minLength":1,"title":"Query","description":"The query to rerank the documents.","examples":["What are the key features of the Mixedbread embedding model?"]},"input":{"items":{"anyOf":[{"type":"string"},{},{"items":{},"type":"array"}]},"type":"array","maxItems":1000,"minItems":1,"title":"Input","description":"The input documents to rerank.","examples":[["Document 1","Document 2"],[{"field1":"value1","field2":"value2"},{"field1":"value3","field2":"value4"}]]},"rank_fields":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Rank Fields","description":"The fields of the documents to rank.","examples":[["content","title"],["document.text","metadata.summary"]]},"top_k":{"type":"integer","minimum":1.0,"title":"Top K","description":"The number of documents to return.","default":-1,"examples":[10]},"return_input":{"type":"boolean","title":"Return Input","description":"Whether to return the documents.","default":false,"examples":[false]},"rewrite_query":{"type":"boolean","title":"Rewrite Query","description":"Wether or not to rewrite the query before passing it to the reranking model","default":false,"examples":[false]}},"type":"object","required":["query","input"],"title":"RerankParams","description":"Parameters for reranking documents."},"RerankResponse":{"properties":{"usage":{"$ref":"#/components/schemas/Usage","description":"The usage of the model","examples":[{"completion_tokens":10,"prompt_tokens":10,"total_tokens":20}]},"model":{"type":"string","title":"Model","description":"The model used"},"data":{"items":{"$ref":"#/components/schemas/RankedDocument"},"type":"array","title":"Data","description":"The ranked documents.","examples":[[{"index":0,"input":{"field1":"value1","field2":"value2"},"object":"rank_result","score":0.95},{"index":1,"input":"Hello, world!","object":"rank_result","score":0.94}]]},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"top_k":{"type":"integer","title":"Top K","description":"The number of documents to return.","examples":[10]},"return_input":{"type":"boolean","title":"Return Input","description":"Whether to return the documents.","examples":[false]}},"type":"object","required":["usage","model","data","top_k","return_input"],"title":"RerankResponse"},"Response":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","const":"response","title":"Object","default":"response"},"created_at":{"type":"number","title":"Created At"},"status":{"type":"string","enum":["completed","failed","in_progress","cancelled","queued","incomplete"],"title":"Status"},"completed_at":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Completed At"},"error":{"anyOf":[{"$ref":"#/components/schemas/ResponseError"},{"type":"null"}]},"incomplete_details":{"anyOf":[{"$ref":"#/components/schemas/ResponseIncompleteDetails"},{"type":"null"}]},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instructions"},"model":{"type":"string","title":"Model","default":"toast-1"},"output":{"items":{"oneOf":[{"$ref":"#/components/schemas/ResponseOutputMessage"},{"$ref":"#/components/schemas/ResponseFunctionToolCall"},{"$ref":"#/components/schemas/ResponseReasoningItem"}],"discriminator":{"propertyName":"type","mapping":{"function_call":"#/components/schemas/ResponseFunctionToolCall","message":"#/components/schemas/ResponseOutputMessage","reasoning":"#/components/schemas/ResponseReasoningItem"}}},"type":"array","title":"Output"},"parallel_tool_calls":{"type":"boolean","title":"Parallel Tool Calls","default":true},"temperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Temperature"},"tool_choice":{"anyOf":[{"type":"string","enum":["none","auto","required"]},{"$ref":"#/components/schemas/ResponseToolChoiceFunction"}],"title":"Tool Choice","default":"auto"},"tools":{"items":{"anyOf":[{"$ref":"#/components/schemas/ResponseFunctionTool"},{"$ref":"#/components/schemas/ResponseNamespaceTool"}]},"type":"array","title":"Tools"},"top_p":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Top P"},"background":{"type":"boolean","title":"Background","default":false},"max_output_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Output Tokens"},"max_tool_calls":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Tool Calls"},"previous_response_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous Response Id"},"reasoning":{"anyOf":[{"$ref":"#/components/schemas/ResponseReasoningConfig"},{"type":"null"}]},"service_tier":{"type":"string","enum":["auto","default","flex","scale","priority"],"title":"Service Tier","default":"default"},"text":{"anyOf":[{"$ref":"#/components/schemas/ResponseTextConfig"},{"type":"null"}]},"truncation":{"type":"string","enum":["auto","disabled"],"title":"Truncation","default":"disabled"},"usage":{"anyOf":[{"$ref":"#/components/schemas/ResponseUsage"},{"type":"null"}]},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"safety_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Safety Identifier"},"prompt_cache_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Cache Key"},"user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User"},"hosted_tool_calls":{"items":{"oneOf":[{"$ref":"#/components/schemas/StoreSearchCallItem"},{"$ref":"#/components/schemas/StoreGrepCallItem"},{"$ref":"#/components/schemas/StoreListChunksCallItem"},{"$ref":"#/components/schemas/MetadataFacetsCallItem"},{"$ref":"#/components/schemas/ListStoresCallItem"}],"discriminator":{"propertyName":"type","mapping":{"list_stores_call":"#/components/schemas/ListStoresCallItem","store_grep_call":"#/components/schemas/StoreGrepCallItem","store_list_chunks_call":"#/components/schemas/StoreListChunksCallItem","store_metadata_facets_call":"#/components/schemas/MetadataFacetsCallItem","store_search_call":"#/components/schemas/StoreSearchCallItem"}}},"type":"array","title":"Hosted Tool Calls"},"hosted_tools":{"items":{"anyOf":[{"$ref":"#/components/schemas/StoreSearchTool"},{"$ref":"#/components/schemas/StoreGrepTool"},{"$ref":"#/components/schemas/StoreListChunksTool"},{"$ref":"#/components/schemas/MetadataFacetsTool"},{"$ref":"#/components/schemas/ListStoresTool"}]},"type":"array","title":"Hosted Tools"},"tool_tickets":{"items":{"$ref":"#/components/schemas/ToolTicket"},"type":"array","title":"Tool Tickets"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"}},"type":"object","required":["id","created_at","status"],"title":"Response","description":"A completed or in-progress OpenAI-compatible Response object."},"ResponseAgentMessageEncryptedContent":{"properties":{"type":{"type":"string","const":"encrypted_content","title":"Type","default":"encrypted_content"},"encrypted_content":{"type":"string","title":"Encrypted Content"}},"type":"object","required":["encrypted_content"],"title":"ResponseAgentMessageEncryptedContent","description":"Opaque agent-to-agent content that only the originating runtime can decrypt."},"ResponseAgentMessageInput":{"properties":{"type":{"type":"string","const":"agent_message","title":"Type","default":"agent_message"},"author":{"type":"string","title":"Author"},"recipient":{"type":"string","title":"Recipient"},"content":{"items":{"oneOf":[{"$ref":"#/components/schemas/ResponseInputTextPart"},{"$ref":"#/components/schemas/ResponseAgentMessageEncryptedContent"}],"discriminator":{"propertyName":"type","mapping":{"encrypted_content":"#/components/schemas/ResponseAgentMessageEncryptedContent","input_text":"#/components/schemas/ResponseInputTextPart"}}},"type":"array","minItems":1,"title":"Content"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"internal_chat_message_metadata_passthrough":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Internal Chat Message Metadata Passthrough"}},"type":"object","required":["author","recipient","content"],"title":"ResponseAgentMessageInput","description":"A Codex multi-agent message replayed as Responses input."},"ResponseCompactionConfig":{"properties":{"type":{"type":"string","const":"compaction","title":"Type","default":"compaction"},"compact_threshold":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Compact Threshold"}},"type":"object","title":"ResponseCompactionConfig"},"ResponseCreateParams":{"properties":{"model":{"type":"string","title":"Model","default":"toast-1"},"input":{"anyOf":[{"type":"string"},{"items":{"oneOf":[{"$ref":"#/components/schemas/ResponseMessageInput"},{"$ref":"#/components/schemas/ResponseFunctionCallInput"},{"$ref":"#/components/schemas/ResponseFunctionCallOutputInput"},{"$ref":"#/components/schemas/ResponseReasoningInput"},{"$ref":"#/components/schemas/ResponseAgentMessageInput"}],"discriminator":{"propertyName":"type","mapping":{"agent_message":"#/components/schemas/ResponseAgentMessageInput","function_call":"#/components/schemas/ResponseFunctionCallInput","function_call_output":"#/components/schemas/ResponseFunctionCallOutputInput","message":"#/components/schemas/ResponseMessageInput","reasoning":"#/components/schemas/ResponseReasoningInput"}}},"type":"array","minItems":1}],"title":"Input"},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instructions"},"tools":{"items":{"oneOf":[{"$ref":"#/components/schemas/ResponseFunctionTool"},{"$ref":"#/components/schemas/ResponseNamespaceTool"},{"$ref":"#/components/schemas/StoreSearchTool"},{"$ref":"#/components/schemas/StoreGrepTool"},{"$ref":"#/components/schemas/StoreListChunksTool"},{"$ref":"#/components/schemas/MetadataFacetsTool"},{"$ref":"#/components/schemas/ListStoresTool"}],"discriminator":{"propertyName":"type","mapping":{"function":"#/components/schemas/ResponseFunctionTool","list_stores":"#/components/schemas/ListStoresTool","namespace":"#/components/schemas/ResponseNamespaceTool","store_grep":"#/components/schemas/StoreGrepTool","store_list_chunks":"#/components/schemas/StoreListChunksTool","store_metadata_facets":"#/components/schemas/MetadataFacetsTool","store_search":"#/components/schemas/StoreSearchTool"}}},"type":"array","title":"Tools"},"tool_choice":{"anyOf":[{"type":"string","enum":["none","auto","required"]},{"$ref":"#/components/schemas/ResponseToolChoiceFunction"},{"$ref":"#/components/schemas/ToolChoiceStoreSearch"},{"$ref":"#/components/schemas/ToolChoiceStoreGrep"},{"$ref":"#/components/schemas/ToolChoiceStoreListChunks"},{"$ref":"#/components/schemas/ToolChoiceMetadataFacets"},{"$ref":"#/components/schemas/ToolChoiceListStores"}],"title":"Tool Choice","default":"auto"},"store":{"type":"boolean","title":"Store","default":true},"previous_response_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous Response Id"},"context_management":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResponseCompactionConfig"},"type":"array","maxItems":1},{"type":"null"}],"title":"Context Management"},"stream":{"type":"boolean","title":"Stream","default":false},"stream_options":{"anyOf":[{"$ref":"#/components/schemas/ResponseStreamOptions"},{"type":"null"}]},"temperature":{"anyOf":[{"type":"number","maximum":2.0,"minimum":0.0},{"type":"null"}],"title":"Temperature"},"top_p":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Top P"},"max_output_tokens":{"anyOf":[{"type":"integer","minimum":16.0},{"type":"null"}],"title":"Max Output Tokens"},"max_tool_calls":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Max Tool Calls"},"parallel_tool_calls":{"type":"boolean","title":"Parallel Tool Calls","default":true},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"include":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Include"},"text":{"anyOf":[{"$ref":"#/components/schemas/ResponseTextConfig"},{"type":"null"}]},"background":{"type":"boolean","title":"Background","default":false},"truncation":{"type":"string","enum":["auto","disabled"],"title":"Truncation","default":"disabled"},"reasoning":{"anyOf":[{"$ref":"#/components/schemas/ResponseReasoningConfig"},{"type":"null"}]},"service_tier":{"anyOf":[{"type":"string","enum":["auto","default","flex","scale","priority"]},{"type":"null"}],"title":"Service Tier"},"safety_identifier":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Safety Identifier"},"prompt_cache_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Cache Key"},"user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User"},"client_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Client Metadata"}},"additionalProperties":false,"type":"object","required":["input"],"title":"ResponseCreateParams","description":"Request body for POST /v1/responses."},"ResponseDeleted":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","const":"response","title":"Object","default":"response"},"deleted":{"type":"boolean","title":"Deleted","default":true}},"type":"object","required":["id"],"title":"ResponseDeleted","description":"Deletion confirmation of a stored response.\n\n`object` is the plain \"response\" the Responses API documents here, not the\n\"<resource>.deleted\" form Chat Completions uses for its own confirmation."},"ResponseError":{"properties":{"code":{"type":"string","title":"Code"},"message":{"type":"string","title":"Message"}},"type":"object","required":["code","message"],"title":"ResponseError"},"ResponseFunctionCallInput":{"properties":{"type":{"type":"string","const":"function_call","title":"Type","default":"function_call"},"call_id":{"type":"string","title":"Call Id"},"name":{"type":"string","title":"Name"},"arguments":{"type":"string","title":"Arguments"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"status":{"anyOf":[{"type":"string","enum":["in_progress","completed","incomplete"]},{"type":"null"}],"title":"Status"}},"type":"object","required":["call_id","name","arguments"],"title":"ResponseFunctionCallInput","description":"A previously returned client function call passed back as input."},"ResponseFunctionCallOutputInput":{"properties":{"type":{"type":"string","const":"function_call_output","title":"Type","default":"function_call_output"},"call_id":{"type":"string","title":"Call Id"},"output":{"anyOf":[{"type":"string"},{"items":{"$ref":"#/components/schemas/ResponseInputTextPart"},"type":"array"}],"title":"Output"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"status":{"anyOf":[{"type":"string","enum":["in_progress","completed","incomplete"]},{"type":"null"}],"title":"Status"}},"type":"object","required":["call_id","output"],"title":"ResponseFunctionCallOutputInput","description":"The caller-provided output of a function call."},"ResponseFunctionCallOutputItem":{"properties":{"type":{"type":"string","const":"function_call_output","title":"Type","default":"function_call_output"},"id":{"type":"string","title":"Id"},"call_id":{"type":"string","title":"Call Id"},"output":{"type":"string","title":"Output"},"status":{"type":"string","enum":["in_progress","completed","incomplete"],"title":"Status","default":"completed"}},"type":"object","required":["id","call_id","output"],"title":"ResponseFunctionCallOutputItem"},"ResponseFunctionTool":{"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,64}$","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"parameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Parameters"},"strict":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Strict"},"type":{"type":"string","const":"function","title":"Type","default":"function"}},"type":"object","required":["name"],"title":"ResponseFunctionTool","description":"A Responses API function tool, whose definition is flat rather than nested."},"ResponseFunctionToolCall":{"properties":{"type":{"type":"string","const":"function_call","title":"Type","default":"function_call"},"id":{"type":"string","title":"Id"},"call_id":{"type":"string","title":"Call Id"},"name":{"type":"string","title":"Name"},"namespace":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Namespace"},"arguments":{"type":"string","title":"Arguments"},"status":{"type":"string","enum":["in_progress","completed","incomplete"],"title":"Status","default":"completed"}},"type":"object","required":["id","call_id","name","arguments"],"title":"ResponseFunctionToolCall"},"ResponseIncompleteDetails":{"properties":{"reason":{"anyOf":[{"type":"string","enum":["max_output_tokens","content_filter"]},{"type":"null"}],"title":"Reason"}},"type":"object","title":"ResponseIncompleteDetails"},"ResponseInputMessageItem":{"properties":{"type":{"type":"string","const":"message","title":"Type","default":"message"},"id":{"type":"string","title":"Id"},"content":{"items":{"$ref":"#/components/schemas/ResponseInputTextPart"},"type":"array","title":"Content"},"role":{"type":"string","enum":["user","system","developer"],"title":"Role"},"status":{"type":"string","enum":["in_progress","completed","incomplete"],"title":"Status","default":"completed"}},"type":"object","required":["id","content","role"],"title":"ResponseInputMessageItem"},"ResponseInputTextPart":{"properties":{"type":{"type":"string","const":"input_text","title":"Type","default":"input_text"},"text":{"type":"string","title":"Text"}},"type":"object","required":["text"],"title":"ResponseInputTextPart","description":"A text input content part."},"ResponseInputTokensDetails":{"properties":{"cached_tokens":{"type":"integer","title":"Cached Tokens","default":0}},"type":"object","title":"ResponseInputTokensDetails"},"ResponseItemList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"anyOf":[{"$ref":"#/components/schemas/ResponseInputMessageItem"},{"$ref":"#/components/schemas/ResponseOutputMessage"},{"$ref":"#/components/schemas/ResponseFunctionToolCall"},{"$ref":"#/components/schemas/ResponseFunctionCallOutputItem"}]},"type":"array","title":"Data"},"first_id":{"type":"string","title":"First Id"},"last_id":{"type":"string","title":"Last Id"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","required":["data","first_id","last_id"],"title":"ResponseItemList"},"ResponseMessageInput":{"properties":{"type":{"type":"string","const":"message","title":"Type","default":"message"},"role":{"type":"string","enum":["user","assistant","system","developer"],"title":"Role"},"content":{"anyOf":[{"type":"string"},{"items":{"oneOf":[{"$ref":"#/components/schemas/ResponseInputTextPart"},{"$ref":"#/components/schemas/ResponseOutputTextPartInput"},{"$ref":"#/components/schemas/ResponseRefusalPartInput"}],"discriminator":{"propertyName":"type","mapping":{"input_text":"#/components/schemas/ResponseInputTextPart","output_text":"#/components/schemas/ResponseOutputTextPartInput","refusal":"#/components/schemas/ResponseRefusalPartInput"}}},"type":"array"}],"title":"Content"},"status":{"anyOf":[{"type":"string","enum":["in_progress","completed","incomplete"]},{"type":"null"}],"title":"Status"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"phase":{"anyOf":[{"type":"string","enum":["commentary","final_answer"]},{"type":"null"}],"title":"Phase"}},"type":"object","required":["role","content"],"title":"ResponseMessageInput","description":"An easy input message or a previously returned output message."},"ResponseNamespaceTool":{"properties":{"type":{"type":"string","const":"namespace","title":"Type","default":"namespace"},"name":{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,64}$","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"tools":{"items":{"$ref":"#/components/schemas/ResponseFunctionTool"},"type":"array","minItems":1,"title":"Tools"}},"type":"object","required":["name","tools"],"title":"ResponseNamespaceTool","description":"A Codex tool namespace containing client-executed functions."},"ResponseOutputMessage":{"properties":{"type":{"type":"string","const":"message","title":"Type","default":"message"},"id":{"type":"string","title":"Id"},"status":{"type":"string","enum":["in_progress","completed","incomplete"],"title":"Status"},"role":{"type":"string","const":"assistant","title":"Role","default":"assistant"},"content":{"items":{"$ref":"#/components/schemas/ResponseOutputText"},"type":"array","title":"Content"}},"type":"object","required":["id","status","content"],"title":"ResponseOutputMessage"},"ResponseOutputText":{"properties":{"type":{"type":"string","const":"output_text","title":"Type","default":"output_text"},"annotations":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Annotations"},"text":{"type":"string","title":"Text"},"logprobs":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Logprobs"}},"type":"object","required":["text"],"title":"ResponseOutputText"},"ResponseOutputTextPartInput":{"properties":{"type":{"type":"string","const":"output_text","title":"Type","default":"output_text"},"text":{"type":"string","title":"Text"},"annotations":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Annotations"}},"type":"object","required":["text"],"title":"ResponseOutputTextPartInput","description":"A prior assistant text part passed back as input."},"ResponseOutputTokensDetails":{"properties":{"reasoning_tokens":{"type":"integer","title":"Reasoning Tokens","default":0}},"type":"object","title":"ResponseOutputTokensDetails"},"ResponseReasoningConfig":{"properties":{"effort":{"anyOf":[{"type":"string","enum":["none","minimal","low","medium","high","xhigh"]},{"type":"null"}],"title":"Effort"},"summary":{"anyOf":[{"type":"string","enum":["auto","concise","detailed"]},{"type":"null"}],"title":"Summary"},"generate_summary":{"anyOf":[{"type":"string","enum":["auto","concise","detailed"]},{"type":"null"}],"title":"Generate Summary"}},"type":"object","title":"ResponseReasoningConfig"},"ResponseReasoningInput":{"properties":{"type":{"type":"string","const":"reasoning","title":"Type","default":"reasoning"},"id":{"type":"string","title":"Id"},"summary":{"items":{"$ref":"#/components/schemas/ResponseReasoningSummaryInput"},"type":"array","title":"Summary"},"content":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResponseReasoningTextInput"},"type":"array"},{"type":"null"}],"title":"Content"},"encrypted_content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Encrypted Content"},"status":{"anyOf":[{"type":"string","enum":["in_progress","completed","incomplete"]},{"type":"null"}],"title":"Status"}},"type":"object","required":["id"],"title":"ResponseReasoningInput","description":"A reasoning item accepted when callers manually replay prior output."},"ResponseReasoningItem":{"properties":{"type":{"type":"string","const":"reasoning","title":"Type","default":"reasoning"},"id":{"type":"string","title":"Id"},"summary":{"items":{"$ref":"#/components/schemas/ResponseReasoningSummaryInput"},"type":"array","title":"Summary"},"content":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResponseReasoningText"},"type":"array"},{"type":"null"}],"title":"Content"},"status":{"type":"string","enum":["in_progress","completed","incomplete"],"title":"Status","default":"completed"}},"type":"object","required":["id"],"title":"ResponseReasoningItem"},"ResponseReasoningSummaryInput":{"properties":{"type":{"type":"string","const":"summary_text","title":"Type","default":"summary_text"},"text":{"type":"string","title":"Text"}},"type":"object","required":["text"],"title":"ResponseReasoningSummaryInput"},"ResponseReasoningText":{"properties":{"type":{"type":"string","const":"reasoning_text","title":"Type","default":"reasoning_text"},"text":{"type":"string","title":"Text"}},"type":"object","required":["text"],"title":"ResponseReasoningText"},"ResponseReasoningTextInput":{"properties":{"type":{"type":"string","const":"reasoning_text","title":"Type","default":"reasoning_text"},"text":{"type":"string","title":"Text"}},"type":"object","required":["text"],"title":"ResponseReasoningTextInput"},"ResponseRefusalPartInput":{"properties":{"type":{"type":"string","const":"refusal","title":"Type","default":"refusal"},"refusal":{"type":"string","title":"Refusal"}},"type":"object","required":["refusal"],"title":"ResponseRefusalPartInput","description":"A prior assistant refusal passed back as input."},"ResponseStreamOptions":{"properties":{"include_obfuscation":{"type":"boolean","title":"Include Obfuscation","default":true}},"type":"object","title":"ResponseStreamOptions"},"ResponseTextConfig":{"properties":{"format":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/ResponseTextFormatText"},{"$ref":"#/components/schemas/ResponseTextFormatJSONObject"},{"$ref":"#/components/schemas/ResponseTextFormatJSONSchema"}],"discriminator":{"propertyName":"type","mapping":{"json_object":"#/components/schemas/ResponseTextFormatJSONObject","json_schema":"#/components/schemas/ResponseTextFormatJSONSchema","text":"#/components/schemas/ResponseTextFormatText"}}},{"type":"null"}],"title":"Format"},"verbosity":{"anyOf":[{"type":"string","enum":["low","medium","high"]},{"type":"null"}],"title":"Verbosity"}},"type":"object","title":"ResponseTextConfig"},"ResponseTextFormatJSONObject":{"properties":{"type":{"type":"string","const":"json_object","title":"Type","default":"json_object"}},"type":"object","title":"ResponseTextFormatJSONObject"},"ResponseTextFormatJSONSchema":{"properties":{"type":{"type":"string","const":"json_schema","title":"Type","default":"json_schema"},"name":{"type":"string","title":"Name"},"schema":{"additionalProperties":true,"type":"object","title":"Schema"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"strict":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Strict"}},"type":"object","required":["name","schema"],"title":"ResponseTextFormatJSONSchema"},"ResponseTextFormatText":{"properties":{"type":{"type":"string","const":"text","title":"Type","default":"text"}},"type":"object","title":"ResponseTextFormatText"},"ResponseToolChoiceFunction":{"properties":{"type":{"type":"string","const":"function","title":"Type","default":"function"},"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"ResponseToolChoiceFunction","description":"Force a Responses API function tool by name."},"ResponseUsage":{"properties":{"input_tokens":{"type":"integer","title":"Input Tokens","default":0},"input_tokens_details":{"$ref":"#/components/schemas/ResponseInputTokensDetails"},"output_tokens":{"type":"integer","title":"Output Tokens","default":0},"output_tokens_details":{"$ref":"#/components/schemas/ResponseOutputTokensDetails"},"total_tokens":{"type":"integer","title":"Total Tokens","default":0}},"type":"object","title":"ResponseUsage"},"ReturnFormat":{"type":"string","enum":["html","markdown","plain"],"title":"ReturnFormat","description":"Format options for the returned document content."},"SalesforceInstallationOverview":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Salesforce installation ID"},"org_id":{"type":"string","title":"Org Id","description":"Salesforce organization ID"},"org_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org Name","description":"Salesforce organization name"},"status":{"type":"string","title":"Status","description":"The installation status"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread ingestion store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread ingestion store name"},"item_count":{"type":"integer","title":"Item Count","description":"Number of Salesforce object types selected for ingestion","default":0},"sync_schedule":{"$ref":"#/components/schemas/SalesforceSyncSchedule","description":"Periodic sync schedule for this installation"}},"type":"object","required":["installation_id","org_id","org_name","status"],"title":"SalesforceInstallationOverview","description":"Summary of a connected Salesforce org for the data sources overview."},"SalesforceInstallationOverviewListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SalesforceInstallationOverview"},"type":"array","title":"Data","description":"Connected Salesforce orgs"}},"type":"object","required":["data"],"title":"SalesforceInstallationOverviewListResponse","description":"List of connected Salesforce orgs for the data sources overview."},"SalesforceManualConnectBody":{"properties":{"client_id":{"type":"string","minLength":1,"title":"Client Id","description":"Connected App consumer key"},"client_secret":{"type":"string","minLength":1,"title":"Client Secret","description":"Connected App consumer secret"},"my_domain_url":{"type":"string","minLength":1,"title":"My Domain Url","description":"The org's My Domain URL (https://<domain>.my.salesforce.com)"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Optional ingestion store name"},"sync_schedule_interval":{"type":"string","enum":["off","ten_minutes","hourly","daily","weekly"],"title":"Sync Schedule Interval","description":"Initial periodic sync interval","default":"off"}},"type":"object","required":["client_id","client_secret","my_domain_url"],"title":"SalesforceManualConnectBody","description":"Request body for connecting Salesforce with a customer Connected App (client-credentials flow)."},"SalesforceObject":{"properties":{"name":{"type":"string","title":"Name","description":"Salesforce object API name (e.g. Account, Invoice__c)"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Salesforce object display label"},"custom":{"type":"boolean","title":"Custom","description":"Whether this is a custom object","default":false},"is_selected":{"type":"boolean","title":"Is Selected","description":"Whether this object type is selected for store ingestion","default":false},"status":{"type":"string","enum":["pending","processing","completed","failed"],"title":"Status","description":"Ingestion status of this object type in the most recent sync","default":"pending"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At","description":"When this object type last completed a sync"}},"type":"object","required":["name"],"title":"SalesforceObject","description":"A Salesforce object type offered for connector ingestion."},"SalesforceObjectSelection":{"properties":{"is_installed":{"type":"boolean","title":"Is Installed","description":"Whether Salesforce is installed for the organization"},"installation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installation Id","description":"Salesforce installation ID"},"org_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org Id","description":"Salesforce organization ID"},"org_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org Name","description":"Salesforce organization name"},"instance_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Url","description":"Salesforce instance URL"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread store name"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"title":"Auth Type","description":"How the org is connected: OAuth or customer Connected App client credentials","default":"oauth2"},"objects":{"items":{"$ref":"#/components/schemas/SalesforceObject"},"type":"array","title":"Objects","description":"Salesforce object types available for ingestion"},"selected_object_names":{"items":{"type":"string"},"type":"array","title":"Selected Object Names","description":"Every Salesforce object API name selected for ingestion"},"catalog_available":{"type":"boolean","title":"Catalog Available","description":"Whether the live object catalog could be fetched (false degrades to the selection only)","default":true},"sync_schedule":{"$ref":"#/components/schemas/SalesforceSyncSchedule","description":"Periodic sync schedule for this installation"},"sync_status":{"type":"string","enum":["syncing","not_syncing","error"],"title":"Sync Status","description":"Current Salesforce ingestion status","default":"not_syncing"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At","description":"Last successful Salesforce sync time"},"sync_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sync Error","description":"Last Salesforce sync error"},"last_sync_status":{"anyOf":[{"type":"string","enum":["queued","in_progress","completed","skipped","error"]},{"type":"null"}],"title":"Last Sync Status","description":"Most recent Salesforce import status"},"last_sync_started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sync Started At","description":"Most recent Salesforce import start time"},"last_sync_completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sync Completed At","description":"Most recent Salesforce import completion time"},"syncs_in_progress":{"type":"integer","title":"Syncs In Progress","description":"Number of active Salesforce imports for this installation","default":0}},"type":"object","required":["is_installed"],"title":"SalesforceObjectSelection","description":"Salesforce object-type selection for a store connector."},"SalesforceObjectSelectionBody":{"properties":{"objects":{"items":{"type":"string"},"type":"array","title":"Objects","description":"Salesforce object API names to ingest into the store"}},"type":"object","required":["objects"],"title":"SalesforceObjectSelectionBody","description":"Request body for updating the Salesforce object-type selection."},"SalesforceObjectSelectionResponse":{"properties":{"data":{"$ref":"#/components/schemas/SalesforceObjectSelection","description":"Salesforce object selection"}},"type":"object","required":["data"],"title":"SalesforceObjectSelectionResponse","description":"Salesforce object selection response."},"SalesforceSync":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Salesforce installation ID"},"queued":{"type":"boolean","title":"Queued","description":"Whether an incremental sync was queued"},"sync_run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sync Run Id","description":"The queued sync run ID, when a sync was queued"}},"type":"object","required":["installation_id","queued"],"title":"SalesforceSync","description":"Result of triggering a Salesforce sync."},"SalesforceSyncResponse":{"properties":{"data":{"$ref":"#/components/schemas/SalesforceSync","description":"Salesforce manual sync result"}},"type":"object","required":["data"],"title":"SalesforceSyncResponse","description":"Salesforce manual sync response."},"SalesforceSyncSchedule":{"properties":{"interval":{"type":"string","enum":["off","ten_minutes","hourly","daily","weekly"],"title":"Interval","description":"Selected periodic sync interval","default":"off"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"When the schedule metadata was last changed"}},"type":"object","title":"SalesforceSyncSchedule","description":"Persisted periodic sync schedule for a Salesforce installation."},"SalesforceSyncScheduleUpdate":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Salesforce installation ID"},"sync_schedule":{"$ref":"#/components/schemas/SalesforceSyncSchedule","description":"Updated Salesforce sync schedule"}},"type":"object","required":["installation_id","sync_schedule"],"title":"SalesforceSyncScheduleUpdate","description":"Result of updating a Salesforce sync schedule."},"SalesforceSyncScheduleUpdateParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Salesforce installation ID"},"interval":{"type":"string","enum":["off","ten_minutes","hourly","daily","weekly"],"title":"Interval","description":"Periodic sync interval to apply"}},"type":"object","required":["installation_id","interval"],"title":"SalesforceSyncScheduleUpdateParams","description":"Parameters for updating a Salesforce installation sync schedule."},"SalesforceSyncScheduleUpdateResponse":{"properties":{"data":{"$ref":"#/components/schemas/SalesforceSyncScheduleUpdate","description":"Salesforce sync schedule update result"}},"type":"object","required":["data"],"title":"SalesforceSyncScheduleUpdateResponse","description":"Salesforce sync schedule update response."},"Scope":{"properties":{"method":{"type":"string","enum":["read","write","delete","list","create","search"],"title":"Method"},"resource_type":{"anyOf":[{"type":"string","enum":["store","completions"]},{"type":"null"}],"title":"Resource Type"},"resource_id":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"},{"type":"null"}],"title":"Resource Id"}},"type":"object","required":["method"],"title":"Scope"},"SearchCursorPagination":{"properties":{"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Maximum number of items to return per page (1-100)","default":20,"examples":[10,20,50]},"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"Cursor for forward pagination - get items after this position. Use last_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="]},"before":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Before","description":"Cursor for backward pagination - get items before this position. Use first_cursor from previous response.","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="]},"include_total":{"type":"boolean","title":"Include Total","description":"Whether to include total count in response (expensive operation)","default":false,"examples":[false,true]},"statuses":{"anyOf":[{"items":{"$ref":"#/components/schemas/StoreFileStatus"},"type":"array"},{"type":"null"}],"title":"Statuses","description":"Status to filter by"},"metadata_filter":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Metadata Filter","description":"Metadata filter to apply to the query"},"q":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Q","description":"Search query for fuzzy matching over name and external_id fields"}},"type":"object","title":"SearchCursorPagination","description":"Cursor pagination with status, metadata, and a search query."},"SearchFilter-Input":{"properties":{"all":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"All","description":"List of conditions or filters to be ANDed together","examples":[[{"key":"price","operator":"gt","value":"100"},{"key":"color","operator":"eq","value":"red"}],null]},"any":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Any","description":"List of conditions or filters to be ORed together","examples":[[{"key":"price","operator":"gt","value":"100"},{"key":"color","operator":"eq","value":"red"}],null]},"none":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"None","description":"List of conditions or filters to be NOTed","examples":[[{"key":"price","operator":"gt","value":"100"},{"key":"color","operator":"eq","value":"red"}],null]}},"type":"object","title":"SearchFilter","description":"Represents a filter with AND, OR, and NOT conditions."},"SearchFilter-Output":{"properties":{"all":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Output"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"All","description":"List of conditions or filters to be ANDed together","examples":[[{"key":"price","operator":"gt","value":"100"},{"key":"color","operator":"eq","value":"red"}],null]},"any":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Output"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Any","description":"List of conditions or filters to be ORed together","examples":[[{"key":"price","operator":"gt","value":"100"},{"key":"color","operator":"eq","value":"red"}],null]},"none":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Output"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"None","description":"List of conditions or filters to be NOTed","examples":[[{"key":"price","operator":"gt","value":"100"},{"key":"color","operator":"eq","value":"red"}],null]}},"type":"object","title":"SearchFilter","description":"Represents a filter with AND, OR, and NOT conditions."},"SearchFilterCondition":{"properties":{"key":{"type":"string","title":"Key","description":"The field to apply the condition on","examples":["price","color"]},"value":{"title":"Value","description":"The value to compare against","examples":["100","red"]},"operator":{"$ref":"#/components/schemas/ConditionOperator","description":"The operator for the condition","examples":["eq","gt"]}},"type":"object","required":["key","value","operator"],"title":"SearchFilterCondition","description":"Represents a condition with a field, operator, and value."},"SlackChannel":{"properties":{"id":{"type":"string","title":"Id","description":"Slack channel ID"},"name":{"type":"string","title":"Name","description":"Slack channel name"},"is_archived":{"type":"boolean","title":"Is Archived","description":"Whether the Slack channel is archived"},"is_member":{"type":"boolean","title":"Is Member","description":"Whether the Slack app bot is a member"},"is_selected":{"type":"boolean","title":"Is Selected","description":"Whether this channel is selected for store ingestion"},"num_members":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Members","description":"Approximate Slack channel member count"},"sync_status":{"type":"string","enum":["syncing","not_syncing","error"],"title":"Sync Status","description":"Current Slack ingestion status","default":"not_syncing"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At","description":"Last successful Slack sync time"},"sync_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sync Error","description":"Last Slack sync error"},"sync_error_retryable":{"type":"boolean","title":"Sync Error Retryable","description":"Whether retrying the channel-level Slack sync error may succeed","default":false},"last_sync_status":{"anyOf":[{"type":"string","enum":["queued","in_progress","completed","skipped","error"]},{"type":"null"}],"title":"Last Sync Status","description":"Most recent Slack history import status"},"last_sync_started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sync Started At","description":"Most recent Slack history import start time"},"last_sync_completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sync Completed At","description":"Most recent Slack history import completion time"},"last_sync_message_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Sync Message Count","description":"Messages fetched in the last Slack history import"},"last_sync_store_file_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Sync Store File Count","description":"Store files written in the last Slack history import"},"last_sync_skipped_message_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Sync Skipped Message Count","description":"Timeline messages skipped as non-ingestable (bot/app posts, system events)"},"last_sync_run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Sync Run Id","description":"Most recent Slack history import run ID"},"syncs_in_progress":{"type":"integer","title":"Syncs In Progress","description":"Number of active Slack history imports for this channel","default":0},"last_sync_warning":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Sync Warning","description":"Most recent Slack item-level sync warning"},"last_sync_failed_item_count":{"type":"integer","title":"Last Sync Failed Item Count","description":"Number of Slack items that failed in the most recent import","default":0},"last_sync_failed_items":{"items":{"$ref":"#/components/schemas/SlackItemFailure"},"type":"array","title":"Last Sync Failed Items","description":"Bounded, user-safe Slack item failures from the most recent import"}},"type":"object","required":["id","name","is_archived","is_member","is_selected"],"title":"SlackChannel","description":"Slack public channel exposed for connector configuration."},"SlackChannelSelection":{"properties":{"is_installed":{"type":"boolean","title":"Is Installed","description":"Whether Slack is installed for the organization"},"installation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installation Id","description":"Slack installation ID"},"team_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Id","description":"Slack team ID"},"team_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Name","description":"Slack team name"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread store name"},"channels":{"items":{"$ref":"#/components/schemas/SlackChannel"},"type":"array","title":"Channels","description":"Public Slack channels for the current page"},"selected_channel_ids":{"items":{"type":"string"},"type":"array","title":"Selected Channel Ids","description":"Every Slack channel ID selected for ingestion, across all pages"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Cursor for the next page of Slack channels, or null when there are no more"},"catalog_status":{"type":"string","enum":["pending","syncing","ready","failed"],"title":"Catalog Status","description":"State of the background channel-catalog sync that backs this listing","default":"ready"},"total_channels":{"type":"integer","title":"Total Channels","description":"Total channels matching the current search across all pages","default":0},"history_imports_in_progress":{"type":"integer","title":"History Imports In Progress","description":"Total active Slack history imports across all channels","default":0}},"type":"object","required":["is_installed","channels"],"title":"SlackChannelSelection","description":"Slack channel selection for a store connector."},"SlackChannelSelectionResponse":{"properties":{"data":{"$ref":"#/components/schemas/SlackChannelSelection","description":"Slack channel selection"}},"type":"object","required":["data"],"title":"SlackChannelSelectionResponse","description":"Slack channel selection response."},"SlackChannelSelectionUpdate":{"properties":{"store_id":{"type":"string","title":"Store Id","description":"Mixedbread store ID"},"selected_channel_ids":{"items":{"type":"string"},"type":"array","title":"Selected Channel Ids","description":"Selected Slack channel IDs"},"joined_channel_ids":{"items":{"type":"string"},"type":"array","title":"Joined Channel Ids","description":"Slack channels the app joined while saving"},"backfill_channel_ids":{"items":{"type":"string"},"type":"array","title":"Backfill Channel Ids","description":"Slack channels queued for historical ingestion"},"skipped_channels":{"additionalProperties":{"type":"string"},"type":"object","title":"Skipped Channels","description":"Slack channel IDs skipped by Slack error"}},"type":"object","required":["store_id","selected_channel_ids","joined_channel_ids","backfill_channel_ids","skipped_channels"],"title":"SlackChannelSelectionUpdate","description":"Result of updating Slack channel selection."},"SlackChannelSelectionUpdateParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Slack installation ID"},"channel_ids":{"items":{"type":"string"},"type":"array","title":"Channel Ids","description":"Slack channel IDs to ingest into the store"}},"type":"object","required":["installation_id","channel_ids"],"title":"SlackChannelSelectionUpdateParams","description":"Parameters for selecting Slack channels for store ingestion."},"SlackChannelSelectionUpdateResponse":{"properties":{"data":{"$ref":"#/components/schemas/SlackChannelSelectionUpdate","description":"Slack channel selection update"}},"type":"object","required":["data"],"title":"SlackChannelSelectionUpdateResponse","description":"Slack channel selection update response."},"SlackChannelSync":{"properties":{"store_id":{"type":"string","title":"Store Id","description":"Mixedbread store ID"},"queued_channel_ids":{"items":{"type":"string"},"type":"array","title":"Queued Channel Ids","description":"Slack channel IDs queued for historical sync"},"skipped_channels":{"additionalProperties":{"type":"string"},"type":"object","title":"Skipped Channels","description":"Slack channel IDs skipped by validation"}},"type":"object","required":["store_id","queued_channel_ids","skipped_channels"],"title":"SlackChannelSync","description":"Result of manually syncing selected Slack channels."},"SlackChannelSyncParams":{"properties":{"installation_id":{"type":"string","format":"uuid","title":"Installation Id","description":"Slack installation ID"},"channel_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Channel Ids","description":"Slack channel IDs to sync. Defaults to all selected channels."},"retry_failed_only":{"type":"boolean","title":"Retry Failed Only","description":"Only retry Slack channels whose most recent import errored or had failed items.","default":false}},"type":"object","required":["installation_id"],"title":"SlackChannelSyncParams","description":"Parameters for manually syncing selected Slack channels."},"SlackChannelSyncResponse":{"properties":{"data":{"$ref":"#/components/schemas/SlackChannelSync","description":"Slack channel manual sync result"}},"type":"object","required":["data"],"title":"SlackChannelSyncResponse","description":"Slack channel manual sync response."},"SlackInstallationOverview":{"properties":{"installation_id":{"type":"string","title":"Installation Id","description":"Slack installation ID"},"team_id":{"type":"string","title":"Team Id","description":"Slack team ID"},"team_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Name","description":"Slack team name"},"status":{"type":"string","title":"Status","description":"The installation status"},"store_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Id","description":"Mixedbread ingestion store ID"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Mixedbread ingestion store name"},"syncing_channel_count":{"type":"integer","title":"Syncing Channel Count","description":"Number of Slack channels selected for ingestion","default":0}},"type":"object","required":["installation_id","team_id","team_name","status"],"title":"SlackInstallationOverview","description":"Summary of a connected Slack workspace for the data sources overview."},"SlackInstallationOverviewListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SlackInstallationOverview"},"type":"array","title":"Data","description":"Connected Slack workspaces"}},"type":"object","required":["data"],"title":"SlackInstallationOverviewListResponse","description":"List of connected Slack workspaces for the data sources overview."},"SlackItemFailure":{"properties":{"code":{"type":"string","title":"Code","description":"Stable Slack item failure code"},"message":{"type":"string","title":"Message","description":"User-safe explanation of the failure"},"retryable":{"type":"boolean","title":"Retryable","description":"Whether retrying the item may succeed without user changes"},"source_message_ts":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Message Ts","description":"Slack timestamp for the message associated with the failed item"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url","description":"Slack permalink for the message associated with the failed item"}},"type":"object","required":["code","message","retryable"],"title":"SlackItemFailure","description":"User-safe summary of an item that failed during Slack ingestion."},"SlackManifestResponse":{"properties":{"manifest_json":{"type":"string","title":"Manifest Json","description":"Slack app manifest JSON pre-filled with this deployment's URLs"},"manifest_yaml":{"type":"string","title":"Manifest Yaml","description":"Slack app manifest YAML pre-filled with this deployment's URLs"}},"type":"object","required":["manifest_json","manifest_yaml"],"title":"SlackManifestResponse","description":"Rendered Slack app manifest (JSON and YAML) for bring-your-own-app setup."},"SlackManualConnectBody":{"properties":{"bot_token":{"type":"string","minLength":1,"title":"Bot Token","description":"Slack bot user OAuth token (xoxb-…)"},"signing_secret":{"type":"string","minLength":1,"title":"Signing Secret","description":"Slack app signing secret"},"store_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store Name","description":"Optional ingestion store name"},"store_config":{"$ref":"#/components/schemas/IntegrationStoreConfig","description":"Configuration applied to the ingestion store and imported files","default":{"metadata_contextualization":true,"file_contextualization":true,"ingestion_mode":"high_quality"}}},"type":"object","required":["bot_token","signing_secret"],"title":"SlackManualConnectBody","description":"Request body for connecting Slack with a customer-provided app (bot token + signing secret)."},"Store":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the store","examples":["1b8b486e-16d0-400b-8868-04cd75217a7e"]},"name":{"type":"string","maxLength":128,"minLength":1,"title":"Name","description":"Name of the store","examples":["customer-support-kb","product-documentation"]},"description":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Description","description":"Detailed description of the store's purpose and contents","examples":["Contains customer support articles and FAQs"]},"is_public":{"type":"boolean","title":"Is Public","description":"Whether the store can be accessed by anyone with valid login credentials","default":false,"examples":[false]},"license":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License","description":"License for public stores"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"Additional metadata associated with the store","examples":[{"category":"support","language":"en"}]},"config":{"anyOf":[{"$ref":"#/components/schemas/StoreConfig"},{"type":"null"}],"description":"Store-level configuration defaults"},"bucket_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bucket Id","description":"Customer bucket backing this store's storage; null = platform default"},"file_counts":{"$ref":"#/components/schemas/FileCounts","description":"Counts of files in different states"},"expires_after":{"anyOf":[{"$ref":"#/components/schemas/ExpiresAfter"},{"type":"null"}],"description":"Optional expiration policy"},"status":{"$ref":"#/components/schemas/StoreStatus","description":"Processing status of the store","default":"completed"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the store was created","examples":["2024-01-01T00:00:00Z"]},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Timestamp when the store was last updated","examples":["2024-01-01T00:00:00Z"]},"last_active_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Active At","description":"Timestamp when the store was last used"},"usage_bytes":{"type":"integer","title":"Usage Bytes","description":"Total storage usage in bytes","default":0,"examples":[1024000]},"usage_tokens":{"type":"integer","title":"Usage Tokens","description":"Total storage usage in tokens","default":0,"examples":[1024000]},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"Optional expiration timestamp for the store","examples":["2024-01-01T00:00:00Z"]},"object":{"type":"string","const":"store","title":"Object","description":"Type of the object","default":"store"}},"type":"object","required":["id","name","created_at","updated_at"],"title":"Store","description":"Model representing a store with its metadata and timestamps."},"StoreAgenticSearchEvent":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for the event"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the event was created"},"type":{"type":"string","const":"agentic_search","title":"Type","default":"agentic_search"},"store_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Store Ids","description":"IDs of the vector stores searched"},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"Time when the agentic search began"},"search_time":{"type":"string","format":"duration","title":"Search Time","description":"Total wall-clock time of the agent loop","default":"PT0S"},"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","description":"Original query submitted by the user"},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instructions","description":"Custom instructions provided with the agentic search, if any"},"ranking_strategy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ranking Strategy","description":"Agent-submitted explanation of how chunks were ranked"},"rounds_executed":{"type":"integer","title":"Rounds Executed","description":"Number of search rounds the agent executed","default":0},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Output"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Output"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Metadata filters submitted with the search request"},"token_usage":{"$ref":"#/components/schemas/AgenticSearchTokenUsage","description":"Token usage for LLM calls during the agentic search"},"tool_calls":{"items":{"$ref":"#/components/schemas/AgenticToolCall"},"type":"array","title":"Tool Calls","description":"Ordered tool calls issued by the agent"},"results":{"items":{"$ref":"#/components/schemas/StoreSearchEventResult"},"type":"array","title":"Results","description":"Chunks returned by the agentic search"}},"type":"object","required":["id","created_at","store_ids","started_at"],"title":"StoreAgenticSearchEvent","description":"Represents an agentic search trace in a vector store.\n\nUnlike StoreSearchEvent, this captures the full sequence of tool calls the\nagent issued (name, arguments, result) so developers can inspect what the\nagent did, along with the token usage."},"StoreChunkFilterParams":{"properties":{"store_identifiers":{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","maxItems":16,"minItems":1,"title":"Store Identifiers","description":"IDs or names of stores"},"top_k":{"type":"integer","minimum":1.0,"title":"Top K","description":"Number of results to return","default":10},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions"},"file_ids":{"anyOf":[{"prefixItems":[{"$ref":"#/components/schemas/ConditionOperator"},{"items":{"type":"string","format":"uuid"},"type":"array"}],"type":"array","maxItems":2,"minItems":2},{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"File Ids","description":"Optional list of file IDs to filter chunks by (inclusion filter)","examples":[["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],["in",["123e4567-e89b-12d3-a456-426614174000"]],["not_in",["123e4567-e89b-12d3-a456-426614174000"]]]},"sort_by":{"anyOf":[{"type":"string"},{"prefixItems":[{"type":"string"},{"type":"boolean"}],"type":"array","maxItems":2,"minItems":2},{"type":"null"}],"title":"Sort By","description":"Optional sort applied to the returned chunks. Pass a metadata field path or a tuple of (field path, ascending). Unprefixed dot paths target file metadata; generated_metadata.* targets chunk metadata.","examples":["price",["price",false],"campaign.name",["generated_metadata.bpm",true]]},"search_options":{"$ref":"#/components/schemas/StoreChunkSearchOptions","description":"Search configuration options"}},"type":"object","required":["store_identifiers"],"title":"StoreChunkFilterParams","description":"Parameters for listing store chunks by metadata filter."},"StoreChunkGrepParams":{"properties":{"store_identifiers":{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","maxItems":16,"minItems":1,"title":"Store Identifiers","description":"IDs or names of stores"},"top_k":{"type":"integer","minimum":1.0,"title":"Top K","description":"Number of results to return","default":10},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions"},"file_ids":{"anyOf":[{"prefixItems":[{"$ref":"#/components/schemas/ConditionOperator"},{"items":{"type":"string","format":"uuid"},"type":"array"}],"type":"array","maxItems":2,"minItems":2},{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"File Ids","description":"Optional list of file IDs to filter chunks by (inclusion filter)","examples":[["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],["in",["123e4567-e89b-12d3-a456-426614174000"]],["not_in",["123e4567-e89b-12d3-a456-426614174000"]]]},"pattern":{"type":"string","maxLength":1024,"minLength":1,"title":"Pattern","description":"Regular expression (RE2 syntax) matched against chunk text","examples":["ERR-\\d{4}","invoice|receipt"]},"targets":{"items":{"$ref":"#/components/schemas/StoreChunkGrepTarget"},"type":"array","minItems":1,"title":"Targets","description":"Chunk content groups to match against. `text` matches the original text of text chunks; `generated` matches ingestion-derived fields (transcription, OCR text, summaries)."},"case_sensitive":{"type":"boolean","title":"Case Sensitive","description":"Whether the regular expression is case-sensitive","default":false},"return_metadata":{"type":"boolean","title":"Return Metadata","description":"Whether to return file metadata","default":true}},"type":"object","required":["store_identifiers","pattern"],"title":"StoreChunkGrepParams","description":"Parameters for matching store chunks against a regular expression.\n\nUnlike semantic search, grep runs your regex against the literal text of each\nchunk. It finds chunks whose text matches the pattern."},"StoreChunkGrepTarget":{"type":"string","enum":["text","generated"],"title":"StoreChunkGrepTarget","description":"Logical chunk content groups the grep tool can match against.\n\nThese map to one or more underlying chunk fields:\n\n- ``text``      → text chunks' ``text`` field (original text content).\n- ``generated`` → fields produced during ingestion (``transcription`` for audio/video,\n  ``ocr_text`` for images, and ``summary`` across modalities)."},"StoreChunkSearchOptions":{"properties":{"score_threshold":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Score Threshold","description":"Minimum similarity score threshold","default":0.0},"rewrite_query":{"type":"boolean","title":"Rewrite Query","description":"Whether to rewrite the query. Ignored when agentic is enabled (the agent handles query decomposition).","default":false},"rerank":{"anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/RerankConfig"},{"type":"null"}],"title":"Rerank","description":"Whether to rerank results and optional reranking configuration. Ignored when agentic is enabled (the agent handles ranking)."},"agentic":{"anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/AgenticSearchConfig"},{"type":"null"}],"title":"Agentic","description":"Whether to use agentic multi-query search with automatic query decomposition and ranking. When enabled, rewrite_query and rerank options are ignored."},"lsf":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Lsf","description":"Whether to apply the learned scoring function to second-stage scoring. Requires weights configured for the searched stores; silently skipped otherwise."},"return_metadata":{"type":"boolean","title":"Return Metadata","description":"Whether to return file metadata","default":true},"apply_search_rules":{"type":"boolean","title":"Apply Search Rules","description":"Whether to apply search rules","default":true}},"type":"object","title":"StoreChunkSearchOptions","description":"Options for configuring store chunk searches."},"StoreChunkSearchParams":{"properties":{"store_identifiers":{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","maxItems":16,"minItems":1,"title":"Store Identifiers","description":"IDs or names of stores"},"top_k":{"type":"integer","minimum":1.0,"title":"Top K","description":"Number of results to return","default":10},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions"},"file_ids":{"anyOf":[{"prefixItems":[{"$ref":"#/components/schemas/ConditionOperator"},{"items":{"type":"string","format":"uuid"},"type":"array"}],"type":"array","maxItems":2,"minItems":2},{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"File Ids","description":"Optional list of file IDs to filter chunks by (inclusion filter)","examples":[["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],["in",["123e4567-e89b-12d3-a456-426614174000"]],["not_in",["123e4567-e89b-12d3-a456-426614174000"]]]},"query":{"$ref":"#/components/schemas/MultiModalQuery","description":"Search query text","examples":["how to configure SSL"]},"search_options":{"$ref":"#/components/schemas/StoreChunkSearchOptions","description":"Search configuration options"},"stream":{"type":"boolean","title":"Stream","description":"When true, return the search as a server-sent event stream: live agentic-search trace events when the search is agentic, and nothing before the results otherwise. A successful stream ends with a search.completed event containing the final search response, followed by [DONE].","default":false}},"type":"object","required":["store_identifiers","query"],"title":"StoreChunkSearchParams","description":"Query parameters for searching store chunks."},"StoreCompletionEvent":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for the event"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the event was created"},"type":{"type":"string","const":"completion","title":"Type","default":"completion"},"store_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Store Ids","description":"IDs of the stores the completion's hosted tools touched"},"completion_id":{"type":"string","title":"Completion Id","description":"ID of the completion; retrievable while it is persisted"},"endpoint":{"type":"string","enum":["chat_completions","responses"],"title":"Endpoint","description":"API the completion was created through","default":"chat_completions"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Model that served the completion"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Conversation title"},"previous_completion_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous Completion Id","description":"Completion this turn continued from, if the conversation was resumed"},"root_completion_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Root Completion Id","description":"First completion of the conversation this turn belongs to; groups the turns of one chat"},"persisted":{"type":"boolean","title":"Persisted","description":"Whether the completion was stored for later retrieval","default":true},"finish_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finish Reason","description":"Why generation ended"},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"Time when the completion began"},"total_time":{"type":"string","format":"duration","title":"Total Time","description":"Wall-clock time of the completion turn","default":"PT0S"},"user_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Message","description":"Text of the last user message in the request, truncated"},"answer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Answer","description":"Text of the generated answer, truncated"},"token_usage":{"$ref":"#/components/schemas/AgenticSearchTokenUsage","description":"Token usage for the model calls of the turn"},"tool_calls":{"items":{"$ref":"#/components/schemas/AgenticToolCall"},"type":"array","title":"Tool Calls","description":"Ordered model generations and hosted tool calls of the turn"}},"type":"object","required":["id","created_at","store_ids","completion_id","started_at"],"title":"StoreCompletionEvent","description":"Represents a chat completion or response that used the store through its hosted tools.\n\nOne event per completion turn, shared by the Chat Completions and Responses\nendpoints. It records the model calls and the hosted store tool calls the\nturn issued, in the same trace shape as agentic search events."},"StoreConfig":{"properties":{"contextualization":{"anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/ContextualizationConfig"}],"title":"Contextualization","description":"Include additional context when embedding chunks.","default":false},"save_content":{"type":"boolean","title":"Save Content","description":"Whether to save original content in the store. When False, only vectors are indexed without the original content (index-only mode). This is useful for data privacy. Note: Reranking is not supported when content is not saved.","default":true}},"type":"object","title":"StoreConfig","description":"Configuration for a store."},"StoreCostInfo":{"properties":{"store_id":{"type":"string","title":"Store Id","description":"The ID of the store"},"cost":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Cost","description":"The cost"},"cost_per_metric":{"additionalProperties":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},"type":"object","title":"Cost Per Metric","description":"The cost per metric"}},"type":"object","required":["store_id","cost","cost_per_metric"],"title":"StoreCostInfo","description":"Cost information for a store."},"StoreCostListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/StoreCostInfo"},"type":"array","title":"Data","description":"The list of store cost information"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"}},"type":"object","required":["data"],"title":"StoreCostListResponse"},"StoreCreateParams":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":128,"minLength":1},{"type":"null"}],"title":"Name","description":"Name for the new store. Can only contain lowercase letters, numbers, periods (.), and hyphens (-).","examples":["technical-documentation"]},"description":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Description","description":"Description of the store","examples":["Contains technical specifications and guides"]},"is_public":{"type":"boolean","title":"Is Public","description":"Whether the store can be accessed by anyone with valid login credentials","default":false,"examples":[false]},"license":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License","description":"License for public stores"},"expires_after":{"anyOf":[{"$ref":"#/components/schemas/ExpiresAfter"},{"type":"null"}],"description":"Optional expiration policy"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"Optional metadata key-value pairs"},"config":{"anyOf":[{"$ref":"#/components/schemas/StoreConfig"},{"type":"null"}],"description":"Store-level configuration defaults"},"file_ids":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"File Ids","description":"Optional list of file IDs"}},"type":"object","title":"StoreCreateParams","description":"Parameters for creating a new store."},"StoreDeleted":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"title":"Id","description":"ID of the deleted store"},"deleted":{"type":"boolean","title":"Deleted","description":"Whether the deletion was successful"},"object":{"type":"string","const":"store","title":"Object","description":"Type of the deleted object","default":"store"}},"type":"object","required":["id","deleted"],"title":"StoreDeleted","description":"Response model for store deletion."},"StoreEventHistogramBucket":{"properties":{"bucket_start":{"type":"string","format":"date-time","title":"Bucket Start","description":"Start time of the bucket"},"bucket_end":{"type":"string","format":"date-time","title":"Bucket End","description":"End time of the bucket"},"type":{"type":"string","enum":["inference.embeddings","inference.reranking","model_request","internal_error","store.created","store.deleted","store.updated","store.search","store.search_agent","store.grep","store.web_search","store.file.created","store.file.deleted","store.file.updated","store.file.search","store.question_answer","completion.completed","store.file.completed","store.file.cancelled","store.reingestion.completed","parsing.job.created","parsing.job.deleted","parsing.job.cancelled","parsing.job.completed","extraction.job.created","extraction.job.deleted","extraction.job.cancelled","extraction.job.completed","file.uploaded","file.deleted","file.updated","file.downloaded","api_key.created","api_key.deleted","api_key.updated","api_key.revoked","api_key.rerolled","data_source.created","data_source.updated","data_source.deleted","data_source.oauth2.requested","data_source.oauth2.authorized","data_source.connector.job.completed","auth.invalid_token","auth.success","auth.error"],"title":"Type","description":"Internal type of the event"},"event_type":{"type":"string","enum":["ingestion","search","agentic_search","grep","completion","qa"],"title":"Event Type","description":"Event type as exposed by the events listing, e.g. `search` or `completion`"},"event_count":{"type":"integer","title":"Event Count","description":"Number of events in the bucket"}},"type":"object","required":["bucket_start","bucket_end","type","event_type","event_count"],"title":"StoreEventHistogramBucket","description":"Represents a histogram of events in a store."},"StoreEventHistogramParams":{"properties":{"start_time":{"type":"string","format":"date-time","title":"Start Time","description":"Start time of the histogram"},"end_time":{"type":"string","format":"date-time","title":"End Time","description":"End time of the histogram"},"bucket_seconds":{"type":"integer","title":"Bucket Seconds","description":"Number of seconds in each bucket","default":7200},"event_types":{"anyOf":[{"items":{"type":"string","enum":["ingestion","search","agentic_search","grep","completion","qa"]},"type":"array"},{"type":"null"}],"title":"Event Types","description":"Restrict the histogram to these event types. When omitted, includes search, agentic_search, grep, completion, ingestion, and qa events."}},"type":"object","title":"StoreEventHistogramParams","description":"Parameters for getting a histogram of events in a store."},"StoreEventHistogramResponse":{"properties":{"object":{"type":"string","const":"store.histogram","title":"Object","description":"The object type of the response","default":"store.histogram"},"data":{"items":{"$ref":"#/components/schemas/StoreEventHistogramBucket"},"type":"array","title":"Data","description":"The histogram of store events"}},"type":"object","required":["data"],"title":"StoreEventHistogramResponse"},"StoreEventListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"oneOf":[{"$ref":"#/components/schemas/StoreIngestionEvent"},{"$ref":"#/components/schemas/StoreSearchEvent"},{"$ref":"#/components/schemas/StoreAgenticSearchEvent"},{"$ref":"#/components/schemas/StoreGrepEvent"},{"$ref":"#/components/schemas/StoreCompletionEvent"},{"$ref":"#/components/schemas/StoreQAEvent"}],"discriminator":{"propertyName":"type","mapping":{"agentic_search":"#/components/schemas/StoreAgenticSearchEvent","completion":"#/components/schemas/StoreCompletionEvent","grep":"#/components/schemas/StoreGrepEvent","ingestion":"#/components/schemas/StoreIngestionEvent","qa":"#/components/schemas/StoreQAEvent","search":"#/components/schemas/StoreSearchEvent"}}},"type":"array","title":"Data","description":"The list of store events"}},"type":"object","required":["pagination","data"],"title":"StoreEventListResponse"},"StoreFile":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the file"},"filename":{"type":"string","title":"Filename","description":"Name of the file"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"Optional file metadata"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"External identifier for this file in the store"},"status":{"$ref":"#/components/schemas/StoreFileStatus","description":"Processing status of the file","default":"pending"},"last_error":{"anyOf":[{},{"type":"null"}],"title":"Last Error","description":"Last error message if processing failed"},"store_id":{"type":"string","title":"Store Id","description":"ID of the containing store"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp of store file creation"},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version","description":"Version number of the file","examples":[1]},"usage_bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Usage Bytes","description":"Storage usage in bytes","examples":[51200]},"usage_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Usage Tokens","description":"Storage usage in tokens","examples":[51200]},"config":{"anyOf":[{"$ref":"#/components/schemas/StoreFileConfig"},{"type":"null"}],"description":"Configuration for the file"},"object":{"type":"string","const":"store.file","title":"Object","description":"Type of the object","default":"store.file"},"chunks":{"anyOf":[{"items":{"oneOf":[{"$ref":"#/components/schemas/TextInputChunk"},{"$ref":"#/components/schemas/ImageUrlInputChunk"},{"$ref":"#/components/schemas/AudioUrlInputChunk"},{"$ref":"#/components/schemas/VideoUrlInputChunk"}],"discriminator":{"propertyName":"type","mapping":{"audio_url":"#/components/schemas/AudioUrlInputChunk","image_url":"#/components/schemas/ImageUrlInputChunk","text":"#/components/schemas/TextInputChunk","video_url":"#/components/schemas/VideoUrlInputChunk"}}},"type":"array"},{"type":"null"}],"title":"Chunks","description":"chunks"},"content_url":{"type":"string","title":"Content Url","description":"Presigned URL for file content"}},"type":"object","required":["id","store_id","created_at","content_url"],"title":"StoreFile","description":"Represents a file stored in a store."},"StoreFileConfig":{"properties":{"parsing_strategy":{"$ref":"#/components/schemas/StoreFileParsingStrategy","description":"Strategy for adding the file, this overrides the store-level default","default":"fast"}},"type":"object","title":"StoreFileConfig","description":"Configuration for a file."},"StoreFileDeleted":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the deleted file"},"deleted":{"type":"boolean","title":"Deleted","description":"Whether the deletion was successful","default":true},"object":{"type":"string","const":"store.file","title":"Object","description":"Type of the deleted object","default":"store.file"}},"type":"object","required":["id"],"title":"StoreFileDeleted","description":"Response model for file deletion."},"StoreFileListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"$ref":"#/components/schemas/StoreFile"},"type":"array","title":"Data","description":"The list of store files"}},"type":"object","required":["pagination","data"],"title":"StoreFileListResponse"},"StoreFileMetadataUpdateParams":{"properties":{"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"Updated metadata for the file"}},"type":"object","title":"StoreFileMetadataUpdateParams","description":"Parameters for updating metadata on an existing store file."},"StoreFileParsingStrategy":{"type":"string","enum":["fast","high_quality"],"title":"StoreFileParsingStrategy","description":"Strategy for adding a file to a store."},"StoreFileStatus":{"type":"string","enum":["pending","in_progress","cancelled","completed","failed"],"title":"StoreFileStatus"},"StoreGrepCallItem":{"properties":{"type":{"type":"string","const":"store_grep_call","title":"Type","default":"store_grep_call"},"id":{"type":"string","title":"Id"},"status":{"type":"string","enum":["in_progress","completed","failed"],"title":"Status","default":"completed"},"pattern":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pattern"},"targets":{"anyOf":[{"items":{"$ref":"#/components/schemas/StoreChunkGrepTarget"},"type":"array"},{"type":"null"}],"title":"Targets"},"case_sensitive":{"type":"boolean","title":"Case Sensitive","default":false},"metadata_filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/MetadataFilter"},"type":"array"},{"type":"null"}],"title":"Metadata Filters"},"filter_mode":{"type":"string","enum":["all","any"],"title":"Filter Mode","default":"all"},"store":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store"},"results":{"anyOf":[{"items":{"$ref":"#/components/schemas/StoreSearchResult"},"type":"array"},{"type":"null"}],"title":"Results"},"error":{"anyOf":[{"$ref":"#/components/schemas/ToolCallError"},{"type":"null"}]},"reasoning_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reasoning Offset"}},"type":"object","required":["id"],"title":"StoreGrepCallItem","description":"Record of one server-side grep execution."},"StoreGrepEvent":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for the event"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the event was created"},"type":{"type":"string","const":"grep","title":"Type","default":"grep"},"store_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Store Ids","description":"IDs of the vector stores grepped"},"pattern":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pattern","description":"Regular expression matched against chunk text"},"case_sensitive":{"type":"boolean","title":"Case Sensitive","description":"Whether the pattern was matched case-sensitively","default":false},"search_time":{"type":"string","format":"duration","title":"Search Time","description":"Time taken to grep the vector store","default":"PT0S"},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Output"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Output"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Metadata filters submitted with the grep request"},"results":{"items":{"$ref":"#/components/schemas/StoreSearchEventResult"},"type":"array","title":"Results","description":"Chunks that matched the pattern"}},"type":"object","required":["id","created_at","store_ids"],"title":"StoreGrepEvent","description":"Represents a grep event in a vector store.\n\nGrep matches chunks against a regular expression rather than running a\nsemantic search, so it has no ranking, rewrite, or rerank fields."},"StoreGrepResponse":{"properties":{"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"oneOf":[{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredTextInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredImageUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredAudioUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredVideoUrlInputChunk"}],"discriminator":{"propertyName":"type","mapping":{"audio_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredAudioUrlInputChunk","image_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredImageUrlInputChunk","text":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredTextInputChunk","video_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredVideoUrlInputChunk"}}},"type":"array","title":"Data","description":"The list of chunks matching the pattern"}},"type":"object","required":["data"],"title":"StoreGrepResponse"},"StoreGrepTool":{"properties":{"store_identifiers":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","minItems":1},{"type":"null"}],"title":"Store Identifiers","description":"IDs or names of the stores the tool runs against; omit to let the model pick a store per call"},"type":{"type":"string","const":"store_grep","title":"Type","default":"store_grep"},"max_num_results":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Max Num Results","description":"Number of chunks returned per grep call","default":30},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions applied to every grep"},"citations":{"type":"boolean","title":"Citations","description":"Cite sources in the answer as <cite i=\"...\"/> tags referencing result index fields","default":false}},"type":"object","title":"StoreGrepTool","description":"Hosted tool: regular-expression match over a store's chunks, executed server-side.\n\ngrep runs the pattern against the literal chunk text — no embeddings, no\nreranker. It covers exactly one store per call, so with several pinned\nstores the model picks which of them to grep."},"StoreIngestionEvent":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for the event"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the event was created"},"type":{"type":"string","const":"ingestion","title":"Type","default":"ingestion"},"store_id":{"type":"string","format":"uuid","title":"Store Id","description":"ID of the vector store"},"store_file_id":{"type":"string","title":"Store File Id","description":"ID of the vector store file"},"total_time":{"type":"string","format":"duration","title":"Total Time","description":"Total time taken to ingest the file, including queue time"},"queue_time":{"type":"string","format":"duration","title":"Queue Time","description":"Time spent in the queue"},"ingestion_time":{"type":"string","format":"duration","title":"Ingestion Time","description":"Time taken to ingest the file, excluding queue time"},"chunk_count":{"type":"integer","title":"Chunk Count","description":"Number of chunks ingested"},"contextualization":{"type":"boolean","title":"Contextualization","description":"Whether contextualization was used"},"mode":{"$ref":"#/components/schemas/StoreFileParsingStrategy","description":"Strategy used to ingest the file"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename","description":"Name of the file if the event is tied to a file"}},"type":"object","required":["id","created_at","store_id","store_file_id","total_time","queue_time","ingestion_time","chunk_count","contextualization","mode"],"title":"StoreIngestionEvent","description":"Represents an ingestion event in a vector store."},"StoreListChunksCallItem":{"properties":{"type":{"type":"string","const":"store_list_chunks_call","title":"Type","default":"store_list_chunks_call"},"id":{"type":"string","title":"Id"},"status":{"type":"string","enum":["in_progress","completed","failed"],"title":"Status","default":"completed"},"metadata_filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/MetadataFilter"},"type":"array"},{"type":"null"}],"title":"Metadata Filters"},"filter_mode":{"type":"string","enum":["all","any"],"title":"Filter Mode","default":"all"},"rank_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rank By"},"direction":{"type":"string","enum":["asc","desc"],"title":"Direction","default":"desc"},"store":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store"},"results":{"anyOf":[{"items":{"$ref":"#/components/schemas/StoreSearchResult"},"type":"array"},{"type":"null"}],"title":"Results"},"error":{"anyOf":[{"$ref":"#/components/schemas/ToolCallError"},{"type":"null"}]},"reasoning_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reasoning Offset"}},"type":"object","required":["id"],"title":"StoreListChunksCallItem","description":"Record of one server-side metadata-driven chunk listing."},"StoreListChunksResponse":{"properties":{"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"oneOf":[{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredTextInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredImageUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredAudioUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredVideoUrlInputChunk"}],"discriminator":{"propertyName":"type","mapping":{"audio_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredAudioUrlInputChunk","image_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredImageUrlInputChunk","text":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredTextInputChunk","video_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredVideoUrlInputChunk"}}},"type":"array","title":"Data","description":"The list of chunks matching the metadata filters"}},"type":"object","required":["data"],"title":"StoreListChunksResponse"},"StoreListChunksTool":{"properties":{"store_identifiers":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","minItems":1},{"type":"null"}],"title":"Store Identifiers","description":"IDs or names of the stores the tool runs against; omit to let the model pick a store per call"},"type":{"type":"string","const":"store_list_chunks","title":"Type","default":"store_list_chunks"},"max_num_results":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Max Num Results","description":"Number of chunks returned per listing call","default":30},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions applied to every listing"},"citations":{"type":"boolean","title":"Citations","description":"Cite sources in the answer as <cite i=\"...\"/> tags referencing result index fields","default":false}},"type":"object","title":"StoreListChunksTool","description":"Hosted tool: metadata-driven listing of a store's chunks, executed server-side.\n\nNo embeddings and no reranker: chunks are selected by metadata filters and\noptionally ordered by a numeric metadata field. It covers a single store per\ncall, so with several pinned stores the model picks which one to list."},"StoreListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"$ref":"#/components/schemas/Store"},"type":"array","title":"Data","description":"The list of stores"}},"type":"object","required":["pagination","data"],"title":"StoreListResponse"},"StoreQAEvent":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for the event"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the event was created"},"type":{"type":"string","const":"qa","title":"Type","default":"qa"},"store_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Store Ids","description":"IDs of the stores the answer was grounded in"},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"Time when the question answering began"},"total_time":{"type":"string","format":"duration","title":"Total Time","description":"Wall-clock time of the request, retrieval and generation included","default":"PT0S"},"search_time":{"type":"string","format":"duration","title":"Search Time","description":"Time spent on the retrieval half","default":"PT0S"},"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","description":"Question submitted by the user"},"answer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Answer","description":"Answer generated by the model"},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instructions","description":"Custom instructions provided with the request, if any"},"cite":{"type":"boolean","title":"Cite","description":"Whether citations were requested","default":false},"cited_chunk_indices":{"items":{"type":"integer"},"type":"array","title":"Cited Chunk Indices","description":"Indices into `results` the answer cited"},"agentic":{"type":"boolean","title":"Agentic","description":"Whether the retrieval ran as an agentic search","default":false},"rounds_executed":{"type":"integer","title":"Rounds Executed","description":"Number of search rounds of the agentic retrieval, when agentic","default":0},"token_usage":{"$ref":"#/components/schemas/AgenticSearchTokenUsage","description":"Token usage of the answer generation; retrieval usage is on its tool calls"},"tool_calls":{"items":{"$ref":"#/components/schemas/AgenticToolCall"},"type":"array","title":"Tool Calls","description":"Retrieval tool calls followed by the answer generation"},"results":{"items":{"$ref":"#/components/schemas/StoreSearchEventResult"},"type":"array","title":"Results","description":"Chunks the answer was grounded in"}},"type":"object","required":["id","created_at","store_ids","started_at"],"title":"StoreQAEvent","description":"Represents a question-answering request over one or more stores.\n\nCaptures both halves of the request in one record: the retrieval (a plain\nor agentic search, recorded as tool calls) and the answer generation (a\n`generation` tool call carrying the model and its token usage)."},"StoreQAParams":{"properties":{"store_identifiers":{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","maxItems":16,"minItems":1,"title":"Store Identifiers","description":"IDs or names of stores"},"top_k":{"type":"integer","minimum":1.0,"title":"Top K","description":"Number of results to return","default":10},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions"},"file_ids":{"anyOf":[{"prefixItems":[{"$ref":"#/components/schemas/ConditionOperator"},{"items":{"type":"string","format":"uuid"},"type":"array"}],"type":"array","maxItems":2,"minItems":2},{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"File Ids","description":"Optional list of file IDs to filter chunks by (inclusion filter)","examples":[["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],["in",["123e4567-e89b-12d3-a456-426614174000"]],["not_in",["123e4567-e89b-12d3-a456-426614174000"]]]},"query":{"type":"string","minLength":1,"title":"Query","description":"Question to answer. If not provided, the question will be extracted from the passed messages."},"search_options":{"$ref":"#/components/schemas/StoreChunkSearchOptions","description":"Search configuration options"},"stream":{"type":"boolean","title":"Stream","description":"Internal: when set, the response is a server-sent event stream of the retrieved chunks, live trace events, and finally the answer. Used by the Mixedbread playground; not part of the documented public API.","default":false},"instructions":{"anyOf":[{"type":"string","maxLength":8000,"minLength":1},{"type":"null"}],"title":"Instructions","description":"Additional custom instructions (followed only when not in conflict with existing rules)"},"qa_options":{"$ref":"#/components/schemas/QuestionAnsweringOptions","description":"Question answering configuration options"}},"type":"object","required":["store_identifiers"],"title":"StoreQAParams","description":"Query parameters for question answering."},"StoreQAResults":{"properties":{"answer":{"type":"string","title":"Answer","description":"The answer generated by the LLM"},"sources":{"items":{"oneOf":[{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredTextInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredImageUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredAudioUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredVideoUrlInputChunk"}],"discriminator":{"propertyName":"type","mapping":{"audio_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredAudioUrlInputChunk","image_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredImageUrlInputChunk","text":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredTextInputChunk","video_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredVideoUrlInputChunk"}}},"type":"array","title":"Sources","description":"Source documents used to generate the answer"}},"additionalProperties":true,"type":"object","required":["answer"],"title":"StoreQAResults","description":"Results from a question answering operation."},"StoreSearchCallItem":{"properties":{"type":{"type":"string","const":"store_search_call","title":"Type","default":"store_search_call"},"id":{"type":"string","title":"Id"},"status":{"type":"string","enum":["in_progress","completed","failed"],"title":"Status","default":"completed"},"queries":{"items":{"type":"string"},"type":"array","title":"Queries"},"metadata_filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/MetadataFilter"},"type":"array"},{"type":"null"}],"title":"Metadata Filters"},"filter_mode":{"type":"string","enum":["all","any"],"title":"Filter Mode","default":"all"},"store":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Store"},"results":{"anyOf":[{"items":{"$ref":"#/components/schemas/StoreSearchResult"},"type":"array"},{"type":"null"}],"title":"Results"},"error":{"anyOf":[{"$ref":"#/components/schemas/ToolCallError"},{"type":"null"}]},"reasoning_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reasoning Offset"}},"type":"object","required":["id"],"title":"StoreSearchCallItem","description":"Record of one server-side store search execution."},"StoreSearchEvent":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for the event"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the event was created"},"type":{"type":"string","const":"search","title":"Type","default":"search"},"store_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Store Ids","description":"IDs of the vector stores searched"},"search_time":{"type":"string","format":"duration","title":"Search Time","description":"Time taken to search the vector store","default":"PT0S"},"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","description":"Query used to search the vector store"},"rewritten_query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rewritten Query","description":"Rewritten query if query rewriting was enabled"},"rewritten_filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Output"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Output"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Rewritten Filters","description":"Filters used after query rewriting"},"rewrite_rank_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rewrite Rank By","description":"Metadata field used for ranking"},"rewrite_rank_direction":{"anyOf":[{"type":"string","enum":["asc","desc"]},{"type":"null"}],"title":"Rewrite Rank Direction","description":"Ranking direction"},"rewrite_rank_mode":{"anyOf":[{"type":"string","enum":["post_search","metadata"]},{"type":"null"}],"title":"Rewrite Rank Mode","description":"Ranking mode"},"rerank":{"type":"boolean","title":"Rerank","description":"Whether to rerank the results","default":false},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Output"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Output"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Metadata filters submitted with the search request"},"results":{"items":{"$ref":"#/components/schemas/StoreSearchEventResult"},"type":"array","title":"Results","description":"Chunks returned by the search"}},"type":"object","required":["id","created_at","store_ids"],"title":"StoreSearchEvent","description":"Represents a search event in a vector store."},"StoreSearchEventResult":{"properties":{"store_id":{"type":"string","title":"Store Id","description":"ID of the store the chunk belongs to"},"file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Id","description":"ID of the file the chunk belongs to"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename","description":"Name of the file the chunk belongs to"},"chunk_index":{"type":"integer","title":"Chunk Index","description":"Index of the chunk within its file"},"score":{"type":"number","title":"Score","description":"Final score assigned to the chunk"},"first_stage_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"First Stage Position","description":"Position of the chunk in the first-stage ranking"},"first_stage_source":{"anyOf":[{"type":"string","enum":["dense","sparse","both"]},{"type":"null"}],"title":"First Stage Source","description":"Which first-stage retriever surfaced the chunk"}},"type":"object","required":["store_id","chunk_index","score"],"title":"StoreSearchEventResult","description":"A single result captured on a search event."},"StoreSearchResponse":{"properties":{"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"oneOf":[{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredTextInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredImageUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredAudioUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredVideoUrlInputChunk"}],"discriminator":{"propertyName":"type","mapping":{"audio_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredAudioUrlInputChunk","image_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredImageUrlInputChunk","text":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredTextInputChunk","video_url":"#/components/schemas/mxbai_omni__core__store__models__chunk_types__ScoredVideoUrlInputChunk"}}},"type":"array","title":"Data","description":"The list of scored store file chunks"}},"additionalProperties":true,"type":"object","required":["data"],"title":"StoreSearchResponse"},"StoreSearchResult":{"properties":{"index":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Index"},"store_id":{"type":"string","title":"Store Id"},"file_id":{"type":"string","title":"File Id"},"chunk_index":{"type":"integer","title":"Chunk Index"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename"},"mime_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mime Type"},"score":{"type":"number","title":"Score"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"ocr_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ocr Text"},"transcription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcription"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata"},"generated_metadata":{"anyOf":[{},{"type":"null"}],"title":"Generated Metadata","description":"Metadata derived at ingestion. For chunks parsed in high-quality mode this carries `layout`, whose `elements` hold the per-region bounding boxes a <cite i=\"...\" e=\"...\"/> tag grounds to."}},"type":"object","required":["store_id","file_id","chunk_index","score"],"title":"StoreSearchResult","description":"User-facing search result chunk."},"StoreSearchTool":{"properties":{"store_identifiers":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","minItems":1},{"type":"null"}],"title":"Store Identifiers","description":"IDs or names of the stores the tool runs against; omit to let the model pick a store per call"},"type":{"type":"string","const":"store_search","title":"Type","default":"store_search"},"max_num_results":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Max Num Results","description":"Number of chunks returned per search call","default":10},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions applied to every search"},"score_threshold":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Score Threshold","description":"Minimum similarity score threshold","default":0.0},"citations":{"type":"boolean","title":"Citations","description":"Cite sources in the answer as <cite i=\"...\"/> tags referencing result index fields","default":false}},"type":"object","title":"StoreSearchTool","description":"Hosted tool: semantic search over the caller's stores, executed server-side."},"StoreStatus":{"type":"string","enum":["expired","in_progress","completed"],"title":"StoreStatus","description":"Status of a store."},"StoreUpdateParams":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":128,"minLength":1},{"type":"null"}],"title":"Name","description":"New name for the store. Can only contain lowercase letters, numbers, periods (.), and hyphens (-)."},"description":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Description","description":"New description"},"is_public":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Public","description":"Whether the store can be accessed by anyone with valid login credentials"},"license":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License","description":"License for public stores"},"expires_after":{"anyOf":[{"$ref":"#/components/schemas/ExpiresAfter"},{"type":"null"}],"description":"Optional expiration policy"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"Optional metadata key-value pairs"}},"type":"object","title":"StoreUpdateParams","description":"Parameters for updating an existing store."},"SyncStatus":{"type":"string","enum":["idle","pending","in_progress","cancelled","completed","failed"],"title":"SyncStatus"},"SystemMessage":{"properties":{"role":{"type":"string","const":"system","title":"Role"},"content":{"anyOf":[{"type":"string"},{"items":{"$ref":"#/components/schemas/TextPart"},"type":"array"}],"title":"Content"}},"type":"object","required":["role","content"],"title":"SystemMessage"},"TextChunkGeneratedMetadata":{"properties":{"type":{"type":"string","const":"text","title":"Type","default":"text"},"file_type":{"type":"string","enum":["text/plain","message/rfc822"],"title":"File Type","default":"text/plain"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"word_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Word Count"},"file_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Size"},"start_line":{"type":"integer","title":"Start Line","default":0},"num_lines":{"type":"integer","title":"Num Lines","default":0},"file_extension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Extension"}},"additionalProperties":true,"type":"object","title":"TextChunkGeneratedMetadata"},"TextInput":{"properties":{"type":{"type":"string","const":"text","title":"Type","description":"Input type identifier","default":"text"},"text":{"type":"string","minLength":1,"title":"Text","description":"Text content to process"}},"type":"object","required":["text"],"title":"TextInput","description":"Model for text input validation.\n\nAttributes:\n    type: Input type identifier, always \"text\"\n    text: The actual text content, with length and whitespace constraints"},"TextInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"text/plain","examples":["text/plain"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"type":{"type":"string","const":"text","title":"Type","description":"Input type identifier","default":"text"},"offset":{"type":"integer","title":"Offset","description":"The offset of the text in the file relative to the start of the file.","default":0,"examples":[0,13,42]},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text","description":"Text content"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this chunk within its source document","examples":["This chunk is from an SEC filing on ACME corp's Q2 2023 performance."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the text chunk","examples":["A short overview of ACME's Q2 2023 performance."]}},"type":"object","required":["chunk_index"],"title":"TextInputChunk"},"TextPart":{"properties":{"type":{"type":"string","const":"text","title":"Type","default":"text"},"text":{"type":"string","title":"Text"}},"type":"object","required":["text"],"title":"TextPart"},"ToolCallError":{"properties":{"code":{"type":"string","enum":["permission_denied","invalid_arguments","server_error"],"title":"Code"},"message":{"type":"string","title":"Message"}},"type":"object","required":["code","message"],"title":"ToolCallError","description":"Machine-readable reason a hosted tool call failed (Mixedbread extension)."},"ToolCallFunction":{"properties":{"name":{"type":"string","title":"Name"},"arguments":{"type":"string","title":"Arguments"}},"type":"object","required":["name","arguments"],"title":"ToolCallFunction"},"ToolChoiceFunction":{"properties":{"type":{"type":"string","const":"function","title":"Type","default":"function"},"function":{"$ref":"#/components/schemas/ToolChoiceFunctionName"}},"type":"object","required":["function"],"title":"ToolChoiceFunction","description":"Force a call to a specific function tool, as in the OpenAI Chat Completions API."},"ToolChoiceFunctionName":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"ToolChoiceFunctionName"},"ToolChoiceListStores":{"properties":{"type":{"type":"string","const":"list_stores","title":"Type","default":"list_stores"}},"type":"object","title":"ToolChoiceListStores","description":"Force a call to the hosted list stores tool (Mixedbread extension)."},"ToolChoiceMetadataFacets":{"properties":{"type":{"type":"string","const":"store_metadata_facets","title":"Type","default":"store_metadata_facets"}},"type":"object","title":"ToolChoiceMetadataFacets","description":"Force a call to the hosted metadata facets tool (Mixedbread extension)."},"ToolChoiceStoreGrep":{"properties":{"type":{"type":"string","const":"store_grep","title":"Type","default":"store_grep"}},"type":"object","title":"ToolChoiceStoreGrep","description":"Force a call to the hosted store grep tool (Mixedbread extension)."},"ToolChoiceStoreListChunks":{"properties":{"type":{"type":"string","const":"store_list_chunks","title":"Type","default":"store_list_chunks"}},"type":"object","title":"ToolChoiceStoreListChunks","description":"Force a call to the hosted list chunks tool (Mixedbread extension)."},"ToolChoiceStoreSearch":{"properties":{"type":{"type":"string","const":"store_search","title":"Type","default":"store_search"}},"type":"object","title":"ToolChoiceStoreSearch","description":"Force a call to the hosted store search tool (Mixedbread extension)."},"ToolMessage":{"properties":{"role":{"type":"string","const":"tool","title":"Role"},"content":{"anyOf":[{"type":"string"},{"items":{"$ref":"#/components/schemas/TextPart"},"type":"array"}],"title":"Content"},"tool_call_id":{"type":"string","title":"Tool Call Id"}},"type":"object","required":["role","content","tool_call_id"],"title":"ToolMessage","description":"Result of a function tool call, sent back by the caller."},"ToolTicket":{"properties":{"tool_call_id":{"type":"string","title":"Tool Call Id","description":"ID of the tool call in `choices[].message.tool_calls` this covers"},"ticket":{"type":"string","title":"Ticket","description":"Opaque token to send as the X-Mxbai-Tool-Ticket header"},"expires_at":{"type":"integer","title":"Expires At","description":"Unix timestamp after which the ticket no longer redeems"}},"type":"object","required":["tool_call_id","ticket","expires_at"],"title":"ToolTicket","description":"Proof that one client-executed tool call belongs to this completion."},"TraceDestination":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the destination"},"name":{"type":"string","title":"Name","description":"Human-readable name"},"provider":{"type":"string","enum":["langfuse","otlp"],"title":"Provider","description":"Destination type"},"endpoint":{"type":"string","title":"Endpoint","description":"OTLP/HTTP traces endpoint spans are posted to"},"credential_hint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credential Hint","description":"Non-secret half of the credential: the Langfuse public key, or the auth header name"},"event_types":{"items":{"type":"string","enum":["agentic_search","completion","search","grep","qa"]},"type":"array","title":"Event Types","description":"Which trace kinds are exported to this destination"},"enabled":{"type":"boolean","title":"Enabled","description":"Whether traces are currently being exported"},"last_exported_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Exported At","description":"When a batch last reached the destination"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Error","description":"Why the most recent delivery failed; cleared by the next success"},"last_error_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Error At","description":"When the most recent delivery failed"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the destination was created"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When the destination was last updated"},"object":{"type":"string","const":"trace_destination","title":"Object","description":"Type of the object","default":"trace_destination"}},"type":"object","required":["id","name","provider","endpoint","event_types","enabled","created_at","updated_at"],"title":"TraceDestination","description":"An OTLP endpoint this organization's agent traces are exported to."},"TraceDestinationCreateParams":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"Human-readable name"},"provider":{"type":"string","enum":["langfuse","otlp"],"title":"Provider","description":"Destination type","default":"langfuse"},"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host","description":"Langfuse base URL, e.g. https://cloud.langfuse.com","examples":["https://cloud.langfuse.com"]},"public_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Public Key","description":"Langfuse project public key"},"secret_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secret Key","description":"Langfuse project secret key"},"endpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endpoint","description":"OTLP/HTTP traces endpoint, for the `otlp` provider"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","description":"Headers sent with every OTLP request, for the `otlp` provider"},"event_types":{"items":{"type":"string","enum":["agentic_search","completion","search","grep","qa"]},"type":"array","title":"Event Types","description":"Which trace kinds to export"},"enabled":{"type":"boolean","title":"Enabled","description":"Whether to start exporting immediately","default":true}},"type":"object","required":["name"],"title":"TraceDestinationCreateParams","description":"Parameters for connecting a destination.\n\n`langfuse` takes the host and project key pair from the Langfuse project\nsettings; `otlp` takes a traces endpoint and the headers it authenticates\nwith, which covers any OTLP/HTTP collector."},"TraceDestinationDeleted":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the deleted destination"},"deleted":{"type":"boolean","const":true,"title":"Deleted","description":"Always true","default":true},"object":{"type":"string","const":"trace_destination","title":"Object","description":"Type of the object","default":"trace_destination"}},"type":"object","required":["id"],"title":"TraceDestinationDeleted","description":"Confirmation that a destination was removed."},"TraceDestinationListResponse":{"properties":{"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"$ref":"#/components/schemas/TraceDestination"},"type":"array","title":"Data","description":"The organization's trace destinations"}},"type":"object","required":["data"],"title":"TraceDestinationListResponse"},"TraceDestinationUpdateParams":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name","description":"Human-readable name"},"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host","description":"Langfuse base URL"},"public_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Public Key","description":"Langfuse project public key"},"secret_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secret Key","description":"Langfuse project secret key"},"endpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Endpoint","description":"OTLP/HTTP traces endpoint"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","description":"Headers sent with every OTLP request"},"event_types":{"anyOf":[{"items":{"type":"string","enum":["agentic_search","completion","search","grep","qa"]},"type":"array"},{"type":"null"}],"title":"Event Types","description":"Which trace kinds to export"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled","description":"Whether traces are exported"}},"type":"object","title":"TraceDestinationUpdateParams","description":"Fields to change on a destination; omitted fields keep their stored value.\n\nCredentials are write-only: supplying `secret_key` (or `headers`) replaces\nthe stored header map, and omitting them leaves it untouched."},"Usage":{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens","description":"The number of tokens used for the prompt"},"total_tokens":{"type":"integer","title":"Total Tokens","description":"The total number of tokens used"},"completion_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Completion Tokens","description":"The number of tokens used for the completion"}},"type":"object","required":["prompt_tokens","total_tokens"],"title":"Usage"},"UsageInfo":{"properties":{"current":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Current","description":"The current usage of the resource","default":"0"},"limit":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Limit","description":"The limit of the resource"},"unit":{"type":"string","title":"Unit","description":"The unit of the resource","default":""}},"type":"object","title":"UsageInfo","description":"Resource usage information."},"UserMessage":{"properties":{"role":{"type":"string","const":"user","title":"Role"},"content":{"anyOf":[{"type":"string"},{"items":{"$ref":"#/components/schemas/TextPart"},"type":"array"}],"title":"Content"}},"type":"object","required":["role","content"],"title":"UserMessage"},"ValidatedJsonSchema":{"properties":{"is_valid":{"type":"boolean","title":"Is Valid","description":"Whether the schema is valid"},"errors":{"items":{"type":"string"},"type":"array","title":"Errors","description":"List of validation errors"},"json_schema":{"additionalProperties":true,"type":"object","title":"Json Schema","description":"The validated JSON schema"}},"type":"object","required":["is_valid","errors","json_schema"],"title":"ValidatedJsonSchema","description":"Result of validating a JSON schema."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VectorStore":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the vector store","examples":["1b8b486e-16d0-400b-8868-04cd75217a7e"]},"name":{"type":"string","maxLength":128,"minLength":1,"title":"Name","description":"Name of the vector store","examples":["customer-support-kb","product-documentation"]},"description":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Description","description":"Detailed description of the vector store's purpose and contents","examples":["Contains customer support articles and FAQs"]},"is_public":{"type":"boolean","title":"Is Public","description":"Whether the vector store can be accessed by anyone with valid login credentials","default":false,"examples":[false]},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"Additional metadata associated with the vector store","examples":[{"category":"support","language":"en"}]},"file_counts":{"$ref":"#/components/schemas/FileCounts","description":"Counts of files in different states"},"expires_after":{"anyOf":[{"$ref":"#/components/schemas/ExpiresAfter"},{"type":"null"}],"description":"Optional expiration policy"},"status":{"$ref":"#/components/schemas/StoreStatus","description":"Processing status of the vector store","default":"completed"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the vector store was created","examples":["2024-01-01T00:00:00Z"]},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Timestamp when the vector store was last updated","examples":["2024-01-01T00:00:00Z"]},"last_active_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Active At","description":"Timestamp when the vector store was last used"},"usage_bytes":{"type":"integer","title":"Usage Bytes","description":"Total storage usage in bytes","default":0,"examples":[1024000]},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"Optional expiration timestamp for the vector store","examples":["2024-01-01T00:00:00Z"]},"object":{"type":"string","const":"vector_store","title":"Object","description":"Type of the object","default":"vector_store"}},"type":"object","required":["id","name","created_at","updated_at"],"title":"VectorStore","description":"Model representing a vector store with its metadata and timestamps."},"VectorStoreChunkSearchOptions":{"properties":{"score_threshold":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Score Threshold","description":"Minimum similarity score threshold","default":0.0},"rewrite_query":{"type":"boolean","title":"Rewrite Query","description":"Whether to rewrite the query. Ignored when agentic is enabled (the agent handles query decomposition).","default":false},"rerank":{"anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/RerankConfig"},{"type":"null"}],"title":"Rerank","description":"Whether to rerank results and optional reranking configuration. Ignored when agentic is enabled (the agent handles ranking)."},"agentic":{"anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/AgenticSearchConfig"},{"type":"null"}],"title":"Agentic","description":"Whether to use agentic multi-query search with automatic query decomposition and ranking. When enabled, rewrite_query and rerank options are ignored."},"lsf":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Lsf","description":"Whether to apply the learned scoring function to second-stage scoring. Requires weights configured for the searched stores; silently skipped otherwise."},"return_metadata":{"type":"boolean","title":"Return Metadata","description":"Whether to return file metadata","default":true},"apply_search_rules":{"type":"boolean","title":"Apply Search Rules","description":"Whether to apply search rules","default":true}},"type":"object","title":"VectorStoreChunkSearchOptions","description":"Options for configuring vector store chunk searches."},"VectorStoreChunkSearchParams":{"properties":{"query":{"type":"string","minLength":1,"title":"Query","description":"Search query text","examples":["how to configure SSL"]},"vector_store_identifiers":{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","maxItems":16,"minItems":1,"title":"Vector Store Identifiers","description":"IDs or names of vector stores to search"},"top_k":{"type":"integer","minimum":1.0,"title":"Top K","description":"Number of results to return","default":10},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions"},"file_ids":{"anyOf":[{"prefixItems":[{"$ref":"#/components/schemas/ConditionOperator"},{"items":{"type":"string","format":"uuid"},"type":"array"}],"type":"array","maxItems":2,"minItems":2},{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"File Ids","description":"Optional list of file IDs to filter chunks by (inclusion filter)","examples":[["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],["in",["123e4567-e89b-12d3-a456-426614174000"]],["not_in",["123e4567-e89b-12d3-a456-426614174000"]]]},"search_options":{"$ref":"#/components/schemas/VectorStoreChunkSearchOptions","description":"Search configuration options"}},"type":"object","required":["query","vector_store_identifiers"],"title":"VectorStoreChunkSearchParams","description":"Query parameters for searching vector store chunks."},"VectorStoreCreateParams":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":128,"minLength":1},{"type":"null"}],"title":"Name","description":"Name for the new vector store. Can only contain lowercase letters, numbers, periods (.), and hyphens (-).","examples":["technical-documentation"]},"description":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Description","description":"Description of the vector store","examples":["Contains technical specifications and guides"]},"is_public":{"type":"boolean","title":"Is Public","description":"Whether the vector store can be accessed by anyone with valid login credentials","default":false,"examples":[false]},"expires_after":{"anyOf":[{"$ref":"#/components/schemas/ExpiresAfter"},{"type":"null"}],"description":"Optional expiration policy"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"Optional metadata key-value pairs"},"file_ids":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"File Ids","description":"Optional list of file IDs"}},"type":"object","title":"VectorStoreCreateParams","description":"Parameters for creating a new vector store."},"VectorStoreDeleted":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}],"title":"Id","description":"ID of the deleted vector store"},"deleted":{"type":"boolean","title":"Deleted","description":"Whether the deletion was successful"},"object":{"type":"string","const":"vector_store","title":"Object","description":"Type of the deleted object","default":"vector_store"}},"type":"object","required":["id","deleted"],"title":"VectorStoreDeleted","description":"Response model for vector store deletion."},"VectorStoreFile":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the file"},"filename":{"type":"string","title":"Filename","description":"Name of the file"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"Optional file metadata"},"status":{"$ref":"#/components/schemas/StoreFileStatus","description":"Processing status of the file","default":"pending"},"last_error":{"anyOf":[{},{"type":"null"}],"title":"Last Error","description":"Last error message if processing failed"},"vector_store_id":{"type":"string","title":"Vector Store Id","description":"ID of the containing store"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp of store file creation"},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version","description":"Version number of the file","examples":[1]},"usage_bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Usage Bytes","description":"Storage usage in bytes","examples":[51200]},"object":{"type":"string","const":"vector_store.file","title":"Object","description":"Type of the object","default":"vector_store.file"},"chunks":{"anyOf":[{"items":{"oneOf":[{"$ref":"#/components/schemas/TextInputChunk"},{"$ref":"#/components/schemas/ImageUrlInputChunk"},{"$ref":"#/components/schemas/AudioUrlInputChunk"},{"$ref":"#/components/schemas/VideoUrlInputChunk"}],"discriminator":{"propertyName":"type","mapping":{"audio_url":"#/components/schemas/AudioUrlInputChunk","image_url":"#/components/schemas/ImageUrlInputChunk","text":"#/components/schemas/TextInputChunk","video_url":"#/components/schemas/VideoUrlInputChunk"}}},"type":"array"},{"type":"null"}],"title":"Chunks","description":"chunks"}},"type":"object","required":["id","vector_store_id","created_at"],"title":"VectorStoreFile","description":"Represents a file stored in a store."},"VectorStoreFileDeleted":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the deleted file"},"deleted":{"type":"boolean","title":"Deleted","description":"Whether the deletion was successful","default":true},"object":{"type":"string","const":"vector_store.file","title":"Object","description":"Type of the deleted object","default":"vector_store.file"}},"type":"object","required":["id"],"title":"VectorStoreFileDeleted","description":"Response model for file deletion."},"VectorStoreFileListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"$ref":"#/components/schemas/VectorStoreFile"},"type":"array","title":"Data","description":"The list of vector store files"}},"type":"object","required":["pagination","data"],"title":"VectorStoreFileListResponse","description":"List response wrapper for vector store files."},"VectorStoreFileStatus":{"type":"string","enum":["pending","in_progress","cancelled","completed","failed"],"title":"VectorStoreFileStatus"},"VectorStoreListResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/CursorPaginationResponse"},"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"$ref":"#/components/schemas/VectorStore"},"type":"array","title":"Data","description":"The list of vector stores"}},"type":"object","required":["pagination","data"],"title":"VectorStoreListResponse"},"VectorStoreQAParams":{"properties":{"query":{"type":"string","minLength":1,"title":"Query","description":"Question to answer. If not provided, the question will be extracted from the passed messages."},"vector_store_identifiers":{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"}]},"type":"array","maxItems":16,"minItems":1,"title":"Vector Store Identifiers","description":"IDs or names of vector stores to search"},"top_k":{"type":"integer","minimum":1.0,"title":"Top K","description":"Number of results to return","default":10},"filters":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"},{"items":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter-Input"},{"$ref":"#/components/schemas/SearchFilterCondition"}]},"type":"array"},{"type":"null"}],"title":"Filters","description":"Optional filter conditions"},"file_ids":{"anyOf":[{"prefixItems":[{"$ref":"#/components/schemas/ConditionOperator"},{"items":{"type":"string","format":"uuid"},"type":"array"}],"type":"array","maxItems":2,"minItems":2},{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"File Ids","description":"Optional list of file IDs to filter chunks by (inclusion filter)","examples":[["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],["in",["123e4567-e89b-12d3-a456-426614174000"]],["not_in",["123e4567-e89b-12d3-a456-426614174000"]]]},"search_options":{"$ref":"#/components/schemas/VectorStoreChunkSearchOptions","description":"Search configuration options"},"stream":{"type":"boolean","title":"Stream","description":"Whether to stream the answer","default":false},"qa_options":{"$ref":"#/components/schemas/QuestionAnsweringOptions","description":"Question answering configuration options"}},"type":"object","required":["vector_store_identifiers"],"title":"VectorStoreQAParams","description":"Query parameters for question answering."},"VectorStoreQAResults":{"properties":{"answer":{"type":"string","title":"Answer","description":"The answer generated by the LLM"},"sources":{"items":{"oneOf":[{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredTextInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredImageUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredAudioUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredVideoUrlInputChunk"}],"discriminator":{"propertyName":"type","mapping":{"audio_url":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredAudioUrlInputChunk","image_url":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredImageUrlInputChunk","text":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredTextInputChunk","video_url":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredVideoUrlInputChunk"}}},"type":"array","title":"Sources","description":"Source documents used to generate the answer"}},"type":"object","required":["answer"],"title":"VectorStoreQAResults","description":"Results from a question answering operation."},"VectorStoreSearchResponse":{"properties":{"object":{"type":"string","const":"list","title":"Object","description":"The object type of the response","default":"list"},"data":{"items":{"oneOf":[{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredTextInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredImageUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredAudioUrlInputChunk"},{"$ref":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredVideoUrlInputChunk"}],"discriminator":{"propertyName":"type","mapping":{"audio_url":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredAudioUrlInputChunk","image_url":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredImageUrlInputChunk","text":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredTextInputChunk","video_url":"#/components/schemas/mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredVideoUrlInputChunk"}}},"type":"array","title":"Data","description":"The list of scored vector store file chunks"}},"type":"object","required":["data"],"title":"VectorStoreSearchResponse"},"VectorStoreUpdateParams":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":128,"minLength":1},{"type":"null"}],"title":"Name","description":"New name for the store. Can only contain lowercase letters, numbers, periods (.), and hyphens (-)."},"description":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Description","description":"New description"},"is_public":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Public","description":"Whether the vector store can be accessed by anyone with valid login credentials"},"expires_after":{"anyOf":[{"$ref":"#/components/schemas/ExpiresAfter"},{"type":"null"}],"description":"Optional expiration policy"},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"Optional metadata key-value pairs"}},"type":"object","title":"VectorStoreUpdateParams","description":"Parameters for updating an existing store."},"VideoChunkGeneratedMetadata":{"properties":{"type":{"type":"string","const":"video","title":"Type","default":"video"},"file_type":{"type":"string","title":"File Type","default":"video/mp4"},"file_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Size"},"total_duration_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Duration Seconds"},"fps":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fps"},"width":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Width"},"height":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Height"},"frame_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Frame Count"},"has_audio_stream":{"type":"boolean","title":"Has Audio Stream","default":false},"bpm":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bpm"},"file_extension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Extension"}},"additionalProperties":true,"type":"object","title":"VideoChunkGeneratedMetadata"},"VideoUrl":{"properties":{"url":{"type":"string","title":"Url","description":"The video URL. Can be either a URL or a Data URI."}},"type":"object","required":["url"],"title":"VideoUrl","description":"Model for video URL validation."},"VideoUrlInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"video/mp4","examples":["video/mp4"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"type":{"type":"string","const":"video_url","title":"Type","description":"Input type identifier","default":"video_url"},"transcription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcription","description":"speech recognition (sr) text of the video","examples":["The year 2025 reports for .."]},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this video chunk within its source file","examples":["This segment demonstrates the product's document search workflow."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the video","examples":["A financial report video for 2025"]},"video_url":{"anyOf":[{"$ref":"#/components/schemas/VideoUrl"},{"type":"null"}],"description":"Video URL"}},"type":"object","required":["chunk_index"],"title":"VideoUrlInputChunk"},"mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredAudioUrlInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"audio/mpeg","examples":["audio/mpeg"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"score":{"type":"number","title":"Score","description":"score of the chunk","examples":[0.5]},"file_id":{"type":"string","title":"File Id","description":"file id","examples":["file1"]},"filename":{"type":"string","title":"Filename","description":"filename","examples":["file1"]},"vector_store_id":{"type":"string","title":"Vector Store Id","description":"store id","examples":["store1"]},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"file metadata","examples":[{"key":"value"}]},"type":{"type":"string","const":"audio_url","title":"Type","description":"Input type identifier","default":"audio_url"},"transcription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcription","description":"speech recognition (sr) text of the audio","examples":["The year 2025 reports for .."]},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this audio chunk within its source file","examples":["This segment introduces ACME's quarterly earnings call."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the audio","examples":["A financial report audio for 2025"]},"audio_url":{"anyOf":[{"$ref":"#/components/schemas/AudioUrl"},{"type":"null"}],"description":"Audio URL"},"sampling_rate":{"type":"integer","title":"Sampling Rate","description":"The sampling rate of the audio."}},"type":"object","required":["chunk_index","score","file_id","filename","vector_store_id","sampling_rate"],"title":"ScoredAudioUrlInputChunk","description":"Scored audio chunk for deprecated API."},"mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredImageUrlInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"image/jpeg","examples":["image/jpeg"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"score":{"type":"number","title":"Score","description":"score of the chunk","examples":[0.5]},"file_id":{"type":"string","title":"File Id","description":"file id","examples":["file1"]},"filename":{"type":"string","title":"Filename","description":"filename","examples":["file1"]},"vector_store_id":{"type":"string","title":"Vector Store Id","description":"store id","examples":["store1"]},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"file metadata","examples":[{"key":"value"}]},"type":{"type":"string","const":"image_url","title":"Type","description":"Input type identifier","default":"image_url"},"ocr_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ocr Text","description":"ocr text of the image","examples":["2025 Financial Report"]},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this image within its source document","examples":["This page contains ACME's Q2 2023 financial results."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the image","examples":["A financial report for 2025"]},"image_url":{"anyOf":[{"$ref":"#/components/schemas/ImageUrl-Output"},{"type":"null"}],"description":"Image URL"}},"type":"object","required":["chunk_index","score","file_id","filename","vector_store_id"],"title":"ScoredImageUrlInputChunk","description":"Scored image chunk for deprecated API."},"mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredTextInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"text/plain","examples":["text/plain"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"score":{"type":"number","title":"Score","description":"score of the chunk","examples":[0.5]},"file_id":{"type":"string","title":"File Id","description":"file id","examples":["file1"]},"filename":{"type":"string","title":"Filename","description":"filename","examples":["file1"]},"vector_store_id":{"type":"string","title":"Vector Store Id","description":"store id","examples":["store1"]},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"file metadata","examples":[{"key":"value"}]},"type":{"type":"string","const":"text","title":"Type","description":"Input type identifier","default":"text"},"offset":{"type":"integer","title":"Offset","description":"The offset of the text in the file relative to the start of the file.","default":0,"examples":[0,13,42]},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text","description":"Text content"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this chunk within its source document","examples":["This chunk is from an SEC filing on ACME corp's Q2 2023 performance."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the text chunk","examples":["A short overview of ACME's Q2 2023 performance."]}},"type":"object","required":["chunk_index","score","file_id","filename","vector_store_id"],"title":"ScoredTextInputChunk","description":"Scored text chunk for deprecated API."},"mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredVideoUrlInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"video/mp4","examples":["video/mp4"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"score":{"type":"number","title":"Score","description":"score of the chunk","examples":[0.5]},"file_id":{"type":"string","title":"File Id","description":"file id","examples":["file1"]},"filename":{"type":"string","title":"Filename","description":"filename","examples":["file1"]},"vector_store_id":{"type":"string","title":"Vector Store Id","description":"store id","examples":["store1"]},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"file metadata","examples":[{"key":"value"}]},"type":{"type":"string","const":"video_url","title":"Type","description":"Input type identifier","default":"video_url"},"transcription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcription","description":"speech recognition (sr) text of the video","examples":["The year 2025 reports for .."]},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this video chunk within its source file","examples":["This segment demonstrates the product's document search workflow."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the video","examples":["A financial report video for 2025"]},"video_url":{"anyOf":[{"$ref":"#/components/schemas/VideoUrl"},{"type":"null"}],"description":"Video URL"}},"type":"object","required":["chunk_index","score","file_id","filename","vector_store_id"],"title":"ScoredVideoUrlInputChunk","description":"Scored video chunk for deprecated API."},"mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleCreateParams":{"properties":{"query":{"type":"string","title":"Query","description":"The query pattern to match"},"rules":{"items":{"oneOf":[{"$ref":"#/components/schemas/QueryStringSubstitutionRule"},{"$ref":"#/components/schemas/QueryRegexSubstitutionRule"},{"$ref":"#/components/schemas/ChunkSearchResultRule"},{"$ref":"#/components/schemas/FileSearchResultRule"}],"description":"The possible rules for a vector store search","discriminator":{"propertyName":"type","mapping":{"chunk_search_result":"#/components/schemas/ChunkSearchResultRule","file_search_result":"#/components/schemas/FileSearchResultRule","query_regex":"#/components/schemas/QueryRegexSubstitutionRule","query_string":"#/components/schemas/QueryStringSubstitutionRule"}}},"type":"array","title":"Rules","description":"The rules to apply on query matches"}},"type":"object","required":["query","rules"],"title":"SearchRuleCreateParams","description":"Parameters for creating a new search rule."},"mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleDeleted":{"properties":{"id":{"type":"string","title":"Id","description":"The deleted search rule ID"},"object":{"type":"string","const":"search_rule","title":"Object","description":"The object type","default":"search_rule"},"deleted":{"type":"boolean","title":"Deleted","description":"Whether the search rule was deleted","default":true}},"type":"object","required":["id"],"title":"SearchRuleDeleted","description":"Response model for deleted search rule."},"mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The search rule ID"},"object":{"type":"string","const":"search_rule","title":"Object","description":"The object type","default":"search_rule"},"query":{"type":"string","title":"Query","description":"The query pattern"},"vector_store_id":{"type":"string","title":"Vector Store Id","description":"The vector store ID"},"rules":{"items":{"oneOf":[{"$ref":"#/components/schemas/QueryStringSubstitutionRule"},{"$ref":"#/components/schemas/QueryRegexSubstitutionRule"},{"$ref":"#/components/schemas/ChunkSearchResultRule"},{"$ref":"#/components/schemas/FileSearchResultRule"}],"description":"The possible rules for a vector store search","discriminator":{"propertyName":"type","mapping":{"chunk_search_result":"#/components/schemas/ChunkSearchResultRule","file_search_result":"#/components/schemas/FileSearchResultRule","query_regex":"#/components/schemas/QueryRegexSubstitutionRule","query_string":"#/components/schemas/QueryStringSubstitutionRule"}}},"type":"array","title":"Rules","description":"The rules to apply"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the rule was created"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When the rule was last updated"}},"type":"object","required":["id","query","vector_store_id","rules","created_at","updated_at"],"title":"SearchRuleResponse","description":"Response model for a search rule."},"mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleSpecificDeleteParams":{"properties":{"rule":{"oneOf":[{"$ref":"#/components/schemas/QueryStringSubstitutionRule"},{"$ref":"#/components/schemas/QueryRegexSubstitutionRule"},{"$ref":"#/components/schemas/ChunkSearchResultRule"},{"$ref":"#/components/schemas/FileSearchResultRule"}],"title":"Rule","description":"The specific rule to delete from the rules array","discriminator":{"propertyName":"type","mapping":{"chunk_search_result":"#/components/schemas/ChunkSearchResultRule","file_search_result":"#/components/schemas/FileSearchResultRule","query_regex":"#/components/schemas/QueryRegexSubstitutionRule","query_string":"#/components/schemas/QueryStringSubstitutionRule"}}}},"type":"object","required":["rule"],"title":"SearchRuleSpecificDeleteParams","description":"Parameters for deleting a specific rule from array."},"mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleSpecificDeleted":{"properties":{"id":{"type":"string","title":"Id","description":"The search rule ID"},"object":{"type":"string","const":"search_rule","title":"Object","description":"The object type","default":"search_rule"},"deleted_rule":{"oneOf":[{"$ref":"#/components/schemas/QueryStringSubstitutionRule"},{"$ref":"#/components/schemas/QueryRegexSubstitutionRule"},{"$ref":"#/components/schemas/ChunkSearchResultRule"},{"$ref":"#/components/schemas/FileSearchResultRule"}],"title":"Deleted Rule","description":"The specific rule that was deleted","discriminator":{"propertyName":"type","mapping":{"chunk_search_result":"#/components/schemas/ChunkSearchResultRule","file_search_result":"#/components/schemas/FileSearchResultRule","query_regex":"#/components/schemas/QueryRegexSubstitutionRule","query_string":"#/components/schemas/QueryStringSubstitutionRule"}}},"remaining_rules":{"type":"integer","title":"Remaining Rules","description":"Number of rules remaining in the array"}},"type":"object","required":["id","deleted_rule","remaining_rules"],"title":"SearchRuleSpecificDeleted","description":"Response model for specific deleted rule."},"mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleUpdateParams":{"properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","description":"The query pattern to match"},"rules":{"anyOf":[{"items":{"oneOf":[{"$ref":"#/components/schemas/QueryStringSubstitutionRule"},{"$ref":"#/components/schemas/QueryRegexSubstitutionRule"},{"$ref":"#/components/schemas/ChunkSearchResultRule"},{"$ref":"#/components/schemas/FileSearchResultRule"}],"description":"The possible rules for a vector store search","discriminator":{"propertyName":"type","mapping":{"chunk_search_result":"#/components/schemas/ChunkSearchResultRule","file_search_result":"#/components/schemas/FileSearchResultRule","query_regex":"#/components/schemas/QueryRegexSubstitutionRule","query_string":"#/components/schemas/QueryStringSubstitutionRule"}}},"type":"array"},{"type":"null"}],"title":"Rules","description":"The rules to apply on query matches"}},"type":"object","title":"SearchRuleUpdateParams","description":"Parameters for updating a search rule."},"mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleCreateParams":{"properties":{"query":{"type":"string","title":"Query","description":"The query pattern to match"},"rules":{"items":{"oneOf":[{"$ref":"#/components/schemas/QueryStringSubstitutionRule"},{"$ref":"#/components/schemas/QueryRegexSubstitutionRule"},{"$ref":"#/components/schemas/ChunkSearchResultRule"},{"$ref":"#/components/schemas/FileSearchResultRule"}],"description":"The possible rules for a vector store search","discriminator":{"propertyName":"type","mapping":{"chunk_search_result":"#/components/schemas/ChunkSearchResultRule","file_search_result":"#/components/schemas/FileSearchResultRule","query_regex":"#/components/schemas/QueryRegexSubstitutionRule","query_string":"#/components/schemas/QueryStringSubstitutionRule"}}},"type":"array","title":"Rules","description":"The rules to apply on query matches"}},"type":"object","required":["query","rules"],"title":"SearchRuleCreateParams","description":"Parameters for creating a new search rule for a store."},"mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleDeleted":{"properties":{"deleted":{"type":"boolean","title":"Deleted","description":"Whether the search rule was deleted"},"object":{"type":"string","const":"search_rule.deleted","title":"Object","description":"The object type","default":"search_rule.deleted"}},"type":"object","required":["deleted"],"title":"SearchRuleDeleted","description":"Response model for deleted store search rule."},"mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The search rule ID"},"object":{"type":"string","const":"search_rule","title":"Object","description":"The object type","default":"search_rule"},"query":{"type":"string","title":"Query","description":"The query pattern"},"store_id":{"type":"string","title":"Store Id","description":"The store ID"},"rules":{"items":{"oneOf":[{"$ref":"#/components/schemas/QueryStringSubstitutionRule"},{"$ref":"#/components/schemas/QueryRegexSubstitutionRule"},{"$ref":"#/components/schemas/ChunkSearchResultRule"},{"$ref":"#/components/schemas/FileSearchResultRule"}],"description":"The possible rules for a vector store search","discriminator":{"propertyName":"type","mapping":{"chunk_search_result":"#/components/schemas/ChunkSearchResultRule","file_search_result":"#/components/schemas/FileSearchResultRule","query_regex":"#/components/schemas/QueryRegexSubstitutionRule","query_string":"#/components/schemas/QueryStringSubstitutionRule"}}},"type":"array","title":"Rules","description":"The rules to apply"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the rule was created"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When the rule was last updated"}},"type":"object","required":["id","query","store_id","rules","created_at","updated_at"],"title":"SearchRuleResponse","description":"Response model for a store search rule."},"mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleSpecificDeleteParams":{"properties":{"rule":{"oneOf":[{"$ref":"#/components/schemas/QueryStringSubstitutionRule"},{"$ref":"#/components/schemas/QueryRegexSubstitutionRule"},{"$ref":"#/components/schemas/ChunkSearchResultRule"},{"$ref":"#/components/schemas/FileSearchResultRule"}],"title":"Rule","description":"The specific rule to delete from the rules array","discriminator":{"propertyName":"type","mapping":{"chunk_search_result":"#/components/schemas/ChunkSearchResultRule","file_search_result":"#/components/schemas/FileSearchResultRule","query_regex":"#/components/schemas/QueryRegexSubstitutionRule","query_string":"#/components/schemas/QueryStringSubstitutionRule"}}}},"type":"object","required":["rule"],"title":"SearchRuleSpecificDeleteParams","description":"Parameters for deleting a specific rule from a search rule array."},"mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleSpecificDeleted":{"properties":{"id":{"type":"string","title":"Id","description":"The search rule ID"},"object":{"type":"string","const":"search_rule","title":"Object","description":"The object type","default":"search_rule"},"deleted_rule":{"oneOf":[{"$ref":"#/components/schemas/QueryStringSubstitutionRule"},{"$ref":"#/components/schemas/QueryRegexSubstitutionRule"},{"$ref":"#/components/schemas/ChunkSearchResultRule"},{"$ref":"#/components/schemas/FileSearchResultRule"}],"title":"Deleted Rule","description":"The specific rule that was deleted","discriminator":{"propertyName":"type","mapping":{"chunk_search_result":"#/components/schemas/ChunkSearchResultRule","file_search_result":"#/components/schemas/FileSearchResultRule","query_regex":"#/components/schemas/QueryRegexSubstitutionRule","query_string":"#/components/schemas/QueryStringSubstitutionRule"}}},"remaining_rules":{"type":"integer","title":"Remaining Rules","description":"Number of rules remaining in the array"}},"type":"object","required":["id","deleted_rule","remaining_rules"],"title":"SearchRuleSpecificDeleted","description":"Response model for a specific deleted rule from a search rule array."},"mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleUpdateParams":{"properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","description":"The query pattern to match"},"rules":{"anyOf":[{"items":{"oneOf":[{"$ref":"#/components/schemas/QueryStringSubstitutionRule"},{"$ref":"#/components/schemas/QueryRegexSubstitutionRule"},{"$ref":"#/components/schemas/ChunkSearchResultRule"},{"$ref":"#/components/schemas/FileSearchResultRule"}],"description":"The possible rules for a vector store search","discriminator":{"propertyName":"type","mapping":{"chunk_search_result":"#/components/schemas/ChunkSearchResultRule","file_search_result":"#/components/schemas/FileSearchResultRule","query_regex":"#/components/schemas/QueryRegexSubstitutionRule","query_string":"#/components/schemas/QueryStringSubstitutionRule"}}},"type":"array"},{"type":"null"}],"title":"Rules","description":"The rules to apply on query matches"}},"type":"object","title":"SearchRuleUpdateParams","description":"Parameters for updating an existing search rule for a store."},"mxbai_omni__core__store__models__chunk_types__ScoredAudioUrlInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"audio/mpeg","examples":["audio/mpeg"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"score":{"type":"number","title":"Score","description":"score of the chunk","examples":[0.5]},"file_id":{"type":"string","title":"File Id","description":"file id","examples":["file1"]},"filename":{"type":"string","title":"Filename","description":"filename","examples":["file1"]},"store_id":{"type":"string","title":"Store Id","description":"store id","examples":["store1"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"external identifier for this file","examples":["ext-123"]},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"file metadata","examples":[{"key":"value"}]},"type":{"type":"string","const":"audio_url","title":"Type","description":"Input type identifier","default":"audio_url"},"transcription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcription","description":"speech recognition (sr) text of the audio","examples":["The year 2025 reports for .."]},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this audio chunk within its source file","examples":["This segment introduces ACME's quarterly earnings call."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the audio","examples":["A financial report audio for 2025"]},"audio_url":{"anyOf":[{"$ref":"#/components/schemas/AudioUrl"},{"type":"null"}],"description":"Audio URL"},"sampling_rate":{"type":"integer","title":"Sampling Rate","description":"The sampling rate of the audio."}},"type":"object","required":["chunk_index","score","file_id","filename","store_id","sampling_rate"],"title":"ScoredAudioUrlInputChunk"},"mxbai_omni__core__store__models__chunk_types__ScoredImageUrlInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"image/jpeg","examples":["image/jpeg"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"score":{"type":"number","title":"Score","description":"score of the chunk","examples":[0.5]},"file_id":{"type":"string","title":"File Id","description":"file id","examples":["file1"]},"filename":{"type":"string","title":"Filename","description":"filename","examples":["file1"]},"store_id":{"type":"string","title":"Store Id","description":"store id","examples":["store1"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"external identifier for this file","examples":["ext-123"]},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"file metadata","examples":[{"key":"value"}]},"type":{"type":"string","const":"image_url","title":"Type","description":"Input type identifier","default":"image_url"},"ocr_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ocr Text","description":"ocr text of the image","examples":["2025 Financial Report"]},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this image within its source document","examples":["This page contains ACME's Q2 2023 financial results."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the image","examples":["A financial report for 2025"]},"image_url":{"anyOf":[{"$ref":"#/components/schemas/ImageUrl-Output"},{"type":"null"}],"description":"Image URL"}},"type":"object","required":["chunk_index","score","file_id","filename","store_id"],"title":"ScoredImageUrlInputChunk"},"mxbai_omni__core__store__models__chunk_types__ScoredTextInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"text/plain","examples":["text/plain"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"score":{"type":"number","title":"Score","description":"score of the chunk","examples":[0.5]},"file_id":{"type":"string","title":"File Id","description":"file id","examples":["file1"]},"filename":{"type":"string","title":"Filename","description":"filename","examples":["file1"]},"store_id":{"type":"string","title":"Store Id","description":"store id","examples":["store1"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"external identifier for this file","examples":["ext-123"]},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"file metadata","examples":[{"key":"value"}]},"type":{"type":"string","const":"text","title":"Type","description":"Input type identifier","default":"text"},"offset":{"type":"integer","title":"Offset","description":"The offset of the text in the file relative to the start of the file.","default":0,"examples":[0,13,42]},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text","description":"Text content"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this chunk within its source document","examples":["This chunk is from an SEC filing on ACME corp's Q2 2023 performance."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the text chunk","examples":["A short overview of ACME's Q2 2023 performance."]}},"type":"object","required":["chunk_index","score","file_id","filename","store_id"],"title":"ScoredTextInputChunk"},"mxbai_omni__core__store__models__chunk_types__ScoredVideoUrlInputChunk":{"properties":{"chunk_index":{"type":"integer","title":"Chunk Index","description":"position of the chunk in a file","examples":[0,1,2,3,4]},"mime_type":{"type":"string","title":"Mime Type","description":"mime type of the chunk","default":"video/mp4","examples":["video/mp4"]},"generated_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MarkdownChunkGeneratedMetadata"},{"$ref":"#/components/schemas/TextChunkGeneratedMetadata"},{"$ref":"#/components/schemas/PDFChunkGeneratedMetadata"},{"$ref":"#/components/schemas/CodeChunkGeneratedMetadata"},{"$ref":"#/components/schemas/AudioChunkGeneratedMetadata"},{"$ref":"#/components/schemas/VideoChunkGeneratedMetadata"},{"$ref":"#/components/schemas/ImageChunkGeneratedMetadata"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioChunkGeneratedMetadata","code":"#/components/schemas/CodeChunkGeneratedMetadata","image":"#/components/schemas/ImageChunkGeneratedMetadata","markdown":"#/components/schemas/MarkdownChunkGeneratedMetadata","pdf":"#/components/schemas/PDFChunkGeneratedMetadata","text":"#/components/schemas/TextChunkGeneratedMetadata","video":"#/components/schemas/VideoChunkGeneratedMetadata"}}},{"type":"null"}],"title":"Generated Metadata","description":"metadata of the chunk","examples":[{"file_size":1024,"file_type":"text/plain","language":"en","type":"text","word_count":100}]},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"model used for this chunk","examples":["text-embedding-ada-002","clip-vit-large-patch14"]},"score":{"type":"number","title":"Score","description":"score of the chunk","examples":[0.5]},"file_id":{"type":"string","title":"File Id","description":"file id","examples":["file1"]},"filename":{"type":"string","title":"Filename","description":"filename","examples":["file1"]},"store_id":{"type":"string","title":"Store Id","description":"store id","examples":["store1"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"external identifier for this file","examples":["ext-123"]},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata","description":"file metadata","examples":[{"key":"value"}]},"type":{"type":"string","const":"video_url","title":"Type","description":"Input type identifier","default":"video_url"},"transcription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcription","description":"speech recognition (sr) text of the video","examples":["The year 2025 reports for .."]},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context","description":"LLM-generated context that situates this video chunk within its source file","examples":["This segment demonstrates the product's document search workflow."]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the video","examples":["A financial report video for 2025"]},"video_url":{"anyOf":[{"$ref":"#/components/schemas/VideoUrl"},{"type":"null"}],"description":"Video URL"}},"type":"object","required":["chunk_index","score","file_id","filename","store_id"],"title":"ScoredVideoUrlInputChunk"}},"securitySchemes":{"ApiKeyAuth":{"type":"http","description":"Api key to access Mixedbreads API","scheme":"bearer"}}}}